losant_rest 1.9.2 → 1.10.3

data/docs/experienceEndpoints.md

@@ -118,6 +118,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
 | statGrouping | string | N | Field to group the statistics by. Accepted values are: statusCode, endpointId, version, domain | statusCode | statusCode |
 | duration | string | N | Duration in milliseconds | 86400000 | 86400000 |
+| end | string | N | End of time range in milliseconds since epoch | 0 | 0 |
 | resolution | string | N | Resolution in milliseconds | 3600000 | 3600000 |
 | versionFilter | string | N | Filters the stats to a particular experience version |  | myVersion |
 | domainFilter | string | N | Filters the stats to a particular experience domain or slug |  | mycustomdomain.com |

data/docs/file.md

@@ -50,7 +50,7 @@ all.Application, all.Organization, all.User, file.*, or file.delete.
 | Code | Type | Description |
 | ---- | ---- | ----------- |
 | 400 | [Error](_schemas.md#error) | Error if malformed request |
-| 404 | [Error](_schemas.md#error) | Error if event was not found |
+| 404 | [Error](_schemas.md#error) | Error if file was not found |
 
 <br/>
 
@@ -132,7 +132,7 @@ all.Application, all.Organization, all.User, file.*, or file.move.
 | Code | Type | Description |
 | ---- | ---- | ----------- |
 | 400 | [Error](_schemas.md#error) | Error if malformed request |
-| 404 | [Error](_schemas.md#error) | Error if application was not found |
+| 404 | [Error](_schemas.md#error) | Error if file was not found |
 
 <br/>
 
@@ -174,7 +174,7 @@ all.Application, all.Organization, all.User, file.*, or file.patch.
 | Code | Type | Description |
 | ---- | ---- | ----------- |
 | 400 | [Error](_schemas.md#error) | Error if malformed request |
-| 404 | [Error](_schemas.md#error) | Error if application was not found |
+| 404 | [Error](_schemas.md#error) | Error if file was not found |
 
 <br/>
 
@@ -216,4 +216,4 @@ all.Application, all.Organization, all.User, file.*, or file.upload.
 | Code | Type | Description |
 | ---- | ---- | ----------- |
 | 400 | [Error](_schemas.md#error) | Error if malformed request |
-| 404 | [Error](_schemas.md#error) | Error if application was not found |
+| 404 | [Error](_schemas.md#error) | Error if file was not found |

data/docs/flow.md

@@ -8,12 +8,14 @@ parameters and the potential responses.
 
 *   [Clear Storage Entries](#clear-storage-entries)
 *   [Delete](#delete)
+*   [Errors](#errors)
 *   [Get](#get)
 *   [Get Log Entries](#get-log-entries)
 *   [Get Storage Entries](#get-storage-entries)
 *   [Patch](#patch)
 *   [Press Virtual Button](#press-virtual-button)
 *   [Set Storage Entry](#set-storage-entry)
+*   [Stats](#stats)
 
 <br/>
 
@@ -97,6 +99,52 @@ all.Application, all.Organization, all.User, flow.*, or flow.delete.
 
 <br/>
 
+## Errors
+
+Get information about errors that occurred during runs of this workflow
+
+```ruby
+result = client.flow.errors(
+  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.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flow.*, or flow.errors.
+
+#### 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 |
+| duration | string | N | Duration of time range in milliseconds | 86400000 | 86400000 |
+| end | string | N | End of time range in milliseconds since epoch | 0 | 0 |
+| limit | string | N | Maximum number of errors to return | 25 | 25 |
+| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | desc | desc |
+| flowVersion | string | N | Flow version name or ID. When not included, will be errors for all versions. Pass develop for just the develop version. |  | develop |
+| deviceId | string | N | For edge workflows, the Device ID to return workflow errors for. When not included, will be errors for all device IDs. |  | 575ed18f7ae143cd83dc4bb6 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Workflow Errors](_schemas.md#workflow-errors) | Workflow error information |
+
+#### 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/>
+
 ## Get
 
 Retrieves information on a flow
@@ -176,7 +224,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 | Code | Type | Description |
 | ---- | ---- | ----------- |
 | 400 | [Error](_schemas.md#error) | Error if malformed request |
-| 404 | [Error](_schemas.md#error) | Error if device was not found |
+| 404 | [Error](_schemas.md#error) | Error if flow was not found |
 
 <br/>
 
@@ -344,3 +392,48 @@ all.Application, all.Organization, all.User, flow.*, or flow.setStorageEntry.
 | ---- | ---- | ----------- |
 | 400 | [Error](_schemas.md#error) | Error if malformed request |
 | 404 | [Error](_schemas.md#error) | Error if flow was not found |
+
+<br/>
+
+## Stats
+
+Get statistics about workflow runs for this workflow
+
+```ruby
+result = client.flow.stats(
+  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.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flow.*, or flow.stats.
+
+#### 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 |
+| duration | string | N | Duration of time range in milliseconds | 86400000 | 86400000 |
+| end | string | N | End of time range in milliseconds since epoch | 0 | 0 |
+| resolution | string | N | Resolution in milliseconds | 3600000 | 3600000 |
+| flowVersion | string | N | Flow version name or ID. When not included, will be aggregate for all versions. Pass develop for just the develop version. |  | develop |
+| deviceId | string | N | For edge workflows, the device ID to return workflow stats for. When not included, will be aggregate for all device IDs. |  | 575ed18f7ae143cd83dc4bb6 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Workflow Statistics](_schemas.md#workflow-statistics) | Statistics for workflow runs |
+
+#### 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 |

data/docs/flowVersion.md

@@ -7,9 +7,11 @@ parameters and the potential responses.
 ##### Contents
 
 *   [Delete](#delete)
+*   [Errors](#errors)
 *   [Get](#get)
 *   [Get Log Entries](#get-log-entries)
 *   [Patch](#patch)
+*   [Stats](#stats)
 
 <br/>
 
@@ -55,6 +57,53 @@ all.Application, all.Organization, all.User, flowVersion.*, or flowVersion.delet
 
 <br/>
 
+## Errors
+
+Get information about errors that occurred during runs of this workflow version
+
+```ruby
+result = client.flow_version.errors(
+  applicationId: my_application_id,
+  flowId: my_flow_id,
+  flowVersionId: my_flow_version_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, flowVersion.*, or flowVersion.errors.
+
+#### 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 |
+| flowVersionId | string | Y | Version ID or version name associated with the flow version |  | 675ed18f7ae143cd83dc4bb7 |
+| duration | string | N | Duration of time range in milliseconds | 86400000 | 86400000 |
+| end | string | N | End of time range in milliseconds since epoch | 0 | 0 |
+| limit | string | N | Maximum number of errors to return | 25 | 25 |
+| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | desc | desc |
+| deviceId | string | N | For edge workflows, the Device ID to return workflow errors for. When not included, will be errors for all device IDs. |  | 575ed18f7ae143cd83dc4bb6 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Workflow Errors](_schemas.md#workflow-errors) | Workflow error information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if flow version was not found |
+
+<br/>
+
 ## Get
 
 Retrieves information on a flow version
@@ -138,7 +187,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 | Code | Type | Description |
 | ---- | ---- | ----------- |
 | 400 | [Error](_schemas.md#error) | Error if malformed request |
-| 404 | [Error](_schemas.md#error) | Error if device was not found |
+| 404 | [Error](_schemas.md#error) | Error if flow version was not found |
 
 <br/>
 
@@ -184,3 +233,49 @@ all.Application, all.Organization, all.User, flowVersion.*, or flowVersion.patch
 | ---- | ---- | ----------- |
 | 400 | [Error](_schemas.md#error) | Error if malformed request |
 | 404 | [Error](_schemas.md#error) | Error if flow version was not found |
+
+<br/>
+
+## Stats
+
+Get statistics about workflow runs for this workflow version
+
+```ruby
+result = client.flow_version.stats(
+  applicationId: my_application_id,
+  flowId: my_flow_id,
+  flowVersionId: my_flow_version_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, flowVersion.*, or flowVersion.stats.
+
+#### 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 |
+| flowVersionId | string | Y | Version ID or version name associated with the flow version |  | 675ed18f7ae143cd83dc4bb7 |
+| duration | string | N | Duration of time range in milliseconds | 86400000 | 86400000 |
+| end | string | N | End of time range in milliseconds since epoch | 0 | 0 |
+| resolution | string | N | Resolution in milliseconds | 3600000 | 3600000 |
+| deviceId | string | N | For edge workflows, the device ID to return workflow stats for. When not included, will be aggregate for all device IDs. |  | 575ed18f7ae143cd83dc4bb6 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Workflow Statistics](_schemas.md#workflow-statistics) | Statistics for workflow runs |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if flow version was not found |

data/lib/losant_rest.rb

@@ -32,6 +32,7 @@ require_relative "losant_rest/application_certificate_authority"
 require_relative "losant_rest/application_certificates"
 require_relative "losant_rest/application_key"
 require_relative "losant_rest/application_keys"
+require_relative "losant_rest/application_templates"
 require_relative "losant_rest/applications"
 require_relative "losant_rest/audit_log"
 require_relative "losant_rest/audit_logs"

data/lib/losant_rest/application.rb

@@ -78,7 +78,7 @@ module LosantRest
         body: body)
     end
 
-    # Returns success when a job has been enqueued to backfill all current data to it's archive
+    # Returns success when a job has been enqueued to backfill all current data to its archive
     #
     # Authentication:
     # The client must be configured with a valid api
@@ -215,7 +215,7 @@ module LosantRest
         body: body)
     end
 
-    # Export an application and all of it's resources
+    # Export an application and all of its resources
     #
     # Authentication:
     # The client must be configured with a valid api
@@ -545,6 +545,97 @@ module LosantRest
         body: body)
     end
 
+    # Get the current application readme information
+    #
+    # 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, application.*, or application.get.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID of the associated application
+    # *  {string} losantdomain - Domain scope of request (rarely needed)
+    # *  {boolean} _actions - Return resource actions in response
+    # *  {boolean} _links - Return resource link in response
+    # *  {boolean} _embedded - Return embedded resources in response
+    #
+    # Responses:
+    # *  200 - The application readme information (https://api.losant.com/#/definitions/applicationReadme)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if application was not found (https://api.losant.com/#/definitions/error)
+    def readme(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
+
+      headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
+      query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
+      query_params[:_links] = params[:_links] if params.has_key?(:_links)
+      query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
+
+      path = "/applications/#{params[:applicationId]}/readme"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Update the current application readme information
+    #
+    # 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.patch.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID of the associated application
+    # *  {hash} readme - Object containing new readme information (https://api.losant.com/#/definitions/applicationReadmePatch)
+    # *  {string} losantdomain - Domain scope of request (rarely needed)
+    # *  {boolean} _actions - Return resource actions in response
+    # *  {boolean} _links - Return resource link in response
+    # *  {boolean} _embedded - Return embedded resources in response
+    #
+    # Responses:
+    # *  200 - Updated readme information (https://api.losant.com/#/definitions/applicationReadme)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if application was not found (https://api.losant.com/#/definitions/error)
+    def readme_patch(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
+      raise ArgumentError.new("readme is required") unless params.has_key?(:readme)
+
+      body = params[:readme] if params.has_key?(:readme)
+      headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
+      query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
+      query_params[:_links] = params[:_links] if params.has_key?(:_links)
+      query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
+
+      path = "/applications/#{params[:applicationId]}/readme"
+
+      @client.request(
+        method: :patch,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Search across an application's resources by target identifier
     #
     # Authentication:

data/lib/losant_rest/application_templates.rb

@@ -0,0 +1,88 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2020 Losant IoT, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require "json"
+
+module LosantRest
+
+  # Class containing all the actions for the Application Templates Resource
+  class ApplicationTemplates
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Returns the application templates the current user has permission to see
+    #
+    # 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.get.
+    #
+    # Parameters:
+    # *  {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated
+    # *  {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
+    # *  {string} page - Which page of results to return
+    # *  {string} perPage - How many items to return per page
+    # *  {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name
+    # *  {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
+    # *  {string} losantdomain - Domain scope of request (rarely needed)
+    # *  {boolean} _actions - Return resource actions in response
+    # *  {boolean} _links - Return resource link in response
+    # *  {boolean} _embedded - Return embedded resources in response
+    #
+    # Responses:
+    # *  200 - Collection of application templates (https://api.losant.com/#/definitions/applicationTemplates)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    def get(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+
+      query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
+      query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
+      query_params[:page] = params[:page] if params.has_key?(:page)
+      query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
+      query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
+      query_params[:filter] = params[:filter] if params.has_key?(:filter)
+      headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
+      query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
+      query_params[:_links] = params[:_links] if params.has_key?(:_links)
+      query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
+
+      path = "/applicationTemplates"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+  end
+end