losant_rest 1.14.1 → 1.15.0

data/lib/losant_rest/embedded_deployments.rb

@@ -0,0 +1,280 @@
+# 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 Deployments Resource
+  class EmbeddedDeployments
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Request an export of the compiled WASM files for a current 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, embeddedDeployments.*, or embeddedDeployments.export.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {hash} options - Export options for embedded deployment (https://api.losant.com/#/definitions/embeddedDeploymentExport)
+    # *  {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 - If generation of export was successfully started (https://api.losant.com/#/definitions/success)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if deployment was not found (https://api.losant.com/#/definitions/error)
+    def export(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)
+
+      body = params[:options] if params.has_key?(:options)
+      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/export"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Returns the embedded deployments for an application
+    #
+    # 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.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} sortField - Field to sort the results by. Accepted values are: 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} deviceId - Filter deployments to the given Device ID
+    # *  {string} version - Filter deployments to the given Workflow Version (matches against both current and desired)
+    # *  {string} flowId - Filter deployments to the given Workflow ID
+    # *  {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 embedded deployments (https://api.losant.com/#/definitions/embeddedDeployments)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if application or device 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)
+
+      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[:deviceId] = params[:deviceId] if params.has_key?(:deviceId)
+      query_params[:version] = params[:version] if params.has_key?(:version)
+      query_params[:flowId] = params[:flowId] if params.has_key?(:flowId)
+      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"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Deploy an embedded workflow version to one or more embedded devices. Version can be blank, if removal is desired.
+    #
+    # 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.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {hash} deployment - Deployment release information (https://api.losant.com/#/definitions/embeddedDeploymentRelease)
+    # *  {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:
+    # *  201 - If deployment release has been initiated successfully (https://api.losant.com/#/definitions/success)
+    #
+    # 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 release(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("deployment is required") unless params.has_key?(:deployment)
+
+      body = params[:deployment] if params.has_key?(:deployment)
+      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/release"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Remove all embedded deployments from a device, remove all embedded deployments of a workflow, or remove a specific workflow from a specific device
+    #
+    # 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.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {hash} deployment - Deployment removal information (https://api.losant.com/#/definitions/embeddedDeploymentRemove)
+    # *  {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:
+    # *  201 - If deployment removal has been initiated successfully (https://api.losant.com/#/definitions/success)
+    #
+    # 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 remove(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("deployment is required") unless params.has_key?(:deployment)
+
+      body = params[:deployment] if params.has_key?(:deployment)
+      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/remove"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Replace deployments of an embedded workflow version with a new version. New version can be blank, if removal is desired.
+    #
+    # 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.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {hash} deployment - Deployment replacement information (https://api.losant.com/#/definitions/embeddedDeploymentReplace)
+    # *  {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:
+    # *  201 - If deployment replacement has been initiated successfully (https://api.losant.com/#/definitions/success)
+    #
+    # 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 replace(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("deployment is required") unless params.has_key?(:deployment)
+
+      body = params[:deployment] if params.has_key?(:deployment)
+      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/replace"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+  end
+end

data/lib/losant_rest/flow.rb

@@ -139,7 +139,7 @@ module LosantRest
     # *  {string} limit - Maximum number of errors to return
     # *  {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
     # *  {string} flowVersion - Flow version name or ID. When not included, will be errors for all versions. Pass develop for just the develop version.
-    # *  {string} deviceId - For edge workflows, the Device ID to return workflow errors for. When not included, will be errors for all device IDs.
+    # *  {string} deviceId - For edge or embedded workflows, the Device ID to return workflow errors for. When not included, will be errors for all device IDs.
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -535,7 +535,7 @@ module LosantRest
     # *  {string} end - End of time range in milliseconds since epoch
     # *  {string} resolution - Resolution in milliseconds
     # *  {string} flowVersion - Flow version name or ID. When not included, will be aggregate for all versions. Pass develop for just the develop version.
-    # *  {string} deviceId - For edge workflows, the device ID to return workflow stats for. When not included, will be aggregate for all device IDs.
+    # *  {string} deviceId - For edge or embedded workflows, the device ID to return workflow stats for. When not included, will be aggregate for all device IDs.
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response

data/lib/losant_rest/flows.rb

@@ -47,7 +47,7 @@ module LosantRest
     # *  {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} flowClass - Filter the workflows by the given flow class. Accepted values are: edge, cloud, customNode, experience
+    # *  {string} flowClass - Filter the workflows by the given flow class. Accepted values are: edge, embedded, cloud, customNode, experience
     # *  {hash} triggerFilter - Array of triggers to filter by - always filters against default flow version. (https://api.losant.com/#/definitions/flowTriggerFilter)
     # *  {string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by the returned workflows
     # *  {hash} query - Workflow filter JSON object which overrides the filterField, filter, triggerFilter, and flowClass parameters. (https://api.losant.com/#/definitions/advancedFlowQuery)
@@ -114,7 +114,7 @@ module LosantRest
     # *  {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} flowClass - Filter the workflows by the given flow class. Accepted values are: edge, cloud, customNode, experience
+    # *  {string} flowClass - Filter the workflows by the given flow class. Accepted values are: edge, embedded, cloud, customNode, experience
     # *  {string} version - Return the workflow versions for the given version.
     # *  {hash} triggerFilter - Array of triggers to filter by - always filters against default flow version. (https://api.losant.com/#/definitions/flowTriggerFilter)
     # *  {string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by the returned workflows

data/lib/losant_rest/version.rb

@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module LosantRest
-  VERSION = "1.14.1"
+  VERSION = "1.15.0"
 end

data/lib/losant_rest.rb

@@ -53,6 +53,8 @@ require_relative "losant_rest/device_recipes"
 require_relative "losant_rest/devices"
 require_relative "losant_rest/edge_deployment"
 require_relative "losant_rest/edge_deployments"
+require_relative "losant_rest/embedded_deployment"
+require_relative "losant_rest/embedded_deployments"
 require_relative "losant_rest/event"
 require_relative "losant_rest/events"
 require_relative "losant_rest/experience"

data/schemas/apiTokenPost.json

@@ -52,6 +52,8 @@
                   "devices.*",
                   "edgeDeployment.*",
                   "edgeDeployments.*",
+                  "embeddedDeployment.*",
+                  "embeddedDeployments.*",
                   "event.*",
                   "events.*",
                   "experience.*",
@@ -180,6 +182,12 @@
                   "edgeDeployments.release",
                   "edgeDeployments.remove",
                   "edgeDeployments.replace",
+                  "embeddedDeployment.get",
+                  "embeddedDeployments.get",
+                  "embeddedDeployments.release",
+                  "embeddedDeployments.remove",
+                  "embeddedDeployments.replace",
+                  "embeddedDeployments.export",
                   "event.delete",
                   "event.get",
                   "event.patch",

data/schemas/application.json

@@ -108,66 +108,66 @@
       "type": "object",
       "properties": {
         "apiTokenCount": {
-          "type": "number"
+          "type": "integer"
         },
         "dataTableCount": {
-          "type": "number"
+          "type": "integer"
         },
         "deviceCount": {
-          "type": "number"
+          "type": "integer"
         },
         "deviceRecipeCount": {
-          "type": "number"
+          "type": "integer"
         },
         "eventCount": {
-          "type": "number"
+          "type": "integer"
         },
         "experienceDomainCount": {
-          "type": "number"
+          "type": "integer"
         },
         "experienceEndpointCount": {
-          "type": "number"
+          "type": "integer"
         },
         "experienceGroupCount": {
-          "type": "number"
+          "type": "integer"
         },
         "experienceSlugCount": {
-          "type": "number"
+          "type": "integer"
         },
         "experienceUserCount": {
-          "type": "number"
+          "type": "integer"
         },
         "experienceVersionCount": {
-          "type": "number"
+          "type": "integer"
         },
         "experienceViewCount": {
-          "type": "number"
+          "type": "integer"
         },
         "fileCount": {
-          "type": "number"
+          "type": "integer"
         },
         "flowCount": {
-          "type": "number"
+          "type": "integer"
         },
         "integrationCount": {
-          "type": "number"
+          "type": "integer"
         },
         "keyCount": {
-          "type": "number"
+          "type": "integer"
         },
         "storageStats": {
           "type": "object",
           "properties": {
             "count": {
-              "type": "number"
+              "type": "integer"
             },
             "size": {
-              "type": "number"
+              "type": "integer"
             }
           }
         },
         "webhookCount": {
-          "type": "number"
+          "type": "integer"
         }
       }
     },
@@ -205,7 +205,7 @@
       "properties": {
         "directory": {
           "type": "string",
-          "max": 255
+          "maxLength": 255
         },
         "mode": {
           "type": "string",
@@ -275,21 +275,21 @@
           "properties": {
             "bucket": {
               "type": "string",
-              "max": 255
+              "maxLength": 255
             },
             "accessKeyId": {
               "type": "string",
-              "min": 4,
-              "max": 128
+              "minLength": 4,
+              "maxLength": 128
             },
             "secretAccessKey": {
               "type": "string",
-              "min": 4,
-              "max": 128
+              "minLength": 4,
+              "maxLength": 128
             },
             "region": {
               "type": "string",
-              "max": 128
+              "maxLength": 128
             }
           },
           "required": [
@@ -315,7 +315,7 @@
             },
             "bucket": {
               "type": "string",
-              "max": 255
+              "maxLength": 255
             }
           },
           "required": [
@@ -330,17 +330,17 @@
           "properties": {
             "account": {
               "type": "string",
-              "min": 3,
-              "max": 24
+              "minLength": 3,
+              "maxLength": 24
             },
             "accountKey": {
               "type": "string",
-              "max": 255
+              "maxLength": 255
             },
             "bucket": {
               "type": "string",
-              "min": 3,
-              "max": 63
+              "minLength": 3,
+              "maxLength": 63
             }
           },
           "required": [

data/schemas/applicationCreationByTemplateResult.json

@@ -113,66 +113,66 @@
           "type": "object",
           "properties": {
             "apiTokenCount": {
-              "type": "number"
+              "type": "integer"
             },
             "dataTableCount": {
-              "type": "number"
+              "type": "integer"
             },
             "deviceCount": {
-              "type": "number"
+              "type": "integer"
             },
             "deviceRecipeCount": {
-              "type": "number"
+              "type": "integer"
             },
             "eventCount": {
-              "type": "number"
+              "type": "integer"
             },
             "experienceDomainCount": {
-              "type": "number"
+              "type": "integer"
             },
             "experienceEndpointCount": {
-              "type": "number"
+              "type": "integer"
             },
             "experienceGroupCount": {
-              "type": "number"
+              "type": "integer"
             },
             "experienceSlugCount": {
-              "type": "number"
+              "type": "integer"
             },
             "experienceUserCount": {
-              "type": "number"
+              "type": "integer"
             },
             "experienceVersionCount": {
-              "type": "number"
+              "type": "integer"
             },
             "experienceViewCount": {
-              "type": "number"
+              "type": "integer"
             },
             "fileCount": {
-              "type": "number"
+              "type": "integer"
             },
             "flowCount": {
-              "type": "number"
+              "type": "integer"
             },
             "integrationCount": {
-              "type": "number"
+              "type": "integer"
             },
             "keyCount": {
-              "type": "number"
+              "type": "integer"
             },
             "storageStats": {
               "type": "object",
               "properties": {
                 "count": {
-                  "type": "number"
+                  "type": "integer"
                 },
                 "size": {
-                  "type": "number"
+                  "type": "integer"
                 }
               }
             },
             "webhookCount": {
-              "type": "number"
+              "type": "integer"
             }
           }
         },
@@ -210,7 +210,7 @@
           "properties": {
             "directory": {
               "type": "string",
-              "max": 255
+              "maxLength": 255
             },
             "mode": {
               "type": "string",
@@ -280,21 +280,21 @@
               "properties": {
                 "bucket": {
                   "type": "string",
-                  "max": 255
+                  "maxLength": 255
                 },
                 "accessKeyId": {
                   "type": "string",
-                  "min": 4,
-                  "max": 128
+                  "minLength": 4,
+                  "maxLength": 128
                 },
                 "secretAccessKey": {
                   "type": "string",
-                  "min": 4,
-                  "max": 128
+                  "minLength": 4,
+                  "maxLength": 128
                 },
                 "region": {
                   "type": "string",
-                  "max": 128
+                  "maxLength": 128
                 }
               },
               "required": [
@@ -320,7 +320,7 @@
                 },
                 "bucket": {
                   "type": "string",
-                  "max": 255
+                  "maxLength": 255
                 }
               },
               "required": [
@@ -335,17 +335,17 @@
               "properties": {
                 "account": {
                   "type": "string",
-                  "min": 3,
-                  "max": 24
+                  "minLength": 3,
+                  "maxLength": 24
                 },
                 "accountKey": {
                   "type": "string",
-                  "max": 255
+                  "maxLength": 255
                 },
                 "bucket": {
                   "type": "string",
-                  "min": 3,
-                  "max": 63
+                  "minLength": 3,
+                  "maxLength": 63
                 }
               },
               "required": [