losant_rest 1.9.2 → 1.10.3

data/lib/losant_rest/auth.rb

@@ -157,5 +157,89 @@ module LosantRest
         body: body)
     end
 
+    # Authenticates a user via a SAML response.
+    #
+    # Authentication:
+    # No api access token is required to call this action.
+    #
+    # Parameters:
+    # *  {hash} saml - Encoded SAML response from an IDP for a user. (https://api.losant.com/#/definitions/samlResponse)
+    # *  {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 - Successful authentication. The included api access token has the scope 'all.User'. (https://api.losant.com/#/definitions/authedUser)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  401 - Unauthorized error if authentication fails (https://api.losant.com/#/definitions/error)
+    def authenticate_user_saml(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("saml is required") unless params.has_key?(:saml)
+
+      body = params[:saml] if params.has_key?(:saml)
+      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 = "/auth/user/saml"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Checks email domain for SSO configuration.
+    #
+    # Authentication:
+    # No api access token is required to call this action.
+    #
+    # Parameters:
+    # *  {string} email - The email address associated with the user login
+    # *  {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 - Successful finding SSO for domain. Returns SSO request URL and type. (https://api.losant.com/#/definitions/ssoRequest)
+    # *  204 - No domain associated with an SSO configuration
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    def sso_domain(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("email is required") unless params.has_key?(:email)
+
+      query_params[:email] = params[:email] if params.has_key?(:email)
+      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 = "/auth/ssoDomain"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
   end
 end

data/lib/losant_rest/client.rb

@@ -27,7 +27,7 @@ module LosantRest
   #
   # User API for accessing Losant data
   #
-  # Built For Version 1.16.2
+  # Built For Version 1.17.3
   class Client
     attr_accessor :auth_token, :url
 
@@ -72,6 +72,10 @@ module LosantRest
       @application_keys ||= ApplicationKeys.new(self)
     end
 
+    def application_templates
+      @application_templates ||= ApplicationTemplates.new(self)
+    end
+
     def applications
       @applications ||= Applications.new(self)
     end
@@ -274,7 +278,7 @@ module LosantRest
 
       headers["Accept"]         = "application/json"
       headers["Content-Type"]   = "application/json"
-      headers["Accept-Version"] = "^1.16.2"
+      headers["Accept-Version"] = "^1.17.3"
       headers["Authorization"]  = "Bearer #{self.auth_token}" if self.auth_token
       path = self.url + options.fetch(:path, "")
 

data/lib/losant_rest/device.rb

@@ -92,6 +92,7 @@ module LosantRest
     # *  {string} end - End time of export (ms since epoch - 0 means now, negative is relative to now)
     # *  {string} email - Email address to send export to. Defaults to current user's email.
     # *  {string} callbackUrl - Callback URL to call with export result
+    # *  {string} includeBlobData - If set will export any blob attributes in base64 form, otherwise they will be downloadable links which will expire.
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -116,6 +117,7 @@ module LosantRest
       query_params[:end] = params[:end] if params.has_key?(:end)
       query_params[:email] = params[:email] if params.has_key?(:email)
       query_params[:callbackUrl] = params[:callbackUrl] if params.has_key?(:callbackUrl)
+      query_params[:includeBlobData] = params[:includeBlobData] if params.has_key?(:includeBlobData)
       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/devices.rb

@@ -31,6 +31,54 @@ module LosantRest
       @client = client
     end
 
+    # Delete devices
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action. The token
+    # must include at least one of the following scopes:
+    # all.Application, all.Organization, all.User, devices.*, or devices.delete.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {hash} options - Object containing device query and email (https://api.losant.com/#/definitions/devicesDeletePost)
+    # *  {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 - Object indicating number of devices deleted or failed (https://api.losant.com/#/definitions/devicesDeleted)
+    # *  202 - If a job was enqueued for the devices to be deleted (https://api.losant.com/#/definitions/jobEnqueuedResult)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if application was not found (https://api.losant.com/#/definitions/error)
+    def delete(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("options is required") unless params.has_key?(:options)
+
+      body = params[:options] if params.has_key?(:options)
+      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]}/devices/delete"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Creates an export of all device metadata
     #
     # Authentication:
@@ -43,6 +91,7 @@ module LosantRest
     # *  {string} applicationId - ID associated with the application
     # *  {string} email - Email address to send export to. Defaults to current user's email.
     # *  {string} callbackUrl - Callback URL to call with export result
+    # *  {hash} options - Object containing device query and optionally email or callback (https://api.losant.com/#/definitions/devicesExportPost)
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -64,6 +113,7 @@ module LosantRest
 
       query_params[:email] = params[:email] if params.has_key?(:email)
       query_params[:callbackUrl] = params[:callbackUrl] if params.has_key?(:callbackUrl)
+      body = params[:options] if params.has_key?(:options)
       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)
@@ -99,6 +149,7 @@ module LosantRest
     # *  {hash} tagFilter - Array of tag pairs to filter by (https://api.losant.com/#/definitions/deviceTagFilter)
     # *  {string} excludeConnectionInfo - If set, do not return connection info
     # *  {string} parentId - Filter devices as children of a given system id
+    # *  {hash} query - Device filter JSON object which overrides the filterField, filter, deviceClass, tagFilter, and parentId parameters. (https://api.losant.com/#/definitions/advancedDeviceQuery)
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -128,6 +179,8 @@ module LosantRest
       query_params[:tagFilter] = params[:tagFilter] if params.has_key?(:tagFilter)
       query_params[:excludeConnectionInfo] = params[:excludeConnectionInfo] if params.has_key?(:excludeConnectionInfo)
       query_params[:parentId] = params[:parentId] if params.has_key?(:parentId)
+      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)
@@ -153,14 +206,15 @@ module LosantRest
     #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
-    # *  {hash} patchInfo - Object containing device filter fields and updated properties (https://api.losant.com/#/definitions/devicesPatch)
+    # *  {hash} patchInfo - Object containing device query or IDs and update operations (https://api.losant.com/#/definitions/devicesPatch)
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  201 - Successfully queued bulk update job (https://api.losant.com/#/definitions/success)
+    # *  200 - Object including an update log link and the number of devices updated, failed, and skipped (https://api.losant.com/#/definitions/devicesUpdated)
+    # *  202 - Successfully queued bulk update job (https://api.losant.com/#/definitions/jobEnqueuedResult)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -172,6 +226,7 @@ module LosantRest
       body = nil
 
       raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
+      raise ArgumentError.new("patchInfo is required") unless params.has_key?(:patchInfo)
 
       body = params[:patchInfo] if params.has_key?(:patchInfo)
       headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
@@ -236,6 +291,54 @@ module LosantRest
         body: body)
     end
 
+    # Removes all device data for the specified time range. Defaults to all data.
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action. The token
+    # must include at least one of the following scopes:
+    # all.Application, all.Organization, all.User, devices.*, or devices.removeData.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {hash} options - Object defining the device data to delete and devices to delete from (https://api.losant.com/#/definitions/devicesRemoveDataPost)
+    # *  {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 - Object indicating number of devices completed or skipped (https://api.losant.com/#/definitions/devicesDataRemoved)
+    # *  202 - If a job was enqueued for device data to be removed (https://api.losant.com/#/definitions/jobEnqueuedResult)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if application was not found (https://api.losant.com/#/definitions/error)
+    def remove_data(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("options is required") unless params.has_key?(:options)
+
+      body = params[:options] if params.has_key?(:options)
+      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]}/devices/removeData"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Send a command to multiple devices
     #
     # Authentication:

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