From fa16d1ab855bd35a27c9a5809a09580d5ed9ceb1 Mon Sep 17 00:00:00 2001 From: Paige Niedringhaus Date: Wed, 15 Mar 2023 15:36:28 -0400 Subject: [PATCH] running precommit hooks on all md files --- src/docs/AuthorizationApi.md | 38 ++- src/docs/Aws.md | 34 +- src/docs/Azure.md | 24 +- src/docs/BillingAccount.md | 12 +- src/docs/BillingAccountApi.md | 33 +- src/docs/BillingAccountRole.md | 9 +- src/docs/Body.md | 8 +- src/docs/Contact.md | 14 +- src/docs/CreateFleetRequest.md | 8 +- src/docs/CreateProjectRequest.md | 10 +- src/docs/DFUEnv.md | 10 +- src/docs/DeleteDeviceFleetsRequest.md | 8 +- src/docs/Device.md | 36 +-- src/docs/DeviceApi.md | 300 +++++++----------- src/docs/DeviceTowerInfo.md | 14 +- src/docs/DeviceUsage.md | 26 +- src/docs/EnvironmentVariables.md | 8 +- src/docs/EnvironmentVariablesApi.md | 208 +++++------- src/docs/Error.md | 18 +- src/docs/FilesApi.md | 68 ++-- src/docs/Fleet.md | 12 +- src/docs/GetBillingAccounts200Response.md | 8 +- ...etDeviceEnvironmentVariables200Response.md | 10 +- src/docs/GetDeviceHealthLog200Response.md | 8 +- ...eviceHealthLog200ResponseHealthLogInner.md | 12 +- src/docs/GetDevicePublicKey200Response.md | 10 +- src/docs/GetDeviceSessions200Response.md | 10 +- .../GetProjectDevicePublicKeys200Response.md | 10 +- ...licKeys200ResponseDevicePublicKeysInner.md | 10 +- src/docs/GetProjectDevices200Response.md | 10 +- src/docs/GetProjectEvents200Response.md | 12 +- src/docs/GetProjectFleets200Response.md | 8 +- src/docs/GetProjectMembers200Response.md | 8 +- src/docs/GetProjectProducts200Response.md | 8 +- src/docs/GetProjects200Response.md | 8 +- src/docs/Google.md | 18 +- src/docs/HandleNoteChanges200Response.md | 12 +- src/docs/HandleNoteGet200Response.md | 12 +- src/docs/HandleNoteSignal200Response.md | 8 +- src/docs/HandleNotefileChanges200Response.md | 12 +- ...HandleNotefileChangesPending200Response.md | 14 +- src/docs/HandleNotefileDeleteRequest.md | 8 +- src/docs/Http.md | 22 +- src/docs/HttpFilter.md | 23 +- src/docs/Location.md | 18 +- src/docs/Login200Response.md | 8 +- src/docs/LoginRequest.md | 10 +- src/docs/Mqtt.md | 34 +- src/docs/Note.md | 10 +- src/docs/Product.md | 14 +- src/docs/ProductApi.md | 72 ++--- src/docs/Project.md | 18 +- src/docs/ProjectMember.md | 12 +- src/docs/Proxy.md | 16 +- src/docs/PutDeviceFleetsRequest.md | 8 +- src/docs/Radresponder.md | 16 +- src/docs/Role.md | 11 +- src/docs/RouteApi.md | 92 ++---- src/docs/Thingworx.md | 20 +- src/docs/TowerLocation.md | 34 +- src/docs/Twilio.md | 24 +- src/docs/UpdateFleetRequest.md | 12 +- 62 files changed, 657 insertions(+), 931 deletions(-) diff --git a/src/docs/AuthorizationApi.md b/src/docs/AuthorizationApi.md index c159af3e..ad37a9c6 100644 --- a/src/docs/AuthorizationApi.md +++ b/src/docs/AuthorizationApi.md @@ -2,41 +2,40 @@ All URIs are relative to *https://api.notefile.net* -Method | HTTP request | Description -------------- | ------------- | ------------- -[**login**](AuthorizationApi.md#login) | **POST** /auth/login | - - +| Method | HTTP request | Description | +| -------------------------------------- | -------------------- | ----------- | +| [**login**](AuthorizationApi.md#login) | **POST** /auth/login | ## login > Login200Response login(loginRequest) - - Gets a session token from the API from a username and password. ### Example ```javascript -import * as NotehubJs from '@blues-inc/notehub-js'; +import * as NotehubJs from "@blues-inc/notehub-js"; let apiInstance = new NotehubJs.AuthorizationApi(); -let loginRequest = {"username":"name@example.com","password":"test-password"}; // LoginRequest | -apiInstance.login(loginRequest).then((data) => { - console.log('API called successfully. Returned data: ' + JSON.stringify(data)); -}, (error) => { - console.error(error); -}); - +let loginRequest = { username: "name@example.com", password: "test-password" }; // LoginRequest | +apiInstance.login(loginRequest).then( + (data) => { + console.log( + "API called successfully. Returned data: " + JSON.stringify(data) + ); + }, + (error) => { + console.error(error); + } +); ``` ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **loginRequest** | [**LoginRequest**](LoginRequest.md)| | +| Name | Type | Description | Notes | +| ---------------- | ----------------------------------- | ----------- | ----- | +| **loginRequest** | [**LoginRequest**](LoginRequest.md) | | ### Return type @@ -50,4 +49,3 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json - diff --git a/src/docs/Aws.md b/src/docs/Aws.md index 8ecd570a..877f467b 100644 --- a/src/docs/Aws.md +++ b/src/docs/Aws.md @@ -2,21 +2,19 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional] -**filter** | [**HttpFilter**](HttpFilter.md) | | [optional] -**transform** | [**HttpTransform**](HttpTransform.md) | | [optional] -**throttleMs** | **Number** | | [optional] -**url** | **String** | | [optional] -**httpHeaders** | **{String: String}** | | [optional] -**disableHttpHeaders** | **Boolean** | | [optional] [default to false] -**timeout** | **Number** | Timeout in seconds for each request | [optional] [default to 15] -**region** | **String** | | [optional] -**accessKeyId** | **String** | | [optional] -**accessKeySecret** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] -**messageGroupId** | **String** | | [optional] -**messageDeduplicationId** | **String** | | [optional] -**channel** | **String** | | [optional] - - +| Name | Type | Description | Notes | +| -------------------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------- | ----------------------------- | +| **fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional] | +| **filter** | [**HttpFilter**](HttpFilter.md) | | [optional] | +| **transform** | [**HttpTransform**](HttpTransform.md) | | [optional] | +| **throttleMs** | **Number** | | [optional] | +| **url** | **String** | | [optional] | +| **httpHeaders** | **{String: String}** | | [optional] | +| **disableHttpHeaders** | **Boolean** | | [optional] [default to false] | +| **timeout** | **Number** | Timeout in seconds for each request | [optional] [default to 15] | +| **region** | **String** | | [optional] | +| **accessKeyId** | **String** | | [optional] | +| **accessKeySecret** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | +| **messageGroupId** | **String** | | [optional] | +| **messageDeduplicationId** | **String** | | [optional] | +| **channel** | **String** | | [optional] | diff --git a/src/docs/Azure.md b/src/docs/Azure.md index 887b094f..f527fd0d 100644 --- a/src/docs/Azure.md +++ b/src/docs/Azure.md @@ -2,16 +2,14 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional] -**filter** | [**HttpFilter**](HttpFilter.md) | | [optional] -**transform** | [**HttpTransform**](HttpTransform.md) | | [optional] -**throttleMs** | **Number** | | [optional] -**url** | **String** | | [optional] -**timeout** | **Number** | Timeout in seconds for each request | [optional] [default to 15] -**functionsKeySecret** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] -**sasPolicyName** | **String** | | [optional] -**sasPolicyKey** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] - - +| Name | Type | Description | Notes | +| ---------------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------- | -------------------------- | +| **fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional] | +| **filter** | [**HttpFilter**](HttpFilter.md) | | [optional] | +| **transform** | [**HttpTransform**](HttpTransform.md) | | [optional] | +| **throttleMs** | **Number** | | [optional] | +| **url** | **String** | | [optional] | +| **timeout** | **Number** | Timeout in seconds for each request | [optional] [default to 15] | +| **functionsKeySecret** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | +| **sasPolicyName** | **String** | | [optional] | +| **sasPolicyKey** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | diff --git a/src/docs/BillingAccount.md b/src/docs/BillingAccount.md index b6c9dc29..dc32a5eb 100644 --- a/src/docs/BillingAccount.md +++ b/src/docs/BillingAccount.md @@ -2,10 +2,8 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**uid** | **String** | | -**name** | **String** | | -**role** | [**BillingAccountRole**](BillingAccountRole.md) | | - - +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------- | ----------- | ----- | +| **uid** | **String** | | +| **name** | **String** | | +| **role** | [**BillingAccountRole**](BillingAccountRole.md) | | diff --git a/src/docs/BillingAccountApi.md b/src/docs/BillingAccountApi.md index 40ddfccf..f2ed8b82 100644 --- a/src/docs/BillingAccountApi.md +++ b/src/docs/BillingAccountApi.md @@ -2,36 +2,36 @@ All URIs are relative to *https://api.notefile.net* -Method | HTTP request | Description -------------- | ------------- | ------------- -[**getBillingAccounts**](BillingAccountApi.md#getBillingAccounts) | **GET** /v1/billing-accounts | - - +| Method | HTTP request | Description | +| ----------------------------------------------------------------- | ---------------------------- | ----------- | +| [**getBillingAccounts**](BillingAccountApi.md#getBillingAccounts) | **GET** /v1/billing-accounts | ## getBillingAccounts > GetBillingAccounts200Response getBillingAccounts() - - Get Billing Accounts accessible by the api_key ### Example ```javascript -import * as NotehubJs from '@blues-inc/notehub-js'; +import * as NotehubJs from "@blues-inc/notehub-js"; let defaultClient = NotehubJs.ApiClient.instance; // Configure API key authorization: api_key -let api_key = defaultClient.authentications['api_key']; -api_key.apiKey = 'YOUR API KEY'; +let api_key = defaultClient.authentications["api_key"]; +api_key.apiKey = "YOUR API KEY"; let apiInstance = new NotehubJs.BillingAccountApi(); -apiInstance.getBillingAccounts().then((data) => { - console.log('API called successfully. Returned data: ' + JSON.stringify(data)); -}, (error) => { - console.error(error); -}); - +apiInstance.getBillingAccounts().then( + (data) => { + console.log( + "API called successfully. Returned data: " + JSON.stringify(data) + ); + }, + (error) => { + console.error(error); + } +); ``` ### Parameters @@ -50,4 +50,3 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - diff --git a/src/docs/BillingAccountRole.md b/src/docs/BillingAccountRole.md index 1c020e03..ef622cff 100644 --- a/src/docs/BillingAccountRole.md +++ b/src/docs/BillingAccountRole.md @@ -2,11 +2,8 @@ ## Enum +- `billing_admin` (value: `"billing_admin"`) -* `billing_admin` (value: `"billing_admin"`) - -* `billing_manager` (value: `"billing_manager"`) - -* `project_creator` (value: `"project_creator"`) - +- `billing_manager` (value: `"billing_manager"`) +- `project_creator` (value: `"project_creator"`) diff --git a/src/docs/Body.md b/src/docs/Body.md index 6e87c8d9..bc2300bf 100644 --- a/src/docs/Body.md +++ b/src/docs/Body.md @@ -2,8 +2,6 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**body** | **Object** | | [optional] - - +| Name | Type | Description | Notes | +| -------- | ---------- | ----------- | ---------- | +| **body** | **Object** | | [optional] | diff --git a/src/docs/Contact.md b/src/docs/Contact.md index f0c703b4..2acf15fa 100644 --- a/src/docs/Contact.md +++ b/src/docs/Contact.md @@ -2,11 +2,9 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **String** | | [optional] -**email** | **String** | | [optional] -**role** | **String** | | [optional] -**organization** | **String** | | [optional] - - +| Name | Type | Description | Notes | +| ---------------- | ---------- | ----------- | ---------- | +| **name** | **String** | | [optional] | +| **email** | **String** | | [optional] | +| **role** | **String** | | [optional] | +| **organization** | **String** | | [optional] | diff --git a/src/docs/CreateFleetRequest.md b/src/docs/CreateFleetRequest.md index b995fda1..b124840d 100644 --- a/src/docs/CreateFleetRequest.md +++ b/src/docs/CreateFleetRequest.md @@ -2,8 +2,6 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**label** | **String** | The label for the Fleet. | [optional] - - +| Name | Type | Description | Notes | +| --------- | ---------- | ------------------------ | ---------- | +| **label** | **String** | The label for the Fleet. | [optional] | diff --git a/src/docs/CreateProjectRequest.md b/src/docs/CreateProjectRequest.md index f58a9dd5..65bb1179 100644 --- a/src/docs/CreateProjectRequest.md +++ b/src/docs/CreateProjectRequest.md @@ -2,9 +2,7 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**label** | **String** | The label for the project. | -**billingAccountUid** | **String** | The billing account UID for the project. The caller of the API must be able to create projects within the billing account, otherwise an error will be returned. | [optional] - - +| Name | Type | Description | Notes | +| --------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **label** | **String** | The label for the project. | +| **billingAccountUid** | **String** | The billing account UID for the project. The caller of the API must be able to create projects within the billing account, otherwise an error will be returned. | [optional] | diff --git a/src/docs/DFUEnv.md b/src/docs/DFUEnv.md index 7104c2c5..a659b5f8 100644 --- a/src/docs/DFUEnv.md +++ b/src/docs/DFUEnv.md @@ -2,9 +2,7 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**card** | [**DFUState**](DFUState.md) | | [optional] -**user** | [**DFUState**](DFUState.md) | | [optional] - - +| Name | Type | Description | Notes | +| -------- | --------------------------- | ----------- | ---------- | +| **card** | [**DFUState**](DFUState.md) | | [optional] | +| **user** | [**DFUState**](DFUState.md) | | [optional] | diff --git a/src/docs/DeleteDeviceFleetsRequest.md b/src/docs/DeleteDeviceFleetsRequest.md index 7826114e..59c68c25 100644 --- a/src/docs/DeleteDeviceFleetsRequest.md +++ b/src/docs/DeleteDeviceFleetsRequest.md @@ -2,8 +2,6 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**fleetUids** | **[String]** | The fleetUIDs to remove from the device. | - - +| Name | Type | Description | Notes | +| ------------- | ------------ | ---------------------------------------- | ----- | +| **fleetUids** | **[String]** | The fleetUIDs to remove from the device. | diff --git a/src/docs/Device.md b/src/docs/Device.md index 5c436029..45b3b003 100644 --- a/src/docs/Device.md +++ b/src/docs/Device.md @@ -2,22 +2,20 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**uid** | **String** | | -**serialNumber** | **String** | | -**provisioned** | **Date** | | -**lastActivity** | **Date** | | [optional] -**contact** | [**Contact**](Contact.md) | | [optional] -**productUid** | **String** | | -**fleetUids** | **[String]** | | -**towerInfo** | [**DeviceTowerInfo**](DeviceTowerInfo.md) | | [optional] -**towerLocation** | [**Location**](Location.md) | | [optional] -**gpsLocation** | [**Location**](Location.md) | | [optional] -**triangulatedLocation** | [**Location**](Location.md) | | [optional] -**voltage** | **Number** | | -**temperature** | **Number** | | -**dfu** | [**DFUEnv**](DFUEnv.md) | | [optional] -**sku** | **String** | | [optional] - - +| Name | Type | Description | Notes | +| ------------------------ | ----------------------------------------- | ----------- | ---------- | +| **uid** | **String** | | +| **serialNumber** | **String** | | +| **provisioned** | **Date** | | +| **lastActivity** | **Date** | | [optional] | +| **contact** | [**Contact**](Contact.md) | | [optional] | +| **productUid** | **String** | | +| **fleetUids** | **[String]** | | +| **towerInfo** | [**DeviceTowerInfo**](DeviceTowerInfo.md) | | [optional] | +| **towerLocation** | [**Location**](Location.md) | | [optional] | +| **gpsLocation** | [**Location**](Location.md) | | [optional] | +| **triangulatedLocation** | [**Location**](Location.md) | | [optional] | +| **voltage** | **Number** | | +| **temperature** | **Number** | | +| **dfu** | [**DFUEnv**](DFUEnv.md) | | [optional] | +| **sku** | **String** | | [optional] | diff --git a/src/docs/DeviceApi.md b/src/docs/DeviceApi.md index 0ebac459..7aab27d5 100644 --- a/src/docs/DeviceApi.md +++ b/src/docs/DeviceApi.md @@ -2,32 +2,28 @@ All URIs are relative to *https://api.notefile.net* -Method | HTTP request | Description -------------- | ------------- | ------------- -[**deleteDeviceEnvironmentVariable**](DeviceApi.md#deleteDeviceEnvironmentVariable) | **DELETE** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables/{key} | -[**deleteDeviceFleets**](DeviceApi.md#deleteDeviceFleets) | **DELETE** /v1/projects/{projectUID}/devices/{deviceUID}/fleets | -[**disableDevice**](DeviceApi.md#disableDevice) | **POST** /v1/projects/{projectUID}/devices/{deviceUID}/disable | -[**enableDevice**](DeviceApi.md#enableDevice) | **POST** /v1/projects/{projectUID}/devices/{deviceUID}/enable | -[**getDeviceEnvironmentVariables**](DeviceApi.md#getDeviceEnvironmentVariables) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables | -[**getDeviceEnvironmentVariablesByPin**](DeviceApi.md#getDeviceEnvironmentVariablesByPin) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables_with_pin | -[**getDeviceFleets**](DeviceApi.md#getDeviceFleets) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/fleets | -[**getDeviceHealthLog**](DeviceApi.md#getDeviceHealthLog) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/health-log | -[**getDeviceLatest**](DeviceApi.md#getDeviceLatest) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/latest | -[**getDevicePublicKey**](DeviceApi.md#getDevicePublicKey) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/public-key | -[**getDeviceSessions**](DeviceApi.md#getDeviceSessions) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/sessions | -[**handleNoteSignal**](DeviceApi.md#handleNoteSignal) | **POST** /v1/projects/{projectUID}/devices/{deviceUID}/signal | -[**putDeviceEnvironmentVariables**](DeviceApi.md#putDeviceEnvironmentVariables) | **PUT** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables | -[**putDeviceEnvironmentVariablesByPin**](DeviceApi.md#putDeviceEnvironmentVariablesByPin) | **PUT** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables_with_pin | -[**putDeviceFleets**](DeviceApi.md#putDeviceFleets) | **PUT** /v1/projects/{projectUID}/devices/{deviceUID}/fleets | - - +| Method | HTTP request | Description | +| ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | ----------- | +| [**deleteDeviceEnvironmentVariable**](DeviceApi.md#deleteDeviceEnvironmentVariable) | **DELETE** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables/{key} | +| [**deleteDeviceFleets**](DeviceApi.md#deleteDeviceFleets) | **DELETE** /v1/projects/{projectUID}/devices/{deviceUID}/fleets | +| [**disableDevice**](DeviceApi.md#disableDevice) | **POST** /v1/projects/{projectUID}/devices/{deviceUID}/disable | +| [**enableDevice**](DeviceApi.md#enableDevice) | **POST** /v1/projects/{projectUID}/devices/{deviceUID}/enable | +| [**getDeviceEnvironmentVariables**](DeviceApi.md#getDeviceEnvironmentVariables) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables | +| [**getDeviceEnvironmentVariablesByPin**](DeviceApi.md#getDeviceEnvironmentVariablesByPin) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables_with_pin | +| [**getDeviceFleets**](DeviceApi.md#getDeviceFleets) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/fleets | +| [**getDeviceHealthLog**](DeviceApi.md#getDeviceHealthLog) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/health-log | +| [**getDeviceLatest**](DeviceApi.md#getDeviceLatest) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/latest | +| [**getDevicePublicKey**](DeviceApi.md#getDevicePublicKey) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/public-key | +| [**getDeviceSessions**](DeviceApi.md#getDeviceSessions) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/sessions | +| [**handleNoteSignal**](DeviceApi.md#handleNoteSignal) | **POST** /v1/projects/{projectUID}/devices/{deviceUID}/signal | +| [**putDeviceEnvironmentVariables**](DeviceApi.md#putDeviceEnvironmentVariables) | **PUT** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables | +| [**putDeviceEnvironmentVariablesByPin**](DeviceApi.md#putDeviceEnvironmentVariablesByPin) | **PUT** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables_with_pin | +| [**putDeviceFleets**](DeviceApi.md#putDeviceFleets) | **PUT** /v1/projects/{projectUID}/devices/{deviceUID}/fleets | ## deleteDeviceEnvironmentVariable > EnvironmentVariables deleteDeviceEnvironmentVariable(projectUID, deviceUID, key) - - Delete environment variable of a device ### Example @@ -40,8 +36,8 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.DeviceApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let deviceUID = "deviceUID_example"; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let deviceUID = "deviceUID_example"; // String | let key = "key_example"; // String | The environment variable key to delete. apiInstance.deleteDeviceEnvironmentVariable(projectUID, deviceUID, key).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); @@ -53,12 +49,11 @@ apiInstance.deleteDeviceEnvironmentVariable(projectUID, deviceUID, key).then((da ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **deviceUID** | **String**| | - **key** | **String**| The environment variable key to delete. | +| Name | Type | Description | Notes | +| -------------- | ---------- | --------------------------------------- | ----- | +| **projectUID** | **String** | | +| **deviceUID** | **String** | | +| **key** | **String** | The environment variable key to delete. | ### Return type @@ -73,13 +68,10 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json - ## deleteDeviceFleets > GetProjectFleets200Response deleteDeviceFleets(projectUID, deviceUID, deleteDeviceFleetsRequest) - - Remove Device from Fleets ### Example @@ -92,9 +84,9 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.DeviceApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let deviceUID = "deviceUID_example"; // String | -let deleteDeviceFleetsRequest = new NotehubJs.DeleteDeviceFleetsRequest(); // DeleteDeviceFleetsRequest | The fleets to remove from the device. Note that the endpoint takes an array of fleetUIDs, to facilitate multi-fleet devices. Multi-fleet is not yet enabled on all SaaS plans - unless it is supported by the SaaS plan of the project, passing more than a single fleetUID in the array is an error. +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let deviceUID = "deviceUID_example"; // String | +let deleteDeviceFleetsRequest = new NotehubJs.DeleteDeviceFleetsRequest(); // DeleteDeviceFleetsRequest | The fleets to remove from the device. Note that the endpoint takes an array of fleetUIDs, to facilitate multi-fleet devices. Multi-fleet is not yet enabled on all SaaS plans - unless it is supported by the SaaS plan of the project, passing more than a single fleetUID in the array is an error. apiInstance.deleteDeviceFleets(projectUID, deviceUID, deleteDeviceFleetsRequest).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); }, (error) => { @@ -105,12 +97,11 @@ apiInstance.deleteDeviceFleets(projectUID, deviceUID, deleteDeviceFleetsRequest) ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **deviceUID** | **String**| | - **deleteDeviceFleetsRequest** | [**DeleteDeviceFleetsRequest**](DeleteDeviceFleetsRequest.md)| The fleets to remove from the device. Note that the endpoint takes an array of fleetUIDs, to facilitate multi-fleet devices. Multi-fleet is not yet enabled on all SaaS plans - unless it is supported by the SaaS plan of the project, passing more than a single fleetUID in the array is an error. | +| Name | Type | Description | Notes | +| ----------------------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | +| **projectUID** | **String** | | +| **deviceUID** | **String** | | +| **deleteDeviceFleetsRequest** | [**DeleteDeviceFleetsRequest**](DeleteDeviceFleetsRequest.md) | The fleets to remove from the device. Note that the endpoint takes an array of fleetUIDs, to facilitate multi-fleet devices. Multi-fleet is not yet enabled on all SaaS plans - unless it is supported by the SaaS plan of the project, passing more than a single fleetUID in the array is an error. | ### Return type @@ -125,13 +116,10 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json - ## disableDevice > disableDevice(projectUID, deviceUID) - - Disable Device ### Example @@ -144,8 +132,8 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.DeviceApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let deviceUID = "deviceUID_example"; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let deviceUID = "deviceUID_example"; // String | apiInstance.disableDevice(projectUID, deviceUID).then(() => { console.log('API called successfully.'); }, (error) => { @@ -156,11 +144,10 @@ apiInstance.disableDevice(projectUID, deviceUID).then(() => { ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **deviceUID** | **String**| | +| Name | Type | Description | Notes | +| -------------- | ---------- | ----------- | ----- | +| **projectUID** | **String** | | +| **deviceUID** | **String** | | ### Return type @@ -175,13 +162,10 @@ null (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## enableDevice > enableDevice(projectUID, deviceUID) - - Enable Device ### Example @@ -194,8 +178,8 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.DeviceApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let deviceUID = "deviceUID_example"; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let deviceUID = "deviceUID_example"; // String | apiInstance.enableDevice(projectUID, deviceUID).then(() => { console.log('API called successfully.'); }, (error) => { @@ -206,11 +190,10 @@ apiInstance.enableDevice(projectUID, deviceUID).then(() => { ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **deviceUID** | **String**| | +| Name | Type | Description | Notes | +| -------------- | ---------- | ----------- | ----- | +| **projectUID** | **String** | | +| **deviceUID** | **String** | | ### Return type @@ -225,13 +208,10 @@ null (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## getDeviceEnvironmentVariables > GetDeviceEnvironmentVariables200Response getDeviceEnvironmentVariables(projectUID, deviceUID) - - Get environment variables of a device ### Example @@ -244,8 +224,8 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.DeviceApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let deviceUID = "deviceUID_example"; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let deviceUID = "deviceUID_example"; // String | apiInstance.getDeviceEnvironmentVariables(projectUID, deviceUID).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); }, (error) => { @@ -256,11 +236,10 @@ apiInstance.getDeviceEnvironmentVariables(projectUID, deviceUID).then((data) => ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **deviceUID** | **String**| | +| Name | Type | Description | Notes | +| -------------- | ---------- | ----------- | ----- | +| **projectUID** | **String** | | +| **deviceUID** | **String** | | ### Return type @@ -275,13 +254,10 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json - ## getDeviceEnvironmentVariablesByPin > GetDeviceEnvironmentVariables200Response getDeviceEnvironmentVariablesByPin(projectUID, deviceUID) - - Get environment variables of a device with device pin authorization ### Example @@ -294,8 +270,8 @@ let pin = defaultClient.authentications['pin']; pin.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.DeviceApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let deviceUID = "deviceUID_example"; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let deviceUID = "deviceUID_example"; // String | apiInstance.getDeviceEnvironmentVariablesByPin(projectUID, deviceUID).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); }, (error) => { @@ -306,11 +282,10 @@ apiInstance.getDeviceEnvironmentVariablesByPin(projectUID, deviceUID).then((data ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **deviceUID** | **String**| | +| Name | Type | Description | Notes | +| -------------- | ---------- | ----------- | ----- | +| **projectUID** | **String** | | +| **deviceUID** | **String** | | ### Return type @@ -325,13 +300,10 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json - ## getDeviceFleets > GetProjectFleets200Response getDeviceFleets(projectUID, deviceUID) - - Get Device Fleets ### Example @@ -344,8 +316,8 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.DeviceApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let deviceUID = "deviceUID_example"; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let deviceUID = "deviceUID_example"; // String | apiInstance.getDeviceFleets(projectUID, deviceUID).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); }, (error) => { @@ -356,11 +328,10 @@ apiInstance.getDeviceFleets(projectUID, deviceUID).then((data) => { ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **deviceUID** | **String**| | +| Name | Type | Description | Notes | +| -------------- | ---------- | ----------- | ----- | +| **projectUID** | **String** | | +| **deviceUID** | **String** | | ### Return type @@ -375,13 +346,10 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json - ## getDeviceHealthLog > GetDeviceHealthLog200Response getDeviceHealthLog(projectUID, deviceUID) - - Get Device Health Log ### Example @@ -394,8 +362,8 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.DeviceApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let deviceUID = "deviceUID_example"; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let deviceUID = "deviceUID_example"; // String | apiInstance.getDeviceHealthLog(projectUID, deviceUID).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); }, (error) => { @@ -406,11 +374,10 @@ apiInstance.getDeviceHealthLog(projectUID, deviceUID).then((data) => { ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **deviceUID** | **String**| | +| Name | Type | Description | Notes | +| -------------- | ---------- | ----------- | ----- | +| **projectUID** | **String** | | +| **deviceUID** | **String** | | ### Return type @@ -425,13 +392,10 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json - ## getDeviceLatest > GetDeviceLatest200Response getDeviceLatest(projectUID, deviceUID) - - Get Device Latest Events ### Example @@ -444,8 +408,8 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.DeviceApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let deviceUID = "deviceUID_example"; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let deviceUID = "deviceUID_example"; // String | apiInstance.getDeviceLatest(projectUID, deviceUID).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); }, (error) => { @@ -456,11 +420,10 @@ apiInstance.getDeviceLatest(projectUID, deviceUID).then((data) => { ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **deviceUID** | **String**| | +| Name | Type | Description | Notes | +| -------------- | ---------- | ----------- | ----- | +| **projectUID** | **String** | | +| **deviceUID** | **String** | | ### Return type @@ -475,13 +438,10 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json - ## getDevicePublicKey > GetDevicePublicKey200Response getDevicePublicKey(projectUID, deviceUID) - - Get Device Public Key ### Example @@ -494,8 +454,8 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.DeviceApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let deviceUID = "deviceUID_example"; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let deviceUID = "deviceUID_example"; // String | apiInstance.getDevicePublicKey(projectUID, deviceUID).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); }, (error) => { @@ -506,11 +466,10 @@ apiInstance.getDevicePublicKey(projectUID, deviceUID).then((data) => { ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **deviceUID** | **String**| | +| Name | Type | Description | Notes | +| -------------- | ---------- | ----------- | ----- | +| **projectUID** | **String** | | +| **deviceUID** | **String** | | ### Return type @@ -525,13 +484,10 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json - ## getDeviceSessions > GetDeviceSessions200Response getDeviceSessions(projectUID, deviceUID, opts) - - Get Device Sessions ### Example @@ -544,11 +500,11 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.DeviceApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let deviceUID = "deviceUID_example"; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let deviceUID = "deviceUID_example"; // String | let opts = { - 'pageSize': 50, // Number | - 'pageNum': 1 // Number | + 'pageSize': 50, // Number | + 'pageNum': 1 // Number | }; apiInstance.getDeviceSessions(projectUID, deviceUID, opts).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); @@ -560,13 +516,12 @@ apiInstance.getDeviceSessions(projectUID, deviceUID, opts).then((data) => { ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **deviceUID** | **String**| | - **pageSize** | **Number**| | [optional] [default to 50] - **pageNum** | **Number**| | [optional] [default to 1] +| Name | Type | Description | Notes | +| -------------- | ---------- | ----------- | -------------------------- | +| **projectUID** | **String** | | +| **deviceUID** | **String** | | +| **pageSize** | **Number** | | [optional] [default to 50] | +| **pageNum** | **Number** | | [optional] [default to 1] | ### Return type @@ -581,13 +536,10 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json - ## handleNoteSignal > HandleNoteSignal200Response handleNoteSignal(projectUID, deviceUID, body) - - Send a signal from Notehub to a Notecard. ### Example @@ -600,8 +552,8 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.DeviceApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let deviceUID = "deviceUID_example"; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let deviceUID = "deviceUID_example"; // String | let body = new NotehubJs.Body(); // Body | Body or payload of singnal to be sent to the device apiInstance.handleNoteSignal(projectUID, deviceUID, body).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); @@ -613,12 +565,11 @@ apiInstance.handleNoteSignal(projectUID, deviceUID, body).then((data) => { ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **deviceUID** | **String**| | - **body** | [**Body**](Body.md)| Body or payload of singnal to be sent to the device | +| Name | Type | Description | Notes | +| -------------- | ------------------- | --------------------------------------------------- | ----- | +| **projectUID** | **String** | | +| **deviceUID** | **String** | | +| **body** | [**Body**](Body.md) | Body or payload of singnal to be sent to the device | ### Return type @@ -633,13 +584,10 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json - ## putDeviceEnvironmentVariables > EnvironmentVariables putDeviceEnvironmentVariables(projectUID, deviceUID, environmentVariables) - - Put environment variables of a device ### Example @@ -652,8 +600,8 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.DeviceApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let deviceUID = "deviceUID_example"; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let deviceUID = "deviceUID_example"; // String | let environmentVariables = new NotehubJs.EnvironmentVariables(); // EnvironmentVariables | Environment variables to be added to the device apiInstance.putDeviceEnvironmentVariables(projectUID, deviceUID, environmentVariables).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); @@ -665,12 +613,11 @@ apiInstance.putDeviceEnvironmentVariables(projectUID, deviceUID, environmentVari ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **deviceUID** | **String**| | - **environmentVariables** | [**EnvironmentVariables**](EnvironmentVariables.md)| Environment variables to be added to the device | +| Name | Type | Description | Notes | +| ------------------------ | --------------------------------------------------- | ----------------------------------------------- | ----- | +| **projectUID** | **String** | | +| **deviceUID** | **String** | | +| **environmentVariables** | [**EnvironmentVariables**](EnvironmentVariables.md) | Environment variables to be added to the device | ### Return type @@ -685,13 +632,10 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json - ## putDeviceEnvironmentVariablesByPin > EnvironmentVariables putDeviceEnvironmentVariablesByPin(projectUID, deviceUID, environmentVariables) - - Put environment variables of a device with device pin authorization ### Example @@ -704,8 +648,8 @@ let pin = defaultClient.authentications['pin']; pin.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.DeviceApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let deviceUID = "deviceUID_example"; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let deviceUID = "deviceUID_example"; // String | let environmentVariables = new NotehubJs.EnvironmentVariables(); // EnvironmentVariables | Environment variables to be added to the device apiInstance.putDeviceEnvironmentVariablesByPin(projectUID, deviceUID, environmentVariables).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); @@ -717,12 +661,11 @@ apiInstance.putDeviceEnvironmentVariablesByPin(projectUID, deviceUID, environmen ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **deviceUID** | **String**| | - **environmentVariables** | [**EnvironmentVariables**](EnvironmentVariables.md)| Environment variables to be added to the device | +| Name | Type | Description | Notes | +| ------------------------ | --------------------------------------------------- | ----------------------------------------------- | ----- | +| **projectUID** | **String** | | +| **deviceUID** | **String** | | +| **environmentVariables** | [**EnvironmentVariables**](EnvironmentVariables.md) | Environment variables to be added to the device | ### Return type @@ -737,13 +680,10 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json - ## putDeviceFleets > GetProjectFleets200Response putDeviceFleets(projectUID, deviceUID, putDeviceFleetsRequest) - - Add Device to Fleets ### Example @@ -756,9 +696,9 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.DeviceApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let deviceUID = "deviceUID_example"; // String | -let putDeviceFleetsRequest = new NotehubJs.PutDeviceFleetsRequest(); // PutDeviceFleetsRequest | The fleets to add to the device. Note that the endpoint takes an array of fleetUIDs, to facilitate multi-fleet devices. Multi-fleet is not yet enabled on all SaaS plans - unless it is supported by the SaaS plan of the project, passing more than a single fleetUID in the array is an error. +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let deviceUID = "deviceUID_example"; // String | +let putDeviceFleetsRequest = new NotehubJs.PutDeviceFleetsRequest(); // PutDeviceFleetsRequest | The fleets to add to the device. Note that the endpoint takes an array of fleetUIDs, to facilitate multi-fleet devices. Multi-fleet is not yet enabled on all SaaS plans - unless it is supported by the SaaS plan of the project, passing more than a single fleetUID in the array is an error. apiInstance.putDeviceFleets(projectUID, deviceUID, putDeviceFleetsRequest).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); }, (error) => { @@ -769,12 +709,11 @@ apiInstance.putDeviceFleets(projectUID, deviceUID, putDeviceFleetsRequest).then( ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **deviceUID** | **String**| | - **putDeviceFleetsRequest** | [**PutDeviceFleetsRequest**](PutDeviceFleetsRequest.md)| The fleets to add to the device. Note that the endpoint takes an array of fleetUIDs, to facilitate multi-fleet devices. Multi-fleet is not yet enabled on all SaaS plans - unless it is supported by the SaaS plan of the project, passing more than a single fleetUID in the array is an error. | +| Name | Type | Description | Notes | +| -------------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- | +| **projectUID** | **String** | | +| **deviceUID** | **String** | | +| **putDeviceFleetsRequest** | [**PutDeviceFleetsRequest**](PutDeviceFleetsRequest.md) | The fleets to add to the device. Note that the endpoint takes an array of fleetUIDs, to facilitate multi-fleet devices. Multi-fleet is not yet enabled on all SaaS plans - unless it is supported by the SaaS plan of the project, passing more than a single fleetUID in the array is an error. | ### Return type @@ -788,4 +727,3 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json - diff --git a/src/docs/DeviceTowerInfo.md b/src/docs/DeviceTowerInfo.md index efa55bb4..f06eff50 100644 --- a/src/docs/DeviceTowerInfo.md +++ b/src/docs/DeviceTowerInfo.md @@ -2,11 +2,9 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**mcc** | **Number** | | [optional] -**mnc** | **Number** | | [optional] -**lac** | **Number** | | [optional] -**cellId** | **Number** | | [optional] - - +| Name | Type | Description | Notes | +| ---------- | ---------- | ----------- | ---------- | +| **mcc** | **Number** | | [optional] | +| **mnc** | **Number** | | [optional] | +| **lac** | **Number** | | [optional] | +| **cellId** | **Number** | | [optional] | diff --git a/src/docs/DeviceUsage.md b/src/docs/DeviceUsage.md index 9513a25c..6346a00b 100644 --- a/src/docs/DeviceUsage.md +++ b/src/docs/DeviceUsage.md @@ -2,17 +2,15 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**since** | **Number** | | [optional] -**duration** | **Number** | | [optional] -**bytesRcvd** | **Number** | | [optional] -**bytesSent** | **Number** | | [optional] -**bytesRcvdSecondary** | **Number** | | [optional] -**bytesSentSecondary** | **Number** | | [optional] -**sessionsTcp** | **Number** | | [optional] -**sessionsTls** | **Number** | | [optional] -**notesRcvd** | **Number** | | [optional] -**noteSent** | **Number** | | [optional] - - +| Name | Type | Description | Notes | +| ---------------------- | ---------- | ----------- | ---------- | +| **since** | **Number** | | [optional] | +| **duration** | **Number** | | [optional] | +| **bytesRcvd** | **Number** | | [optional] | +| **bytesSent** | **Number** | | [optional] | +| **bytesRcvdSecondary** | **Number** | | [optional] | +| **bytesSentSecondary** | **Number** | | [optional] | +| **sessionsTcp** | **Number** | | [optional] | +| **sessionsTls** | **Number** | | [optional] | +| **notesRcvd** | **Number** | | [optional] | +| **noteSent** | **Number** | | [optional] | diff --git a/src/docs/EnvironmentVariables.md b/src/docs/EnvironmentVariables.md index 8181f751..9984c7d2 100644 --- a/src/docs/EnvironmentVariables.md +++ b/src/docs/EnvironmentVariables.md @@ -2,8 +2,6 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**environmentVariables** | **{String: String}** | | - - +| Name | Type | Description | Notes | +| ------------------------ | -------------------- | ----------- | ----- | +| **environmentVariables** | **{String: String}** | | diff --git a/src/docs/EnvironmentVariablesApi.md b/src/docs/EnvironmentVariablesApi.md index de72ab26..00e9fbc1 100644 --- a/src/docs/EnvironmentVariablesApi.md +++ b/src/docs/EnvironmentVariablesApi.md @@ -2,28 +2,24 @@ All URIs are relative to *https://api.notefile.net* -Method | HTTP request | Description -------------- | ------------- | ------------- -[**deleteDeviceEnvironmentVariable**](EnvironmentVariablesApi.md#deleteDeviceEnvironmentVariable) | **DELETE** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables/{key} | -[**deleteFleetEnvironmentVariable**](EnvironmentVariablesApi.md#deleteFleetEnvironmentVariable) | **DELETE** /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables/{key} | -[**deleteProjectEnvironmentVariable**](EnvironmentVariablesApi.md#deleteProjectEnvironmentVariable) | **DELETE** /v1/projects/{projectUID}/environment_variables/{key} | -[**getDeviceEnvironmentVariables**](EnvironmentVariablesApi.md#getDeviceEnvironmentVariables) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables | -[**getDeviceEnvironmentVariablesByPin**](EnvironmentVariablesApi.md#getDeviceEnvironmentVariablesByPin) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables_with_pin | -[**getFleetEnvironmentVariables**](EnvironmentVariablesApi.md#getFleetEnvironmentVariables) | **GET** /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables | -[**getProjectEnvironmentVariables**](EnvironmentVariablesApi.md#getProjectEnvironmentVariables) | **GET** /v1/projects/{projectUID}/environment_variables | -[**putDeviceEnvironmentVariables**](EnvironmentVariablesApi.md#putDeviceEnvironmentVariables) | **PUT** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables | -[**putDeviceEnvironmentVariablesByPin**](EnvironmentVariablesApi.md#putDeviceEnvironmentVariablesByPin) | **PUT** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables_with_pin | -[**putFleetEnvironmentVariables**](EnvironmentVariablesApi.md#putFleetEnvironmentVariables) | **PUT** /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables | -[**putProjectEnvironmentVariables**](EnvironmentVariablesApi.md#putProjectEnvironmentVariables) | **PUT** /v1/projects/{projectUID}/environment_variables | - - +| Method | HTTP request | Description | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | ----------- | +| [**deleteDeviceEnvironmentVariable**](EnvironmentVariablesApi.md#deleteDeviceEnvironmentVariable) | **DELETE** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables/{key} | +| [**deleteFleetEnvironmentVariable**](EnvironmentVariablesApi.md#deleteFleetEnvironmentVariable) | **DELETE** /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables/{key} | +| [**deleteProjectEnvironmentVariable**](EnvironmentVariablesApi.md#deleteProjectEnvironmentVariable) | **DELETE** /v1/projects/{projectUID}/environment_variables/{key} | +| [**getDeviceEnvironmentVariables**](EnvironmentVariablesApi.md#getDeviceEnvironmentVariables) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables | +| [**getDeviceEnvironmentVariablesByPin**](EnvironmentVariablesApi.md#getDeviceEnvironmentVariablesByPin) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables_with_pin | +| [**getFleetEnvironmentVariables**](EnvironmentVariablesApi.md#getFleetEnvironmentVariables) | **GET** /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables | +| [**getProjectEnvironmentVariables**](EnvironmentVariablesApi.md#getProjectEnvironmentVariables) | **GET** /v1/projects/{projectUID}/environment_variables | +| [**putDeviceEnvironmentVariables**](EnvironmentVariablesApi.md#putDeviceEnvironmentVariables) | **PUT** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables | +| [**putDeviceEnvironmentVariablesByPin**](EnvironmentVariablesApi.md#putDeviceEnvironmentVariablesByPin) | **PUT** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables_with_pin | +| [**putFleetEnvironmentVariables**](EnvironmentVariablesApi.md#putFleetEnvironmentVariables) | **PUT** /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables | +| [**putProjectEnvironmentVariables**](EnvironmentVariablesApi.md#putProjectEnvironmentVariables) | **PUT** /v1/projects/{projectUID}/environment_variables | ## deleteDeviceEnvironmentVariable > EnvironmentVariables deleteDeviceEnvironmentVariable(projectUID, deviceUID, key) - - Delete environment variable of a device ### Example @@ -36,8 +32,8 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.EnvironmentVariablesApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let deviceUID = "deviceUID_example"; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let deviceUID = "deviceUID_example"; // String | let key = "key_example"; // String | The environment variable key to delete. apiInstance.deleteDeviceEnvironmentVariable(projectUID, deviceUID, key).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); @@ -49,12 +45,11 @@ apiInstance.deleteDeviceEnvironmentVariable(projectUID, deviceUID, key).then((da ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **deviceUID** | **String**| | - **key** | **String**| The environment variable key to delete. | +| Name | Type | Description | Notes | +| -------------- | ---------- | --------------------------------------- | ----- | +| **projectUID** | **String** | | +| **deviceUID** | **String** | | +| **key** | **String** | The environment variable key to delete. | ### Return type @@ -69,13 +64,10 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json - ## deleteFleetEnvironmentVariable > EnvironmentVariables deleteFleetEnvironmentVariable(projectUID, fleetUID, key) - - Delete environment variables of a fleet ### Example @@ -88,8 +80,8 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.EnvironmentVariablesApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let fleetUID = "fleetUID_example"; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let fleetUID = "fleetUID_example"; // String | let key = "key_example"; // String | The environment variable key to delete. apiInstance.deleteFleetEnvironmentVariable(projectUID, fleetUID, key).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); @@ -101,12 +93,11 @@ apiInstance.deleteFleetEnvironmentVariable(projectUID, fleetUID, key).then((data ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **fleetUID** | **String**| | - **key** | **String**| The environment variable key to delete. | +| Name | Type | Description | Notes | +| -------------- | ---------- | --------------------------------------- | ----- | +| **projectUID** | **String** | | +| **fleetUID** | **String** | | +| **key** | **String** | The environment variable key to delete. | ### Return type @@ -121,13 +112,10 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json - ## deleteProjectEnvironmentVariable > EnvironmentVariables deleteProjectEnvironmentVariable(projectUID, key) - - Delete an environment variable of a project by key ### Example @@ -140,7 +128,7 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.EnvironmentVariablesApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | let key = "key_example"; // String | The environment variable key to delete. apiInstance.deleteProjectEnvironmentVariable(projectUID, key).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); @@ -152,11 +140,10 @@ apiInstance.deleteProjectEnvironmentVariable(projectUID, key).then((data) => { ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **key** | **String**| The environment variable key to delete. | +| Name | Type | Description | Notes | +| -------------- | ---------- | --------------------------------------- | ----- | +| **projectUID** | **String** | | +| **key** | **String** | The environment variable key to delete. | ### Return type @@ -171,13 +158,10 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json - ## getDeviceEnvironmentVariables > GetDeviceEnvironmentVariables200Response getDeviceEnvironmentVariables(projectUID, deviceUID) - - Get environment variables of a device ### Example @@ -190,8 +174,8 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.EnvironmentVariablesApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let deviceUID = "deviceUID_example"; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let deviceUID = "deviceUID_example"; // String | apiInstance.getDeviceEnvironmentVariables(projectUID, deviceUID).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); }, (error) => { @@ -202,11 +186,10 @@ apiInstance.getDeviceEnvironmentVariables(projectUID, deviceUID).then((data) => ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **deviceUID** | **String**| | +| Name | Type | Description | Notes | +| -------------- | ---------- | ----------- | ----- | +| **projectUID** | **String** | | +| **deviceUID** | **String** | | ### Return type @@ -221,13 +204,10 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json - ## getDeviceEnvironmentVariablesByPin > GetDeviceEnvironmentVariables200Response getDeviceEnvironmentVariablesByPin(projectUID, deviceUID) - - Get environment variables of a device with device pin authorization ### Example @@ -240,8 +220,8 @@ let pin = defaultClient.authentications['pin']; pin.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.EnvironmentVariablesApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let deviceUID = "deviceUID_example"; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let deviceUID = "deviceUID_example"; // String | apiInstance.getDeviceEnvironmentVariablesByPin(projectUID, deviceUID).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); }, (error) => { @@ -252,11 +232,10 @@ apiInstance.getDeviceEnvironmentVariablesByPin(projectUID, deviceUID).then((data ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **deviceUID** | **String**| | +| Name | Type | Description | Notes | +| -------------- | ---------- | ----------- | ----- | +| **projectUID** | **String** | | +| **deviceUID** | **String** | | ### Return type @@ -271,13 +250,10 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json - ## getFleetEnvironmentVariables > EnvironmentVariables getFleetEnvironmentVariables(projectUID, fleetUID) - - Get environment variables of a fleet ### Example @@ -290,8 +266,8 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.EnvironmentVariablesApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let fleetUID = "fleetUID_example"; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let fleetUID = "fleetUID_example"; // String | apiInstance.getFleetEnvironmentVariables(projectUID, fleetUID).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); }, (error) => { @@ -302,11 +278,10 @@ apiInstance.getFleetEnvironmentVariables(projectUID, fleetUID).then((data) => { ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **fleetUID** | **String**| | +| Name | Type | Description | Notes | +| -------------- | ---------- | ----------- | ----- | +| **projectUID** | **String** | | +| **fleetUID** | **String** | | ### Return type @@ -321,13 +296,10 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json - ## getProjectEnvironmentVariables > EnvironmentVariables getProjectEnvironmentVariables(projectUID) - - Get environment variables of a project ### Example @@ -340,7 +312,7 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.EnvironmentVariablesApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | apiInstance.getProjectEnvironmentVariables(projectUID).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); }, (error) => { @@ -351,10 +323,9 @@ apiInstance.getProjectEnvironmentVariables(projectUID).then((data) => { ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | +| Name | Type | Description | Notes | +| -------------- | ---------- | ----------- | ----- | +| **projectUID** | **String** | | ### Return type @@ -369,13 +340,10 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json - ## putDeviceEnvironmentVariables > EnvironmentVariables putDeviceEnvironmentVariables(projectUID, deviceUID, environmentVariables) - - Put environment variables of a device ### Example @@ -388,8 +356,8 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.EnvironmentVariablesApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let deviceUID = "deviceUID_example"; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let deviceUID = "deviceUID_example"; // String | let environmentVariables = new NotehubJs.EnvironmentVariables(); // EnvironmentVariables | Environment variables to be added to the device apiInstance.putDeviceEnvironmentVariables(projectUID, deviceUID, environmentVariables).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); @@ -401,12 +369,11 @@ apiInstance.putDeviceEnvironmentVariables(projectUID, deviceUID, environmentVari ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **deviceUID** | **String**| | - **environmentVariables** | [**EnvironmentVariables**](EnvironmentVariables.md)| Environment variables to be added to the device | +| Name | Type | Description | Notes | +| ------------------------ | --------------------------------------------------- | ----------------------------------------------- | ----- | +| **projectUID** | **String** | | +| **deviceUID** | **String** | | +| **environmentVariables** | [**EnvironmentVariables**](EnvironmentVariables.md) | Environment variables to be added to the device | ### Return type @@ -421,13 +388,10 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json - ## putDeviceEnvironmentVariablesByPin > EnvironmentVariables putDeviceEnvironmentVariablesByPin(projectUID, deviceUID, environmentVariables) - - Put environment variables of a device with device pin authorization ### Example @@ -440,8 +404,8 @@ let pin = defaultClient.authentications['pin']; pin.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.EnvironmentVariablesApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let deviceUID = "deviceUID_example"; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let deviceUID = "deviceUID_example"; // String | let environmentVariables = new NotehubJs.EnvironmentVariables(); // EnvironmentVariables | Environment variables to be added to the device apiInstance.putDeviceEnvironmentVariablesByPin(projectUID, deviceUID, environmentVariables).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); @@ -453,12 +417,11 @@ apiInstance.putDeviceEnvironmentVariablesByPin(projectUID, deviceUID, environmen ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **deviceUID** | **String**| | - **environmentVariables** | [**EnvironmentVariables**](EnvironmentVariables.md)| Environment variables to be added to the device | +| Name | Type | Description | Notes | +| ------------------------ | --------------------------------------------------- | ----------------------------------------------- | ----- | +| **projectUID** | **String** | | +| **deviceUID** | **String** | | +| **environmentVariables** | [**EnvironmentVariables**](EnvironmentVariables.md) | Environment variables to be added to the device | ### Return type @@ -473,13 +436,10 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json - ## putFleetEnvironmentVariables > EnvironmentVariables putFleetEnvironmentVariables(projectUID, fleetUID, environmentVariables) - - Put environment variables of a fleet ### Example @@ -492,8 +452,8 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.EnvironmentVariablesApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let fleetUID = "fleetUID_example"; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let fleetUID = "fleetUID_example"; // String | let environmentVariables = new NotehubJs.EnvironmentVariables(); // EnvironmentVariables | Environment variables to be added to the fleet apiInstance.putFleetEnvironmentVariables(projectUID, fleetUID, environmentVariables).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); @@ -505,12 +465,11 @@ apiInstance.putFleetEnvironmentVariables(projectUID, fleetUID, environmentVariab ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **fleetUID** | **String**| | - **environmentVariables** | [**EnvironmentVariables**](EnvironmentVariables.md)| Environment variables to be added to the fleet | +| Name | Type | Description | Notes | +| ------------------------ | --------------------------------------------------- | ---------------------------------------------- | ----- | +| **projectUID** | **String** | | +| **fleetUID** | **String** | | +| **environmentVariables** | [**EnvironmentVariables**](EnvironmentVariables.md) | Environment variables to be added to the fleet | ### Return type @@ -525,13 +484,10 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json - ## putProjectEnvironmentVariables > EnvironmentVariables putProjectEnvironmentVariables(projectUID, opts) - - Put environment variables of a project ### Example @@ -544,9 +500,9 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.EnvironmentVariablesApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | let opts = { - 'environmentVariables': new NotehubJs.EnvironmentVariables() // EnvironmentVariables | + 'environmentVariables': new NotehubJs.EnvironmentVariables() // EnvironmentVariables | }; apiInstance.putProjectEnvironmentVariables(projectUID, opts).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); @@ -558,11 +514,10 @@ apiInstance.putProjectEnvironmentVariables(projectUID, opts).then((data) => { ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **environmentVariables** | [**EnvironmentVariables**](EnvironmentVariables.md)| | [optional] +| Name | Type | Description | Notes | +| ------------------------ | --------------------------------------------------- | ----------- | ---------- | +| **projectUID** | **String** | | +| **environmentVariables** | [**EnvironmentVariables**](EnvironmentVariables.md) | | [optional] | ### Return type @@ -576,4 +531,3 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json - diff --git a/src/docs/Error.md b/src/docs/Error.md index 31fbc219..30be334a 100644 --- a/src/docs/Error.md +++ b/src/docs/Error.md @@ -2,13 +2,11 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**err** | **String** | Human readable error message. | -**code** | **Number** | The HTTP error code associated with the error. | -**status** | **String** | Machine readable representation of the HTTP error code. | -**request** | **String** | | [optional] -**details** | **Object** | | [optional] -**debug** | **String** | | [optional] - - +| Name | Type | Description | Notes | +| ----------- | ---------- | ------------------------------------------------------- | ---------- | +| **err** | **String** | Human readable error message. | +| **code** | **Number** | The HTTP error code associated with the error. | +| **status** | **String** | Machine readable representation of the HTTP error code. | +| **request** | **String** | | [optional] | +| **details** | **Object** | | [optional] | +| **debug** | **String** | | [optional] | diff --git a/src/docs/FilesApi.md b/src/docs/FilesApi.md index ef562d8b..750d7134 100644 --- a/src/docs/FilesApi.md +++ b/src/docs/FilesApi.md @@ -2,20 +2,16 @@ All URIs are relative to *https://api.notefile.net* -Method | HTTP request | Description -------------- | ------------- | ------------- -[**handleNotefileChanges**](FilesApi.md#handleNotefileChanges) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/files/changes | -[**handleNotefileChangesPending**](FilesApi.md#handleNotefileChangesPending) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/files/changes/pending | -[**handleNotefileDelete**](FilesApi.md#handleNotefileDelete) | **DELETE** /v1/projects/{projectUID}/devices/{deviceUID}/files | - - +| Method | HTTP request | Description | +| ---------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ----------- | +| [**handleNotefileChanges**](FilesApi.md#handleNotefileChanges) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/files/changes | +| [**handleNotefileChangesPending**](FilesApi.md#handleNotefileChangesPending) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/files/changes/pending | +| [**handleNotefileDelete**](FilesApi.md#handleNotefileDelete) | **DELETE** /v1/projects/{projectUID}/devices/{deviceUID}/files | ## handleNotefileChanges > HandleNotefileChanges200Response handleNotefileChanges(projectUID, deviceUID, opts) - - Used to perform queries on a single or multiple files to determine if new Notes are available to read ### Example @@ -28,8 +24,8 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.FilesApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let deviceUID = "deviceUID_example"; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let deviceUID = "deviceUID_example"; // String | let opts = { 'tracker': "tracker_example", // String | The change tracker ID. 'files': ["null"] // [String] | One or more files to obtain change information from. @@ -44,13 +40,12 @@ apiInstance.handleNotefileChanges(projectUID, deviceUID, opts).then((data) => { ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **deviceUID** | **String**| | - **tracker** | **String**| The change tracker ID. | [optional] - **files** | [**[String]**](String.md)| One or more files to obtain change information from. | [optional] +| Name | Type | Description | Notes | +| -------------- | ------------------------- | ---------------------------------------------------- | ---------- | +| **projectUID** | **String** | | +| **deviceUID** | **String** | | +| **tracker** | **String** | The change tracker ID. | [optional] | +| **files** | [**[String]**](String.md) | One or more files to obtain change information from. | [optional] | ### Return type @@ -65,13 +60,10 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json - ## handleNotefileChangesPending > HandleNotefileChangesPending200Response handleNotefileChangesPending(projectUID, deviceUID) - - Returns info about file changes that are pending upload to Notehub or download to the Notecard. ### Example @@ -84,8 +76,8 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.FilesApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let deviceUID = "deviceUID_example"; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let deviceUID = "deviceUID_example"; // String | apiInstance.handleNotefileChangesPending(projectUID, deviceUID).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); }, (error) => { @@ -96,11 +88,10 @@ apiInstance.handleNotefileChangesPending(projectUID, deviceUID).then((data) => { ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **deviceUID** | **String**| | +| Name | Type | Description | Notes | +| -------------- | ---------- | ----------- | ----- | +| **projectUID** | **String** | | +| **deviceUID** | **String** | | ### Return type @@ -115,13 +106,10 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json - ## handleNotefileDelete > handleNotefileDelete(projectUID, deviceUID, handleNotefileDeleteRequest) - - Deletes Notefiles and the Notes they contain. ### Example @@ -134,9 +122,9 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.FilesApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let deviceUID = "deviceUID_example"; // String | -let handleNotefileDeleteRequest = new NotehubJs.HandleNotefileDeleteRequest(); // HandleNotefileDeleteRequest | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let deviceUID = "deviceUID_example"; // String | +let handleNotefileDeleteRequest = new NotehubJs.HandleNotefileDeleteRequest(); // HandleNotefileDeleteRequest | apiInstance.handleNotefileDelete(projectUID, deviceUID, handleNotefileDeleteRequest).then(() => { console.log('API called successfully.'); }, (error) => { @@ -147,12 +135,11 @@ apiInstance.handleNotefileDelete(projectUID, deviceUID, handleNotefileDeleteRequ ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **deviceUID** | **String**| | - **handleNotefileDeleteRequest** | [**HandleNotefileDeleteRequest**](HandleNotefileDeleteRequest.md)| | +| Name | Type | Description | Notes | +| ------------------------------- | ----------------------------------------------------------------- | ----------- | ----- | +| **projectUID** | **String** | | +| **deviceUID** | **String** | | +| **handleNotefileDeleteRequest** | [**HandleNotefileDeleteRequest**](HandleNotefileDeleteRequest.md) | | ### Return type @@ -166,4 +153,3 @@ null (empty response body) - **Content-Type**: application/json - **Accept**: application/json - diff --git a/src/docs/Fleet.md b/src/docs/Fleet.md index d7d29ca8..2f7b0b6c 100644 --- a/src/docs/Fleet.md +++ b/src/docs/Fleet.md @@ -2,10 +2,8 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**uid** | **String** | | -**label** | **String** | | -**created** | **Date** | | - - +| Name | Type | Description | Notes | +| ----------- | ---------- | ----------- | ----- | +| **uid** | **String** | | +| **label** | **String** | | +| **created** | **Date** | | diff --git a/src/docs/GetBillingAccounts200Response.md b/src/docs/GetBillingAccounts200Response.md index bbef2c34..d25a9654 100644 --- a/src/docs/GetBillingAccounts200Response.md +++ b/src/docs/GetBillingAccounts200Response.md @@ -2,8 +2,6 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**billingAccounts** | [**[BillingAccount]**](BillingAccount.md) | | [optional] - - +| Name | Type | Description | Notes | +| ------------------- | ----------------------------------------- | ----------- | ---------- | +| **billingAccounts** | [**[BillingAccount]**](BillingAccount.md) | | [optional] | diff --git a/src/docs/GetDeviceEnvironmentVariables200Response.md b/src/docs/GetDeviceEnvironmentVariables200Response.md index a6462b24..b003b306 100644 --- a/src/docs/GetDeviceEnvironmentVariables200Response.md +++ b/src/docs/GetDeviceEnvironmentVariables200Response.md @@ -2,9 +2,7 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**environmentVariables** | **{String: String}** | The environment variables for this device that have been set using host firmware or the Notehub API or UI. | -**environmentVariablesEnvDefault** | **{String: String}** | The environment variables that have been set using the env.default request through the Notecard API. | - - +| Name | Type | Description | Notes | +| ---------------------------------- | -------------------- | ---------------------------------------------------------------------------------------------------------- | ----- | +| **environmentVariables** | **{String: String}** | The environment variables for this device that have been set using host firmware or the Notehub API or UI. | +| **environmentVariablesEnvDefault** | **{String: String}** | The environment variables that have been set using the env.default request through the Notecard API. | diff --git a/src/docs/GetDeviceHealthLog200Response.md b/src/docs/GetDeviceHealthLog200Response.md index b906c193..aa51a4ad 100644 --- a/src/docs/GetDeviceHealthLog200Response.md +++ b/src/docs/GetDeviceHealthLog200Response.md @@ -2,8 +2,6 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**healthLog** | [**[GetDeviceHealthLog200ResponseHealthLogInner]**](GetDeviceHealthLog200ResponseHealthLogInner.md) | | - - +| Name | Type | Description | Notes | +| ------------- | --------------------------------------------------------------------------------------------------- | ----------- | ----- | +| **healthLog** | [**[GetDeviceHealthLog200ResponseHealthLogInner]**](GetDeviceHealthLog200ResponseHealthLogInner.md) | | diff --git a/src/docs/GetDeviceHealthLog200ResponseHealthLogInner.md b/src/docs/GetDeviceHealthLog200ResponseHealthLogInner.md index 5eac19b9..8774dc06 100644 --- a/src/docs/GetDeviceHealthLog200ResponseHealthLogInner.md +++ b/src/docs/GetDeviceHealthLog200ResponseHealthLogInner.md @@ -2,10 +2,8 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**when** | **Date** | | -**alert** | **Boolean** | | -**text** | **String** | | - - +| Name | Type | Description | Notes | +| --------- | ----------- | ----------- | ----- | +| **when** | **Date** | | +| **alert** | **Boolean** | | +| **text** | **String** | | diff --git a/src/docs/GetDevicePublicKey200Response.md b/src/docs/GetDevicePublicKey200Response.md index 43a7dc09..50355b0f 100644 --- a/src/docs/GetDevicePublicKey200Response.md +++ b/src/docs/GetDevicePublicKey200Response.md @@ -2,9 +2,7 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**uid** | **String** | | -**key** | **String** | | - - +| Name | Type | Description | Notes | +| ------- | ---------- | ----------- | ----- | +| **uid** | **String** | | +| **key** | **String** | | diff --git a/src/docs/GetDeviceSessions200Response.md b/src/docs/GetDeviceSessions200Response.md index 601875c1..b7e262c9 100644 --- a/src/docs/GetDeviceSessions200Response.md +++ b/src/docs/GetDeviceSessions200Response.md @@ -2,9 +2,7 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**sessions** | [**[DeviceSession]**](DeviceSession.md) | | -**hasMore** | **Boolean** | | - - +| Name | Type | Description | Notes | +| ------------ | --------------------------------------- | ----------- | ----- | +| **sessions** | [**[DeviceSession]**](DeviceSession.md) | | +| **hasMore** | **Boolean** | | diff --git a/src/docs/GetProjectDevicePublicKeys200Response.md b/src/docs/GetProjectDevicePublicKeys200Response.md index 9dde8725..7fcf3399 100644 --- a/src/docs/GetProjectDevicePublicKeys200Response.md +++ b/src/docs/GetProjectDevicePublicKeys200Response.md @@ -2,9 +2,7 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**devicePublicKeys** | [**[GetProjectDevicePublicKeys200ResponseDevicePublicKeysInner]**](GetProjectDevicePublicKeys200ResponseDevicePublicKeysInner.md) | | -**hasMore** | **Boolean** | | - - +| Name | Type | Description | Notes | +| -------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ----------- | ----- | +| **devicePublicKeys** | [**[GetProjectDevicePublicKeys200ResponseDevicePublicKeysInner]**](GetProjectDevicePublicKeys200ResponseDevicePublicKeysInner.md) | | +| **hasMore** | **Boolean** | | diff --git a/src/docs/GetProjectDevicePublicKeys200ResponseDevicePublicKeysInner.md b/src/docs/GetProjectDevicePublicKeys200ResponseDevicePublicKeysInner.md index 1b98d304..2ed3b25a 100644 --- a/src/docs/GetProjectDevicePublicKeys200ResponseDevicePublicKeysInner.md +++ b/src/docs/GetProjectDevicePublicKeys200ResponseDevicePublicKeysInner.md @@ -2,9 +2,7 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**uid** | **String** | | [optional] -**key** | **String** | | [optional] - - +| Name | Type | Description | Notes | +| ------- | ---------- | ----------- | ---------- | +| **uid** | **String** | | [optional] | +| **key** | **String** | | [optional] | diff --git a/src/docs/GetProjectDevices200Response.md b/src/docs/GetProjectDevices200Response.md index f5efd81b..51064c3e 100644 --- a/src/docs/GetProjectDevices200Response.md +++ b/src/docs/GetProjectDevices200Response.md @@ -2,9 +2,7 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**devices** | [**[Device]**](Device.md) | | -**hasMore** | **Boolean** | | - - +| Name | Type | Description | Notes | +| ----------- | ------------------------- | ----------- | ----- | +| **devices** | [**[Device]**](Device.md) | | +| **hasMore** | **Boolean** | | diff --git a/src/docs/GetProjectEvents200Response.md b/src/docs/GetProjectEvents200Response.md index 6d359071..dee461b0 100644 --- a/src/docs/GetProjectEvents200Response.md +++ b/src/docs/GetProjectEvents200Response.md @@ -2,10 +2,8 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**events** | [**[Event]**](Event.md) | | -**through** | **String** | the EventUID of the most recent event displayed | -**hasMore** | **Boolean** | True if there are more events | - - +| Name | Type | Description | Notes | +| ----------- | ----------------------- | ----------------------------------------------- | ----- | +| **events** | [**[Event]**](Event.md) | | +| **through** | **String** | the EventUID of the most recent event displayed | +| **hasMore** | **Boolean** | True if there are more events | diff --git a/src/docs/GetProjectFleets200Response.md b/src/docs/GetProjectFleets200Response.md index 1b31889c..6aada7d7 100644 --- a/src/docs/GetProjectFleets200Response.md +++ b/src/docs/GetProjectFleets200Response.md @@ -2,8 +2,6 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**fleets** | [**[Fleet]**](Fleet.md) | | - - +| Name | Type | Description | Notes | +| ---------- | ----------------------- | ----------- | ----- | +| **fleets** | [**[Fleet]**](Fleet.md) | | diff --git a/src/docs/GetProjectMembers200Response.md b/src/docs/GetProjectMembers200Response.md index 388a39af..280d8c30 100644 --- a/src/docs/GetProjectMembers200Response.md +++ b/src/docs/GetProjectMembers200Response.md @@ -2,8 +2,6 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**members** | [**[ProjectMember]**](ProjectMember.md) | | - - +| Name | Type | Description | Notes | +| ----------- | --------------------------------------- | ----------- | ----- | +| **members** | [**[ProjectMember]**](ProjectMember.md) | | diff --git a/src/docs/GetProjectProducts200Response.md b/src/docs/GetProjectProducts200Response.md index 4270b830..191af805 100644 --- a/src/docs/GetProjectProducts200Response.md +++ b/src/docs/GetProjectProducts200Response.md @@ -2,8 +2,6 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**products** | [**[Product]**](Product.md) | | [optional] - - +| Name | Type | Description | Notes | +| ------------ | --------------------------- | ----------- | ---------- | +| **products** | [**[Product]**](Product.md) | | [optional] | diff --git a/src/docs/GetProjects200Response.md b/src/docs/GetProjects200Response.md index 7add9a27..71386f8a 100644 --- a/src/docs/GetProjects200Response.md +++ b/src/docs/GetProjects200Response.md @@ -2,8 +2,6 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**projects** | [**[Project]**](Project.md) | | [optional] - - +| Name | Type | Description | Notes | +| ------------ | --------------------------- | ----------- | ---------- | +| **projects** | [**[Project]**](Project.md) | | [optional] | diff --git a/src/docs/Google.md b/src/docs/Google.md index f699d89d..afb5c6e2 100644 --- a/src/docs/Google.md +++ b/src/docs/Google.md @@ -2,13 +2,11 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional] -**filter** | [**HttpFilter**](HttpFilter.md) | | [optional] -**transform** | [**HttpTransform**](HttpTransform.md) | | [optional] -**throttleMs** | **Number** | | [optional] -**url** | **String** | | [optional] -**timeout** | **Number** | Timeout in seconds for each request | [optional] [default to 15] - - +| Name | Type | Description | Notes | +| -------------- | ------------------------------------- | ----------------------------------------------------------------------------- | -------------------------- | +| **fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional] | +| **filter** | [**HttpFilter**](HttpFilter.md) | | [optional] | +| **transform** | [**HttpTransform**](HttpTransform.md) | | [optional] | +| **throttleMs** | **Number** | | [optional] | +| **url** | **String** | | [optional] | +| **timeout** | **Number** | Timeout in seconds for each request | [optional] [default to 15] | diff --git a/src/docs/HandleNoteChanges200Response.md b/src/docs/HandleNoteChanges200Response.md index 9ff9d864..c43b3a79 100644 --- a/src/docs/HandleNoteChanges200Response.md +++ b/src/docs/HandleNoteChanges200Response.md @@ -2,10 +2,8 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**total** | **Number** | The total number of notes. | [optional] -**changes** | **Number** | The number of pending changes in the Notefile. | [optional] -**notes** | **Object** | An object with a key for each note and a value object with the body of each Note and the time the Note was added. | [optional] - - +| Name | Type | Description | Notes | +| ----------- | ---------- | ----------------------------------------------------------------------------------------------------------------- | ---------- | +| **total** | **Number** | The total number of notes. | [optional] | +| **changes** | **Number** | The number of pending changes in the Notefile. | [optional] | +| **notes** | **Object** | An object with a key for each note and a value object with the body of each Note and the time the Note was added. | [optional] | diff --git a/src/docs/HandleNoteGet200Response.md b/src/docs/HandleNoteGet200Response.md index e1f0d68b..ca186efd 100644 --- a/src/docs/HandleNoteGet200Response.md +++ b/src/docs/HandleNoteGet200Response.md @@ -2,10 +2,8 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**body** | **Object** | The note body | [optional] -**payload** | **String** | The note payload | [optional] -**time** | **Number** | The time the Note was added to the Notecard or Notehub | [optional] - - +| Name | Type | Description | Notes | +| ----------- | ---------- | ------------------------------------------------------ | ---------- | +| **body** | **Object** | The note body | [optional] | +| **payload** | **String** | The note payload | [optional] | +| **time** | **Number** | The time the Note was added to the Notecard or Notehub | [optional] | diff --git a/src/docs/HandleNoteSignal200Response.md b/src/docs/HandleNoteSignal200Response.md index e6c16322..fb96d838 100644 --- a/src/docs/HandleNoteSignal200Response.md +++ b/src/docs/HandleNoteSignal200Response.md @@ -2,8 +2,6 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**connected** | **Boolean** | true if the Notecard is connected to Notehub. | [optional] - - +| Name | Type | Description | Notes | +| ------------- | ----------- | --------------------------------------------- | ---------- | +| **connected** | **Boolean** | true if the Notecard is connected to Notehub. | [optional] | diff --git a/src/docs/HandleNotefileChanges200Response.md b/src/docs/HandleNotefileChanges200Response.md index 32eca6da..eb2a4f06 100644 --- a/src/docs/HandleNotefileChanges200Response.md +++ b/src/docs/HandleNotefileChanges200Response.md @@ -2,10 +2,8 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**total** | **Number** | The total number of files. | [optional] -**changes** | **Number** | The number of pending changes in the Notefile. | [optional] -**info** | **Object** | An object with a key for each Notefile that matched the request parameters, and value object with the changes and total for each file. | [optional] - - +| Name | Type | Description | Notes | +| ----------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **total** | **Number** | The total number of files. | [optional] | +| **changes** | **Number** | The number of pending changes in the Notefile. | [optional] | +| **info** | **Object** | An object with a key for each Notefile that matched the request parameters, and value object with the changes and total for each file. | [optional] | diff --git a/src/docs/HandleNotefileChangesPending200Response.md b/src/docs/HandleNotefileChangesPending200Response.md index fec6ffb4..25238983 100644 --- a/src/docs/HandleNotefileChangesPending200Response.md +++ b/src/docs/HandleNotefileChangesPending200Response.md @@ -2,11 +2,9 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**total** | **Number** | The total number of files. | [optional] -**changes** | **Number** | The number of pending changes in the Notefile. | [optional] -**pending** | **Boolean** | Whether there are pending changes. | [optional] -**info** | **Object** | An object with a key for each Notefile that matched the request parameters, and value object with the changes and total for each file. | [optional] - - +| Name | Type | Description | Notes | +| ----------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **total** | **Number** | The total number of files. | [optional] | +| **changes** | **Number** | The number of pending changes in the Notefile. | [optional] | +| **pending** | **Boolean** | Whether there are pending changes. | [optional] | +| **info** | **Object** | An object with a key for each Notefile that matched the request parameters, and value object with the changes and total for each file. | [optional] | diff --git a/src/docs/HandleNotefileDeleteRequest.md b/src/docs/HandleNotefileDeleteRequest.md index 0bce8ac0..e89bea27 100644 --- a/src/docs/HandleNotefileDeleteRequest.md +++ b/src/docs/HandleNotefileDeleteRequest.md @@ -2,8 +2,6 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**files** | **[String]** | One or more files to obtain change information from. | [optional] - - +| Name | Type | Description | Notes | +| --------- | ------------ | ---------------------------------------------------- | ---------- | +| **files** | **[String]** | One or more files to obtain change information from. | [optional] | diff --git a/src/docs/Http.md b/src/docs/Http.md index 17e4be71..a6eb6480 100644 --- a/src/docs/Http.md +++ b/src/docs/Http.md @@ -2,15 +2,13 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional] -**filter** | [**HttpFilter**](HttpFilter.md) | | [optional] -**transform** | [**HttpTransform**](HttpTransform.md) | | [optional] -**throttleMs** | **Number** | Minimum time between requests in Miliseconds | [optional] -**url** | **String** | Route URL | [optional] -**httpHeaders** | **{String: String}** | | [optional] -**disableHttpHeaders** | **Boolean** | | [optional] [default to false] -**timeout** | **Number** | Timeout in seconds for each request | [optional] [default to 15] - - +| Name | Type | Description | Notes | +| ---------------------- | ------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------- | +| **fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional] | +| **filter** | [**HttpFilter**](HttpFilter.md) | | [optional] | +| **transform** | [**HttpTransform**](HttpTransform.md) | | [optional] | +| **throttleMs** | **Number** | Minimum time between requests in Miliseconds | [optional] | +| **url** | **String** | Route URL | [optional] | +| **httpHeaders** | **{String: String}** | | [optional] | +| **disableHttpHeaders** | **Boolean** | | [optional] [default to false] | +| **timeout** | **Number** | Timeout in seconds for each request | [optional] [default to 15] | diff --git a/src/docs/HttpFilter.md b/src/docs/HttpFilter.md index 86c7d851..9561f1ee 100644 --- a/src/docs/HttpFilter.md +++ b/src/docs/HttpFilter.md @@ -2,23 +2,16 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **String** | What notefiles this route applies to. | [optional] -**systemNotefiles** | **Boolean** | Whether system notefiles should be affected by this route | [optional] -**files** | **[String]** | | [optional] - - +| Name | Type | Description | Notes | +| ------------------- | ------------ | --------------------------------------------------------- | ---------- | +| **type** | **String** | What notefiles this route applies to. | [optional] | +| **systemNotefiles** | **Boolean** | Whether system notefiles should be affected by this route | [optional] | +| **files** | **[String]** | | [optional] | ## Enum: TypeEnum +- `all` (value: `"all"`) -* `all` (value: `"all"`) - -* `include` (value: `"include"`) - -* `exclude` (value: `"exclude"`) - - - +- `include` (value: `"include"`) +- `exclude` (value: `"exclude"`) diff --git a/src/docs/Location.md b/src/docs/Location.md index a6b5fcc9..f981c084 100644 --- a/src/docs/Location.md +++ b/src/docs/Location.md @@ -2,13 +2,11 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**when** | **String** | | -**name** | **String** | | -**country** | **String** | | -**timezone** | **String** | | -**latitude** | **Number** | | -**longitude** | **Number** | | - - +| Name | Type | Description | Notes | +| ------------- | ---------- | ----------- | ----- | +| **when** | **String** | | +| **name** | **String** | | +| **country** | **String** | | +| **timezone** | **String** | | +| **latitude** | **Number** | | +| **longitude** | **Number** | | diff --git a/src/docs/Login200Response.md b/src/docs/Login200Response.md index 7881e796..4ba2e9f7 100644 --- a/src/docs/Login200Response.md +++ b/src/docs/Login200Response.md @@ -2,8 +2,6 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**sessionToken** | **String** | | [optional] - - +| Name | Type | Description | Notes | +| ---------------- | ---------- | ----------- | ---------- | +| **sessionToken** | **String** | | [optional] | diff --git a/src/docs/LoginRequest.md b/src/docs/LoginRequest.md index a40a7f21..ca5b64c0 100644 --- a/src/docs/LoginRequest.md +++ b/src/docs/LoginRequest.md @@ -2,9 +2,7 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**username** | **String** | | [optional] -**password** | **String** | | [optional] - - +| Name | Type | Description | Notes | +| ------------ | ---------- | ----------- | ---------- | +| **username** | **String** | | [optional] | +| **password** | **String** | | [optional] | diff --git a/src/docs/Mqtt.md b/src/docs/Mqtt.md index 2a18eee5..a211ca94 100644 --- a/src/docs/Mqtt.md +++ b/src/docs/Mqtt.md @@ -2,21 +2,19 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional] -**filter** | [**HttpFilter**](HttpFilter.md) | | [optional] -**transform** | [**HttpTransform**](HttpTransform.md) | | [optional] -**throttleMs** | **Number** | | [optional] -**timeout** | **Number** | Timeout in seconds for each request | [optional] [default to 15] -**broker** | **String** | | [optional] -**port** | **Number** | | [optional] -**username** | **String** | | [optional] -**password** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] -**topic** | **String** | | [optional] -**certificate** | **String** | Certificate with \\n newlines. This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] -**certificateName** | **String** | Name of certificate. | [optional] -**key** | **String** | Key with \\n newlines. This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] -**privateKeyName** | **String** | Name of key | [optional] - - +| Name | Type | Description | Notes | +| ------------------- | ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -------------------------- | +| **fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional] | +| **filter** | [**HttpFilter**](HttpFilter.md) | | [optional] | +| **transform** | [**HttpTransform**](HttpTransform.md) | | [optional] | +| **throttleMs** | **Number** | | [optional] | +| **timeout** | **Number** | Timeout in seconds for each request | [optional] [default to 15] | +| **broker** | **String** | | [optional] | +| **port** | **Number** | | [optional] | +| **username** | **String** | | [optional] | +| **password** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | +| **topic** | **String** | | [optional] | +| **certificate** | **String** | Certificate with \\n newlines. This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | +| **certificateName** | **String** | Name of certificate. | [optional] | +| **key** | **String** | Key with \\n newlines. This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | +| **privateKeyName** | **String** | Name of key | [optional] | diff --git a/src/docs/Note.md b/src/docs/Note.md index da4280c6..e39f5673 100644 --- a/src/docs/Note.md +++ b/src/docs/Note.md @@ -2,9 +2,7 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**body** | **Object** | | [optional] -**payload** | **String** | | [optional] - - +| Name | Type | Description | Notes | +| ----------- | ---------- | ----------- | ---------- | +| **body** | **Object** | | [optional] | +| **payload** | **String** | | [optional] | diff --git a/src/docs/Product.md b/src/docs/Product.md index b52c68e0..4ff20713 100644 --- a/src/docs/Product.md +++ b/src/docs/Product.md @@ -2,11 +2,9 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**uid** | **String** | | -**label** | **String** | | -**autoProvisionFleets** | **[String]** | | [optional] -**disableDevicesByDefault** | **Boolean** | | - - +| Name | Type | Description | Notes | +| --------------------------- | ------------ | ----------- | ---------- | +| **uid** | **String** | | +| **label** | **String** | | +| **autoProvisionFleets** | **[String]** | | [optional] | +| **disableDevicesByDefault** | **Boolean** | | diff --git a/src/docs/ProductApi.md b/src/docs/ProductApi.md index 77e69289..ab708a89 100644 --- a/src/docs/ProductApi.md +++ b/src/docs/ProductApi.md @@ -2,20 +2,16 @@ All URIs are relative to *https://api.notefile.net* -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createProduct**](ProductApi.md#createProduct) | **POST** /v1/projects/{projectUID}/products | -[**getProjectByProduct**](ProductApi.md#getProjectByProduct) | **GET** /v1/products/{productUID}/project | -[**getProjectProducts**](ProductApi.md#getProjectProducts) | **GET** /v1/projects/{projectUID}/products | - - +| Method | HTTP request | Description | +| ------------------------------------------------------------ | ------------------------------------------- | ----------- | +| [**createProduct**](ProductApi.md#createProduct) | **POST** /v1/projects/{projectUID}/products | +| [**getProjectByProduct**](ProductApi.md#getProjectByProduct) | **GET** /v1/products/{productUID}/project | +| [**getProjectProducts**](ProductApi.md#getProjectProducts) | **GET** /v1/projects/{projectUID}/products | ## createProduct > Product createProduct(projectUID, createProductRequest) - - Create Product within a Project ### Example @@ -28,7 +24,7 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.ProductApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | let createProductRequest = new NotehubJs.CreateProductRequest(); // CreateProductRequest | Product to be created apiInstance.createProduct(projectUID, createProductRequest).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); @@ -40,11 +36,10 @@ apiInstance.createProduct(projectUID, createProductRequest).then((data) => { ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **createProductRequest** | [**CreateProductRequest**](CreateProductRequest.md)| Product to be created | +| Name | Type | Description | Notes | +| ------------------------ | --------------------------------------------------- | --------------------- | ----- | +| **projectUID** | **String** | | +| **createProductRequest** | [**CreateProductRequest**](CreateProductRequest.md) | Product to be created | ### Return type @@ -59,40 +54,40 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json - ## getProjectByProduct > Project getProjectByProduct(productUID) - - Get a Project by ProductUID ### Example ```javascript -import * as NotehubJs from '@blues-inc/notehub-js'; +import * as NotehubJs from "@blues-inc/notehub-js"; let defaultClient = NotehubJs.ApiClient.instance; // Configure API key authorization: api_key -let api_key = defaultClient.authentications['api_key']; -api_key.apiKey = 'YOUR API KEY'; +let api_key = defaultClient.authentications["api_key"]; +api_key.apiKey = "YOUR API KEY"; let apiInstance = new NotehubJs.ProductApi(); -let productUID = com.blues.airnote; // String | -apiInstance.getProjectByProduct(productUID).then((data) => { - console.log('API called successfully. Returned data: ' + JSON.stringify(data)); -}, (error) => { - console.error(error); -}); - +let productUID = com.blues.airnote; // String | +apiInstance.getProjectByProduct(productUID).then( + (data) => { + console.log( + "API called successfully. Returned data: " + JSON.stringify(data) + ); + }, + (error) => { + console.error(error); + } +); ``` ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **productUID** | **String**| | +| Name | Type | Description | Notes | +| -------------- | ---------- | ----------- | ----- | +| **productUID** | **String** | | ### Return type @@ -107,13 +102,10 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json - ## getProjectProducts > GetProjectProducts200Response getProjectProducts(projectUID) - - Get Products within a Project ### Example @@ -126,7 +118,7 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.ProductApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | apiInstance.getProjectProducts(projectUID).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); }, (error) => { @@ -137,10 +129,9 @@ apiInstance.getProjectProducts(projectUID).then((data) => { ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | +| Name | Type | Description | Notes | +| -------------- | ---------- | ----------- | ----- | +| **projectUID** | **String** | | ### Return type @@ -154,4 +145,3 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json - diff --git a/src/docs/Project.md b/src/docs/Project.md index c20293d5..982de00e 100644 --- a/src/docs/Project.md +++ b/src/docs/Project.md @@ -2,13 +2,11 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**uid** | **String** | | -**label** | **String** | | -**created** | **Date** | | -**role** | [**Role**](Role.md) | | [optional] -**administrativeContact** | [**Contact**](Contact.md) | | [optional] -**technicalContact** | [**Contact**](Contact.md) | | [optional] - - +| Name | Type | Description | Notes | +| ------------------------- | ------------------------- | ----------- | ---------- | +| **uid** | **String** | | +| **label** | **String** | | +| **created** | **Date** | | +| **role** | [**Role**](Role.md) | | [optional] | +| **administrativeContact** | [**Contact**](Contact.md) | | [optional] | +| **technicalContact** | [**Contact**](Contact.md) | | [optional] | diff --git a/src/docs/ProjectMember.md b/src/docs/ProjectMember.md index 037eebeb..551abcae 100644 --- a/src/docs/ProjectMember.md +++ b/src/docs/ProjectMember.md @@ -2,10 +2,8 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **String** | | -**email** | **String** | The email address of the project member. This property will only be populated if the viewer is an owner of the project. | -**role** | [**Role**](Role.md) | | - - +| Name | Type | Description | Notes | +| --------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----- | +| **name** | **String** | | +| **email** | **String** | The email address of the project member. This property will only be populated if the viewer is an owner of the project. | +| **role** | [**Role**](Role.md) | | diff --git a/src/docs/Proxy.md b/src/docs/Proxy.md index 4edbfba6..6f74a029 100644 --- a/src/docs/Proxy.md +++ b/src/docs/Proxy.md @@ -2,12 +2,10 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional] -**url** | **String** | | [optional] -**alias** | **String** | | [optional] -**httpHeaders** | **{String: String}** | | [optional] -**timeout** | **Number** | Timeout in seconds for each request | [optional] [default to 15] - - +| Name | Type | Description | Notes | +| --------------- | -------------------- | ----------------------------------------------------------------------------- | -------------------------- | +| **fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional] | +| **url** | **String** | | [optional] | +| **alias** | **String** | | [optional] | +| **httpHeaders** | **{String: String}** | | [optional] | +| **timeout** | **Number** | Timeout in seconds for each request | [optional] [default to 15] | diff --git a/src/docs/PutDeviceFleetsRequest.md b/src/docs/PutDeviceFleetsRequest.md index 3199de5b..2e23a039 100644 --- a/src/docs/PutDeviceFleetsRequest.md +++ b/src/docs/PutDeviceFleetsRequest.md @@ -2,8 +2,6 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**fleetUids** | **[String]** | The fleetUIDs to add to the device. | - - +| Name | Type | Description | Notes | +| ------------- | ------------ | ----------------------------------- | ----- | +| **fleetUids** | **[String]** | The fleetUIDs to add to the device. | diff --git a/src/docs/Radresponder.md b/src/docs/Radresponder.md index cffeca7b..798b9510 100644 --- a/src/docs/Radresponder.md +++ b/src/docs/Radresponder.md @@ -2,12 +2,10 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional] -**testApi** | **Boolean** | | [optional] [default to false] -**dataFeedKey** | **String** | | [optional] -**clientId** | **String** | | [optional] -**clientSecret** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] - - +| Name | Type | Description | Notes | +| ---------------- | ------------ | ---------------------------------------------------------------------------------------------- | ----------------------------- | +| **fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional] | +| **testApi** | **Boolean** | | [optional] [default to false] | +| **dataFeedKey** | **String** | | [optional] | +| **clientId** | **String** | | [optional] | +| **clientSecret** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | diff --git a/src/docs/Role.md b/src/docs/Role.md index ae5d3bd2..609c94a7 100644 --- a/src/docs/Role.md +++ b/src/docs/Role.md @@ -2,13 +2,10 @@ ## Enum +- `owner` (value: `"owner"`) -* `owner` (value: `"owner"`) - -* `developer` (value: `"developer"`) - -* `viewer` (value: `"viewer"`) - -* `null` (value: `"null"`) +- `developer` (value: `"developer"`) +- `viewer` (value: `"viewer"`) +- `null` (value: `"null"`) diff --git a/src/docs/RouteApi.md b/src/docs/RouteApi.md index dafaba2f..388f39f0 100644 --- a/src/docs/RouteApi.md +++ b/src/docs/RouteApi.md @@ -2,22 +2,18 @@ All URIs are relative to *https://api.notefile.net* -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createRoute**](RouteApi.md#createRoute) | **POST** /v1/projects/{projectUID}/routes | -[**deleteRoute**](RouteApi.md#deleteRoute) | **DELETE** /v1/projects/{projectUID}/routes/{routeUID} | -[**getRoute**](RouteApi.md#getRoute) | **GET** /v1/projects/{projectUID}/routes/{routeUID} | -[**getRoutes**](RouteApi.md#getRoutes) | **GET** /v1/projects/{projectUID}/routes | -[**updateRoute**](RouteApi.md#updateRoute) | **PUT** /v1/projects/{projectUID}/routes/{routeUID} | - - +| Method | HTTP request | Description | +| ------------------------------------------ | ------------------------------------------------------ | ----------- | +| [**createRoute**](RouteApi.md#createRoute) | **POST** /v1/projects/{projectUID}/routes | +| [**deleteRoute**](RouteApi.md#deleteRoute) | **DELETE** /v1/projects/{projectUID}/routes/{routeUID} | +| [**getRoute**](RouteApi.md#getRoute) | **GET** /v1/projects/{projectUID}/routes/{routeUID} | +| [**getRoutes**](RouteApi.md#getRoutes) | **GET** /v1/projects/{projectUID}/routes | +| [**updateRoute**](RouteApi.md#updateRoute) | **PUT** /v1/projects/{projectUID}/routes/{routeUID} | ## createRoute > Route createRoute(projectUID, route) - - Create Route within a Project ### Example @@ -30,7 +26,7 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.RouteApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | let route = { "label": "Route Label", "type":"http", @@ -51,11 +47,10 @@ apiInstance.createRoute(projectUID, route).then((data) => { ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **route** | [**Route**](Route.md)| Route to be Created | +| Name | Type | Description | Notes | +| -------------- | --------------------- | ------------------- | ----- | +| **projectUID** | **String** | | +| **route** | [**Route**](Route.md) | Route to be Created | ### Return type @@ -70,13 +65,10 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json - ## deleteRoute > Object deleteRoute(projectUID, routeUID) - - Delete single route within a project ### Example @@ -89,8 +81,8 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.RouteApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let routeUID = route:cbd20093cba58392c9f9bbdd0cdeb1a0; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let routeUID = route:cbd20093cba58392c9f9bbdd0cdeb1a0; // String | apiInstance.deleteRoute(projectUID, routeUID).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); }, (error) => { @@ -101,11 +93,10 @@ apiInstance.deleteRoute(projectUID, routeUID).then((data) => { ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **routeUID** | **String**| | +| Name | Type | Description | Notes | +| -------------- | ---------- | ----------- | ----- | +| **projectUID** | **String** | | +| **routeUID** | **String** | | ### Return type @@ -120,13 +111,10 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json - ## getRoute > Route getRoute(projectUID, routeUID) - - Get single route within a project ### Example @@ -139,8 +127,8 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.RouteApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let routeUID = route:cbd20093cba58392c9f9bbdd0cdeb1a0; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let routeUID = route:cbd20093cba58392c9f9bbdd0cdeb1a0; // String | apiInstance.getRoute(projectUID, routeUID).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); }, (error) => { @@ -151,11 +139,10 @@ apiInstance.getRoute(projectUID, routeUID).then((data) => { ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **routeUID** | **String**| | +| Name | Type | Description | Notes | +| -------------- | ---------- | ----------- | ----- | +| **projectUID** | **String** | | +| **routeUID** | **String** | | ### Return type @@ -170,13 +157,10 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json - ## getRoutes > [UserDbRoute] getRoutes(projectUID) - - Get all Routes within a Project ### Example @@ -189,7 +173,7 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.RouteApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | apiInstance.getRoutes(projectUID).then((data) => { console.log('API called successfully. Returned data: ' + JSON.stringify(data)); }, (error) => { @@ -200,10 +184,9 @@ apiInstance.getRoutes(projectUID).then((data) => { ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | +| Name | Type | Description | Notes | +| -------------- | ---------- | ----------- | ----- | +| **projectUID** | **String** | | ### Return type @@ -218,13 +201,10 @@ Name | Type | Description | Notes - **Content-Type**: Not defined - **Accept**: application/json - ## updateRoute > Route updateRoute(projectUID, routeUID, route) - - Update route by UID ### Example @@ -237,8 +217,8 @@ let api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; let apiInstance = new NotehubJs.RouteApi(); -let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | -let routeUID = route:cbd20093cba58392c9f9bbdd0cdeb1a0; // String | +let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String | +let routeUID = route:cbd20093cba58392c9f9bbdd0cdeb1a0; // String | let route = { "http" { "filter": { @@ -261,12 +241,11 @@ apiInstance.updateRoute(projectUID, routeUID, route).then((data) => { ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **projectUID** | **String**| | - **routeUID** | **String**| | - **route** | [**Route**](Route.md)| Route settings to be updated | +| Name | Type | Description | Notes | +| -------------- | --------------------- | ---------------------------- | ----- | +| **projectUID** | **String** | | +| **routeUID** | **String** | | +| **route** | [**Route**](Route.md) | Route settings to be updated | ### Return type @@ -280,4 +259,3 @@ Name | Type | Description | Notes - **Content-Type**: application/json - **Accept**: application/json - diff --git a/src/docs/Thingworx.md b/src/docs/Thingworx.md index e93fd64f..358b14a8 100644 --- a/src/docs/Thingworx.md +++ b/src/docs/Thingworx.md @@ -2,14 +2,12 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional] -**filter** | [**HttpFilter**](HttpFilter.md) | | [optional] -**transform** | [**HttpTransform**](HttpTransform.md) | | [optional] -**throttleMs** | **Number** | | [optional] -**url** | **String** | | [optional] -**timeout** | **Number** | Timeout in seconds for each request | [optional] [default to 15] -**appKey** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] - - +| Name | Type | Description | Notes | +| -------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------- | -------------------------- | +| **fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional] | +| **filter** | [**HttpFilter**](HttpFilter.md) | | [optional] | +| **transform** | [**HttpTransform**](HttpTransform.md) | | [optional] | +| **throttleMs** | **Number** | | [optional] | +| **url** | **String** | | [optional] | +| **timeout** | **Number** | Timeout in seconds for each request | [optional] [default to 15] | +| **appKey** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] | diff --git a/src/docs/TowerLocation.md b/src/docs/TowerLocation.md index 4acc340e..74e20f3e 100644 --- a/src/docs/TowerLocation.md +++ b/src/docs/TowerLocation.md @@ -2,21 +2,19 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**time** | **Number** | | [optional] -**n** | **String** | Name of the location | [optional] -**c** | **String** | Country code | [optional] -**lat** | **Number** | | [optional] -**lon** | **Number** | | [optional] -**zone** | **String** | | [optional] -**mcc** | **Number** | | [optional] -**mnc** | **Number** | | [optional] -**lac** | **Number** | | [optional] -**cid** | **Number** | | [optional] -**l** | **String** | Open location code | [optional] -**z** | **Number** | Timezone ID | [optional] -**count** | **Number** | Number of times this location was recently used | [optional] -**towers** | **Number** | Number of triangulation points | [optional] - - +| Name | Type | Description | Notes | +| ---------- | ---------- | ----------------------------------------------- | ---------- | +| **time** | **Number** | | [optional] | +| **n** | **String** | Name of the location | [optional] | +| **c** | **String** | Country code | [optional] | +| **lat** | **Number** | | [optional] | +| **lon** | **Number** | | [optional] | +| **zone** | **String** | | [optional] | +| **mcc** | **Number** | | [optional] | +| **mnc** | **Number** | | [optional] | +| **lac** | **Number** | | [optional] | +| **cid** | **Number** | | [optional] | +| **l** | **String** | Open location code | [optional] | +| **z** | **Number** | Timezone ID | [optional] | +| **count** | **Number** | Number of times this location was recently used | [optional] | +| **towers** | **Number** | Number of triangulation points | [optional] | diff --git a/src/docs/Twilio.md b/src/docs/Twilio.md index 5a880342..20c5f0e1 100644 --- a/src/docs/Twilio.md +++ b/src/docs/Twilio.md @@ -2,16 +2,14 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional] -**filter** | [**HttpFilter**](HttpFilter.md) | | [optional] -**timeout** | **Number** | Timeout in seconds for each request | [optional] [default to 15] -**accountSid** | **String** | Twilio Account SID | [optional] -**authToken** | **String** | Twilio Auth Token. This value will be omitted from the response and replaced with a placeholder. | [optional] -**to** | **String** | Phone number to send SMS to, leave blank to use notefile, must use E.164 format | [optional] -**from** | **String** | Phone number to send SMS from, leave blank to use notefile, must use E.164 format | [optional] -**message** | **String** | Message to send, leave blank to use notefile. | [optional] -**throttleMs** | **Number** | | [optional] - - +| Name | Type | Description | Notes | +| -------------- | ------------------------------- | ------------------------------------------------------------------------------------------------ | -------------------------- | +| **fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional] | +| **filter** | [**HttpFilter**](HttpFilter.md) | | [optional] | +| **timeout** | **Number** | Timeout in seconds for each request | [optional] [default to 15] | +| **accountSid** | **String** | Twilio Account SID | [optional] | +| **authToken** | **String** | Twilio Auth Token. This value will be omitted from the response and replaced with a placeholder. | [optional] | +| **to** | **String** | Phone number to send SMS to, leave blank to use notefile, must use E.164 format | [optional] | +| **from** | **String** | Phone number to send SMS from, leave blank to use notefile, must use E.164 format | [optional] | +| **message** | **String** | Message to send, leave blank to use notefile. | [optional] | +| **throttleMs** | **Number** | | [optional] | diff --git a/src/docs/UpdateFleetRequest.md b/src/docs/UpdateFleetRequest.md index 58162015..db5a6b78 100644 --- a/src/docs/UpdateFleetRequest.md +++ b/src/docs/UpdateFleetRequest.md @@ -2,10 +2,8 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**label** | **String** | The label for the Fleet. | [optional] -**addDevices** | **[String]** | List of DeviceUIDs to add to fleet | [optional] -**removeDevices** | **[String]** | List of DeviceUIDs to remove from fleet | [optional] - - +| Name | Type | Description | Notes | +| ----------------- | ------------ | --------------------------------------- | ---------- | +| **label** | **String** | The label for the Fleet. | [optional] | +| **addDevices** | **[String]** | List of DeviceUIDs to add to fleet | [optional] | +| **removeDevices** | **[String]** | List of DeviceUIDs to remove from fleet | [optional] |