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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- KianaApi.AuthenticatedtokencontrollerApi | createAuthenticatedTokenUsingPOST | POST /v2/api/authenticatedtokens | Create authentication token. KianaApi.AuthenticatedtokencontrollerApi | deleteAuthenticatedTokenUsingDELETE | DELETE /v2/api/authenticatedtokens/{authenticatedTokenId} | Delete user by id. KianaApi.CameramonitorcontrollerApi | deleteCameraUsingDELETE | DELETE /v2/api/cameras/{cameraId} | Delete camera from map. KianaApi.CameramonitorcontrollerApi | getCameraUsingGET | GET /v2/api/cameras/{cameraId} | Get camera. KianaApi.CameramonitorcontrollerApi | getCamerasUsingGET | GET /v2/api/cameras | Get cameras. KianaApi.CameramonitorcontrollerApi | saveCamerasUsingPOST | POST /v2/api/cameras | Add camera to map. KianaApi.CameramonitorcontrollerApi | updateCamerasUsingPUT | PUT /v2/api/cameras/{cameraId} | Update camera on map. KianaApi.DevicetokencontrollerApi | createDeviceTokenUsingPOST | POST /v2/api/devices/tokens | createDeviceToken KianaApi.DevicetokencontrollerApi | deleteDeviceTokenUsingDELETE | DELETE /v2/api/devices/tokens/{token} | deleteDeviceToken KianaApi.GeofencenotealertcontrollerApi | changeGeofenceNoteAlertStatusUsingPATCH | PATCH /v2/api/geofence-note-alerts/{alertId} | Change geofence note alert status. KianaApi.GeofencenotealertcontrollerApi | getGeoNoteAlertsUsingGET | GET /v2/api/geofence-note-alerts | Get alerts for geofence note. KianaApi.GeofencenotecontrollerApi | deleteGeoNoteUsingDELETE | DELETE /v2/api/geofence-notes/{geofenceNoteId} | Delete geofence note. KianaApi.GeofencenotecontrollerApi | getGeoNoteAttachmentUsingGET | GET /v2/api/geofence-notes/{geofenceNoteId}/attachments | Get geofence note attachments. KianaApi.GeofencenotecontrollerApi | getGeoNoteUsingGET | GET /v2/api/geofence-notes/{geofenceNoteId} | Find geofence note by id. KianaApi.GeofencenotecontrollerApi | getGeoNotesUsingGET | GET /v2/api/geofence-notes | Get geofence notes. KianaApi.GeofencenotecontrollerApi | saveGeoNoteUsingPOST | POST /v2/api/geofence-notes | Create geofence note. KianaApi.GeofencenotecontrollerApi | updateGeoNoteUsingPUT | PUT /v2/api/geofence-notes/{geofenceNoteId} | Update geofence note. KianaApi.MediacontrollerApi | saveMediasUsingPOST | POST /v2/api/medias | Upload medias. KianaApi.MonitorcontrollerApi | deleteMonitorUsingDELETE | DELETE /v2/api/monitors/{monitorId} | Delete monitor from map. KianaApi.MonitorcontrollerApi | getMonitorUsingGET | GET /v2/api/monitors/{monitorId} | Get monitor. KianaApi.MonitorcontrollerApi | getMonitorsUsingGET | GET /v2/api/monitors | Get monitors. KianaApi.MonitorcontrollerApi | getTypesUsingGET | GET /v2/api/monitors/types | Get types. KianaApi.MonitorcontrollerApi | saveMonitorsUsingPOST | POST /v2/api/monitors | Add monitor to map. KianaApi.MonitorcontrollerApi | updateMonitorsUsingPUT | PUT /v2/api/monitors/{monitorId} | Update monitor on map. KianaApi.PermissioncontrollerApi | getPermissionsUsingGET | GET /v2/api/permissions | Get permissions. KianaApi.RolecontrollerApi | getRolesUsingGET | GET /v2/api/roles | Get roles. KianaApi.TagcontrollerApi | getTagsUsingGET | GET /v2/api/tags | Get tags. KianaApi.TagcontrollerApi | saveTagsUsingPOST | POST /v2/api/tags | Create tags. KianaApi.TrackableobjectcontrollerApi | findTrackableUsingGET | GET /v2/api/trackables/{trackableId} | Get trackable info KianaApi.TrackableobjectcontrollerApi | getRisksUsingGET | GET /v2/api/trackables/risks | Get risks. KianaApi.TrackableobjectcontrollerApi | getTrackablesUsingGET | GET /v2/api/trackables/{trackableId}/trackevents | Get track events for trackable. If only from date defined - to date will be current date. KianaApi.TrackableobjectcontrollerApi | getTrackablesUsingGET1 | GET /v2/api/trackables | Get for trackables KianaApi.TrackableobjectcontrollerApi | getTypesUsingGET1 | GET /v2/api/trackables/types | Get types. KianaApi.TrackableobjectcontrollerApi | updateTrackableUsingPUT | PUT /v2/api/trackables/{trackableId} | Update trackable info KianaApi.UsercontrollerApi | deleteUserUsingDELETE | DELETE /v2/api/users/{userId} | Delete user by id. KianaApi.UsercontrollerApi | getUserUsingGET | GET /v2/api/users/me | Get current user information. KianaApi.UsercontrollerApi | getUserUsingGET1 | GET /v2/api/users/{userId} | Find user by id. KianaApi.UsercontrollerApi | getUsersUsingGET | GET /v2/api/users | Get users. KianaApi.UsercontrollerApi | insertUserUsingPOST | POST /v2/api/users | Add a new user. KianaApi.UsercontrollerApi | updateUserUsingPUT | PUT /v2/api/users/{userId} | Update user. KianaApi.UsercontrollerApi | verifyUsingPOST | POST /v2/api/users/{userId} | Verify user. KianaApi.VideoprovidercontrollerApi | getCameraUsingGET1 | GET /v2/api/video-providers/cameras | Get all cameras KianaApi.VideoprovidercontrollerApi | getCameraVideoUsingGET | GET /v2/api/video-providers/cameras/{cameraId}/video | Get video URL KianaApi.VideoprovidercontrollerApi | getCamerasUsingGET1 | GET /v2/api/video-providers/cameras/{cameraId} | Get camera by id

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.