ApiV1 - JavaScript client for api_v1 No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:
- API version: v1
- Package version: v1
- Build package: io.swagger.codegen.v3.generators.javascript.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 api_v1 --save
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 ApiV1 = require('api_v1');
var defaultClient = ApiV1.ApiClient.instance;
// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"
var api = new ApiV1.InvitationsApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.apiV1InvitationsGet(callback);
All URIs are relative to https://menadevs.com/api/v1/
Class | Method | HTTP request | Description |
---|---|---|---|
ApiV1.InvitationsApi | apiV1InvitationsGet | GET /api/v1/invitations | Invitation |
ApiV1.InvitationsApi | createNewInvitation | POST /api/v1/invitations | Invitation |
ApiV1.JobApi | apiV1JobsIdGet | GET /api/v1/jobs/{id} | Retrieves a job |
ApiV1.JobsApi | apiV1JobsGet | GET /api/v1/jobs | All jobs |
ApiV1.UserApi | apiV1UsersIdGet | GET /api/v1/users/{id} | Retrieves a user |
ApiV1.UserApi | apiV1UsersSearchGet | GET /api/v1/users/search | Searches for a user using an incorrect query parameter |
ApiV1.UsersApi | apiV1UsersGet | GET /api/v1/users | All users |
- ApiV1.ErrorsMap
- ApiV1.ErrorsObject
- ApiV1.Invitation
- ApiV1.InvitationInvitation
- ApiV1.Jobs
- ApiV1.JobsAttributes
- ApiV1.JobsData
- ApiV1.JobsMeta
- ApiV1.JobsPagination
- ApiV1.User
- ApiV1.Users
- ApiV1.UsersAttributes
- ApiV1.UsersData
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header