kiana-api v1.0.0

kiana_api

KianaApi - JavaScript client for kiana_api No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

• API version: 2.0
• Package version: 2.0
• 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 kiana_api --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 kiana_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('kiana_api') 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/YOUR_USERNAME/kiana_api then install it via:

    npm install YOUR_USERNAME/kiana_api --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 KianaApi = require('kiana_api');

var api = new KianaApi.AuthenticatedtokencontrollerApi()

var nonce = "nonce_example"; // {String} Nonce

var requestTime = "requestTime_example"; // {String} Request-Time

var credentialsParam = new KianaApi.Credentials(); // {Credentials} credentialsParam

var authorization = "authorization_example"; // {String} Api Key


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAuthenticatedTokenUsingPOST(nonce, requestTime, credentialsParam, authorization, callback);

Documentation for API Endpoints

All URIs are relative to https://192.168.135.3:8082

Documentation for Models

• KianaApi.AuthenticatedTokenResponse
• KianaApi.BasicRoleResponse
• KianaApi.CameraParam
• KianaApi.CameraProvider
• KianaApi.CameraResponse
• KianaApi.CreateMonitorParam
• KianaApi.Credentials
• KianaApi.CustomFieldValueParam
• KianaApi.CustomFieldValueResponse
• KianaApi.DeviceTokenParam
• KianaApi.DeviceTokenResponse
• KianaApi.ErrorResponse
• KianaApi.GeofenceNoteAlertParam
• KianaApi.GeofenceNoteAlertResponse
• KianaApi.GeofenceNoteParam
• KianaApi.GeofenceNoteResponse
• KianaApi.IterableCameraResponse
• KianaApi.IterableGeofenceNoteAlertResponse
• KianaApi.IterableGeofenceNoteResponse
• KianaApi.IterableMediaResponse
• KianaApi.IterableMonitorResponse
• KianaApi.IterablePermissionResponse
• KianaApi.IterableRoleResponse
• KianaApi.IterableTagResponse
• KianaApi.IterableTrackEventResponse
• KianaApi.IterableTrackableResponse
• KianaApi.IterableUserResponse
• KianaApi.Iterablestring
• KianaApi.MediaResponse
• KianaApi.MonitorResponse
• KianaApi.NoteParam
• KianaApi.NoteResponse
• KianaApi.PermissionResponse
• KianaApi.Point
• KianaApi.RoleResponse
• KianaApi.TagListParam
• KianaApi.TagParam
• KianaApi.TagResponse
• KianaApi.TrackEventResponse
• KianaApi.TrackableResponse
• KianaApi.UpdateMonitorParam
• KianaApi.UpdateTrackableParam
• KianaApi.UserParam
• KianaApi.UserResponse
• KianaApi.UserRoleResponse

Documentation for Authorization

All endpoints do not require authorization.