losant_rest 1.14.1 → 1.15.0

data/docs/embeddedDeployment.md

@@ -0,0 +1,49 @@
+# Embedded Deployment Actions
+
+Details on the various actions that can be performed on the
+Embedded Deployment resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Get](#get)
+
+<br/>
+
+## Get
+
+Retrieves information on an embedded deployment
+
+```ruby
+result = client.embedded_deployment.get(
+  applicationId: my_application_id,
+  embeddedDeploymentId: my_embedded_deployment_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, embeddedDeployment.*, or embeddedDeployment.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| embeddedDeploymentId | string | Y | ID associated with the embedded deployment |  | 575ed78e7ae143cd83dc4aab |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Embedded Deployment](_schemas.md#embedded-deployment) | Embedded deployment information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if embedded deployment was not found |

data/docs/embeddedDeployments.md

@@ -0,0 +1,215 @@
+# Embedded Deployments Actions
+
+Details on the various actions that can be performed on the
+Embedded Deployments resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Export](#export)
+*   [Get](#get)
+*   [Release](#release)
+*   [Remove](#remove)
+*   [Replace](#replace)
+
+<br/>
+
+## Export
+
+Request an export of the compiled WASM files for a current deployment
+
+```ruby
+result = client.embedded_deployments.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, embeddedDeployments.*, or embeddedDeployments.export.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| options | [Embedded Deployment Export](_schemas.md#embedded-deployment-export) | N | Export options for embedded deployment |  | [Embedded Deployment Export Example](_schemas.md#embedded-deployment-export-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 deployment was not found |
+
+<br/>
+
+## Get
+
+Returns the embedded deployments for an application
+
+```ruby
+result = client.embedded_deployments.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, embeddedDeployments.*, or embeddedDeployments.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, lastUpdated | lastUpdated | creationDate |
+| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | desc | asc |
+| page | string | N | Which page of results to return | 0 | 0 |
+| perPage | string | N | How many items to return per page | 1000 | 10 |
+| deviceId | string | N | Filter deployments to the given Device ID |  | 575ecf887ae143cd83dc4aa2 |
+| version | string | N | Filter deployments to the given Workflow Version (matches against both current and desired) |  | myFlowVersion |
+| flowId | string | N | Filter deployments to the given Workflow ID |  | 575ed18f7ae143cd83dc4aa6 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Embedded Deployments](_schemas.md#embedded-deployments) | Collection of embedded deployments |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if application or device was not found |
+
+<br/>
+
+## Release
+
+Deploy an embedded workflow version to one or more embedded devices. Version can be blank, if removal is desired.
+
+```ruby
+result = client.embedded_deployments.release(
+  applicationId: my_application_id,
+  deployment: my_deployment)
+
+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, embeddedDeployments.*, or embeddedDeployments.release.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| deployment | [Embedded Deployment Release](_schemas.md#embedded-deployment-release) | Y | Deployment release information |  | [Embedded Deployment Release Example](_schemas.md#embedded-deployment-release-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 201 | [Success](_schemas.md#success) | If deployment release has been initiated successfully |
+
+#### 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/>
+
+## Remove
+
+Remove all embedded deployments from a device, remove all embedded deployments of a workflow, or remove a specific workflow from a specific device
+
+```ruby
+result = client.embedded_deployments.remove(
+  applicationId: my_application_id,
+  deployment: my_deployment)
+
+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, embeddedDeployments.*, or embeddedDeployments.remove.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| deployment | [Embedded Deployment Remove](_schemas.md#embedded-deployment-remove) | Y | Deployment removal information |  | [Embedded Deployment Remove Example](_schemas.md#embedded-deployment-remove-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 201 | [Success](_schemas.md#success) | If deployment removal has been initiated successfully |
+
+#### 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/>
+
+## Replace
+
+Replace deployments of an embedded workflow version with a new version. New version can be blank, if removal is desired.
+
+```ruby
+result = client.embedded_deployments.replace(
+  applicationId: my_application_id,
+  deployment: my_deployment)
+
+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, embeddedDeployments.*, or embeddedDeployments.replace.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| deployment | [Embedded Deployment Replace](_schemas.md#embedded-deployment-replace) | Y | Deployment replacement information |  | [Embedded Deployment Replace Example](_schemas.md#embedded-deployment-replace-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 201 | [Success](_schemas.md#success) | If deployment replacement has been initiated successfully |
+
+#### 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

@@ -128,7 +128,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 | 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 |
+| deviceId | string | N | For edge or embedded 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
@@ -463,7 +463,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 | 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 |
+| deviceId | string | N | For edge or embedded 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

data/docs/flows.md

@@ -39,7 +39,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 | perPage | string | N | How many items to return per page | 100 | 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*flow |
-| flowClass | string | N | Filter the workflows by the given flow class. Accepted values are: edge, cloud, customNode, experience | cloud | cloud |
+| flowClass | string | N | Filter the workflows by the given flow class. Accepted values are: edge, embedded, cloud, customNode, experience | cloud | cloud |
 | triggerFilter | [Workflow Trigger Filter](_schemas.md#workflow-trigger-filter) | N | Array of triggers to filter by - always filters against default flow version. |  | [Workflow Trigger Filter Example](_schemas.md#workflow-trigger-filter-example) |
 | includeCustomNodes | string | N | If the result of the request should also include the details of any custom nodes referenced by the returned workflows | false | true |
 | query | [Advanced Workflow Query](_schemas.md#advanced-workflow-query) | N | Workflow filter JSON object which overrides the filterField, filter, triggerFilter, and flowClass parameters. |  | [Advanced Workflow Query Example](_schemas.md#advanced-workflow-query-example) |
@@ -89,7 +89,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 | perPage | string | N | How many items to return per page | 100 | 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*flow |
-| flowClass | string | N | Filter the workflows by the given flow class. Accepted values are: edge, cloud, customNode, experience | cloud | cloud |
+| flowClass | string | N | Filter the workflows by the given flow class. Accepted values are: edge, embedded, cloud, customNode, experience | cloud | cloud |
 | version | string | Y | Return the workflow versions for the given version. |  | myVersion |
 | triggerFilter | [Workflow Trigger Filter](_schemas.md#workflow-trigger-filter) | N | Array of triggers to filter by - always filters against default flow version. |  | [Workflow Trigger Filter Example](_schemas.md#workflow-trigger-filter-example) |
 | includeCustomNodes | string | N | If the result of the request should also include the details of any custom nodes referenced by the returned workflows | false | true |

data/lib/losant_rest/client.rb

@@ -27,7 +27,7 @@ module LosantRest
   #
   # User API for accessing Losant data
   #
-  # Built For Version 1.21.1
+  # Built For Version 1.22.0
   class Client
     attr_accessor :auth_token, :url
 
@@ -156,6 +156,14 @@ module LosantRest
       @edge_deployments ||= EdgeDeployments.new(self)
     end
 
+    def embedded_deployment
+      @embedded_deployment ||= EmbeddedDeployment.new(self)
+    end
+
+    def embedded_deployments
+      @embedded_deployments ||= EmbeddedDeployments.new(self)
+    end
+
     def event
       @event ||= Event.new(self)
     end
@@ -350,7 +358,7 @@ module LosantRest
 
       headers["Accept"]         = "application/json"
       headers["Content-Type"]   = "application/json"
-      headers["Accept-Version"] = "^1.21.1"
+      headers["Accept-Version"] = "^1.22.0"
       headers["Authorization"]  = "Bearer #{self.auth_token}" if self.auth_token
       path = self.url + options.fetch(:path, "")
 

data/lib/losant_rest/embedded_deployment.rb

@@ -0,0 +1,81 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2021 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 Embedded Deployment Resource
+  class EmbeddedDeployment
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieves information on an embedded deployment
+    #
+    # 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, embeddedDeployment.*, or embeddedDeployment.get.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} embeddedDeploymentId - ID associated with the embedded deployment
+    # *  {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 - Embedded deployment information (https://api.losant.com/#/definitions/embeddedDeployment)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if embedded deployment was not found (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
+
+      raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
+      raise ArgumentError.new("embeddedDeploymentId is required") unless params.has_key?(:embeddedDeploymentId)
+
+      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]}/embedded/deployments/#{params[:embeddedDeploymentId]}"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+  end
+end