/we-toolkit

Providing easy access to Telecom Egypt's API

Primary LanguageTypeScript

we-toolkit

we-toolkit is a package that provides easy access to Telecom Egypt's API.

Installation

Use the package manager npm to install we-toolkit.

npm install we-toolkit

Usage

import { getBalance, getUsage, login } from "we-toolkit"

// Use the functions provided by the package
// For example:
let authData = await login("number", "password");
let balance = await getBalance(authData);
let usage = await getUsage(authData);

API

login(number, password)

Logs in to the service and returns an authData object.

getBalance(authData)

Returns the balance for the authenticated user.

getUsage(authData)

Returns the data usage for the authenticated user.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Acknowledgements

License

MIT