turboself-api
TypeScript icon, indicating that this package has built-in type declarations

1.2.6 • Public • Published

turboself-api

npm npm version npm npm

A simple wrapper to interact with the TurboSelf API.

[!warning] This project is not affiliated with TurboSelf or INCB in any way.

📝 Roadmap

  • [ ] Authentification

    • [x] With credentials
    • [ ] With token (with Pronote for example)
  • [x] Reset password request (with email)

  • [x] Get informations

    • [x] Balance
    • [x] Bookings
    • [x] History
    • [x] Host
    • [x] Last transaction
    • [x] Permissions to book evenings meals
    • [x] Siblings
    • [x] User
  • [x] Seaching an etablishment

    • [x] By city
    • [x] With Limit
  • [x] Get etablishment informations

  • [x] Book a meal (book and cancel)

📦 Installation

npm install turboself-api

🔧 Usage

Authentification with credentials

const TurboSelf = require("turboself-api");

async function main() {
  let client = await TurboSelf.authenticateWithCredentials({
    username: "your_email",
    password: "your_password",
  });
  console.log(client);
}

main();

Other exemples

To see more examples, check the examples folder.

௷ Credits

Thanks to the following people for their contributions to this project:

Package Sidebar

Install

npm i turboself-api

Weekly Downloads

52

Version

1.2.6

License

GPL-3.0

Unpacked Size

154 kB

Total Files

74

Last publish

Collaborators

  • raphckrman