3.0.0 • Published 5 years ago

cheninitial v3.0.0

Weekly downloads
-
License
Unlicense
Repository
-
Last release
5 years ago

uaes_fota_platform

UaesFotaPlatform - JavaScript client for uaes_fota_platform https://fota.uaes.com.cn This SDK is automatically generated by the Swagger Codegen project:

  • API version: version
  • Package version: version
  • Build package: io.swagger.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 uaes_fota_platform --save
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

Finally, switch to the directory you want to use your uaes_fota_platform from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('uaes_fota_platform') in javascript files from the directory you ran the last command above from.

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, 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.

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 UaesFotaPlatform = require('uaes_fota_platform');

var api = new UaesFotaPlatform.DepartmentControllerApi()

var uuid = "uuid_example"; // {String} user uuid

var deptId = 789; // {Number} dept id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addDeptMemberUsingPUT(uuid, deptId, callback);

Documentation for API Endpoints

All URIs are relative to https://fota.uaescloud.com:444

ClassMethodHTTP requestDescription
UaesFotaPlatform.DepartmentControllerApiaddDeptMemberUsingPUTPUT /fota-iam/admin/addDeptMemberadd dept member
UaesFotaPlatform.DepartmentControllerApicreateUsingPOSTPOST /fota-iam/admin/addDeptdept create
UaesFotaPlatform.DepartmentControllerApideleteUsingDELETEDELETE /fota-iam/admin/deleteDeptdept delete
UaesFotaPlatform.DepartmentControllerApigetDeptByIdUsingGETGET /fota-iam/self/searchDeptByIdsearch dept by dept id
UaesFotaPlatform.DepartmentControllerApigetDeptByNameUsingGETGET /fota-iam/self/searchDeptByNamesearch dept by dept name
UaesFotaPlatform.DepartmentControllerApisearchDeptPageUsingGETGET /fota-iam/self/searchDept/pagepaging search dept
UaesFotaPlatform.DepartmentControllerApisearchMemberByDeptIdUsingGETGET /fota-iam/self/searchMemberByDeptIdsearch member by dept id
UaesFotaPlatform.DepartmentControllerApiupdateUsingPUTPUT /fota-iam/admin/updateDeptdept update
UaesFotaPlatform.TestControllerApiadminUsingGETGET /fota-iam/admin/helloadmin
UaesFotaPlatform.TestControllerApiappUsingGETGET /fota-iam/app/helloapp
UaesFotaPlatform.TestControllerApichainingUsingGETGET /fota-iam/apiexceptionchaining
UaesFotaPlatform.TestControllerApiengineerUsingGETGET /fota-iam/engineer/helloengineer
UaesFotaPlatform.TestControllerApimanagerUsingGETGET /fota-iam/manager/hellomanager
UaesFotaPlatform.TestControllerApipublicUserUsingGETGET /fota-iam/public/hellopublicUser
UaesFotaPlatform.TestControllerApiselfUsingGETGET /fota-iam/self/helloself
UaesFotaPlatform.TestControllerApiviewUsingGETGET /fota-iam/view/helloview
UaesFotaPlatform.UserAdminControllerApiaddRoleForUserUsingPUTPUT /fota-iam/admin/user/admin/addRoleadd user role info
UaesFotaPlatform.UserAdminControllerApiaddUserUsingPOSTPOST /fota-iam/admin/user/admin/addUseradd user
UaesFotaPlatform.UserAdminControllerApideleteUserUsingDELETEDELETE /fota-iam/admin/user/admin/deleteUserdelete user
UaesFotaPlatform.UserAdminControllerApigetAllUsersUsingGETGET /fota-iam/admin/user/admin/getAllUsersget all user info
UaesFotaPlatform.UserAdminControllerApigetUserByUserNameUsingGETGET /fota-iam/admin/user/admin/getUserByNameget user info by user name
UaesFotaPlatform.UserAdminControllerApigetUserByUuidUsingGETGET /fota-iam/admin/user/admin/getUserByIdget user info by user id
UaesFotaPlatform.UserAdminControllerApigetUsersByDeptUsingGETGET /fota-iam/admin/user/admin/searchUsersByDeptIdsearch members by dept id
UaesFotaPlatform.UserAdminControllerApigetUsersUsingGETGET /fota-iam/admin/user/admin/searchUsersByNamesearch users by name
UaesFotaPlatform.UserAdminControllerApipasswordResetUsingGETGET /fota-iam/admin/user/admin/passwordResetpassword reset
UaesFotaPlatform.UserAdminControllerApiremoveRoleForUserUsingPUTPUT /fota-iam/admin/user/admin/removeRoleremove user role info
UaesFotaPlatform.UserAdminControllerApisetActiveUsingPUTPUT /fota-iam/admin/user/admin/setActiveStatusupdate user active
UaesFotaPlatform.UserAdminControllerApiupdateUserUsingPUTPUT /fota-iam/admin/user/admin/updateUserupdate user
UaesFotaPlatform.UserLoginControllerApiloginUsingGETGET /fota-iam/public/user/oauth/login登陆
UaesFotaPlatform.UserRoleAdminControllerApigetRoleByNameUsingGETGET /fota-iam/admin/role/admin/getRoleByNameget role by role name
UaesFotaPlatform.UserRoleAdminControllerApigetRoleByUuidUsingGETGET /fota-iam/admin/role/admin/getRoleByIdget role by role id
UaesFotaPlatform.UserRoleAdminControllerApigetRolesUsingGETGET /fota-iam/admin/role/admin/getAllRolesget all roles
UaesFotaPlatform.UserSelfServiceControllerApichangePasswordUsingPUTPUT /fota-iam/self/passwordChangechange password
UaesFotaPlatform.UserSelfServiceControllerApigetUserByUserNameUsingGET1GET /fota-iam/self/getUserInfoget user info
UaesFotaPlatform.UserSelfServiceControllerApirefreshTokensUsingGETGET /fota-iam/self/oauth/refreshTokensrefresh token

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.