service_provider_and_device_entitlement_management_api v2.7.5

service_provider_and_device_entitlement_management_api

ServiceProviderAndDeviceEntitlementManagementApi - JavaScript client for service_provider_and_device_entitlement_management_api Service Provider and Device Entitlement Management API This SDK is automatically generated by the OpenAPI Generator project:

• API version: 2.7.5
• Package version: 2.7.5
• 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 service_provider_and_device_entitlement_management_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 service_provider_and_device_entitlement_management_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 ServiceProviderAndDeviceEntitlementManagementApi = require('service_provider_and_device_entitlement_management_api');

var defaultClient = ServiceProviderAndDeviceEntitlementManagementApi.ApiClient.instance;

var api = new ServiceProviderAndDeviceEntitlementManagementApi.AnalyticsApi()
var deviceuuid = null; // {String} UUID of the Device
var eventtype = device_radar_motion_event; // {String} type of event
var startdatetime = 2022-02-16T07:00Z; // {Date} UTC Date-time
var enddatetime = 2022-02-16T11:21:57.079Z; // {Date} UTC Date-time
var windowsize = 3600000; // {Number} window size (time in milliseconds and should be within the time range)
var opts = {
  'timezone': "'devicetime'" // {String} format datetime by timezone (eg:America/Los_Angeles)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAggregatedEventStats(deviceuuid, eventtype, startdatetime, enddatetime, windowsize, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://sandbox-mqtt.commscope.cloud:3443