files.com 1.1.682 → 1.1.684

data/docs/automation_run.md

@@ -15,12 +15,34 @@
   "retried_at": "2000-01-01T01:00:00Z",
   "retried_in_run_id": 1,
   "retry_of_run_id": 1,
+  "rerun_of_run_id": 1,
+  "rerun_from_node_id": "example",
   "runtime": 1.0,
   "status": "success",
   "successful_operations": 1,
   "failed_operations": 1,
   "definition": "example",
   "node_states": "example",
+  "execution_nodes": [
+    {
+      "node_id": "example",
+      "node_type": "example",
+      "status": "example",
+      "run_stage": "example",
+      "reused": true,
+      "successful_operations": 1,
+      "failed_operations": 1,
+      "started_at": "2000-01-01T01:00:00Z",
+      "completed_at": "2000-01-01T01:00:00Z",
+      "duration_ms": 1,
+      "inputs": [
+        "example"
+      ],
+      "outputs": "example",
+      "input_items": "example",
+      "output_items": "example"
+    }
+  ],
   "journal_url": "example",
   "status_messages_url": "https://www.example.com/log_file.txt"
 }
@@ -37,12 +59,15 @@
 * `retried_at` (date-time): If set, this Automation run was retried due to `failure` or `partial_failure`.
 * `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.
+* `rerun_of_run_id` (int64): ID of the run whose persisted node outputs this run reused.
+* `rerun_from_node_id` (string): Node at which this run resumed execution.
 * `runtime` (double): Automation run runtime.
 * `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.
+* `execution_nodes` (array(object)): Execution status, timing, and bounded output summaries for each node. 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.
 
@@ -81,6 +106,22 @@ Files::AutomationRun.find(id)
 * `id` (int64): Required - Automation Run ID.
 
 
+---
+
+## Show Automation Run Node
+
+```
+Files::AutomationRun.find_node(id, 
+  node_id: "node_id"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Automation Run ID.
+* `node_id` (string): Required - Node ID from the pinned Automation definition.
+
+
 ---
 
 ## Cancel Automation Run
@@ -94,6 +135,22 @@ Files::AutomationRun.cancel(id)
 * `id` (int64): Required - Automation Run ID.
 
 
+---
+
+## Re-run Automation from Node
+
+```
+Files::AutomationRun.rerun(id, 
+  node_id: "node_id"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Automation Run ID.
+* `node_id` (string): Required - Node ID at which execution should resume.
+
+
 ---
 
 ## Cancel Automation Run
@@ -107,3 +164,21 @@ automation_run.cancel
 ### Parameters
 
 * `id` (int64): Required - Automation Run ID.
+
+
+---
+
+## Re-run Automation from Node
+
+```
+automation_run = Files::AutomationRun.find(id)
+
+automation_run.rerun(
+  node_id: "node_id"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Automation Run ID.
+* `node_id` (string): Required - Node ID at which execution should resume.

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

@@ -135,6 +135,15 @@ module Files
       @attributes[:import_urls] = value
     end
 
+    # string - If trigger is `email`, this is the address that triggers the Automation.
+    def inbound_email_address
+      @attributes[:inbound_email_address]
+    end
+
+    def inbound_email_address=(value)
+      @attributes[:inbound_email_address] = value
+    end
+
     # boolean - Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination.  If this flag is `true`, the source folder structure will be flattened in the destination.  This is useful for copying or moving files from multiple folders into a single destination folder.
     def flatten_destination_structure
       @attributes[:flatten_destination_structure]
@@ -396,12 +405,27 @@ module Files
       @attributes[:holiday_region] = value
     end
 
-    # Manually Run Automation
+    # Upgrade a legacy Automation to Automation v2
+    def upgrade(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("/automations/#{@attributes[:id]}/upgrade", :post, params, @options)
+    end
+
+    # Manually Run Automation. v2 Automations require Site or Workspace Admin permission
+    #
+    # Parameters:
+    #   items - array(object) - Initial items for a v2 manual trigger. Each item contains exactly one `file` path or `data` object.
     def manual_run(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 InvalidParameterError.new("Bad parameter: items must be an Array") if params[:items] and !params[:items].is_a?(Array)
       raise MissingParameterError.new("Parameter missing: id") unless params[:id]
 
       Api.send_request("/automations/#{@attributes[:id]}/manual_run", :post, params, @options)
@@ -620,11 +644,26 @@ module Files
       Automation.new(response.data, options)
     end
 
-    # Manually Run Automation
+    # Upgrade a legacy Automation to Automation v2
+    def self.upgrade(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("/automations/#{params[:id]}/upgrade", :post, params, options)
+      Automation.new(response.data, options)
+    end
+
+    # Manually Run Automation. v2 Automations require Site or Workspace Admin permission
+    #
+    # Parameters:
+    #   items - array(object) - Initial items for a v2 manual trigger. Each item contains exactly one `file` path or `data` object.
     def self.manual_run(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 InvalidParameterError.new("Bad parameter: items must be an Array") if params[:items] and !params[:items].is_a?(Array)
       raise MissingParameterError.new("Parameter missing: id") unless params[:id]
 
       Api.send_request("/automations/#{params[:id]}/manual_run", :post, params, options)

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

@@ -23,5 +23,10 @@ module Files
     def nodes
       @attributes[:nodes]
     end
+
+    # string - Stable public URL for the Automation v2 graph definition JSON Schema.
+    def schema_url
+      @attributes[:schema_url]
+    end
   end
 end

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Files
+  class AutomationExecutionNode
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # string - Node ID from the pinned Automation definition.
+    def node_id
+      @attributes[:node_id]
+    end
+
+    # string - Node type.
+    def node_type
+      @attributes[:node_type]
+    end
+
+    # string - Node status.
+    def status
+      @attributes[:status]
+    end
+
+    # string - Current node execution stage.
+    def run_stage
+      @attributes[:run_stage]
+    end
+
+    # boolean - Whether this node reused persisted output from an earlier run.
+    def reused
+      @attributes[:reused]
+    end
+
+    # int64 - Count of successful operations in this node.
+    def successful_operations
+      @attributes[:successful_operations]
+    end
+
+    # int64 - Count of failed operations in this node.
+    def failed_operations
+      @attributes[:failed_operations]
+    end
+
+    # date-time - When this node started.
+    def started_at
+      @attributes[:started_at]
+    end
+
+    # date-time - When this node completed.
+    def completed_at
+      @attributes[:completed_at]
+    end
+
+    # int64 - Node runtime in milliseconds.
+    def duration_ms
+      @attributes[:duration_ms]
+    end
+
+    # array(object) - Ordered inbound edge references.
+    def inputs
+      @attributes[:inputs]
+    end
+
+    # object - Output counts, item kinds, and typed-error summaries by outlet.
+    def outputs
+      @attributes[:outputs]
+    end
+
+    # object - Materialized input items currently available, grouped by inlet.
+    def input_items
+      @attributes[:input_items]
+    end
+
+    # object - Materialized output items grouped by outlet.
+    def output_items
+      @attributes[:output_items]
+    end
+  end
+end