losant_rest 1.10.1 → 1.11.1

data/lib/losant_rest/experience_endpoints.rb

@@ -148,6 +148,7 @@ module LosantRest
     # *  {string} applicationId - ID associated with the application
     # *  {string} statGrouping - Field to group the statistics by. Accepted values are: statusCode, endpointId, version, domain
     # *  {string} duration - Duration in milliseconds
+    # *  {string} end - End of time range in milliseconds since epoch
     # *  {string} resolution - Resolution in milliseconds
     # *  {string} versionFilter - Filters the stats to a particular experience version
     # *  {string} domainFilter - Filters the stats to a particular experience domain or slug
@@ -174,6 +175,7 @@ module LosantRest
 
       query_params[:statGrouping] = params[:statGrouping] if params.has_key?(:statGrouping)
       query_params[:duration] = params[:duration] if params.has_key?(:duration)
+      query_params[:end] = params[:end] if params.has_key?(:end)
       query_params[:resolution] = params[:resolution] if params.has_key?(:resolution)
       query_params[:versionFilter] = params[:versionFilter] if params.has_key?(:versionFilter)
       query_params[:domainFilter] = params[:domainFilter] if params.has_key?(:domainFilter)

data/lib/losant_rest/file.rb

@@ -52,7 +52,7 @@ module LosantRest
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
-    # *  404 - Error if event was not found (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if file 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 }
@@ -146,7 +146,7 @@ module LosantRest
     #
     # 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)
+    # *  404 - Error if file was not found (https://api.losant.com/#/definitions/error)
     def move(params = {})
       params = Utils.symbolize_hash_keys(params)
       query_params = { _actions: false, _links: true, _embedded: true }
@@ -195,7 +195,7 @@ module LosantRest
     #
     # 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)
+    # *  404 - Error if file was not found (https://api.losant.com/#/definitions/error)
     def patch(params = {})
       params = Utils.symbolize_hash_keys(params)
       query_params = { _actions: false, _links: true, _embedded: true }

data/lib/losant_rest/flow.rb

@@ -123,6 +123,64 @@ module LosantRest
         body: body)
     end
 
+    # Get information about errors that occurred during runs of this workflow
+    #
+    # 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, flow.*, or flow.errors.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} flowId - ID associated with the flow
+    # *  {string} duration - Duration of time range in milliseconds
+    # *  {string} end - End of time range in milliseconds since epoch
+    # *  {string} limit - Maximum number of errors to return
+    # *  {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
+    # *  {string} flowVersion - Flow version name or ID. When not included, will be errors for all versions. Pass develop for just the develop version.
+    # *  {string} deviceId - For edge workflows, the Device ID to return workflow errors for. When not included, will be errors for all device IDs.
+    # *  {string} 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 - Workflow error information (https://api.losant.com/#/definitions/flowErrors)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if flow was not found (https://api.losant.com/#/definitions/error)
+    def errors(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("flowId is required") unless params.has_key?(:flowId)
+
+      query_params[:duration] = params[:duration] if params.has_key?(:duration)
+      query_params[:end] = params[:end] if params.has_key?(:end)
+      query_params[:limit] = params[:limit] if params.has_key?(:limit)
+      query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
+      query_params[:flowVersion] = params[:flowVersion] if params.has_key?(:flowVersion)
+      query_params[:deviceId] = params[:deviceId] if params.has_key?(:deviceId)
+      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]}/flows/#{params[:flowId]}/errors"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Retrieves information on a flow
     #
     # Authentication:
@@ -194,7 +252,7 @@ module LosantRest
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
-    # *  404 - Error if device was not found (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if flow was not found (https://api.losant.com/#/definitions/error)
     def get_log_entries(params = {})
       params = Utils.symbolize_hash_keys(params)
       query_params = { _actions: false, _links: true, _embedded: true }
@@ -416,5 +474,61 @@ module LosantRest
         body: body)
     end
 
+    # Get statistics about workflow runs for this workflow
+    #
+    # 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, flow.*, or flow.stats.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} flowId - ID associated with the flow
+    # *  {string} duration - Duration of time range in milliseconds
+    # *  {string} end - End of time range in milliseconds since epoch
+    # *  {string} resolution - Resolution in milliseconds
+    # *  {string} flowVersion - Flow version name or ID. When not included, will be aggregate for all versions. Pass develop for just the develop version.
+    # *  {string} deviceId - For edge workflows, the device ID to return workflow stats for. When not included, will be aggregate for all device IDs.
+    # *  {string} 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 - Statistics for workflow runs (https://api.losant.com/#/definitions/flowStats)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if flow was not found (https://api.losant.com/#/definitions/error)
+    def stats(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("flowId is required") unless params.has_key?(:flowId)
+
+      query_params[:duration] = params[:duration] if params.has_key?(:duration)
+      query_params[:end] = params[:end] if params.has_key?(:end)
+      query_params[:resolution] = params[:resolution] if params.has_key?(:resolution)
+      query_params[:flowVersion] = params[:flowVersion] if params.has_key?(:flowVersion)
+      query_params[:deviceId] = params[:deviceId] if params.has_key?(:deviceId)
+      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]}/flows/#{params[:flowId]}/stats"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
   end
 end

data/lib/losant_rest/flow_version.rb

@@ -79,6 +79,64 @@ module LosantRest
         body: body)
     end
 
+    # Get information about errors that occurred during runs of this workflow version
+    #
+    # 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, flowVersion.*, or flowVersion.errors.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} flowId - ID associated with the flow
+    # *  {string} flowVersionId - Version ID or version name associated with the flow version
+    # *  {string} duration - Duration of time range in milliseconds
+    # *  {string} end - End of time range in milliseconds since epoch
+    # *  {string} limit - Maximum number of errors to return
+    # *  {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
+    # *  {string} deviceId - For edge workflows, the Device ID to return workflow errors for. When not included, will be errors for all device IDs.
+    # *  {string} losantdomain - Domain scope of request (rarely needed)
+    # *  {boolean} _actions - Return resource actions in response
+    # *  {boolean} _links - Return resource link in response
+    # *  {boolean} _embedded - Return embedded resources in response
+    #
+    # Responses:
+    # *  200 - Workflow error information (https://api.losant.com/#/definitions/flowErrors)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if flow version was not found (https://api.losant.com/#/definitions/error)
+    def errors(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("flowId is required") unless params.has_key?(:flowId)
+      raise ArgumentError.new("flowVersionId is required") unless params.has_key?(:flowVersionId)
+
+      query_params[:duration] = params[:duration] if params.has_key?(:duration)
+      query_params[:end] = params[:end] if params.has_key?(:end)
+      query_params[:limit] = params[:limit] if params.has_key?(:limit)
+      query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
+      query_params[:deviceId] = params[:deviceId] if params.has_key?(:deviceId)
+      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]}/flows/#{params[:flowId]}/versions/#{params[:flowVersionId]}/errors"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Retrieves information on a flow version
     #
     # Authentication:
@@ -153,7 +211,7 @@ module LosantRest
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
-    # *  404 - Error if device was not found (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if flow version was not found (https://api.losant.com/#/definitions/error)
     def get_log_entries(params = {})
       params = Utils.symbolize_hash_keys(params)
       query_params = { _actions: false, _links: true, _embedded: true }
@@ -234,5 +292,61 @@ module LosantRest
         body: body)
     end
 
+    # Get statistics about workflow runs for this workflow version
+    #
+    # 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, flowVersion.*, or flowVersion.stats.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} flowId - ID associated with the flow
+    # *  {string} flowVersionId - Version ID or version name associated with the flow version
+    # *  {string} duration - Duration of time range in milliseconds
+    # *  {string} end - End of time range in milliseconds since epoch
+    # *  {string} resolution - Resolution in milliseconds
+    # *  {string} deviceId - For edge workflows, the device ID to return workflow stats for. When not included, will be aggregate for all device IDs.
+    # *  {string} losantdomain - Domain scope of request (rarely needed)
+    # *  {boolean} _actions - Return resource actions in response
+    # *  {boolean} _links - Return resource link in response
+    # *  {boolean} _embedded - Return embedded resources in response
+    #
+    # Responses:
+    # *  200 - Statistics for workflow runs (https://api.losant.com/#/definitions/flowStats)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if flow version was not found (https://api.losant.com/#/definitions/error)
+    def stats(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("flowId is required") unless params.has_key?(:flowId)
+      raise ArgumentError.new("flowVersionId is required") unless params.has_key?(:flowVersionId)
+
+      query_params[:duration] = params[:duration] if params.has_key?(:duration)
+      query_params[:end] = params[:end] if params.has_key?(:end)
+      query_params[:resolution] = params[:resolution] if params.has_key?(:resolution)
+      query_params[:deviceId] = params[:deviceId] if params.has_key?(:deviceId)
+      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]}/flows/#{params[:flowId]}/versions/#{params[:flowVersionId]}/stats"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
   end
 end

data/lib/losant_rest/flow_versions.rb

@@ -49,6 +49,7 @@ module LosantRest
     # *  {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: version
     # *  {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
     # *  {string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by the returned workflows
+    # *  {hash} query - Workflow filter JSON object which overrides the filterField and filter parameters. (https://api.losant.com/#/definitions/advancedFlowVersionQuery)
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -76,6 +77,8 @@ module LosantRest
       query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
       query_params[:filter] = params[:filter] if params.has_key?(:filter)
       query_params[:includeCustomNodes] = params[:includeCustomNodes] if params.has_key?(:includeCustomNodes)
+      query_params[:query] = params[:query] if params.has_key?(:query)
+      query_params[:query] = JSON.dump(query_params[:query]) if query_params.has_key?(:query)
       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/losant_rest/flows.rb

@@ -50,6 +50,7 @@ module LosantRest
     # *  {string} flowClass - Filter the workflows by the given flow class. Accepted values are: edge, cloud, customNode, experience
     # *  {hash} triggerFilter - Array of triggers to filter by - always filters against default flow version. (https://api.losant.com/#/definitions/flowTriggerFilter)
     # *  {string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by the returned workflows
+    # *  {hash} query - Workflow filter JSON object which overrides the filterField, filter, triggerFilter, and flowClass parameters. (https://api.losant.com/#/definitions/advancedFlowQuery)
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -78,6 +79,8 @@ module LosantRest
       query_params[:flowClass] = params[:flowClass] if params.has_key?(:flowClass)
       query_params[:triggerFilter] = params[:triggerFilter] if params.has_key?(:triggerFilter)
       query_params[:includeCustomNodes] = params[:includeCustomNodes] if params.has_key?(:includeCustomNodes)
+      query_params[:query] = params[:query] if params.has_key?(:query)
+      query_params[:query] = JSON.dump(query_params[:query]) if query_params.has_key?(:query)
       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)
@@ -113,6 +116,7 @@ module LosantRest
     # *  {string} version - Return the workflow versions for the given version.
     # *  {hash} triggerFilter - Array of triggers to filter by - always filters against default flow version. (https://api.losant.com/#/definitions/flowTriggerFilter)
     # *  {string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by the returned workflows
+    # *  {hash} query - Workflow filter JSON object which overrides the filterField, filter, triggerFilter, and flowClass parameters. (https://api.losant.com/#/definitions/advancedFlowByVersionQuery)
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -143,6 +147,8 @@ module LosantRest
       query_params[:version] = params[:version] if params.has_key?(:version)
       query_params[:triggerFilter] = params[:triggerFilter] if params.has_key?(:triggerFilter)
       query_params[:includeCustomNodes] = params[:includeCustomNodes] if params.has_key?(:includeCustomNodes)
+      query_params[:query] = params[:query] if params.has_key?(:query)
+      query_params[:query] = JSON.dump(query_params[:query]) if query_params.has_key?(:query)
       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/losant_rest/me.rb

@@ -248,47 +248,6 @@ module LosantRest
         body: body)
     end
 
-    # Disconnects the user from Twitter
-    #
-    # 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, me.*, or me.disconnectTwitter.
-    #
-    # Parameters:
-    # *  {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 - Updated user information (https://api.losant.com/#/definitions/me)
-    #
-    # Errors:
-    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
-    def disconnect_twitter(params = {})
-      params = Utils.symbolize_hash_keys(params)
-      query_params = { _actions: false, _links: true, _embedded: true }
-      headers = {}
-      body = nil
-
-
-      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/disconnectTwitter"
-
-      @client.request(
-        method: :patch,
-        path: path,
-        query: query_params,
-        headers: headers,
-        body: body)
-    end
-
     # Enables two factor auth for the current user
     #
     # Authentication:

data/lib/losant_rest/version.rb

@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module LosantRest
-  VERSION = "1.10.1"
+  VERSION = "1.11.1"
 end

data/schemas/advancedDeviceQuery.json

@@ -159,6 +159,28 @@
             },
             "$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
@@ -240,6 +262,28 @@
             },
             "$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
@@ -321,6 +365,28 @@
             },
             "$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
@@ -402,6 +468,28 @@
             },
             "$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
@@ -666,6 +754,28 @@
             },
             "$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