onboarding_service v1.0.0
onboarding_service
OnboardingService - JavaScript client for onboarding_service
About the service Onboarding service is responsible for user onboarding as well as authentication and authorization
This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install onboarding_service --save
git
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
For browser
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.
Webpack Configuration
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
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var OnboardingService = require('onboarding_service');
var defaultClient = OnboardingService.ApiClient.instance;
var api = new OnboardingService.UserOnboardingApi()
var opts = {
'body': new OnboardingService.SignInRequest() // {SignInRequest}
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.signIn(opts, callback);
Documentation for API Endpoints
All URIs are relative to http://localhost:8090
Class | Method | HTTP request | Description |
---|---|---|---|
OnboardingService.UserOnboardingApi | signIn | POST /user/signin | This endpoint is use for user signIn |
OnboardingService.UserOnboardingApi | signUp | POST /user/register | This endpoint is use for onboarding new user |
Documentation for Models
- OnboardingService.Error
- OnboardingService.ErrorResponse
- OnboardingService.MetaResponse
- OnboardingService.PagingResponse
- OnboardingService.ResponseStatus
- OnboardingService.SignInRequest
- OnboardingService.SignUpRequest
- OnboardingService.SignUpResponse
- OnboardingService.TokenDto
- OnboardingService.TokenResponse
- OnboardingService.UserDto
Documentation for Authorization
BearerAuth
5 months ago