kosmos-mayi-libra-api

kosmos-libra-api

KosmosLibraApi - JavaScript client for kosmos-libra-api Api Documentation This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• Package version: 1.0
• Build package: org.openapitools.codegen.languages.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 kosmos-libra-api --save

Finally, you need to build the module:

npm run build

Local development

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 kosmos-libra-api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

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 KosmosLibraApi = require('kosmos-libra-api');


var api = new KosmosLibraApi.AdminControllerApi()
var id = 789; // {Number} id
api.deleteAdminDepartment(id).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
KosmosLibraApi.AdminControllerApi	deleteAdminDepartment	DELETE /admin/department	deleteDepartment
KosmosLibraApi.AdminControllerApi	deleteAdminOperation	DELETE /admin/operation	deleteOperation
KosmosLibraApi.AdminControllerApi	deleteAdminOrganization	DELETE /admin/organization	deleteOrganization
KosmosLibraApi.AdminControllerApi	deleteAdminUser	DELETE /admin/user	deleteUser
KosmosLibraApi.AdminControllerApi	deleteAdminUserrole	DELETE /admin/userrole	deleteUserRole
KosmosLibraApi.AdminControllerApi	getAdminDepartment	GET /admin/department	department
KosmosLibraApi.AdminControllerApi	getAdminDepartments	GET /admin/departments	userDepartments
KosmosLibraApi.AdminControllerApi	getAdminOperation	GET /admin/operation	operation
KosmosLibraApi.AdminControllerApi	getAdminOperations	GET /admin/operations	operations
KosmosLibraApi.AdminControllerApi	getAdminOrganization	GET /admin/organization	organization
KosmosLibraApi.AdminControllerApi	getAdminOrganizations	GET /admin/organizations	userOrganizations
KosmosLibraApi.AdminControllerApi	getAdminRoleoperations	GET /admin/roleoperations	roleoperations
KosmosLibraApi.AdminControllerApi	getAdminUser	GET /admin/user	user
KosmosLibraApi.AdminControllerApi	getAdminUserrole	GET /admin/userrole	userRole
KosmosLibraApi.AdminControllerApi	getAdminUserroles	GET /admin/userroles	userRoles
KosmosLibraApi.AdminControllerApi	getAdminUsers	GET /admin/users	users
KosmosLibraApi.AdminControllerApi	postAdminDepartment	POST /admin/department	createDepartment
KosmosLibraApi.AdminControllerApi	postAdminOperation	POST /admin/operation	createOperation
KosmosLibraApi.AdminControllerApi	postAdminOrganization	POST /admin/organization	createOrganization
KosmosLibraApi.AdminControllerApi	postAdminUser	POST /admin/user	createUser
KosmosLibraApi.AdminControllerApi	postAdminUserrole	POST /admin/userrole	createUserRole
KosmosLibraApi.AdminControllerApi	putAdminDepartment	PUT /admin/department	updateDepartment
KosmosLibraApi.AdminControllerApi	putAdminOperation	PUT /admin/operation	updateOperation
KosmosLibraApi.AdminControllerApi	putAdminOrganization	PUT /admin/organization	updateOrganization
KosmosLibraApi.AdminControllerApi	putAdminRoleoperations	PUT /admin/roleoperations	updateRoleOperation
KosmosLibraApi.AdminControllerApi	putAdminUser	PUT /admin/user	updateUser
KosmosLibraApi.AdminControllerApi	putAdminUserrole	PUT /admin/userrole	updateUserRole
KosmosLibraApi.StorageContextEndpointApi	postAvalonStorageCache	POST /avalon/storage/cache	cache
KosmosLibraApi.StorageContextEndpointApi	postAvalonStorageCaches	POST /avalon/storage/caches	caches
KosmosLibraApi.UserControllerApi	getUserMydetail	GET /user/mydetail	getMyUserDetail

Documentation for Models

• KosmosLibraApi.Department
• KosmosLibraApi.Operation
• KosmosLibraApi.Organization
• KosmosLibraApi.PageDepartment
• KosmosLibraApi.PageOperation
• KosmosLibraApi.PageOrganization
• KosmosLibraApi.PageParameter
• KosmosLibraApi.PageUser
• KosmosLibraApi.PageUserRole
• KosmosLibraApi.RoleOperation
• KosmosLibraApi.Sort
• KosmosLibraApi.UploadResult
• KosmosLibraApi.User
• KosmosLibraApi.UserDetail
• KosmosLibraApi.UserRole

Documentation for Authorization

All endpoints do not require authorization.