losant_rest 1.15.2 → 1.16.2

data/lib/losant_rest/instance_sandbox.rb

@@ -0,0 +1,181 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2022 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 Instance Sandbox Resource
+  class InstanceSandbox
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Deletes a sandbox user account
+    #
+    # 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.Instance, all.User, instanceSandbox.*, or instanceSandbox.delete.
+    #
+    # Parameters:
+    # *  {string} instanceId - ID associated with the instance
+    # *  {string} instanceSandboxId - ID associated with the sandbox user
+    # *  {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 a sandbox was successfully deleted (https://api.losant.com/#/definitions/success)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if instance, organization or invite was not found (https://api.losant.com/#/definitions/error)
+    def delete(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
+      raise ArgumentError.new("instanceSandboxId is required") unless params.has_key?(:instanceSandboxId)
+
+      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 = "/instances/#{params[:instanceId]}/sandboxes/#{params[:instanceSandboxId]}"
+
+      @client.request(
+        method: :delete,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Returns a sandbox user
+    #
+    # 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.Instance, all.Instance.read, all.User, all.User.read, instanceSandbox.*, or instanceSandbox.get.
+    #
+    # Parameters:
+    # *  {string} instanceId - ID associated with the instance
+    # *  {string} instanceSandboxId - ID associated with the sandbox user
+    # *  {string} summaryExclude - Comma-separated list of summary fields to exclude from user summary
+    # *  {string} summaryInclude - Comma-separated list of summary fields to include in user summary
+    # *  {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 - A single sandbox user (https://api.losant.com/#/definitions/instanceSandbox)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if sandbox 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("instanceId is required") unless params.has_key?(:instanceId)
+      raise ArgumentError.new("instanceSandboxId is required") unless params.has_key?(:instanceSandboxId)
+
+      query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
+      query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
+      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 = "/instances/#{params[:instanceId]}/sandboxes/#{params[:instanceSandboxId]}"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Restores a sandbox user account
+    #
+    # 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.Instance, all.User, instanceSandbox.*, or instanceSandbox.undelete.
+    #
+    # Parameters:
+    # *  {string} instanceId - ID associated with the instance
+    # *  {string} instanceSandboxId - ID associated with the sandbox user
+    # *  {string} summaryExclude - Comma-separated list of summary fields to exclude from user summary
+    # *  {string} summaryInclude - Comma-separated list of summary fields to include in user summary
+    # *  {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 - A single restored sandbox user (https://api.losant.com/#/definitions/instanceSandbox)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if sandbox was not found (https://api.losant.com/#/definitions/error)
+    def undelete(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
+      raise ArgumentError.new("instanceSandboxId is required") unless params.has_key?(:instanceSandboxId)
+
+      query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
+      query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
+      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 = "/instances/#{params[:instanceId]}/sandboxes/#{params[:instanceSandboxId]}/undelete"
+
+      @client.request(
+        method: :patch,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+  end
+end

data/lib/losant_rest/instance_sandboxes.rb

@@ -0,0 +1,94 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2022 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 Instance Sandboxes Resource
+  class InstanceSandboxes
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Returns a collection of instance sandboxes
+    #
+    # 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.Instance, all.Instance.read, all.User, all.User.read, instanceSandboxes.*, or instanceSandboxes.get.
+    #
+    # Parameters:
+    # *  {string} instanceId - ID associated with the instance
+    # *  {string} sortField - Field to sort the results by. Accepted values are: firstName, lastName, email, id, creationDate, lastSuccessfulLogin, lastFailedLogin, failedLoginCount, lastUpdated
+    # *  {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
+    # *  {string} startingAfterId - Exclusive ID from which to begin querying
+    # *  {string} endingBeforeId - Exclusive ID at which to end querying
+    # *  {string} limit - How many items to return
+    # *  {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: firstName, lastName, email
+    # *  {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
+    # *  {string} includeDeleted - If the result of the request should also include deleted sandboxes.
+    # *  {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 instance sandboxes (https://api.losant.com/#/definitions/instanceSandboxes)
+    #
+    # 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
+
+      raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
+
+      query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
+      query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
+      query_params[:startingAfterId] = params[:startingAfterId] if params.has_key?(:startingAfterId)
+      query_params[:endingBeforeId] = params[:endingBeforeId] if params.has_key?(:endingBeforeId)
+      query_params[:limit] = params[:limit] if params.has_key?(:limit)
+      query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
+      query_params[:filter] = params[:filter] if params.has_key?(:filter)
+      query_params[:includeDeleted] = params[:includeDeleted] if params.has_key?(:includeDeleted)
+      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 = "/instances/#{params[:instanceId]}/sandboxes"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+  end
+end

data/lib/losant_rest/version.rb

@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module LosantRest
-  VERSION = "1.15.2"
+  VERSION = "1.16.2"
 end

data/lib/losant_rest.rb

@@ -81,6 +81,8 @@ require_relative "losant_rest/flows"
 require_relative "losant_rest/instance"
 require_relative "losant_rest/instance_api_token"
 require_relative "losant_rest/instance_api_tokens"
+require_relative "losant_rest/instance_custom_node"
+require_relative "losant_rest/instance_custom_nodes"
 require_relative "losant_rest/instance_member"
 require_relative "losant_rest/instance_members"
 require_relative "losant_rest/instance_org"
@@ -89,6 +91,8 @@ require_relative "losant_rest/instance_org_invites"
 require_relative "losant_rest/instance_org_member"
 require_relative "losant_rest/instance_org_members"
 require_relative "losant_rest/instance_orgs"
+require_relative "losant_rest/instance_sandbox"
+require_relative "losant_rest/instance_sandboxes"
 require_relative "losant_rest/instances"
 require_relative "losant_rest/integration"
 require_relative "losant_rest/integrations"

data/schemas/apiTokenPost.json

@@ -116,6 +116,7 @@
                   "applicationCertificateAuthorities.post",
                   "applicationDashboard.get",
                   "applicationDashboard.patch",
+                  "applicationDashboard.sendReport",
                   "applicationDashboard.delete",
                   "applicationDashboards.get",
                   "applicationDashboards.post",
@@ -265,6 +266,7 @@
                   "flows.get",
                   "flows.getByVersion",
                   "flows.import",
+                  "flows.palette",
                   "flows.post",
                   "flowVersion.delete",
                   "flowVersion.errors",
@@ -379,7 +381,22 @@
               "instanceApiToken.*",
               "instanceApiToken.get",
               "instanceApiToken.patch",
-              "instanceApiToken.delete"
+              "instanceApiToken.delete",
+              "instanceCustomNodes.*",
+              "instanceCustomNodes.get",
+              "instanceCustomNodes.post",
+              "instanceCustomNode.*",
+              "instanceCustomNode.get",
+              "instanceCustomNode.patch",
+              "instanceCustomNode.delete",
+              "instanceCustomNode.errors",
+              "instanceCustomNode.stats",
+              "instanceSandbox.*",
+              "instanceSandbox.get",
+              "instanceSandbox.delete",
+              "instanceSandbox.undelete",
+              "instanceSandboxes.*",
+              "instanceSandboxes.get"
             ]
           },
           {

data/schemas/application.json

@@ -57,7 +57,7 @@
     },
     "endpointSlug": {
       "type": "string",
-      "minLength": 4,
+      "minLength": 3,
       "maxLength": 63,
       "pattern": "^[0-9a-z-]*$"
     },

data/schemas/applicationApplyTemplatePatch.json

@@ -10,6 +10,11 @@
       "type": "string",
       "format": "email",
       "maxLength": 1024
+    },
+    "callbackUrl": {
+      "type": "string",
+      "format": "uri",
+      "maxLength": 1024
     }
   },
   "required": [

data/schemas/applicationClonePost.json

@@ -40,6 +40,11 @@
       "type": "string",
       "format": "email",
       "maxLength": 1024
+    },
+    "callbackUrl": {
+      "type": "string",
+      "format": "uri",
+      "maxLength": 1024
     }
   },
   "additionalProperties": false

data/schemas/applicationCreationByTemplateResult.json

@@ -62,7 +62,7 @@
         },
         "endpointSlug": {
           "type": "string",
-          "minLength": 4,
+          "minLength": 3,
           "maxLength": 63,
           "pattern": "^[0-9a-z-]*$"
         },

data/schemas/applicationDashboardPost.json

@@ -966,6 +966,147 @@
             ],
             "additionalProperties": false
           },
+          {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string",
+                "maxLength": 48
+              },
+              "title": {
+                "type": "string",
+                "maxLength": 255
+              },
+              "description": {
+                "type": "string",
+                "maxLength": 32767
+              },
+              "applicationId": {
+                "type": "string",
+                "pattern": "^[A-Fa-f\\d]{24}$"
+              },
+              "startX": {
+                "type": "number"
+              },
+              "startY": {
+                "type": "number"
+              },
+              "width": {
+                "type": "number"
+              },
+              "height": {
+                "type": "number"
+              },
+              "blockType": {
+                "type": "string",
+                "enum": [
+                  "device-count"
+                ]
+              },
+              "config": {
+                "type": "object",
+                "properties": {
+                  "segments": {
+                    "type": "array",
+                    "minItems": 1,
+                    "maxItems": 100,
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "id": {
+                          "type": "string",
+                          "maxLength": 48
+                        },
+                        "query": {
+                          "type": "string",
+                          "maxLength": 32767
+                        }
+                      },
+                      "required": [
+                        "id",
+                        "query"
+                      ],
+                      "additionalProperties": false
+                    }
+                  },
+                  "conditions": {
+                    "type": "array",
+                    "maxItems": 100,
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "color": {
+                          "type": "string",
+                          "maxLength": 64
+                        },
+                        "id": {
+                          "type": "string",
+                          "maxLength": 48
+                        },
+                        "label": {
+                          "type": "string",
+                          "maxLength": 32767
+                        },
+                        "condition": {
+                          "type": "string",
+                          "maxLength": 2048
+                        },
+                        "imageUrl": {
+                          "type": "string",
+                          "maxLength": 32767
+                        },
+                        "shape": {
+                          "type": "string",
+                          "enum": [
+                            "circle",
+                            "square",
+                            "triangle-down",
+                            "triangle-up",
+                            "octagon"
+                          ]
+                        }
+                      },
+                      "additionalProperties": false
+                    }
+                  },
+                  "defaultCondition": {
+                    "type": "object",
+                    "properties": {
+                      "color": {
+                        "type": "string",
+                        "maxLength": 64
+                      },
+                      "label": {
+                        "type": "string",
+                        "maxLength": 32767
+                      },
+                      "value": {
+                        "type": "string",
+                        "maxLength": 32767
+                      }
+                    },
+                    "required": [
+                      "color"
+                    ],
+                    "additionalProperties": false
+                  }
+                },
+                "required": [
+                  "segments",
+                  "defaultCondition"
+                ],
+                "additionalProperties": false
+              }
+            },
+            "required": [
+              "blockType",
+              "startX",
+              "startY",
+              "width",
+              "height"
+            ],
+            "additionalProperties": false
+          },
           {
             "type": "object",
             "properties": {
@@ -5318,6 +5459,11 @@
               "maxLength": 1024
             }
           },
+          "callbackUrl": {
+            "type": "string",
+            "format": "uri",
+            "maxLength": 1024
+          },
           "subject": {
             "type": "string",
             "maxLength": 255
@@ -5340,12 +5486,28 @@
           "locale": {
             "type": "string",
             "maxLength": 5
+          },
+          "ctx": {
+            "ref": "#/definitions/dashboardContextInstance"
+          },
+          "branded": {
+            "type": "boolean"
           }
         },
         "additionalProperties": false,
-        "required": [
-          "cron",
-          "toEmail"
+        "anyOf": [
+          {
+            "required": [
+              "cron",
+              "toEmail"
+            ]
+          },
+          {
+            "required": [
+              "cron",
+              "callbackUrl"
+            ]
+          }
         ]
       }
     },

data/schemas/applicationExportPost.json

@@ -18,6 +18,11 @@
       "type": "string",
       "format": "email",
       "maxLength": 1024
+    },
+    "callbackUrl": {
+      "type": "string",
+      "format": "uri",
+      "maxLength": 1024
     }
   },
   "additionalProperties": false

data/schemas/applicationImportOptions.json

@@ -0,0 +1,43 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "importUrl": {
+      "type": "string",
+      "format": "uri",
+      "maxLength": 1024
+    },
+    "callbackUrl": {
+      "type": "string",
+      "format": "uri",
+      "maxLength": 1024
+    },
+    "include": {
+      "type": "array",
+      "items": {
+        "enum": [
+          "ApplicationCertificateAuthority",
+          "Dashboard",
+          "DataTableRow",
+          "DataTable",
+          "DeviceRecipe",
+          "Device",
+          "ExperienceEndpoint",
+          "ExperienceFlowVersion",
+          "ExperienceGroup",
+          "ExperienceUser",
+          "ExperienceVersion",
+          "ExperienceView",
+          "File",
+          "FlowVersion",
+          "Flow",
+          "Integration",
+          "Notebook",
+          "Webhook"
+        ]
+      },
+      "uniqueItems": true
+    }
+  },
+  "additionalProperties": false
+}

data/schemas/applicationPatch.json

@@ -13,7 +13,7 @@
     },
     "endpointSlug": {
       "type": "string",
-      "minLength": 4,
+      "minLength": 3,
       "maxLength": 63,
       "pattern": "^[0-9a-z-]*$"
     },

data/schemas/applicationPost.json

@@ -29,7 +29,7 @@
     },
     "endpointSlug": {
       "type": "string",
-      "minLength": 4,
+      "minLength": 3,
       "maxLength": 63,
       "pattern": "^[0-9a-z-]*$"
     },

data/schemas/applicationSearchResult.json

@@ -39,7 +39,8 @@
           "file",
           "flow",
           "integration",
-          "webhook"
+          "webhook",
+          "notebook"
         ]
       }
     },