losant_rest 1.20.1 → 1.21.1

data/lib/platform_rest/instance_sandbox.rb

@@ -52,7 +52,7 @@ module PlatformRest
     #
     # 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)
+    # *  404 - Error if sandbox or instance 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 }
@@ -77,6 +77,56 @@ module PlatformRest
         body: body)
     end
 
+    # Returns device counts by day for the time range specified for all applications the sandbox user owns
+    #
+    # 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.deviceCounts.
+    #
+    # Parameters:
+    # *  {string} instanceId - ID associated with the instance
+    # *  {string} instanceSandboxId - ID associated with the sandbox user
+    # *  {string} start - Start of range for device count query (ms since epoch)
+    # *  {string} end - End of range for device count query (ms since epoch)
+    # *  {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 - Device counts by day (https://api.losant.com/#/definitions/deviceCounts)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if sandbox or instance was not found (https://api.losant.com/#/definitions/error)
+    def device_counts(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[:start] = params[:start] if params.has_key?(:start)
+      query_params[:end] = params[:end] if params.has_key?(:end)
+      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]}/deviceCounts"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Returns a sandbox user
     #
     # Authentication:
@@ -100,7 +150,7 @@ module PlatformRest
     #
     # 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)
+    # *  404 - Error if sandbox or instance 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 }
@@ -127,6 +177,164 @@ module PlatformRest
         body: body)
     end
 
+    # Returns notebook execution usage by day for the time range specified for all applications the sandbox user owns
+    #
+    # 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.notebookMinuteCounts.
+    #
+    # Parameters:
+    # *  {string} instanceId - ID associated with the instance
+    # *  {string} instanceSandboxId - ID associated with the sandbox user
+    # *  {string} start - Start of range for notebook execution query (ms since epoch)
+    # *  {string} end - End of range for notebook execution query (ms since epoch)
+    # *  {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 - Notebook usage information (https://api.losant.com/#/definitions/notebookMinuteCounts)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if sandbox or instance was not found (https://api.losant.com/#/definitions/error)
+    def notebook_minute_counts(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[:start] = params[:start] if params.has_key?(:start)
+      query_params[:end] = params[:end] if params.has_key?(:end)
+      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]}/notebookMinuteCounts"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Returns payload counts for the time range specified for all applications the sandbox user owns
+    #
+    # 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.payloadCounts.
+    #
+    # Parameters:
+    # *  {string} instanceId - ID associated with the instance
+    # *  {string} instanceSandboxId - ID associated with the sandbox user
+    # *  {string} start - Start of range for payload count query (ms since epoch)
+    # *  {string} end - End of range for payload count query (ms since epoch)
+    # *  {string} asBytes - If the resulting stats should be returned as bytes
+    # *  {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 - Payload counts, by type and source (https://api.losant.com/#/definitions/payloadStats)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if sandbox or instance was not found (https://api.losant.com/#/definitions/error)
+    def payload_counts(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[:start] = params[:start] if params.has_key?(:start)
+      query_params[:end] = params[:end] if params.has_key?(:end)
+      query_params[:asBytes] = params[:asBytes] if params.has_key?(:asBytes)
+      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]}/payloadCounts"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Returns payload counts per resolution in the time range specified for all applications the sandbox user owns
+    #
+    # 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.payloadCountsBreakdown.
+    #
+    # Parameters:
+    # *  {string} instanceId - ID associated with the instance
+    # *  {string} instanceSandboxId - ID associated with the sandbox user
+    # *  {string} start - Start of range for payload count query (ms since epoch)
+    # *  {string} end - End of range for payload count query (ms since epoch)
+    # *  {string} resolution - Resolution in milliseconds. Accepted values are: 86400000, 3600000
+    # *  {string} asBytes - If the resulting stats should be returned as bytes
+    # *  {string} includeNonBillable - If non-billable payloads should be included in the result
+    # *  {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 - Sum of payload counts by date (https://api.losant.com/#/definitions/payloadCountsBreakdown)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if sandbox or instance was not found (https://api.losant.com/#/definitions/error)
+    def payload_counts_breakdown(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[:start] = params[:start] if params.has_key?(:start)
+      query_params[:end] = params[:end] if params.has_key?(:end)
+      query_params[:resolution] = params[:resolution] if params.has_key?(:resolution)
+      query_params[:asBytes] = params[:asBytes] if params.has_key?(:asBytes)
+      query_params[:includeNonBillable] = params[:includeNonBillable] if params.has_key?(:includeNonBillable)
+      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]}/payloadCountsBreakdown"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Restores a sandbox user account
     #
     # Authentication:
@@ -150,7 +358,7 @@ module PlatformRest
     #
     # 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)
+    # *  404 - Error if sandbox or instance 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 }

data/lib/platform_rest/me.rb

@@ -659,6 +659,7 @@ module PlatformRest
     # Parameters:
     # *  {string} start - Start of range for payload count query (ms since epoch)
     # *  {string} end - End of range for payload count query (ms since epoch)
+    # *  {string} asBytes - If the resulting stats should be returned as bytes
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -678,6 +679,7 @@ module PlatformRest
 
       query_params[:start] = params[:start] if params.has_key?(:start)
       query_params[:end] = params[:end] if params.has_key?(:end)
+      query_params[:asBytes] = params[:asBytes] if params.has_key?(:asBytes)
       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)

data/lib/platform_rest/org.rb

@@ -380,6 +380,7 @@ module PlatformRest
     # *  {string} orgId - ID associated with the organization
     # *  {string} start - Start of range for payload count query (ms since epoch)
     # *  {string} end - End of range for payload count query (ms since epoch)
+    # *  {string} asBytes - If the resulting stats should be returned as bytes
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -401,6 +402,7 @@ module PlatformRest
 
       query_params[:start] = params[:start] if params.has_key?(:start)
       query_params[:end] = params[:end] if params.has_key?(:end)
+      query_params[:asBytes] = params[:asBytes] if params.has_key?(:asBytes)
       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)

data/lib/platform_rest/version.rb

@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module PlatformRest
-  VERSION = "1.20.1"
+  VERSION = "1.21.1"
 end

data/lib/platform_rest.rb

@@ -89,6 +89,8 @@ require_relative "platform_rest/instance_custom_node"
 require_relative "platform_rest/instance_custom_nodes"
 require_relative "platform_rest/instance_member"
 require_relative "platform_rest/instance_members"
+require_relative "platform_rest/instance_notification_rule"
+require_relative "platform_rest/instance_notification_rules"
 require_relative "platform_rest/instance_org"
 require_relative "platform_rest/instance_org_invite"
 require_relative "platform_rest/instance_org_invites"

data/schemas/advancedDeviceQuery.json

@@ -334,6 +334,109 @@
         }
       ]
     },
+    "deletedAt": {
+      "oneOf": [
+        {
+          "type": [
+            "string",
+            "number",
+            "boolean",
+            "null"
+          ]
+        },
+        {
+          "type": "object",
+          "properties": {
+            "$eq": {
+              "type": [
+                "string",
+                "number",
+                "boolean",
+                "null"
+              ]
+            },
+            "$ne": {
+              "type": [
+                "string",
+                "number",
+                "boolean",
+                "null"
+              ]
+            },
+            "$gt": {
+              "type": [
+                "string",
+                "number",
+                "boolean",
+                "null"
+              ]
+            },
+            "$lt": {
+              "type": [
+                "string",
+                "number",
+                "boolean",
+                "null"
+              ]
+            },
+            "$gte": {
+              "type": [
+                "string",
+                "number",
+                "boolean",
+                "null"
+              ]
+            },
+            "$lte": {
+              "type": [
+                "string",
+                "number",
+                "boolean",
+                "null"
+              ]
+            },
+            "$startsWith": {
+              "type": "string",
+              "minLength": 1
+            },
+            "$endsWith": {
+              "type": "string",
+              "minLength": 1
+            },
+            "$contains": {
+              "type": "string",
+              "minLength": 1
+            },
+            "$ci": {
+              "type": "boolean"
+            },
+            "$in": {
+              "type": "array",
+              "maxItems": 100,
+              "items": {
+                "type": [
+                  "string",
+                  "number",
+                  "boolean"
+                ]
+              }
+            },
+            "$nin": {
+              "type": "array",
+              "maxItems": 100,
+              "items": {
+                "type": [
+                  "string",
+                  "number",
+                  "boolean"
+                ]
+              }
+            }
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
     "name": {
       "oneOf": [
         {

data/schemas/apiTokenPost.json

@@ -185,6 +185,7 @@
                   "devices.attributeNames",
                   "devices.patch",
                   "devices.delete",
+                  "devices.restore",
                   "devices.removeData",
                   "devices.detailedSummary",
                   "devices.deviceNames",
@@ -379,6 +380,7 @@
               "instance.patch",
               "instance.historicalSummaries",
               "instance.generateReport",
+              "instance.payloadCounts",
               "instance.payloadCountsBreakdown",
               "instance.deviceCounts",
               "instance.notebookMinuteCounts",
@@ -386,6 +388,7 @@
               "instanceOrg.get",
               "instanceOrg.patch",
               "instanceOrg.delete",
+              "instanceOrg.payloadCounts",
               "instanceOrg.payloadCountsBreakdown",
               "instanceOrg.deviceCounts",
               "instanceOrg.notebookMinuteCounts",
@@ -430,10 +433,23 @@
               "instanceCustomNode.delete",
               "instanceCustomNode.errors",
               "instanceCustomNode.stats",
+              "instanceNotificationRules.*",
+              "instanceNotificationRules.get",
+              "instanceNotificationRules.post",
+              "instanceNotificationRule.*",
+              "instanceNotificationRule.get",
+              "instanceNotificationRule.patch",
+              "instanceNotificationRule.delete",
+              "instanceNotificationRule.evaluate",
+              "instanceNotificationRule.logs",
               "instanceSandbox.*",
               "instanceSandbox.get",
               "instanceSandbox.delete",
               "instanceSandbox.undelete",
+              "instanceSandbox.payloadCounts",
+              "instanceSandbox.payloadCountsBreakdown",
+              "instanceSandbox.deviceCounts",
+              "instanceSandbox.notebookMinuteCounts",
               "instanceSandboxes.*",
               "instanceSandboxes.get",
               "instanceAuditLog.*",

data/schemas/applicationSearchResult.json

@@ -12,18 +12,57 @@
         "type": "string"
       },
       "metadata": {
-        "type": "object"
-      },
-      "viewType": {
-        "type": "string"
+        "type": "object",
+        "properties": {
+          "descriptor": {
+            "type": "string"
+          },
+          "parentDirectory": {
+            "type": "string"
+          },
+          "contentType": {
+            "type": "string"
+          }
+        }
       },
       "version": {
         "type": "string"
       },
+      "viewType": {
+        "type": "string",
+        "enum": [
+          "layout",
+          "page",
+          "component"
+        ]
+      },
+      "flowClass": {
+        "type": "string",
+        "enum": [
+          "standalone",
+          "gateway",
+          "peripheral",
+          "floating",
+          "edgeCompute",
+          "system",
+          "embedded"
+        ]
+      },
+      "deviceClass": {
+        "type": "string",
+        "enum": [
+          "cloud",
+          "edge",
+          "embedded",
+          "experience",
+          "customNode"
+        ]
+      },
       "_type": {
         "type": "string",
         "enum": [
           "applicationApiToken",
+          "credential",
           "dashboard",
           "dataTable",
           "deviceRecipe",
@@ -39,8 +78,9 @@
           "file",
           "flow",
           "integration",
-          "webhook",
-          "notebook"
+          "notebook",
+          "resourceJob",
+          "webhook"
         ]
       }
     },

data/schemas/bulkRestoreResponse.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "restored": {
+      "type": "number"
+    },
+    "failed": {
+      "type": "number"
+    }
+  }
+}

data/schemas/credentialLinkedResources.json

@@ -798,6 +798,10 @@
                                 }
                               },
                               "maxItems": 100
+                            },
+                            "configName": {
+                              "type": "string",
+                              "maxLength": 1024
                             }
                           },
                           "additionalProperties": false
@@ -3925,6 +3929,10 @@
                                     }
                                   },
                                   "maxItems": 100
+                                },
+                                "configName": {
+                                  "type": "string",
+                                  "maxLength": 1024
                                 }
                               },
                               "additionalProperties": false
@@ -6961,6 +6969,10 @@
                                     }
                                   },
                                   "maxItems": 100
+                                },
+                                "configName": {
+                                  "type": "string",
+                                  "maxLength": 1024
                                 }
                               },
                               "additionalProperties": false

data/schemas/dataExport.json

@@ -376,6 +376,109 @@
             }
           ]
         },
+        "deletedAt": {
+          "oneOf": [
+            {
+              "type": [
+                "string",
+                "number",
+                "boolean",
+                "null"
+              ]
+            },
+            {
+              "type": "object",
+              "properties": {
+                "$eq": {
+                  "type": [
+                    "string",
+                    "number",
+                    "boolean",
+                    "null"
+                  ]
+                },
+                "$ne": {
+                  "type": [
+                    "string",
+                    "number",
+                    "boolean",
+                    "null"
+                  ]
+                },
+                "$gt": {
+                  "type": [
+                    "string",
+                    "number",
+                    "boolean",
+                    "null"
+                  ]
+                },
+                "$lt": {
+                  "type": [
+                    "string",
+                    "number",
+                    "boolean",
+                    "null"
+                  ]
+                },
+                "$gte": {
+                  "type": [
+                    "string",
+                    "number",
+                    "boolean",
+                    "null"
+                  ]
+                },
+                "$lte": {
+                  "type": [
+                    "string",
+                    "number",
+                    "boolean",
+                    "null"
+                  ]
+                },
+                "$startsWith": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "$endsWith": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "$contains": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "$ci": {
+                  "type": "boolean"
+                },
+                "$in": {
+                  "type": "array",
+                  "maxItems": 100,
+                  "items": {
+                    "type": [
+                      "string",
+                      "number",
+                      "boolean"
+                    ]
+                  }
+                },
+                "$nin": {
+                  "type": "array",
+                  "maxItems": 100,
+                  "items": {
+                    "type": [
+                      "string",
+                      "number",
+                      "boolean"
+                    ]
+                  }
+                }
+              },
+              "additionalProperties": false
+            }
+          ]
+        },
         "name": {
           "oneOf": [
             {