WorkEvolveApi - JavaScript client for work_evolve_api workEvolve Restful API generated by Swagger This SDK is automatically generated by the Swagger Codegen project:
- API version: 0.1.0
- Package version: 0.1.0
- Build package: io.swagger.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 work_evolve_api --save
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
Finally, switch to the directory you want to use your work_evolve_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('work_evolve_api')
in javascript files from the directory you ran the last
command above from.
If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/work_evolve_api then install it via:
npm install YOUR_USERNAME/work_evolve_api --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, that's to say your javascript file where you actually
use this library):
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 WorkEvolveApi = require('work_evolve_api');
var defaultClient = WorkEvolveApi.ApiClient.instance;
// Configure API key authorization: default
var default = defaultClient.authentications['default'];
default.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//default.apiKeyPrefix['Authorization'] = "Token"
var api = new WorkEvolveApi.AddressBookApi()
var tenantId = "tenantId_example"; // {String} id of tenant to filter by
var addressBookId = "addressBookId_example"; // {String} id of addressbook to filter by
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.getAddressBookById(tenantId, addressBookId, callback);
All URIs are relative to http://localhost:81/l5-swaggers/public/v1
Class | Method | HTTP request | Description |
---|---|---|---|
WorkEvolveApi.AddressBookApi | getAddressBookById | GET /tenants/{tenantId}/addressbooks/{addressBookId} | get addressbook by id |
WorkEvolveApi.AddressBookApi | getAllAddressBooks | POST /tenants/{tenantId}/addressbooks/get | get all addressbooks |
WorkEvolveApi.AddressBookApi | removeAddressBookById | DELETE /tenants/{tenantId}/addressbooks/{addressBookId} | delete addressbook by id |
WorkEvolveApi.AddressBookApi | saveAddressBook | POST /tenants/{tenantId}/addressbooks | save a new addressbook |
WorkEvolveApi.AddressBookApi | updateAddressBook | POST /tenants/{tenantId}/addressbooks/{addressBookId} | update addressbook by id |
WorkEvolveApi.ProjectApi | getAllProjects | POST /tenants/{tenantId}/projects/get | get all projects |
WorkEvolveApi.ProjectApi | getProjectById | GET /tenants/{tenantId}/projects/{projectId} | get project by id |
WorkEvolveApi.ProjectApi | saveProject | POST /tenants/{tenantId}/projects | save a new project |
WorkEvolveApi.ProjectApi | updateProject | POST /tenants/{tenantId}/projects/{projectId} | update project by id |
WorkEvolveApi.SampleApi | getSample | GET /sample | Sample |
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header