BreakdownSchedSdk - JavaScript client for breakdown_sched_sdk No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:
- API version: 0.1.0
- Package version: 0.1.0
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
For Node.js
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install breakdown_sched_sdk --save
Finally, you need to build the module:
npm run build
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
To use the link you just defined in your project, switch to the directory you want to use your breakdown_sched_sdk from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --save
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Please follow the installation instruction and execute the following JS code:
var BreakdownSchedSdk = require('breakdown_sched_sdk');
var api = new BreakdownSchedSdk.AuthApi()
var inlineObject3 = new BreakdownSchedSdk.InlineObject3(); // {InlineObject3}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.authForgotPasswordPost(inlineObject3, callback);
All URIs are relative to http://localhost:3000/v1
Class | Method | HTTP request | Description |
---|---|---|---|
BreakdownSchedSdk.AuthApi | authForgotPasswordPost | POST /auth/forgot-password | Forgot password |
BreakdownSchedSdk.AuthApi | authLoginPost | POST /auth/login | Login |
BreakdownSchedSdk.AuthApi | authRefreshTokensPost | POST /auth/refresh-tokens | Refresh auth tokens |
BreakdownSchedSdk.AuthApi | authRegisterPost | POST /auth/register | Register as user |
BreakdownSchedSdk.AuthApi | authResetPasswordPost | POST /auth/reset-password | Reset password |
BreakdownSchedSdk.UsersApi | usersGet | GET /users | Get all users |
BreakdownSchedSdk.UsersApi | usersIdDelete | DELETE /users/{id} | Delete a user |
BreakdownSchedSdk.UsersApi | usersIdGet | GET /users/{id} | Get a user |
BreakdownSchedSdk.UsersApi | usersIdPatch | PATCH /users/{id} | Update a user |
BreakdownSchedSdk.UsersApi | usersPost | POST /users | Create a user |
- BreakdownSchedSdk.AuthTokens
- BreakdownSchedSdk.Error
- BreakdownSchedSdk.InlineObject
- BreakdownSchedSdk.InlineObject1
- BreakdownSchedSdk.InlineObject2
- BreakdownSchedSdk.InlineObject3
- BreakdownSchedSdk.InlineObject4
- BreakdownSchedSdk.InlineObject5
- BreakdownSchedSdk.InlineObject6
- BreakdownSchedSdk.InlineResponse201
- BreakdownSchedSdk.Scene
- BreakdownSchedSdk.Token
- BreakdownSchedSdk.User
- Type: Bearer authentication (JWT)