losant_rest 1.8.7 → 1.8.9

data/docs/application.md

@@ -9,6 +9,8 @@ parameters and the potential responses.
 *   [Archive Data](#archive-data)
 *   [Backfill Archive Data](#backfill-archive-data)
 *   [Delete](#delete)
+*   [Full Data Tables Archive](#full-data-tables-archive)
+*   [Full Events Archive](#full-events-archive)
 *   [Get](#get)
 *   [Mqtt Publish Message](#mqtt-publish-message)
 *   [Patch](#patch)
@@ -131,6 +133,80 @@ all.Application, all.Organization, all.User, application.*, or application.delet
 
 <br/>
 
+## Full Data Tables Archive
+
+Returns success when a job has been enqueued to archive all selected data tables
+
+```ruby
+result = client.application.full_data_tables_archive(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.Organization, all.User, application.*, or application.fullDataTablesArchive.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID of the associated application |  | 575ec8687ae143cd83dc4a97 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | Enqueued a job to archive all selected data tables of this application archive location |
+
+#### 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/>
+
+## Full Events Archive
+
+Returns success when a job has been enqueued to archive all current events
+
+```ruby
+result = client.application.full_events_archive(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.Organization, all.User, application.*, or application.fullEventsArchive.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID of the associated application |  | 575ec8687ae143cd83dc4a97 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | Enqueued a job to archive all events to this application archive location |
+
+#### 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/>
+
 ## Get
 
 Retrieves information on an application

data/docs/auth.md

@@ -7,7 +7,6 @@ parameters and the potential responses.
 ##### Contents
 
 *   [Authenticate Device](#authenticate-device)
-*   [Authenticate Solution User](#authenticate-solution-user)
 *   [Authenticate User](#authenticate-user)
 *   [Authenticate User Github](#authenticate-user-github)
 
@@ -48,41 +47,6 @@ No api access token is required to call this action.
 
 <br/>
 
-## Authenticate Solution User
-
-Authenticates a solution user using the provided credentials.
-
-```ruby
-result = client.auth.authenticate_solution_user(credentials: my_credentials)
-
-puts result
-```
-
-#### Authentication
-No api access token is required to call this action.
-
-#### Available Parameters
-
-| Name | Type | Required | Description | Default | Example |
-| ---- | ---- | -------- | ----------- | ------- | ------- |
-| credentials | [Solution User Credentials](_schemas.md#solution-user-credentials) | Y | Solution user authentication credentials. The included api access token has the scope &#x27;all.SolutionUser&#x27;. |  | [Solution User Credentials Example](_schemas.md#solution-user-credentials-example) |
-| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
-
-#### Successful Responses
-
-| Code | Type | Description |
-| ---- | ---- | ----------- |
-| 200 | [Authenticated Solution User](_schemas.md#authenticated-solution-user) | Successful authentication |
-
-#### Error Responses
-
-| Code | Type | Description |
-| ---- | ---- | ----------- |
-| 400 | [Error](_schemas.md#error) | Error if malformed request |
-| 401 | [Error](_schemas.md#error) | Unauthorized error if authentication fails |
-
-<br/>
-
 ## Authenticate User
 
 Authenticates a user using the provided credentials.

data/docs/dashboards.md

@@ -24,7 +24,7 @@ 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.Organization, all.Organization.read, all.SolutionUser, all.SolutionUser.read, all.User, all.User.read, dashboards.*, or dashboards.get.
+all.Organization, all.Organization.read, all.User, all.User.read, dashboards.*, or dashboards.get.
 
 #### Available Parameters
 

data/docs/dataTableRows.md

@@ -38,7 +38,7 @@ all.Application, all.Organization, all.User, dataTableRows.*, or dataTableRows.d
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
 | dataTableId | string | Y | ID associated with the data table |  | 575ed78e7ae143cd83dc4aab |
-| query | [Data Table Query](_schemas.md#data-table-query) | N | Query to apply to filter the data table |  | [Data Table Query Example](_schemas.md#data-table-query-example) |
+| query | [Advanced Query](_schemas.md#advanced-query) | N | Query to apply to filter the data table |  | [Advanced Query Example](_schemas.md#advanced-query-example) |
 | limit | string | N | Limit number of rows to delete from data table | 1000 | 10 |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
@@ -214,7 +214,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 | limit | string | N | How many rows to return | 1000 | 0 |
 | offset | string | N | How many rows to skip | 0 | 0 |
 | includeFields | string | N | Comma-separated list of fields to include in resulting rows. When not provided, returns all fields. |  | id,createdAt |
-| query | [Data Table Query](_schemas.md#data-table-query) | N | Query to apply to filter the data table |  | [Data Table Query Example](_schemas.md#data-table-query-example) |
+| query | [Advanced Query](_schemas.md#advanced-query) | N | Query to apply to filter the data table |  | [Advanced Query Example](_schemas.md#advanced-query-example) |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/docs/device.md

@@ -213,6 +213,7 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
 | deviceId | string | Y | ID associated with the device |  | 575ecf887ae143cd83dc4aa2 |
 | start | string | N | Start of time range to look at to build composite state | 1 | 1465790400000 |
 | end | string | N | End of time range to look at to build composite state | 0 | 1465790400000 |
+| attributes | string | N | Comma-separated list of attributes to include. When not provided, returns all attributes. |  | myAttr1,myAttr2 |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/docs/events.md

@@ -6,6 +6,8 @@ parameters and the potential responses.
 
 ##### Contents
 
+*   [Delete](#delete)
+*   [Export](#export)
 *   [Get](#get)
 *   [Most Recent by Severity](#most-recent-by-severity)
 *   [Patch](#patch)
@@ -13,6 +15,82 @@ parameters and the potential responses.
 
 <br/>
 
+## Delete
+
+Delete events
+
+```ruby
+result = client.events.delete(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, events.*, or events.delete.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| query | [Advanced Event Query](_schemas.md#advanced-event-query) | N | Query to apply to filter the events |  | [Advanced Event Query Example](_schemas.md#advanced-event-query-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Events Deleted](_schemas.md#events-deleted) | If request successfully deletes a set of Events |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if events were not found |
+
+<br/>
+
+## Export
+
+Request an export of an application&#x27;s event data
+
+```ruby
+result = client.events.export(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, events.*, or events.export.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| exportData | [Event Export Options](_schemas.md#event-export-options) | N | Export options for events |  | [Event Export Options Example](_schemas.md#event-export-options-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If generation of export was successfully started |
+
+#### 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/>
+
 ## Get
 
 Returns the events for an application
@@ -40,6 +118,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: subject |  | subject |
 | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. |  | abnormal power to * |
 | state | string | N | If provided, return events only in the given state. Accepted values are: new, acknowledged, resolved |  | new |
+| query | [Advanced Event Query](_schemas.md#advanced-event-query) | N | Event filter JSON object which overides the filterField, filter, and state parameters. |  | [Advanced Event Query Example](_schemas.md#advanced-event-query-example) |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses
@@ -78,6 +157,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
 | filter | string | N | Filter to apply against event subjects. Supports globbing. Blank or not provided means no filtering. |  | abnormal power to * |
+| query | [Advanced Event Query](_schemas.md#advanced-event-query) | N | Event filter JSON object which overides the filter parameter. |  | [Advanced Event Query Example](_schemas.md#advanced-event-query-example) |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses
@@ -119,6 +199,7 @@ all.Application, all.Organization, all.User, events.*, or events.patch.
 | filterField | string | N | Field to filter the events to act on by. Blank or not provided means no filtering. Accepted values are: subject |  | subject |
 | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. |  | abnormal power to * |
 | state | string | N | If provided, act on events only in the given state. Accepted values are: new, acknowledged, resolved |  | new |
+| query | [Advanced Event Query](_schemas.md#advanced-event-query) | N | Event filter JSON object which overides the filterField, filter, and state parameters. |  | [Advanced Event Query Example](_schemas.md#advanced-event-query-example) |
 | updates | [Event Patch](_schemas.md#event-patch) | Y | Object containing updated information for the events |  | [Event Patch Example](_schemas.md#event-patch-example) |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 

data/docs/file.md

@@ -10,6 +10,7 @@ parameters and the potential responses.
 *   [Get](#get)
 *   [Move](#move)
 *   [Patch](#patch)
+*   [Upload](#upload)
 
 <br/>
 
@@ -174,3 +175,45 @@ all.Application, all.Organization, all.User, file.*, or file.patch.
 | ---- | ---- | ----------- |
 | 400 | [Error](_schemas.md#error) | Error if malformed request |
 | 404 | [Error](_schemas.md#error) | Error if application was not found |
+
+<br/>
+
+## Upload
+
+Uploads the file
+
+```ruby
+result = client.file.upload(
+  applicationId: my_application_id,
+  fileId: my_file_id,
+  file: my_file)
+
+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, file.*, or file.upload.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| fileId | string | Y | ID associated with the file |  | 575ec76c7ae143cd83dc4a96 |
+| file | file | Y | The content of the file to upload |  | undefined |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [File Schema](_schemas.md#file-schema) | Updated file content |
+
+#### 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/me.md

@@ -17,6 +17,7 @@ parameters and the potential responses.
 *   [Get](#get)
 *   [Patch](#patch)
 *   [Payload Counts](#payload-counts)
+*   [Refresh Token](#refresh-token)
 *   [Transfer Resources](#transfer-resources)
 *   [Verify Email](#verify-email)
 
@@ -35,7 +36,7 @@ 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.SolutionUser, all.User, me.*, or me.addRecentItem.
+all.User, me.*, or me.addRecentItem.
 
 #### Available Parameters
 
@@ -71,7 +72,7 @@ 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.SolutionUser, all.User, me.*, or me.changePassword.
+all.User, me.*, or me.changePassword.
 
 #### Available Parameters
 
@@ -107,7 +108,7 @@ 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.SolutionUser, all.User, me.*, or me.delete.
+all.User, me.*, or me.delete.
 
 #### Available Parameters
 
@@ -143,7 +144,7 @@ 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.SolutionUser, all.User, me.*, or me.disableTwoFactorAuth.
+all.User, me.*, or me.disableTwoFactorAuth.
 
 #### Available Parameters
 
@@ -179,7 +180,7 @@ 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.SolutionUser, all.User, me.*, or me.disconnectGithub.
+all.User, me.*, or me.disconnectGithub.
 
 #### Available Parameters
 
@@ -214,7 +215,7 @@ 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.SolutionUser, all.User, me.*, or me.disconnectTwitter.
+all.User, me.*, or me.disconnectTwitter.
 
 #### Available Parameters
 
@@ -249,7 +250,7 @@ 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.SolutionUser, all.User, me.*, or me.enableTwoFactorAuth.
+all.User, me.*, or me.enableTwoFactorAuth.
 
 #### Available Parameters
 
@@ -285,7 +286,7 @@ 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.SolutionUser, all.SolutionUser.read, all.User, all.User.read, me.*, or me.fetchRecentItems.
+all.User, all.User.read, me.*, or me.fetchRecentItems.
 
 #### Available Parameters
 
@@ -322,7 +323,7 @@ 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.SolutionUser, all.SolutionUser.read, all.User, all.User.read, me.*, or me.get.
+all.User, all.User.read, me.*, or me.get.
 
 #### Available Parameters
 
@@ -359,7 +360,7 @@ 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.SolutionUser, all.User, me.*, or me.patch.
+all.User, me.*, or me.patch.
 
 #### Available Parameters
 
@@ -397,7 +398,7 @@ 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.SolutionUser, all.User, all.User.read, me.*, or me.payloadCounts.
+all.User, all.User.read, me.*, or me.payloadCounts.
 
 #### Available Parameters
 
@@ -421,6 +422,42 @@ all.SolutionUser, all.User, all.User.read, me.*, or me.payloadCounts.
 
 <br/>
 
+## Refresh Token
+
+Returns a new auth token based on the current auth token
+
+```ruby
+result = client.me.refresh_token(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, or me.*.
+
+#### 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 | [Authenticated User](_schemas.md#authenticated-user) | Successful token regeneration |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 401 | [Error](_schemas.md#error) | Unauthorized error if authentication fails |
+
+<br/>
+
 ## Transfer Resources
 
 Moves resources to a new owner
@@ -434,7 +471,7 @@ 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.SolutionUser, all.User, me.*, or me.transferResources.
+all.User, me.*, or me.transferResources.
 
 #### Available Parameters
 
@@ -470,7 +507,7 @@ 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.SolutionUser, all.User, me.*, or me.verifyEmail.
+all.User, me.*, or me.verifyEmail.
 
 #### Available Parameters