nomad_hawk_cli

NomadHawkCli - JavaScript client for nomad_hawk_cli This is the API descriptor for the Nomad Hawk API, responsible for tracking and analytics. This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.1.0
• Package version: 1.12.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_hawk_cli --save

Getting Started

Please follow the installation instruction and execute the following JS code:

const nomadHawkCli = require('/nomad_javascript_client');

var defaultClient = nomadHawkCli.ApiClient.instance;
defaultClient.defaultHeaders['source'] = 'storefront';
defaultClient.platformParameters = {
  "ALICLOUD_APIGATEWAY_APP_SECRET": process.env["ALICLOUD_APIGATEWAY_APP_SECRET"]
};

// Configure API key authorization: AlibabaXCaKey
var AlibabaXCaKey = defaultClient.authentications[nomadHawkCli.ApiClient.KEY_x_ca_key];
AlibabaXCaKey.apiKey = process.env['ALICLOUD_APIGATEWAY_APP_KEY'];

// Configure API key authorization: AlibabaXCaStage
var AlibabaXCaStage = defaultClient.authentications[nomadHawkCli.ApiClient.KEY_x_ca_stage];
AlibabaXCaStage.apiKey = process.env["ALICLOUD_STAGE"];

// Currently optional - configure app code authorization:
var AppCode = defaultClient.authentication[nomadHawkCli.ApiClient.KEY_authorization]
AppCode.apiKey = process.env["ALICLOUD_APP_CODE"]


var api = new nomadHawkCli.TrackApi();

(async () => {
  var eventData = {
    "type": "alert",
    "sales_channel": "Retail",
    "label": "too_many_orders",
    "message": "An informative message"
  };
  var event = new nomadHawkCli.Event.constructFromObject(eventData);

  /* POST */
  var apiReponse1 = await api.track(event);
  console.log("apiReponse1:", apiReponse1);

  /* API disabled */
  // var apiReponse2 = await api.trackWithStore(event, "another_store");
  // console.log("apiReponse2:", apiReponse2);

})();

Documentation for API Endpoints

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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- NomadHawkCli.TrackApi | track | POST /track | track NomadHawkCli.TrackApi | trackWithStore | POST /track/{store_id} | trackWithStore

Documentation for Models

• NomadHawkCli.ApiResponse
• NomadHawkCli.ApiResponseConnectorResponse
• NomadHawkCli.ApiResponseData
• NomadHawkCli.Event
• NomadHawkCli.EventItem

Documentation for Authorization

app_code

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

ca_key

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

ca_stage

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