files.com 1.1.679 → 1.1.680

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8903be135ecc5d24d7ff1d0c05d817b511848118b9f4b348470ad7a5888e3aa
-  data.tar.gz: fcb51efc5e6673d393f2381a9992b75a6b1bc294ea0a1c319375a812caffdaad
+  metadata.gz: a3ed7783348dc256c9b8494234c6aa30ef8ebb741823ef5b448c73a8914a08a2
+  data.tar.gz: 518d591f6f1058bfaf127a7780d7510a5702019288d9f155ecca8155f4ac9c53
 SHA512:
-  metadata.gz: 9350dfdcd0e2c42f37c000c383263da394bb703497e3eeb0e8576376c45e75e523fd80c8f2131d9ad55072004fbbb237367fd0de18e943adb32619dafd8ca8a8
-  data.tar.gz: 8c3793b9c8a6ac6c7937d4ce7c0696eba8c979831895a572533f4362631ab08a51b96dadb0663f9a1526f5aab2f3d3e9f2d69a5479738fe34b4eef5442ba313f
+  metadata.gz: 100499f45577b4cfa4c24bf8c8624709fe65c96628aeca54026d8b660af6bd776da5978feb054f2825fbb73d1b5b87f85cd06e8269d1eb766dface24d8de774f
+  data.tar.gz: 95413d3720645e247e3f686bf29b28c0e7aaf364d9390eb109fcc40bd1fe4223a1ee08d8902970cf9f13a872ded2ce81073c6181eca0c8279b66edc3cb9ad805

data/_VERSION

@@ -1 +1 @@
-1.1.679
+1.1.680

data/docs/automation_run.md

@@ -8,6 +8,7 @@
   "automation_id": 1,
   "automation_version_id": 1,
   "workspace_id": 1,
+  "cancel_requested_at": "2000-01-01T01:00:00Z",
   "completed_at": "2000-01-01T01:00:00Z",
   "created_at": "2000-01-01T01:00:00Z",
   "retry_at": "2000-01-01T01:00:00Z",
@@ -19,6 +20,7 @@
   "successful_operations": 1,
   "failed_operations": 1,
   "definition": "example",
+  "node_states": "example",
   "journal_url": "example",
   "status_messages_url": "https://www.example.com/log_file.txt"
 }
@@ -28,6 +30,7 @@
 * `automation_id` (int64): ID of the associated Automation.
 * `automation_version_id` (int64): ID of the immutable Automation version pinned by this run.
 * `workspace_id` (int64): Workspace ID.
+* `cancel_requested_at` (date-time): Date/time at which cancellation was requested.
 * `completed_at` (date-time): Automation run completion/failure date/time.
 * `created_at` (date-time): Automation run start date/time.
 * `retry_at` (date-time): If set, this automation will be retried at this date/time due to `failure` or `partial_failure`.
@@ -35,10 +38,11 @@
 * `retried_in_run_id` (int64): ID of the run that is or will be retrying this run.
 * `retry_of_run_id` (int64): ID of the original run that this run is retrying.
 * `runtime` (double): Automation run runtime.
-* `status` (string): The success status of the AutomationRun. One of `running`, `success`, `partial_failure`, or `failure`.
+* `status` (string): The status of the AutomationRun. One of `queued`, `running`, `success`, `partial_failure`, `failure`, `skipped`, or `canceled`.
 * `successful_operations` (int64): Count of successful operations.
 * `failed_operations` (int64): Count of failed operations.
 * `definition` (object): Automation definition snapshot pinned by this run. For performance reasons, this is not provided when listing Automation runs.
+* `node_states` (object): Status and execution stage for each node in this run. For performance reasons, this is not provided when listing Automation runs.
 * `journal_url` (string): Link to the run journal artifact.
 * `status_messages_url` (string): Link to status messages log file.
 
@@ -75,3 +79,31 @@ Files::AutomationRun.find(id)
 ### Parameters
 
 * `id` (int64): Required - Automation Run ID.
+
+
+---
+
+## Cancel Automation Run
+
+```
+Files::AutomationRun.cancel(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Automation Run ID.
+
+
+---
+
+## Cancel Automation Run
+
+```
+automation_run = Files::AutomationRun.find(id)
+
+automation_run.cancel
+```
+
+### Parameters
+
+* `id` (int64): Required - Automation Run ID.

data/lib/files.com/models/automation_run.rb

@@ -29,6 +29,11 @@ module Files
       @attributes[:workspace_id]
     end
 
+    # date-time - Date/time at which cancellation was requested.
+    def cancel_requested_at
+      @attributes[:cancel_requested_at]
+    end
+
     # date-time - Automation run completion/failure date/time.
     def completed_at
       @attributes[:completed_at]
@@ -64,7 +69,7 @@ module Files
       @attributes[:runtime]
     end
 
-    # string - The success status of the AutomationRun. One of `running`, `success`, `partial_failure`, or `failure`.
+    # string - The status of the AutomationRun. One of `queued`, `running`, `success`, `partial_failure`, `failure`, `skipped`, or `canceled`.
     def status
       @attributes[:status]
     end
@@ -84,6 +89,11 @@ module Files
       @attributes[:definition]
     end
 
+    # object - Status and execution stage for each node in this run. For performance reasons, this is not provided when listing Automation runs.
+    def node_states
+      @attributes[:node_states]
+    end
+
     # string - Link to the run journal artifact.
     def journal_url
       @attributes[:journal_url]
@@ -94,6 +104,17 @@ module Files
       @attributes[:status_messages_url]
     end
 
+    # Cancel Automation Run
+    def cancel(params = {})
+      params ||= {}
+      params[:id] = @attributes[:id]
+      raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      Api.send_request("/automation_runs/#{@attributes[:id]}/cancel", :post, params, @options)
+    end
+
     # Parameters:
     #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
     #   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
@@ -134,5 +155,16 @@ module Files
     def self.get(id, params = {}, options = {})
       find(id, params, options)
     end
+
+    # Cancel Automation Run
+    def self.cancel(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      response, options = Api.send_request("/automation_runs/#{params[:id]}/cancel", :post, params, options)
+      AutomationRun.new(response.data, options)
+    end
   end
 end

data/lib/files.com/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Files
-  VERSION = "1.1.679"
+  VERSION = "1.1.680"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.679
+  version: 1.1.680
 platform: ruby
 authors:
 - files.com