losant_rest 1.17.5 → 1.18.0

data/lib/losant_rest/instance.rb

@@ -319,5 +319,59 @@ module LosantRest
         body: body)
     end
 
+    # Returns payload counts per resolution in the time range specified for this instance
+    #
+    # 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, instance.*, or instance.payloadCountsBreakdown.
+    #
+    # Parameters:
+    # *  {string} instanceId - ID associated with the instance
+    # *  {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 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)
+
+      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]}/payloadCountsBreakdown"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
   end
 end

data/lib/losant_rest/instance_org.rb

@@ -276,5 +276,61 @@ module LosantRest
         body: body)
     end
 
+    # Returns payload counts per resolution in the time range specified for all application this organization 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, instanceOrg.*, or instanceOrg.payloadCountsBreakdown.
+    #
+    # Parameters:
+    # *  {string} instanceId - ID associated with the instance
+    # *  {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} 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 - Payload counts, by type and source (https://api.losant.com/#/definitions/payloadCountsBreakdown)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if 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("orgId is required") unless params.has_key?(:orgId)
+
+      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]}/orgs/#{params[:orgId]}/payloadCountsBreakdown"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
   end
 end

data/lib/losant_rest/me.rb

@@ -608,6 +608,57 @@ module LosantRest
         body: body)
     end
 
+    # Returns payload counts per resolution in the time range specified for all applications the current 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.User, all.User.read, me.*, or me.payloadCountsBreakdown.
+    #
+    # 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} 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)
+    def payload_counts_breakdown(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+
+      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 = "/me/payloadCountsBreakdown"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Returns a new auth token based on the current auth token
     #
     # Authentication:

data/lib/losant_rest/org.rb

@@ -416,6 +416,60 @@ module LosantRest
         body: body)
     end
 
+    # Returns payload counts per resolution in the time range specified for all application this organization 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.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.payloadCountsBreakdown.
+    #
+    # Parameters:
+    # *  {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} 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 organization 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("orgId is required") unless params.has_key?(:orgId)
+
+      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 = "/orgs/#{params[:orgId]}/payloadCountsBreakdown"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Gets the current pending invites
     #
     # Authentication:

data/lib/losant_rest/version.rb

@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module LosantRest
-  VERSION = "1.17.5"
+  VERSION = "1.18.0"
 end

data/schemas/advancedFlowQuery.json

@@ -965,6 +965,109 @@
           "additionalProperties": false
         }
       ]
+    },
+    "customNodeSupports": {
+      "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
+        }
+      ]
     }
   },
   "additionalProperties": false

data/schemas/advancedFlowVersionQuery.json

@@ -963,6 +963,109 @@
           "additionalProperties": false
         }
       ]
+    },
+    "customNodeSupports": {
+      "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
+        }
+      ]
     }
   },
   "additionalProperties": false

data/schemas/apiTokenPost.json

@@ -100,6 +100,7 @@
                   "application.mqttSubscriptionStream",
                   "application.patch",
                   "application.payloadCounts",
+                  "application.payloadCountsBreakdown",
                   "application.deviceCounts",
                   "application.notebookMinuteCounts",
                   "application.search",
@@ -159,6 +160,7 @@
                   "device.getState",
                   "device.patch",
                   "device.payloadCounts",
+                  "device.payloadCountsBreakdown",
                   "device.removeData",
                   "device.sendCommand",
                   "device.sendState",
@@ -178,6 +180,7 @@
                   "devices.deviceNames",
                   "devices.export",
                   "devices.get",
+                  "devices.getCompositeState",
                   "devices.payloadCounts",
                   "devices.post",
                   "devices.sendCommand",
@@ -342,6 +345,7 @@
                   "org.modifyMember",
                   "org.removeMember",
                   "org.payloadCounts",
+                  "org.payloadCountsBreakdown",
                   "org.deviceCounts",
                   "org.notebookMinuteCounts",
                   "org.invoices",
@@ -362,12 +366,14 @@
               "instance.patch",
               "instance.historicalSummaries",
               "instance.generateReport",
+              "instance.payloadCountsBreakdown",
               "instance.deviceCounts",
               "instance.notebookMinuteCounts",
               "instanceOrg.*",
               "instanceOrg.get",
               "instanceOrg.patch",
               "instanceOrg.delete",
+              "instanceOrg.payloadCountsBreakdown",
               "instanceOrg.deviceCounts",
               "instanceOrg.notebookMinuteCounts",
               "instanceOrgs.*",
@@ -453,6 +459,7 @@
               "me.addRecentItem",
               "me.fetchRecentItems",
               "me.payloadCounts",
+              "me.payloadCountsBreakdown",
               "me.deviceCounts",
               "me.notebookMinuteCounts",
               "me.transferResources",

data/schemas/compositeDevicesState.json

@@ -0,0 +1,97 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "items": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "name": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 255
+          },
+          "compositeState": {
+            "title": "Composite Device State",
+            "description": "Schema for a composite Device state",
+            "type": "object",
+            "patternProperties": {
+              "^[0-9a-zA-Z_-]{1,255}$": {
+                "type": "object",
+                "properties": {
+                  "value": {
+                    "type": [
+                      "number",
+                      "string",
+                      "boolean"
+                    ]
+                  },
+                  "time": {
+                    "oneOf": [
+                      {
+                        "type": "string"
+                      },
+                      {
+                        "type": "number"
+                      },
+                      {
+                        "type": "object",
+                        "properties": {
+                          "$date": {
+                            "type": "string"
+                          }
+                        },
+                        "additionalProperties": false,
+                        "required": [
+                          "$date"
+                        ]
+                      }
+                    ]
+                  }
+                }
+              }
+            },
+            "additionalProperties": false
+          }
+        }
+      }
+    },
+    "count": {
+      "type": "integer"
+    },
+    "totalCount": {
+      "type": "integer"
+    },
+    "perPage": {
+      "type": "integer"
+    },
+    "page": {
+      "type": "integer"
+    },
+    "sortField": {
+      "type": "string"
+    },
+    "sortDirection": {
+      "type": "string",
+      "enum": [
+        "asc",
+        "desc",
+        "ASC",
+        "DESC",
+        ""
+      ]
+    },
+    "applicationId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "query": {
+      "type": "object"
+    }
+  }
+}

data/schemas/deviceCredentials.json

@@ -39,6 +39,7 @@
           "device.sendCommand",
           "device.setConnectionStatus",
           "devices.get",
+          "devices.getCompositeState",
           "devices.sendCommand"
         ]
       }

data/schemas/edgeDeployment.json

@@ -48,6 +48,13 @@
       "minLength": 1,
       "maxLength": 255
     },
+    "flowClass": {
+      "type": "string",
+      "enum": [
+        "edge",
+        "customNode"
+      ]
+    },
     "fileName": {
       "type": "string",
       "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"

data/schemas/edgeDeployments.json

@@ -55,6 +55,13 @@
             "minLength": 1,
             "maxLength": 255
           },
+          "flowClass": {
+            "type": "string",
+            "enum": [
+              "edge",
+              "customNode"
+            ]
+          },
           "fileName": {
             "type": "string",
             "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"

data/schemas/experienceLinkedResources.json

@@ -3055,10 +3055,12 @@
               },
               "customNodeSupports": {
                 "type": "array",
+                "maxItems": 1,
                 "items": {
                   "type": "string",
                   "enum": [
-                    "cloud"
+                    "cloud",
+                    "edge"
                   ]
                 }
               },