losant_rest 1.16.6 → 1.17.0

data/lib/losant_rest/resource_job.rb

@@ -0,0 +1,326 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2022 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 LosantRest
+
+  # Class containing all the actions for the Resource Job Resource
+  class ResourceJob
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Marks a specific resource job execution for cancellation
+    #
+    # 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, resourceJob.*, or resourceJob.cancelExecution.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} resourceJobId - ID associated with the resource job
+    # *  {undefined} executionId - The ID of the execution to cancel
+    # *  {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 - If the execution was successfully marked for cancellation (https://api.losant.com/#/definitions/success)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if execution was not found (https://api.losant.com/#/definitions/error)
+    def cancel_execution(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("resourceJobId is required") unless params.has_key?(:resourceJobId)
+      raise ArgumentError.new("executionId is required") unless params.has_key?(:executionId)
+
+      query_params[:executionId] = params[:executionId] if params.has_key?(:executionId)
+      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]}/resource-jobs/#{params[:resourceJobId]}/cancelExecution"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Deletes a resource job
+    #
+    # 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, resourceJob.*, or resourceJob.delete.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} resourceJobId - ID associated with the resource job
+    # *  {string} includeWorkflows - If the workflows that trigger from this resource job should also be deleted.
+    # *  {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 - If resource job was successfully deleted (https://api.losant.com/#/definitions/success)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if resource job 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("resourceJobId is required") unless params.has_key?(:resourceJobId)
+
+      query_params[:includeWorkflows] = params[:includeWorkflows] if params.has_key?(:includeWorkflows)
+      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]}/resource-jobs/#{params[:resourceJobId]}"
+
+      @client.request(
+        method: :delete,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Queues the execution of a resource job
+    #
+    # 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, resourceJob.*, or resourceJob.execute.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} resourceJobId - ID associated with the resource job
+    # *  {hash} executionOptions - The options for the execution (https://api.losant.com/#/definitions/resourceJobExecutionOptions)
+    # *  {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 - If the job was successfully queued (https://api.losant.com/#/definitions/successWithExecutionId)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if resource job was not found (https://api.losant.com/#/definitions/error)
+    def execute(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("resourceJobId is required") unless params.has_key?(:resourceJobId)
+      raise ArgumentError.new("executionOptions is required") unless params.has_key?(:executionOptions)
+
+      body = params[:executionOptions] if params.has_key?(:executionOptions)
+      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]}/resource-jobs/#{params[:resourceJobId]}/execute"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Returns a resource job
+    #
+    # 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, resourceJob.*, or resourceJob.get.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} resourceJobId - ID associated with the resource job
+    # *  {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 - A single resource job (https://api.losant.com/#/definitions/resourceJob)
+    #
+    # 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)
+      raise ArgumentError.new("resourceJobId is required") unless params.has_key?(:resourceJobId)
+
+      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]}/resource-jobs/#{params[:resourceJobId]}"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Retrieves information on resource job executions
+    #
+    # 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, resourceJob.*, or resourceJob.logs.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} resourceJobId - ID associated with the resource job
+    # *  {string} limit - Max log entries to return (ordered by time descending)
+    # *  {string} since - Look for log entries since this time (ms since epoch)
+    # *  {string} losantdomain - Domain scope of request (rarely needed)
+    # *  {boolean} _actions - Return resource actions in response
+    # *  {boolean} _links - Return resource link in response
+    # *  {boolean} _embedded - Return embedded resources in response
+    #
+    # Responses:
+    # *  200 - Resource job execution information (https://api.losant.com/#/definitions/resourceJobExecutionLogs)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if resource job was not found (https://api.losant.com/#/definitions/error)
+    def logs(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("resourceJobId is required") unless params.has_key?(:resourceJobId)
+
+      query_params[:limit] = params[:limit] if params.has_key?(:limit)
+      query_params[:since] = params[:since] if params.has_key?(:since)
+      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]}/resource-jobs/#{params[:resourceJobId]}/logs"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Update a resource job
+    #
+    # 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, resourceJob.*, or resourceJob.patch.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} resourceJobId - ID associated with the resource job
+    # *  {hash} resourceJob - The new resource job configuration (https://api.losant.com/#/definitions/resourceJobPatch)
+    # *  {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 updated resource job (https://api.losant.com/#/definitions/resourceJob)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if resource job 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 }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
+      raise ArgumentError.new("resourceJobId is required") unless params.has_key?(:resourceJobId)
+      raise ArgumentError.new("resourceJob is required") unless params.has_key?(:resourceJob)
+
+      body = params[:resourceJob] if params.has_key?(:resourceJob)
+      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]}/resource-jobs/#{params[:resourceJobId]}"
+
+      @client.request(
+        method: :patch,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+  end
+end

data/lib/losant_rest/resource_jobs.rb

@@ -0,0 +1,138 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2022 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 LosantRest
+
+  # Class containing all the actions for the Resource Jobs Resource
+  class ResourceJobs
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Returns the resource jobs 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, resourceJobs.*, or resourceJobs.get.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated, lastExecutionRequested, resourceType
+    # *  {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
+    # *  {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name, resourceType
+    # *  {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
+    # *  {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 resource jobs (https://api.losant.com/#/definitions/resourceJobs)
+    #
+    # 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[:filterField] = params[:filterField] if params.has_key?(:filterField)
+      query_params[:filter] = params[:filter] if params.has_key?(:filter)
+      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]}/resource-jobs"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Create a new resource job 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.Organization, all.User, resourceJobs.*, or resourceJobs.post.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {hash} resourceJob - New resource job information (https://api.losant.com/#/definitions/resourceJobPost)
+    # *  {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 created resource job (https://api.losant.com/#/definitions/resourceJob)
+    #
+    # 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 post(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("resourceJob is required") unless params.has_key?(:resourceJob)
+
+      body = params[:resourceJob] if params.has_key?(:resourceJob)
+      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]}/resource-jobs"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+  end
+end

data/lib/losant_rest/version.rb

@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module LosantRest
-  VERSION = "1.16.6"
+  VERSION = "1.17.0"
 end

data/lib/losant_rest.rb

@@ -102,6 +102,8 @@ require_relative "losant_rest/notebooks"
 require_relative "losant_rest/org"
 require_relative "losant_rest/org_invites"
 require_relative "losant_rest/orgs"
+require_relative "losant_rest/resource_job"
+require_relative "losant_rest/resource_jobs"
 require_relative "losant_rest/user_api_token"
 require_relative "losant_rest/user_api_tokens"
 require_relative "losant_rest/webhook"

data/schemas/apiTokenPost.json

@@ -79,6 +79,8 @@
                   "flows.*",
                   "flowVersion.*",
                   "flowVersions.*",
+                  "resourceJobs.*",
+                  "resourceJob.*",
                   "notebook.*",
                   "notebooks.*",
                   "webhook.*",
@@ -291,6 +293,14 @@
                   "notebook.upload",
                   "notebooks.get",
                   "notebooks.post",
+                  "resourceJob.get",
+                  "resourceJob.logs",
+                  "resourceJob.patch",
+                  "resourceJob.delete",
+                  "resourceJob.execute",
+                  "resourceJob.cancelExecution",
+                  "resourceJobs.get",
+                  "resourceJobs.post",
                   "webhook.delete",
                   "webhook.get",
                   "webhook.patch",

data/schemas/applicationCreationByTemplateResult.json

@@ -372,15 +372,7 @@
             "type": "string"
           },
           "id": {
-            "oneOf": [
-              {
-                "type": "string",
-                "pattern": "^[A-Fa-f\\d]{24}$"
-              },
-              {
-                "type": "string"
-              }
-            ]
+            "type": "string"
           },
           "message": {
             "type": "string"

data/schemas/applicationExportPost.json

@@ -23,6 +23,10 @@
       "type": "string",
       "format": "uri",
       "maxLength": 1024
+    },
+    "forceJob": {
+      "type": "boolean",
+      "default": false
     }
   },
   "additionalProperties": false

data/schemas/applicationTemplate.json

@@ -107,6 +107,9 @@
         "notebookCount": {
           "type": "integer"
         },
+        "resourceJobCount": {
+          "type": "integer"
+        },
         "dataTableCsvSize": {
           "type": "integer"
         },

data/schemas/applicationTemplates.json

@@ -114,6 +114,9 @@
               "notebookCount": {
                 "type": "integer"
               },
+              "resourceJobCount": {
+                "type": "integer"
+              },
               "dataTableCsvSize": {
                 "type": "integer"
               },

data/schemas/auditLog.json

@@ -61,7 +61,8 @@
         "Flow",
         "Integration",
         "Notebook",
-        "Webhook"
+        "Webhook",
+        "ResourceJob"
       ]
     },
     "secondaryTargetName": {

data/schemas/auditLogFilter.json

@@ -59,7 +59,8 @@
               "Flow",
               "Integration",
               "Notebook",
-              "Webhook"
+              "Webhook",
+              "ResourceJob"
             ]
           },
           "name": {

data/schemas/auditLogs.json

@@ -68,7 +68,8 @@
               "Flow",
               "Integration",
               "Notebook",
-              "Webhook"
+              "Webhook",
+              "ResourceJob"
             ]
           },
           "secondaryTargetName": {

data/schemas/dataTableRowInsertResult.json

@@ -48,7 +48,8 @@
           },
           "maxItems": 1000
         }
-      }
+      },
+      "additionalProperties": false
     }
   ]
 }