nomad_envoy_utils_cli v1.2.0

nomad_envoy_utils_cli

NomadEnvoyUtilsCli - JavaScript client for nomad_envoy_utils_cli This is the API descriptor for the EC Platform and customs utils. Developed by Samarkand Global, EC Platform including Youzan Read the documentation online at Nomad API Suite. - Install for python with pip install nomad_envoy_utils_cli - Install for node with npm install nomad_envoy_utils_cli This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.2.2
• Package version: 1.2.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 nomad_envoy_utils_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_envoy_utils_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:

const nomadEnvoyUtilsCli = require("/nomad_javascript_client");

var defaultClient = nomadEnvoyUtilsCli.ApiClient.instance;
defaultClient.defaultHeaders["x-ca-stage"] = "test";
defaultClient.defaultHeaders["Authorization"] =
  "APPCODE " + process.env["ALICLOUD_APIGATEWAY_APP_API_KEY"];

var api = new nomadEnvoyUtilsCli.PlatformApi(defaultClient);
var cypher = new nomadEnvoyUtilsCli.Cypher(
  store_id="samarkand.youzan.kuiseng",
  operation="DecryptBatch",
  items=["$Kg7PP/qJTnIYX+22Y2pa+A==$1$"]
);
var callback = function (error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log("API called successfully. Returned data: " + data.data);
    console.log(data);
  }
};
(async () => {
  /* POST batchOperatecypher(userId, name, callback)*/
  api.batchOperatecypher(cypher, callback);
})();

Documentation for API Endpoints

All URIs are relative to https://nomad-envoy-utils.samarkand-global.cn

Documentation for Models

• NomadEnvoyUtilsCli.ApiResponse
• NomadEnvoyUtilsCli.ApiResponseData
• NomadEnvoyUtilsCli.Cypher

Documentation for Authorization

ca_key

• Type: API key
• API key parameter name: Authorization
• Location: URL query string

ca_stage

• Type: API key
• API key parameter name: x-ca-stage
• Location: HTTP header