losant_rest 1.9.3 → 1.10.4

data/docs/application.md

@@ -6,6 +6,7 @@ parameters and the potential responses.
 
 ##### Contents
 
+*   [Apply Template](#apply-template)
 *   [Archive Data](#archive-data)
 *   [Backfill Archive Data](#backfill-archive-data)
 *   [Clone](#clone)
@@ -14,6 +15,7 @@ parameters and the potential responses.
 *   [Full Data Tables Archive](#full-data-tables-archive)
 *   [Full Events Archive](#full-events-archive)
 *   [Get](#get)
+*   [Import](#import)
 *   [Mqtt Publish Message](#mqtt-publish-message)
 *   [Patch](#patch)
 *   [Payload Counts](#payload-counts)
@@ -23,6 +25,47 @@ parameters and the potential responses.
 
 <br/>
 
+## Apply Template
+
+Add resources to an application via an application template
+
+```ruby
+result = client.application.apply_template(
+  applicationId: my_application_id,
+  options: my_options)
+
+puts result
+```
+
+#### Authentication
+The client must be configured with a valid api access token to call this
+action. The token must include at least one of the following scopes:
+all.Application, all.Organization, all.User, application.*, or application.applyTemplate.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID of the associated application |  | 575ec8687ae143cd83dc4a97 |
+| options | [Application Apply Template Patch Schema](_schemas.md#application-apply-template-patch-schema) | Y | Object containing template import options |  | [Application Apply Template Patch Schema Example](_schemas.md#application-apply-template-patch-schema-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Application](_schemas.md#application) | Updated application information |
+| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If a job was enqueued for the resources to be imported into the application |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if application is not found |
+
+<br/>
+
 ## Archive Data
 
 Returns success when a job has been enqueued to archive this application&#x27;s device data for a given day
@@ -332,6 +375,48 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 
 <br/>
 
+## Import
+
+Add multiple resources to an application via a zip file
+
+```ruby
+result = client.application.import(
+  applicationId: my_application_id,
+  importBundle: my_import_bundle)
+
+puts result
+```
+
+#### Authentication
+The client must be configured with a valid api access token to call this
+action. The token must include at least one of the following scopes:
+all.Application, all.Organization, all.User, application.*, or application.import.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID of the associated application |  | 575ec8687ae143cd83dc4a97 |
+| importBundle | file | Y | The zip file containing all of the resources to import into the application |  | undefined |
+| email | string | N | Email address to notify the user when the job to import the application resources has completed or errored, defaults to the email address of the user making the request |  | email@example.com |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Application](_schemas.md#application) | Updated application information |
+| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If a job was enqueued for the resources to be imported into the application |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if application is not found |
+
+<br/>
+
 ## Mqtt Publish Message
 
 Publishes the given message to the given MQTT topic

data/docs/applicationApiTokens.md

@@ -31,7 +31,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
-| sortField | string | N | Field to sort the results by. Accepted values are: name, status, id, creationDate, lastUpdated | name | name |
+| sortField | string | N | Field to sort the results by. Accepted values are: name, status, id, creationDate, lastUpdated, expirationDate | name | name |
 | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
 | page | string | N | Which page of results to return | 0 | 0 |
 | perPage | string | N | How many items to return per page | 1000 | 10 |

data/docs/applicationTemplate.md

@@ -0,0 +1,46 @@
+# Application Template Actions
+
+Details on the various actions that can be performed on the
+Application Template resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Get](#get)
+
+<br/>
+
+## Get
+
+Retrieves information on an application template
+
+```ruby
+result = client.application_template.get(templateId: my_template_id)
+
+puts result
+```
+
+#### Authentication
+The client must be configured with a valid api access token to call this
+action. The token must include at least one of the following scopes:
+all.User, all.User.read, applicationTemplate.*, or applicationTemplate.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| templateId | string | Y | ID associated with the template |  | 575ed0de7ae143cd83dc4aa5 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Application Template](_schemas.md#application-template) | Application template information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if template was not found |

data/docs/applicationTemplates.md

@@ -7,6 +7,8 @@ parameters and the potential responses.
 ##### Contents
 
 *   [Get](#get)
+*   [Get Categories](#get-categories)
+*   [Get Unique Keywords](#get-unique-keywords)
 
 <br/>
 
@@ -33,8 +35,10 @@ all.User, all.User.read, applicationTemplates.*, or applicationTemplates.get.
 | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
 | page | string | N | Which page of results to return | 0 | 0 |
 | perPage | string | N | How many items to return per page | 1000 | 10 |
-| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name |  | name |
+| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name, authorName |  | name |
 | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. |  | my * app |
+| keywords | array | N | List of keywords to filter by. Matches all provided keywords. |  | [ &#x27;gps&#x27;, &#x27;aws&#x27; ] |
+| categoryId | string | N | ID of a category to filter by. |  | 575ec76c7ae143cd83dc4a96 |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses
@@ -48,3 +52,74 @@ all.User, all.User.read, applicationTemplates.*, or applicationTemplates.get.
 | Code | Type | Description |
 | ---- | ---- | ----------- |
 | 400 | [Error](_schemas.md#error) | Error if malformed request |
+
+<br/>
+
+## Get Categories
+
+Returns a category list, beginning at the specified category
+
+```ruby
+result = client.application_templates.get_categories(optional_params)
+
+puts result
+```
+
+#### Authentication
+The client must be configured with a valid api access token to call this
+action. The token must include at least one of the following scopes:
+all.User, all.User.read, applicationTemplates.*, or applicationTemplates.getCategories.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| baseId | string | N | ID of the category to begin from |  | 575ed6e87ae143cd83dc4aa8 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Application Template Categories](_schemas.md#application-template-categories) | Collection of application categories |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+
+<br/>
+
+## Get Unique Keywords
+
+Returns an array of all unique keywords currently in use by templates
+
+```ruby
+result = client.application_templates.get_unique_keywords(optional_params)
+
+puts result
+```
+
+#### Authentication
+The client must be configured with a valid api access token to call this
+action. The token must include at least one of the following scopes:
+all.User, all.User.read, applicationTemplates.*, or applicationTemplates.getUniqueKeywords.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Template Keywords](_schemas.md#template-keywords) | Array of all unique template keywords |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |

data/docs/device.md

@@ -88,6 +88,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 | end | string | N | End time of export (ms since epoch - 0 means now, negative is relative to now) | 0 | 1465790400000 |
 | email | string | N | Email address to send export to. Defaults to current user's email. |  | email@example.com |
 | callbackUrl | string | N | Callback URL to call with export result |  | https://example.com/cburl |
+| includeBlobData | string | N | If set will export any blob attributes in base64 form, otherwise they will be downloadable links which will expire. |  | true |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses
@@ -169,8 +170,9 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
 | deviceId | string | Y | ID associated with the device |  | 575ecf887ae143cd83dc4aa2 |
-| limit | string | N | Max command entries to return (ordered by time descending) | 1 | 10 |
+| limit | string | N | Maximum number of command entries to return | 1 | 10 |
 | since | string | N | Look for command entries since this time (ms since epoch) |  | 1465790400000 |
+| sortDirection | string | N | Direction to sort the command entries (by time). Accepted values are: asc, desc | desc | desc |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses
@@ -254,8 +256,9 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
 | deviceId | string | Y | ID associated with the device |  | 575ecf887ae143cd83dc4aa2 |
-| limit | string | N | Max log entries to return (ordered by time descending) | 1 | 10 |
+| limit | string | N | Maximum number of log entries to return | 1 | 10 |
 | since | string | N | Look for log entries since this time (ms since epoch) |  | 1465790400000 |
+| sortDirection | string | N | Direction to sort the log entries (by time). Accepted values are: asc, desc | desc | desc |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses
@@ -296,8 +299,9 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
 | deviceId | string | Y | ID associated with the device |  | 575ecf887ae143cd83dc4aa2 |
-| limit | string | N | Max state entries to return (ordered by time descending) | 1 | 10 |
+| limit | string | N | Maximum number of state entries to return | 1 | 10 |
 | since | string | N | Look for state entries since this time (ms since epoch) |  | 1465790400000 |
+| sortDirection | string | N | Direction to sort the state entries (by time). Accepted values are: asc, desc | desc | desc |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/docs/devices.md

@@ -6,14 +6,57 @@ parameters and the potential responses.
 
 ##### Contents
 
+*   [Delete](#delete)
 *   [Export](#export)
 *   [Get](#get)
 *   [Patch](#patch)
 *   [Post](#post)
+*   [Remove Data](#remove-data)
 *   [Send Command](#send-command)
 
 <br/>
 
+## Delete
+
+Delete devices
+
+```ruby
+result = client.devices.delete(
+  applicationId: my_application_id,
+  options: my_options)
+
+puts result
+```
+
+#### Authentication
+The client must be configured with a valid api access token to call this
+action. The token must include at least one of the following scopes:
+all.Application, all.Organization, all.User, devices.*, or devices.delete.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| options | [Devices Delete Post](_schemas.md#devices-delete-post) | Y | Object containing device query and email |  | [Devices Delete Post Example](_schemas.md#devices-delete-post-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Devices Deleted](_schemas.md#devices-deleted) | Object indicating number of devices deleted or failed |
+| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If a job was enqueued for the devices to be deleted |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if application was not found |
+
+<br/>
+
 ## Export
 
 Creates an export of all device metadata
@@ -36,6 +79,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
 | email | string | N | Email address to send export to. Defaults to current user&#x27;s email. |  | email@example.com |
 | callbackUrl | string | N | Callback URL to call with export result |  | https://example.com/cburl |
+| options | [Devices Metadata Export Post](_schemas.md#devices-metadata-export-post) | N | Object containing device query and optionally email or callback |  | [Devices Metadata Export Post Example](_schemas.md#devices-metadata-export-post-example) |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses
@@ -83,7 +127,7 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
 | tagFilter | [Device Tag Filter](_schemas.md#device-tag-filter) | N | Array of tag pairs to filter by |  | [Device Tag Filter Example](_schemas.md#device-tag-filter-example) |
 | excludeConnectionInfo | string | N | If set, do not return connection info |  | true |
 | parentId | string | N | Filter devices as children of a given system id |  | 575ecf887ae143cd83dc4aa2 |
-| query | [Advanced Device Query](_schemas.md#advanced-device-query) | N | Device filter JSON object which overides the filterField, filter, deviceClass, tagFilter, and parentId parameters. |  | [Advanced Device Query Example](_schemas.md#advanced-device-query-example) |
+| query | [Advanced Device Query](_schemas.md#advanced-device-query) | N | Device filter JSON object which overrides the filterField, filter, deviceClass, tagFilter, and parentId parameters. |  | [Advanced Device Query Example](_schemas.md#advanced-device-query-example) |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses
@@ -106,7 +150,9 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
 Update the fields of one or more devices
 
 ```ruby
-result = client.devices.patch(applicationId: my_application_id)
+result = client.devices.patch(
+  applicationId: my_application_id,
+  patchInfo: my_patch_info)
 
 puts result
 ```
@@ -121,14 +167,15 @@ all.Application, all.Organization, all.User, devices.*, or devices.patch.
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
-| patchInfo | [Devices Patch](_schemas.md#devices-patch) | N | Object containing device filter fields and updated properties |  | [Devices Patch Example](_schemas.md#devices-patch-example) |
+| patchInfo | [Devices Patch](_schemas.md#devices-patch) | Y | Object containing device query or IDs and update operations |  | [Devices Patch Example](_schemas.md#devices-patch-example) |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 201 | [Success](_schemas.md#success) | Successfully queued bulk update job |
+| 200 | [Devices Updated](_schemas.md#devices-updated) | Object including an update log link and the number of devices updated, failed, and skipped |
+| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | Successfully queued bulk update job |
 
 #### Error Responses
 
@@ -179,6 +226,47 @@ all.Application, all.Organization, all.User, devices.*, or devices.post.
 
 <br/>
 
+## Remove Data
+
+Removes all device data for the specified time range. Defaults to all data.
+
+```ruby
+result = client.devices.remove_data(
+  applicationId: my_application_id,
+  options: my_options)
+
+puts result
+```
+
+#### Authentication
+The client must be configured with a valid api access token to call this
+action. The token must include at least one of the following scopes:
+all.Application, all.Organization, all.User, devices.*, or devices.removeData.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| options | [Devices Remove Data Post](_schemas.md#devices-remove-data-post) | Y | Object defining the device data to delete and devices to delete from |  | [Devices Remove Data Post Example](_schemas.md#devices-remove-data-post-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Devices Data Removed](_schemas.md#devices-data-removed) | Object indicating number of devices completed or skipped |
+| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If a job was enqueued for device data to be removed |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if application was not found |
+
+<br/>
+
 ## Send Command
 
 Send a command to multiple devices