# 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](https://github.com/swagger-api/swagger-codegen) project: - API version: 2.0 - Package version: 2.0 - Build package: io.swagger.codegen.languages.JavascriptClientCodegen ## Installation ### For [Node.js](https://nodejs.org/) #### npm To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). Then install it via: ```shell 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: ```shell npm install ``` Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`: ```shell npm link ``` Finally, switch to the directory you want to use your kiana_api from, and run: ```shell npm link /path/to/ ``` 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: ```shell npm install YOUR_USERNAME/kiana_api --save ``` ### For browser The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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): ```shell 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: ```javascript module: { rules: [ { parser: { amd: false } } ] } ``` ## Getting Started Please follow the [installation](#installation) instruction and execute the following JS code: ```javascript 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**](docs/AuthenticatedtokencontrollerApi.md#createAuthenticatedTokenUsingPOST) | **POST** /v2/api/authenticatedtokens | Create authentication token. *KianaApi.AuthenticatedtokencontrollerApi* | [**deleteAuthenticatedTokenUsingDELETE**](docs/AuthenticatedtokencontrollerApi.md#deleteAuthenticatedTokenUsingDELETE) | **DELETE** /v2/api/authenticatedtokens/{authenticatedTokenId} | Delete user by id. *KianaApi.CameramonitorcontrollerApi* | [**deleteCameraUsingDELETE**](docs/CameramonitorcontrollerApi.md#deleteCameraUsingDELETE) | **DELETE** /v2/api/cameras/{cameraId} | Delete camera from map. *KianaApi.CameramonitorcontrollerApi* | [**getCameraUsingGET**](docs/CameramonitorcontrollerApi.md#getCameraUsingGET) | **GET** /v2/api/cameras/{cameraId} | Get camera. *KianaApi.CameramonitorcontrollerApi* | [**getCamerasUsingGET**](docs/CameramonitorcontrollerApi.md#getCamerasUsingGET) | **GET** /v2/api/cameras | Get cameras. *KianaApi.CameramonitorcontrollerApi* | [**saveCamerasUsingPOST**](docs/CameramonitorcontrollerApi.md#saveCamerasUsingPOST) | **POST** /v2/api/cameras | Add camera to map. *KianaApi.CameramonitorcontrollerApi* | [**updateCamerasUsingPUT**](docs/CameramonitorcontrollerApi.md#updateCamerasUsingPUT) | **PUT** /v2/api/cameras/{cameraId} | Update camera on map. *KianaApi.DevicetokencontrollerApi* | [**createDeviceTokenUsingPOST**](docs/DevicetokencontrollerApi.md#createDeviceTokenUsingPOST) | **POST** /v2/api/devices/tokens | createDeviceToken *KianaApi.DevicetokencontrollerApi* | [**deleteDeviceTokenUsingDELETE**](docs/DevicetokencontrollerApi.md#deleteDeviceTokenUsingDELETE) | **DELETE** /v2/api/devices/tokens/{token} | deleteDeviceToken *KianaApi.GeofencenotealertcontrollerApi* | [**changeGeofenceNoteAlertStatusUsingPATCH**](docs/GeofencenotealertcontrollerApi.md#changeGeofenceNoteAlertStatusUsingPATCH) | **PATCH** /v2/api/geofence-note-alerts/{alertId} | Change geofence note alert status. *KianaApi.GeofencenotealertcontrollerApi* | [**getGeoNoteAlertsUsingGET**](docs/GeofencenotealertcontrollerApi.md#getGeoNoteAlertsUsingGET) | **GET** /v2/api/geofence-note-alerts | Get alerts for geofence note. *KianaApi.GeofencenotecontrollerApi* | [**deleteGeoNoteUsingDELETE**](docs/GeofencenotecontrollerApi.md#deleteGeoNoteUsingDELETE) | **DELETE** /v2/api/geofence-notes/{geofenceNoteId} | Delete geofence note. *KianaApi.GeofencenotecontrollerApi* | [**getGeoNoteAttachmentUsingGET**](docs/GeofencenotecontrollerApi.md#getGeoNoteAttachmentUsingGET) | **GET** /v2/api/geofence-notes/{geofenceNoteId}/attachments | Get geofence note attachments. *KianaApi.GeofencenotecontrollerApi* | [**getGeoNoteUsingGET**](docs/GeofencenotecontrollerApi.md#getGeoNoteUsingGET) | **GET** /v2/api/geofence-notes/{geofenceNoteId} | Find geofence note by id. *KianaApi.GeofencenotecontrollerApi* | [**getGeoNotesUsingGET**](docs/GeofencenotecontrollerApi.md#getGeoNotesUsingGET) | **GET** /v2/api/geofence-notes | Get geofence notes. *KianaApi.GeofencenotecontrollerApi* | [**saveGeoNoteUsingPOST**](docs/GeofencenotecontrollerApi.md#saveGeoNoteUsingPOST) | **POST** /v2/api/geofence-notes | Create geofence note. *KianaApi.GeofencenotecontrollerApi* | [**updateGeoNoteUsingPUT**](docs/GeofencenotecontrollerApi.md#updateGeoNoteUsingPUT) | **PUT** /v2/api/geofence-notes/{geofenceNoteId} | Update geofence note. *KianaApi.MediacontrollerApi* | [**saveMediasUsingPOST**](docs/MediacontrollerApi.md#saveMediasUsingPOST) | **POST** /v2/api/medias | Upload medias. *KianaApi.MonitorcontrollerApi* | [**deleteMonitorUsingDELETE**](docs/MonitorcontrollerApi.md#deleteMonitorUsingDELETE) | **DELETE** /v2/api/monitors/{monitorId} | Delete monitor from map. *KianaApi.MonitorcontrollerApi* | [**getMonitorUsingGET**](docs/MonitorcontrollerApi.md#getMonitorUsingGET) | **GET** /v2/api/monitors/{monitorId} | Get monitor. *KianaApi.MonitorcontrollerApi* | [**getMonitorsUsingGET**](docs/MonitorcontrollerApi.md#getMonitorsUsingGET) | **GET** /v2/api/monitors | Get monitors. *KianaApi.MonitorcontrollerApi* | [**getTypesUsingGET**](docs/MonitorcontrollerApi.md#getTypesUsingGET) | **GET** /v2/api/monitors/types | Get types. *KianaApi.MonitorcontrollerApi* | [**saveMonitorsUsingPOST**](docs/MonitorcontrollerApi.md#saveMonitorsUsingPOST) | **POST** /v2/api/monitors | Add monitor to map. *KianaApi.MonitorcontrollerApi* | [**updateMonitorsUsingPUT**](docs/MonitorcontrollerApi.md#updateMonitorsUsingPUT) | **PUT** /v2/api/monitors/{monitorId} | Update monitor on map. *KianaApi.PermissioncontrollerApi* | [**getPermissionsUsingGET**](docs/PermissioncontrollerApi.md#getPermissionsUsingGET) | **GET** /v2/api/permissions | Get permissions. *KianaApi.RolecontrollerApi* | [**getRolesUsingGET**](docs/RolecontrollerApi.md#getRolesUsingGET) | **GET** /v2/api/roles | Get roles. *KianaApi.TagcontrollerApi* | [**getTagsUsingGET**](docs/TagcontrollerApi.md#getTagsUsingGET) | **GET** /v2/api/tags | Get tags. *KianaApi.TagcontrollerApi* | [**saveTagsUsingPOST**](docs/TagcontrollerApi.md#saveTagsUsingPOST) | **POST** /v2/api/tags | Create tags. *KianaApi.TrackableobjectcontrollerApi* | [**findTrackableUsingGET**](docs/TrackableobjectcontrollerApi.md#findTrackableUsingGET) | **GET** /v2/api/trackables/{trackableId} | Get trackable info *KianaApi.TrackableobjectcontrollerApi* | [**getRisksUsingGET**](docs/TrackableobjectcontrollerApi.md#getRisksUsingGET) | **GET** /v2/api/trackables/risks | Get risks. *KianaApi.TrackableobjectcontrollerApi* | [**getTrackablesUsingGET**](docs/TrackableobjectcontrollerApi.md#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**](docs/TrackableobjectcontrollerApi.md#getTrackablesUsingGET1) | **GET** /v2/api/trackables | Get for trackables *KianaApi.TrackableobjectcontrollerApi* | [**getTypesUsingGET1**](docs/TrackableobjectcontrollerApi.md#getTypesUsingGET1) | **GET** /v2/api/trackables/types | Get types. *KianaApi.TrackableobjectcontrollerApi* | [**updateTrackableUsingPUT**](docs/TrackableobjectcontrollerApi.md#updateTrackableUsingPUT) | **PUT** /v2/api/trackables/{trackableId} | Update trackable info *KianaApi.UsercontrollerApi* | [**deleteUserUsingDELETE**](docs/UsercontrollerApi.md#deleteUserUsingDELETE) | **DELETE** /v2/api/users/{userId} | Delete user by id. *KianaApi.UsercontrollerApi* | [**getUserUsingGET**](docs/UsercontrollerApi.md#getUserUsingGET) | **GET** /v2/api/users/me | Get current user information. *KianaApi.UsercontrollerApi* | [**getUserUsingGET1**](docs/UsercontrollerApi.md#getUserUsingGET1) | **GET** /v2/api/users/{userId} | Find user by id. *KianaApi.UsercontrollerApi* | [**getUsersUsingGET**](docs/UsercontrollerApi.md#getUsersUsingGET) | **GET** /v2/api/users | Get users. *KianaApi.UsercontrollerApi* | [**insertUserUsingPOST**](docs/UsercontrollerApi.md#insertUserUsingPOST) | **POST** /v2/api/users | Add a new user. *KianaApi.UsercontrollerApi* | [**updateUserUsingPUT**](docs/UsercontrollerApi.md#updateUserUsingPUT) | **PUT** /v2/api/users/{userId} | Update user. *KianaApi.UsercontrollerApi* | [**verifyUsingPOST**](docs/UsercontrollerApi.md#verifyUsingPOST) | **POST** /v2/api/users/{userId} | Verify user. *KianaApi.VideoprovidercontrollerApi* | [**getCameraUsingGET1**](docs/VideoprovidercontrollerApi.md#getCameraUsingGET1) | **GET** /v2/api/video-providers/cameras | Get all cameras *KianaApi.VideoprovidercontrollerApi* | [**getCameraVideoUsingGET**](docs/VideoprovidercontrollerApi.md#getCameraVideoUsingGET) | **GET** /v2/api/video-providers/cameras/{cameraId}/video | Get video URL *KianaApi.VideoprovidercontrollerApi* | [**getCamerasUsingGET1**](docs/VideoprovidercontrollerApi.md#getCamerasUsingGET1) | **GET** /v2/api/video-providers/cameras/{cameraId} | Get camera by id ## Documentation for Models - [KianaApi.AuthenticatedTokenResponse](docs/AuthenticatedTokenResponse.md) - [KianaApi.BasicRoleResponse](docs/BasicRoleResponse.md) - [KianaApi.CameraParam](docs/CameraParam.md) - [KianaApi.CameraProvider](docs/CameraProvider.md) - [KianaApi.CameraResponse](docs/CameraResponse.md) - [KianaApi.CreateMonitorParam](docs/CreateMonitorParam.md) - [KianaApi.Credentials](docs/Credentials.md) - [KianaApi.CustomFieldValueParam](docs/CustomFieldValueParam.md) - [KianaApi.CustomFieldValueResponse](docs/CustomFieldValueResponse.md) - [KianaApi.DeviceTokenParam](docs/DeviceTokenParam.md) - [KianaApi.DeviceTokenResponse](docs/DeviceTokenResponse.md) - [KianaApi.ErrorResponse](docs/ErrorResponse.md) - [KianaApi.GeofenceNoteAlertParam](docs/GeofenceNoteAlertParam.md) - [KianaApi.GeofenceNoteAlertResponse](docs/GeofenceNoteAlertResponse.md) - [KianaApi.GeofenceNoteParam](docs/GeofenceNoteParam.md) - [KianaApi.GeofenceNoteResponse](docs/GeofenceNoteResponse.md) - [KianaApi.IterableCameraResponse](docs/IterableCameraResponse.md) - [KianaApi.IterableGeofenceNoteAlertResponse](docs/IterableGeofenceNoteAlertResponse.md) - [KianaApi.IterableGeofenceNoteResponse](docs/IterableGeofenceNoteResponse.md) - [KianaApi.IterableMediaResponse](docs/IterableMediaResponse.md) - [KianaApi.IterableMonitorResponse](docs/IterableMonitorResponse.md) - [KianaApi.IterablePermissionResponse](docs/IterablePermissionResponse.md) - [KianaApi.IterableRoleResponse](docs/IterableRoleResponse.md) - [KianaApi.IterableTagResponse](docs/IterableTagResponse.md) - [KianaApi.IterableTrackEventResponse](docs/IterableTrackEventResponse.md) - [KianaApi.IterableTrackableResponse](docs/IterableTrackableResponse.md) - [KianaApi.IterableUserResponse](docs/IterableUserResponse.md) - [KianaApi.Iterablestring](docs/Iterablestring.md) - [KianaApi.MediaResponse](docs/MediaResponse.md) - [KianaApi.MonitorResponse](docs/MonitorResponse.md) - [KianaApi.NoteParam](docs/NoteParam.md) - [KianaApi.NoteResponse](docs/NoteResponse.md) - [KianaApi.PermissionResponse](docs/PermissionResponse.md) - [KianaApi.Point](docs/Point.md) - [KianaApi.RoleResponse](docs/RoleResponse.md) - [KianaApi.TagListParam](docs/TagListParam.md) - [KianaApi.TagParam](docs/TagParam.md) - [KianaApi.TagResponse](docs/TagResponse.md) - [KianaApi.TrackEventResponse](docs/TrackEventResponse.md) - [KianaApi.TrackableResponse](docs/TrackableResponse.md) - [KianaApi.UpdateMonitorParam](docs/UpdateMonitorParam.md) - [KianaApi.UpdateTrackableParam](docs/UpdateTrackableParam.md) - [KianaApi.UserParam](docs/UserParam.md) - [KianaApi.UserResponse](docs/UserResponse.md) - [KianaApi.UserRoleResponse](docs/UserRoleResponse.md) ## Documentation for Authorization All endpoints do not require authorization.