losant_rest 1.2.3 → 1.3.0

data/docs/dataTable.md

@@ -0,0 +1,214 @@
+# Data Table Actions
+
+Details on the various actions that can be performed on the
+Data Table resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Add Column](#add-column)
+*   [Delete](#delete)
+*   [Get](#get)
+*   [Patch](#patch)
+*   [Remove Column](#remove-column)
+
+<br/>
+
+## Add Column
+
+Adds a new column to this data table
+
+```ruby
+result = client.data_table.add_column(
+  applicationId: my_application_id,
+  dataTableId: my_data_table_id,
+  dataTableColumn: my_data_table_column)
+
+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, dataTable.*, or dataTable.addColumn.
+
+#### 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 |
+| dataTableColumn | [Data Table Column](_schemas.md#data-table-column) | Y | Object containing the new column properties |  | [Data Table Column Example](_schemas.md#data-table-column-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Data Table](_schemas.md#data-table) | Updated data table information |
+
+#### 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/>
+
+## Delete
+
+Deletes a data table
+
+```ruby
+result = client.data_table.delete(
+  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, dataTable.*, or dataTable.delete.
+
+#### 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 |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If data table was successfully deleted |
+
+#### 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
+
+Retrieves information on a data table
+
+```ruby
+result = client.data_table.get(
+  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.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, dataTable.*, or dataTable.get.
+
+#### 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 |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Data Table](_schemas.md#data-table) | Data table information |
+
+#### 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/>
+
+## Patch
+
+Updates information about a data table
+
+```ruby
+result = client.data_table.patch(
+  applicationId: my_application_id,
+  dataTableId: my_data_table_id,
+  dataTable: my_data_table)
+
+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, dataTable.*, or dataTable.patch.
+
+#### 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 |
+| dataTable | [Data Table Patch](_schemas.md#data-table-patch) | Y | Object containing updated properties of the data table |  | [Data Table Patch Example](_schemas.md#data-table-patch-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Data Table](_schemas.md#data-table) | Updated data table information |
+
+#### 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/>
+
+## Remove Column
+
+Removes a column from this data table
+
+```ruby
+result = client.data_table.remove_column(
+  applicationId: my_application_id,
+  dataTableId: my_data_table_id,
+  columnName: my_column_name)
+
+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, dataTable.*, or dataTable.removeColumn.
+
+#### 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 |
+| columnName | string | Y | Name of the column to remove |  | myColumnName |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Data Table](_schemas.md#data-table) | Updated data table information |
+
+#### 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 |

data/docs/dataTableRow.md

@@ -0,0 +1,136 @@
+# Data Table Row Actions
+
+Details on the various actions that can be performed on the
+Data Table Row resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Delete](#delete)
+*   [Get](#get)
+*   [Patch](#patch)
+
+<br/>
+
+## Delete
+
+Deletes a data table row
+
+```ruby
+result = client.data_table_row.delete(
+  applicationId: my_application_id,
+  dataTableId: my_data_table_id,
+  rowId: my_row_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, dataTableRow.*, or dataTableRow.delete.
+
+#### 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 |
+| rowId | string | Y | ID associated with the data table row |  | 596f832b128eda5cfe765443 |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If data table row was successfully deleted |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if data table row was not found |
+
+<br/>
+
+## Get
+
+Retrieves the data table row
+
+```ruby
+result = client.data_table_row.get(
+  applicationId: my_application_id,
+  dataTableId: my_data_table_id,
+  rowId: my_row_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, dataTableRow.*, or dataTableRow.get.
+
+#### 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 |
+| rowId | string | Y | ID associated with the data table row |  | 596f832b128eda5cfe765443 |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Data Table Row](_schemas.md#data-table-row) | Data table row information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if data table row was not found |
+
+<br/>
+
+## Patch
+
+Updates the data table row
+
+```ruby
+result = client.data_table_row.patch(
+  applicationId: my_application_id,
+  dataTableId: my_data_table_id,
+  rowId: my_row_id,
+  dataTableRow: my_data_table_row)
+
+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, dataTableRow.*, or dataTableRow.patch.
+
+#### 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 |
+| rowId | string | Y | ID associated with the data table row |  | 596f832b128eda5cfe765443 |
+| dataTableRow | [Data Table Row Insert/Update](_schemas.md#data-table-row-insert/update) | Y | Object containing updated properties for the data table row |  | [Data Table Row Insert/Update Example](_schemas.md#data-table-row-insert/update-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Data Table Row](_schemas.md#data-table-row) | Updated data table row information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if data table row was not found |

data/docs/dataTableRows.md

@@ -0,0 +1,139 @@
+# Data Table Rows Actions
+
+Details on the various actions that can be performed on the
+Data Table Rows resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Get](#get)
+*   [Post](#post)
+*   [Query](#query)
+
+<br/>
+
+## Get
+
+Returns the rows for a data table
+
+```ruby
+result = client.data_table_rows.get(
+  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.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, dataTableRows.*, or dataTableRows.get.
+
+#### 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 |
+| sortColumn | string | N | Column to sort the rows by |  | myColumnName |
+| sortDirection | string | N | Direction to sort the rows by. Accepted values are: asc, desc | asc | asc |
+| limit | string | N | How many rows to return | 1000 | 0 |
+| offset | string | N | How many rows to skip | 0 | 0 |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Data Table Rows](_schemas.md#data-table-rows) | Collection of data table rows |
+
+#### 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/>
+
+## Post
+
+Inserts a new row into a data table
+
+```ruby
+result = client.data_table_rows.post(
+  applicationId: my_application_id,
+  dataTableId: my_data_table_id,
+  dataTableRow: my_data_table_row)
+
+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.post.
+
+#### 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 |
+| dataTableRow | [Data Table Row Insert/Update](_schemas.md#data-table-row-insert/update) | Y | The row to insert |  | [Data Table Row Insert/Update Example](_schemas.md#data-table-row-insert/update-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 201 | [Data Table Row](_schemas.md#data-table-row) | Successfully created data table row |
+
+#### 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/>
+
+## Query
+
+Queries for rows from a data table
+
+```ruby
+result = client.data_table_rows.query(
+  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.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, dataTableRows.*, or dataTableRows.query.
+
+#### 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 |
+| sortColumn | string | N | Column to sort the rows by |  | myColumnName |
+| sortDirection | string | N | Direction to sort the rows by. Accepted values are: asc, desc | asc | asc |
+| limit | string | N | How many rows to return | 1000 | 0 |
+| offset | string | N | How many rows to skip | 0 | 0 |
+| 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) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Data Table Rows](_schemas.md#data-table-rows) | Collection of data table rows |
+
+#### 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 |

data/docs/dataTables.md

@@ -0,0 +1,91 @@
+# Data Tables Actions
+
+Details on the various actions that can be performed on the
+Data Tables resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Get](#get)
+*   [Post](#post)
+
+<br/>
+
+## Get
+
+Returns the data tables for an application
+
+```ruby
+result = client.data_tables.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, dataTables.*, or dataTables.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: name, id, creationDate | 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*table |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Data Tables](_schemas.md#data-tables) | Collection of data tables |
+
+#### 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 data table for an application
+
+```ruby
+result = client.data_tables.post(
+  applicationId: my_application_id,
+  dataTable: my_data_table)
+
+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, dataTables.*, or dataTables.post.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| dataTable | [Data Table Post](_schemas.md#data-table-post) | Y | New data table information |  | [Data Table Post Example](_schemas.md#data-table-post-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 201 | [Data Table](_schemas.md#data-table) | Successfully created data table |
+
+#### 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/flow.md

@@ -6,6 +6,7 @@ parameters and the potential responses.
 
 ##### Contents
 
+*   [Clear Storage Entries](#clear-storage-entries)
 *   [Delete](#delete)
 *   [Get](#get)
 *   [Get Log Entries](#get-log-entries)
@@ -16,6 +17,45 @@ parameters and the potential responses.
 
 <br/>
 
+## Clear Storage Entries
+
+Clear all storage entries
+
+```ruby
+result = client.flow.clear_storage_entries(
+  applicationId: my_application_id,
+  flowId: my_flow_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, flow.*, or flow.clearStorageEntries.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| flowId | string | Y | ID associated with the flow |  | 575ed18f7ae143cd83dc4aa6 |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Workflow Storage Entries](_schemas.md#workflow-storage-entries) | The current storage entries |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if flow was not found |
+
+<br/>
+
 ## Delete
 
 Deletes a flow
@@ -163,7 +203,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Workflow Storage Entries](_schemas.md#workflow-storage-entries) | The stored values |
+| 200 | [Workflow Storage Entries](_schemas.md#workflow-storage-entries) | The current storage entries |
 
 #### Error Responses
 

data/lib/losant_rest/client.rb

@@ -27,7 +27,7 @@ module LosantRest
   #
   # User API for accessing Losant data
   #
-  # Built For Version 1.6.4
+  # Built For Version 1.7.0
   class Client
     attr_accessor :auth_token, :url
 
@@ -84,6 +84,22 @@ module LosantRest
       @data ||= Data.new(self)
     end
 
+    def data_table
+      @data_table ||= DataTable.new(self)
+    end
+
+    def data_table_row
+      @data_table_row ||= DataTableRow.new(self)
+    end
+
+    def data_table_rows
+      @data_table_rows ||= DataTableRows.new(self)
+    end
+
+    def data_tables
+      @data_tables ||= DataTables.new(self)
+    end
+
     def device
       @device ||= Device.new(self)
     end
@@ -202,7 +218,7 @@ module LosantRest
 
       headers["Accept"]         = "application/json"
       headers["Content-Type"]   = "application/json"
-      headers["Accept-Version"] = "^1.6.4"
+      headers["Accept-Version"] = "^1.7.0"
       headers["Authorization"]  = "Bearer #{self.auth_token}" if self.auth_token
       path = self.url + options.fetch(:path, "")