losant_rest 1.4.2 → 1.5.0

data/lib/losant_rest/edge_deployments.rb

@@ -0,0 +1,234 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2018 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.
+
+module LosantRest
+
+  # Class containing all the actions for the Edge Deployments Resource
+  class EdgeDeployments
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Returns the edge 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, edgeDeployments.*, or edgeDeployments.get.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} sortField - Field to sort the results by. Accepted values are: id, deviceId, flowId, desiredVersion, currentVersion, 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)
+    # *  {undefined} filterEmpty - Filter out deployments where both the current and desired version are null.
+    # *  {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 edge deployments (https://api.losant.com/#/definitions/edgeDeployments)
+    #
+    # 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 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[:filterEmpty] = params[:filterEmpty] if params.has_key?(:filterEmpty)
+      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]}/edge/deployments"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Deploy an edge workflow version to one or more edge 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, edgeDeployments.*, or edgeDeployments.release.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {hash} deployment - Deployment release information (https://api.losant.com/#/definitions/edgeDeploymentRelease)
+    # *  {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]}/edge/deployments/release"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Remove all edge deployments from a device, remove all edge 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, edgeDeployments.*, or edgeDeployments.remove.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {hash} deployment - Deployment removal information (https://api.losant.com/#/definitions/edgeDeploymentRemove)
+    # *  {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]}/edge/deployments/remove"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Replace deployments of an edge 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, edgeDeployments.*, or edgeDeployments.replace.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {hash} deployment - Deployment replacement information (https://api.losant.com/#/definitions/edgeDeploymentReplace)
+    # *  {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]}/edge/deployments/replace"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+  end
+end

data/lib/losant_rest/flows.rb

@@ -45,6 +45,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
     # *  {hash} triggerFilter - Array of triggers to filter by - always filters against default flow version. (https://api.losant.com/#/definitions/flowTriggerFilter)
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
@@ -71,6 +72,7 @@ module LosantRest
       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)
+      query_params[:flowClass] = params[:flowClass] if params.has_key?(:flowClass)
       query_params[:triggerFilter] = params[:triggerFilter] if params.has_key?(:triggerFilter)
       headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
       query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)

data/lib/losant_rest/version.rb

@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module LosantRest
-  VERSION = "1.4.2"
+  VERSION = "1.5.0"
 end

data/schemas/application.json

@@ -41,8 +41,8 @@
     "endpointSlug": {
       "type": "string",
       "minLength": 4,
-      "maxLength": 255,
-      "pattern": "^[0-9a-z_-]*$"
+      "maxLength": 63,
+      "pattern": "^[0-9a-z-]*$"
     },
     "expUserTokenCutoff": {
       "type": "string",

data/schemas/applicationApiTokenPost.json

@@ -36,6 +36,7 @@
           "deviceRecipe.*",
           "deviceRecipes.*",
           "devices.*",
+          "edgeDeployments.*",
           "event.*",
           "events.*",
           "experienceDomain.*",
@@ -56,6 +57,8 @@
           "flowVersions.*",
           "webhook.*",
           "webhooks.*",
+          "application.archiveData",
+          "application.backfillArchiveData",
           "application.delete",
           "application.get",
           "application.patch",
@@ -109,6 +112,10 @@
           "devices.get",
           "devices.post",
           "devices.sendCommand",
+          "edgeDeployments.get",
+          "edgeDeployments.release",
+          "edgeDeployments.remove",
+          "edgeDeployments.replace",
           "event.delete",
           "event.get",
           "event.patch",

data/schemas/applicationPatch.json

@@ -14,8 +14,8 @@
     "endpointSlug": {
       "type": "string",
       "minLength": 4,
-      "maxLength": 255,
-      "pattern": "^[0-9a-z_-]*$"
+      "maxLength": 63,
+      "pattern": "^[0-9a-z-]*$"
     },
     "expUserTokenCutoff": {
       "type": "string",

data/schemas/applicationPost.json

@@ -18,8 +18,8 @@
     "endpointSlug": {
       "type": "string",
       "minLength": 4,
-      "maxLength": 255,
-      "pattern": "^[0-9a-z_-]*$"
+      "maxLength": 63,
+      "pattern": "^[0-9a-z-]*$"
     },
     "expUserTokenCutoff": {
       "type": "string",

data/schemas/applications.json

@@ -48,8 +48,8 @@
           "endpointSlug": {
             "type": "string",
             "minLength": 4,
-            "maxLength": 255,
-            "pattern": "^[0-9a-z_-]*$"
+            "maxLength": 63,
+            "pattern": "^[0-9a-z-]*$"
           },
           "expUserTokenCutoff": {
             "type": "string",

data/schemas/authedDevice.json

@@ -16,7 +16,8 @@
         "standalone",
         "gateway",
         "peripheral",
-        "floating"
+        "floating",
+        "edgeCompute"
       ]
     },
     "token": {

data/schemas/dashboard.json

@@ -114,6 +114,10 @@
             "type": "string",
             "maxLength": 255
           },
+          "description": {
+            "type": "string",
+            "maxLength": 32767
+          },
           "applicationId": {
             "type": "string",
             "pattern": "^[A-Fa-f\\d]{24}$"

data/schemas/dashboardPatch.json

@@ -22,6 +22,10 @@
             "type": "string",
             "maxLength": 255
           },
+          "description": {
+            "type": "string",
+            "maxLength": 32767
+          },
           "applicationId": {
             "type": "string",
             "pattern": "^[A-Fa-f\\d]{24}$"

data/schemas/dashboardPost.json

@@ -26,6 +26,10 @@
             "type": "string",
             "maxLength": 255
           },
+          "description": {
+            "type": "string",
+            "maxLength": 32767
+          },
           "applicationId": {
             "type": "string",
             "pattern": "^[A-Fa-f\\d]{24}$"

data/schemas/dashboards.json

@@ -121,6 +121,10 @@
                   "type": "string",
                   "maxLength": 255
                 },
+                "description": {
+                  "type": "string",
+                  "maxLength": 32767
+                },
                 "applicationId": {
                   "type": "string",
                   "pattern": "^[A-Fa-f\\d]{24}$"

data/schemas/device.json

@@ -87,13 +87,18 @@
         "standalone",
         "gateway",
         "peripheral",
-        "floating"
+        "floating",
+        "edgeCompute"
       ]
     },
     "gatewayId": {
       "type": "string",
       "pattern": "^[A-Fa-f\\d]{24}$"
     },
+    "edgeAgentVersion": {
+      "type": "string",
+      "pattern": "^(0|([1-9]\\d*))\\.(0|([1-9]\\d*))\\.(0|([1-9]\\d*))$"
+    },
     "connectionInfo": {
       "type": "object",
       "properties": {

data/schemas/devicePatch.json

@@ -67,7 +67,8 @@
         "standalone",
         "gateway",
         "peripheral",
-        "floating"
+        "floating",
+        "edgeCompute"
       ]
     },
     "gatewayId": {

data/schemas/devicePost.json

@@ -67,7 +67,8 @@
         "standalone",
         "gateway",
         "peripheral",
-        "floating"
+        "floating",
+        "edgeCompute"
       ]
     },
     "gatewayId": {

data/schemas/deviceRecipe.json

@@ -96,7 +96,8 @@
         "standalone",
         "gateway",
         "peripheral",
-        "floating"
+        "floating",
+        "edgeCompute"
       ]
     },
     "gatewayId": {