losant_rest 1.22.1 → 1.22.2

data/docs/applicationJobLog.md

@@ -0,0 +1,49 @@
+# Application Job Log Actions
+
+Details on the various actions that can be performed on the
+Application Job Log resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Get](#get)
+
+<br/>
+
+## Get
+
+Returns the job log for the given ID
+
+```ruby
+result = client.application_job_log.get(
+  applicationId: my_application_id,
+  jobId: my_job_id)
+
+puts result
+```
+
+#### 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, applicationJobLog.*, or applicationJobLog.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| jobId | string | Y | ID associated with the job execution |  | 575ec8687ae143cd83dc4a98 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Application Job Log](_schemas.md#application-job-log) | An application job log |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if application job log was not found |

data/docs/applicationJobLogs.md

@@ -0,0 +1,51 @@
+# Application Job Logs Actions
+
+Details on the various actions that can be performed on the
+Application Job Logs resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Get](#get)
+
+<br/>
+
+## Get
+
+Returns the job logs for an application
+
+```ruby
+result = client.application_job_logs.get(applicationId: my_application_id)
+
+puts result
+```
+
+#### 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, applicationJobLogs.*, or applicationJobLogs.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| sortField | string | N | Field to sort the results by. Accepted values are: name, status, resourceType, runQueuedAt, runStartedAt, runCompletedAt | runQueuedAt | status |
+| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
+| page | string | N | Which page of results to return | 0 | 0 |
+| perPage | string | N | How many items to return per page | 100 | 10 |
+| query | [Advanced Application Job Log Query](_schemas.md#advanced-application-job-log-query) | N | Filter application job logs by a query. |  | [Advanced Application Job Log Query Example](_schemas.md#advanced-application-job-log-query-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Application Job Logs](_schemas.md#application-job-logs) | Collection of application job logs |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if application was not found |

data/docs/data.md

@@ -34,7 +34,7 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
-| query | [Data Export](_schemas.md#data-export) | Y | The query parameters |  | [Data Export Example](_schemas.md#data-export-example) |
+| query | [Devices Data Export](_schemas.md#devices-data-export) | Y | The query parameters |  | [Devices Data Export Example](_schemas.md#devices-data-export-example) |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/docs/device.md

@@ -91,6 +91,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 | email | string | N | Email address to send export to. Defaults to current user's email. |  | email@example.com |
 | callbackUrl | string | N | Callback URL to call with export result |  | https://example.com/cburl |
 | includeBlobData | string | N | If set will export any blob attributes in base64 form, otherwise they will be downloadable links which will expire. |  | true |
+| query | [Device Data Export](_schemas.md#device-data-export) | N | The export parameters. When provided overrides any options provided as a query param. |  | [Device Data Export Example](_schemas.md#device-data-export-example) |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/docs/events.md

@@ -36,6 +36,8 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
 | query | [Advanced Event Query](_schemas.md#advanced-event-query) | N | Query to apply to filter the events |  | [Advanced Event Query Example](_schemas.md#advanced-event-query-example) |
+| email | string | N | Email address to send job complete notification to. Defaults to current user's email. |  | email@example.com |
+| callbackUrl | string | N | Callback URL to call with delete result |  | https://example.com/cburl |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses
@@ -43,6 +45,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 | Code | Type | Description |
 | ---- | ---- | ----------- |
 | 200 | [Events Deleted](_schemas.md#events-deleted) | If request successfully deletes a set of Events |
+| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If a bulk delete job has been enqueued |
 
 #### Error Responses
 

data/lib/platform_rest/application_job_log.rb

@@ -0,0 +1,81 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2024 Losant IoT, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require "json"
+
+module PlatformRest
+
+  # Class containing all the actions for the Application Job Log Resource
+  class ApplicationJobLog
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Returns the job log for the given ID
+    #
+    # 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, applicationJobLog.*, or applicationJobLog.get.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} jobId - ID associated with the job execution
+    # *  {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 - An application job log (https://api.losant.com/#/definitions/applicationJobLog)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if application job log was not found (https://api.losant.com/#/definitions/error)
+    def get(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
+      raise ArgumentError.new("jobId is required") unless params.has_key?(:jobId)
+
+      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]}/jobLogs/#{params[:jobId]}"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+  end
+end

data/lib/platform_rest/application_job_logs.rb

@@ -0,0 +1,90 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2024 Losant IoT, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require "json"
+
+module PlatformRest
+
+  # Class containing all the actions for the Application Job Logs Resource
+  class ApplicationJobLogs
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Returns the job logs for an application
+    #
+    # 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, applicationJobLogs.*, or applicationJobLogs.get.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} sortField - Field to sort the results by. Accepted values are: name, status, resourceType, runQueuedAt, runStartedAt, runCompletedAt
+    # *  {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
+    # *  {string} page - Which page of results to return
+    # *  {string} perPage - How many items to return per page
+    # *  {hash} query - Filter application job logs by a query. (https://api.losant.com/#/definitions/advancedApplicationJobLogQuery)
+    # *  {string} losantdomain - Domain scope of request (rarely needed)
+    # *  {boolean} _actions - Return resource actions in response
+    # *  {boolean} _links - Return resource link in response
+    # *  {boolean} _embedded - Return embedded resources in response
+    #
+    # Responses:
+    # *  200 - Collection of application job logs (https://api.losant.com/#/definitions/applicationJobLogs)
+    #
+    # 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 get(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)
+
+      query_params[:sortField] = params[:sortField] if params.has_key?(:sortField)
+      query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
+      query_params[:page] = params[:page] if params.has_key?(:page)
+      query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
+      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)
+      query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
+
+      path = "/applications/#{params[:applicationId]}/jobLogs"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+  end
+end

data/lib/platform_rest/client.rb

@@ -72,6 +72,14 @@ module PlatformRest
       @application_dashboards ||= ApplicationDashboards.new(self)
     end
 
+    def application_job_log
+      @application_job_log ||= ApplicationJobLog.new(self)
+    end
+
+    def application_job_logs
+      @application_job_logs ||= ApplicationJobLogs.new(self)
+    end
+
     def application_key
       @application_key ||= ApplicationKey.new(self)
     end

data/lib/platform_rest/data.rb

@@ -41,7 +41,7 @@ module PlatformRest
     #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
-    # *  {hash} query - The query parameters (https://api.losant.com/#/definitions/dataExport)
+    # *  {hash} query - The query parameters (https://api.losant.com/#/definitions/devicesDataExport)
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response

data/lib/platform_rest/device.rb

@@ -93,6 +93,7 @@ module PlatformRest
     # *  {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.
+    # *  {hash} query - The export parameters. When provided overrides any options provided as a query param. (https://api.losant.com/#/definitions/deviceDataExport)
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -118,6 +119,7 @@ module PlatformRest
       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)
+      body = params[:query] if 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/platform_rest/events.rb

@@ -42,6 +42,8 @@ module PlatformRest
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {hash} query - Query to apply to filter the events (https://api.losant.com/#/definitions/advancedEventQuery)
+    # *  {string} email - Email address to send job complete notification to. Defaults to current user's email.
+    # *  {string} callbackUrl - Callback URL to call with delete result
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -49,6 +51,7 @@ module PlatformRest
     #
     # Responses:
     # *  200 - If request successfully deletes a set of Events (https://api.losant.com/#/definitions/eventsDeleted)
+    # *  202 - If a bulk delete job has been enqueued (https://api.losant.com/#/definitions/jobEnqueuedResult)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -62,6 +65,8 @@ module PlatformRest
       raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
 
       body = params[:query] if params.has_key?(:query)
+      query_params[:email] = params[:email] if params.has_key?(:email)
+      query_params[:callbackUrl] = params[:callbackUrl] if params.has_key?(:callbackUrl)
       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.22.1"
+  VERSION = "1.22.2"
 end

data/lib/platform_rest.rb

@@ -32,6 +32,8 @@ require_relative "platform_rest/application_certificate_authority"
 require_relative "platform_rest/application_certificates"
 require_relative "platform_rest/application_dashboard"
 require_relative "platform_rest/application_dashboards"
+require_relative "platform_rest/application_job_log"
+require_relative "platform_rest/application_job_logs"
 require_relative "platform_rest/application_key"
 require_relative "platform_rest/application_keys"
 require_relative "platform_rest/application_template"