losant_rest 1.3.3 → 1.4.0

data/docs/dataTableRows.md

@@ -6,12 +6,53 @@ parameters and the potential responses.
 
 ##### Contents
 
+*   [Export](#export)
 *   [Get](#get)
 *   [Post](#post)
 *   [Query](#query)
 
 <br/>
 
+## Export
+
+Request an export of the data table&#x27;s data
+
+```ruby
+result = client.data_table_rows.export(
+  applicationId: my_application_id,
+  dataTableId: my_data_table_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.Application, all.Organization, all.User, dataTableRows.*, or dataTableRows.export.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| dataTableId | string | Y | ID associated with the data table |  | 575ed78e7ae143cd83dc4aab |
+| exportData | [Data Table Export](_schemas.md#data-table-export) | N | Object containing export specifications |  | [Data Table Export Example](_schemas.md#data-table-export-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If request was successfully queued |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if data table was not found |
+
+<br/>
+
 ## Get
 
 Returns the rows for a data table

data/docs/deviceRecipe.md

@@ -44,6 +44,7 @@ all.Application, all.Organization, all.User, deviceRecipe.*, or deviceRecipe.bul
 | Code | Type | Description |
 | ---- | ---- | ----------- |
 | 201 | [Device Recipe Bulk Create](_schemas.md#device-recipe-bulk-create) | If devices were successfully created |
+| 202 | [Device Recipe Bulk Create Enqueue](_schemas.md#device-recipe-bulk-create-enqueue) | If devices were enqueued to be created |
 
 #### Error Responses
 

data/docs/{experienceTemplate.md → experienceDomain.md}

@@ -1,7 +1,7 @@
-# Experience Template Actions
+# Experience Domain Actions
 
 Details on the various actions that can be performed on the
-Experience Template resource, including the expected
+Experience Domain resource, including the expected
 parameters and the potential responses.
 
 ##### Contents
@@ -14,12 +14,12 @@ parameters and the potential responses.
 
 ## Delete
 
-Deletes an experience template
+Deletes an experience domain
 
 ```ruby
-result = client.experience_template.delete(
+result = client.experience_domain.delete(
   applicationId: my_application_id,
-  experienceTemplateId: my_experience_template_id)
+  experienceDomainId: my_experience_domain_id)
 
 puts result
 ```
@@ -27,38 +27,38 @@ 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, experienceTemplate.*, or experienceTemplate.delete.
+all.Application, all.Organization, all.User, experienceDomain.*, or experienceDomain.delete.
 
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
-| experienceTemplateId | string | Y | ID associated with the experience template |  | 575ed78e7ae143cd83dc4aab |
+| experienceDomainId | string | Y | ID associated with the experience domain |  | 575ed78e7ae143cd83dc4aab |
 
 #### Successful Responses
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Success](_schemas.md#success) | If experience template was successfully deleted |
+| 200 | [Success](_schemas.md#success) | If experience domain was successfully deleted |
 
 #### Error Responses
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
 | 400 | [Error](_schemas.md#error) | Error if malformed request |
-| 404 | [Error](_schemas.md#error) | Error if experience template was not found |
+| 404 | [Error](_schemas.md#error) | Error if experience domain was not found |
 
 <br/>
 
 ## Get
 
-Retrieves information on an experience template
+Retrieves information on an experience domain
 
 ```ruby
-result = client.experience_template.get(
+result = client.experience_domain.get(
   applicationId: my_application_id,
-  experienceTemplateId: my_experience_template_id)
+  experienceDomainId: my_experience_domain_id)
 
 puts result
 ```
@@ -66,39 +66,39 @@ 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.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceTemplate.*, or experienceTemplate.get.
+all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceDomain.*, or experienceDomain.get.
 
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
-| experienceTemplateId | string | Y | ID associated with the experience template |  | 575ed78e7ae143cd83dc4aab |
+| experienceDomainId | string | Y | ID associated with the experience domain |  | 575ed78e7ae143cd83dc4aab |
 
 #### Successful Responses
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Experience Template](_schemas.md#experience-template) | Experience template information |
+| 200 | [Experience Domain](_schemas.md#experience-domain) | Experience domain information |
 
 #### Error Responses
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
 | 400 | [Error](_schemas.md#error) | Error if malformed request |
-| 404 | [Error](_schemas.md#error) | Error if experience template was not found |
+| 404 | [Error](_schemas.md#error) | Error if experience domain was not found |
 
 <br/>
 
 ## Patch
 
-Updates information about an experience template
+Updates information about an experience domain
 
 ```ruby
-result = client.experience_template.patch(
+result = client.experience_domain.patch(
   applicationId: my_application_id,
-  experienceTemplateId: my_experience_template_id,
-  experienceTemplate: my_experience_template)
+  experienceDomainId: my_experience_domain_id,
+  experienceDomain: my_experience_domain)
 
 puts result
 ```
@@ -106,25 +106,25 @@ 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, experienceTemplate.*, or experienceTemplate.patch.
+all.Application, all.Organization, all.User, experienceDomain.*, or experienceDomain.patch.
 
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
-| experienceTemplateId | string | Y | ID associated with the experience template |  | 575ed78e7ae143cd83dc4aab |
-| experienceTemplate | [Experience Template Patch](_schemas.md#experience-template-patch) | Y | Object containing new properties of the experience template |  | [Experience Template Patch Example](_schemas.md#experience-template-patch-example) |
+| experienceDomainId | string | Y | ID associated with the experience domain |  | 575ed78e7ae143cd83dc4aab |
+| experienceDomain | [Experience Domain Patch](_schemas.md#experience-domain-patch) | Y | Object containing new properties of the experience domain |  | [Experience Domain Patch Example](_schemas.md#experience-domain-patch-example) |
 
 #### Successful Responses
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Experience Template](_schemas.md#experience-template) | Updated experience template information |
+| 200 | [Experience Domain](_schemas.md#experience-domain) | Updated experience domain information |
 
 #### Error Responses
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
 | 400 | [Error](_schemas.md#error) | Error if malformed request |
-| 404 | [Error](_schemas.md#error) | Error if experience template was not found |
+| 404 | [Error](_schemas.md#error) | Error if experience domain was not found |

data/docs/experienceDomains.md

@@ -0,0 +1,85 @@
+# Experience Domains Actions
+
+Details on the various actions that can be performed on the
+Experience Domains resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Get](#get)
+*   [Post](#post)
+
+<br/>
+
+## Get
+
+Returns the experience domains for an application
+
+```ruby
+result = client.experience_domains.get(applicationId: my_application_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.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceDomains.*, or experienceDomains.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Experience Domains](_schemas.md#experience-domains) | Collection of experience domains |
+
+#### 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/>
+
+## Post
+
+Create a new experience domain for an application
+
+```ruby
+result = client.experience_domains.post(
+  applicationId: my_application_id,
+  experienceDomain: my_experience_domain)
+
+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, experienceDomains.*, or experienceDomains.post.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| experienceDomain | [Experience Domain Post](_schemas.md#experience-domain-post) | Y | New experience domain information |  | [Experience Domain Post Example](_schemas.md#experience-domain-post-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 201 | [Experience Domain](_schemas.md#experience-domain) | Successfully created experience domain |
+
+#### 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 |

data/docs/experienceView.md

@@ -0,0 +1,130 @@
+# Experience View Actions
+
+Details on the various actions that can be performed on the
+Experience View resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Delete](#delete)
+*   [Get](#get)
+*   [Patch](#patch)
+
+<br/>
+
+## Delete
+
+Deletes an experience view
+
+```ruby
+result = client.experience_view.delete(
+  applicationId: my_application_id,
+  experienceViewId: my_experience_view_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.Application, all.Organization, all.User, experienceView.*, or experienceView.delete.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| experienceViewId | string | Y | ID associated with the experience view |  | 575ed78e7ae143cd83dc4aab |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If experience view was successfully deleted |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if experience view was not found |
+
+<br/>
+
+## Get
+
+Retrieves information on an experience view
+
+```ruby
+result = client.experience_view.get(
+  applicationId: my_application_id,
+  experienceViewId: my_experience_view_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.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceView.*, or experienceView.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| experienceViewId | string | Y | ID associated with the experience view |  | 575ed78e7ae143cd83dc4aab |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Experience View](_schemas.md#experience-view) | Experience view information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if experience view was not found |
+
+<br/>
+
+## Patch
+
+Updates information about an experience view
+
+```ruby
+result = client.experience_view.patch(
+  applicationId: my_application_id,
+  experienceViewId: my_experience_view_id,
+  experienceView: my_experience_view)
+
+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, experienceView.*, or experienceView.patch.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| experienceViewId | string | Y | ID associated with the experience view |  | 575ed78e7ae143cd83dc4aab |
+| experienceView | [Experience View Patch](_schemas.md#experience-view-patch) | Y | Object containing new properties of the experience view |  | [Experience View Patch Example](_schemas.md#experience-view-patch-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Experience View](_schemas.md#experience-view) | Updated experience view information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if experience view was not found |

data/docs/{experienceTemplates.md → experienceViews.md}

@@ -1,7 +1,7 @@
-# Experience Templates Actions
+# Experience Views Actions
 
 Details on the various actions that can be performed on the
-Experience Templates resource, including the expected
+Experience Views resource, including the expected
 parameters and the potential responses.
 
 ##### Contents
@@ -13,10 +13,10 @@ parameters and the potential responses.
 
 ## Get
 
-Returns the experience templates for an application
+Returns the experience views for an application
 
 ```ruby
-result = client.experience_templates.get(applicationId: my_application_id)
+result = client.experience_views.get(applicationId: my_application_id)
 
 puts result
 ```
@@ -24,26 +24,26 @@ 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.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceTemplates.*, or experienceTemplates.get.
+all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceViews.*, or experienceViews.get.
 
 #### Available Parameters
 
 | 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: id, creationDate, name | name | name |
+| sortField | string | N | Field to sort the results by. Accepted values are: id, creationDate, name, lastUpdated | 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 |
 | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name |  | name |
-| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. |  | my*template |
-| templateType | string | N | Filter templates to those only of the given type. Accepted values are: page, layout, component |  | page |
+| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. |  | my*view |
+| viewType | string | N | Filter views to those only of the given type. Accepted values are: page, layout, component |  | page |
 
 #### Successful Responses
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Experience Templates](_schemas.md#experience-templates) | Collection of experience templates |
+| 200 | [Experience Views](_schemas.md#experience-views) | Collection of experience views |
 
 #### Error Responses
 
@@ -56,12 +56,12 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 
 ## Post
 
-Create a new experience template for an application
+Create a new experience view for an application
 
 ```ruby
-result = client.experience_templates.post(
+result = client.experience_views.post(
   applicationId: my_application_id,
-  experienceTemplate: my_experience_template)
+  experienceView: my_experience_view)
 
 puts result
 ```
@@ -69,20 +69,20 @@ 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, experienceTemplates.*, or experienceTemplates.post.
+all.Application, all.Organization, all.User, experienceViews.*, or experienceViews.post.
 
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
-| experienceTemplate | [Experience Template Post](_schemas.md#experience-template-post) | Y | New experience template information |  | [Experience Template Post Example](_schemas.md#experience-template-post-example) |
+| experienceView | [Experience View Post](_schemas.md#experience-view-post) | Y | New experience view information |  | [Experience View Post Example](_schemas.md#experience-view-post-example) |
 
 #### Successful Responses
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 201 | [Experience Template](_schemas.md#experience-template) | Successfully created experience template |
+| 201 | [Experience View](_schemas.md#experience-view) | Successfully created experience view |
 
 #### Error Responses