nomad_cbec_limit_cli v1.1.1
nomad_cbec_limit_cli
NomadCbecLimitCli - JavaScript client for nomad_cbec_limit_cli This is the API descriptor for the Nomad CBEC, responsible for CBEC customer queries. Read the documentation online at Nomad API Suite.
- Install for node with
npm install nomad_cbec_cli
Install for python with
pip install nomad-cbec-cli
This SDK is automatically generated by the OpenAPI Generator project:API version: 1.1.1
- Package version: 1.1.1
- 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 nomad_cbec_limit_cli --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 nomad_cbec_limit_cli 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 NomadCbecLimitCli = require("nomad_cbec_limit_cli");
var defaultClient = NomadCbecLimitCli.ApiClient.instance;
defaultClient.defaultHeaders["x-ca-stage"] = "release";
defaultClient.defaultHeaders["Authorization"] =
"APPCODE " + process.env["ALICLOUD_APIGATEWAY_APP_API_KEY"];
var api = new NomadCbecLimitCli.LimitApi(defaultClient);
var id = "370aaa"; // {String} Customer ID
var name = "姓名"; // {String} Customer Name
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log("API called successfully. Returned data: " + data);
}
};
api.cbecLimit(id, name, callback);
Documentation for API Endpoints
All URIs are relative to https://nomad.samarkand-global.cn/cbec
Class | Method | HTTP request | Description |
---|---|---|---|
NomadCbecLimitCli.HealthApi | getHealth | GET /health | health |
NomadCbecLimitCli.LimitApi | cbecLimit | GET /limit | limit |
Documentation for Models
Documentation for Authorization
ApiKeyAuth
- Type: API key
- API key parameter name: APPCODE
- Location: HTTP header
2 years ago