files.com 1.1.679 → 1.1.681

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a8903be135ecc5d24d7ff1d0c05d817b511848118b9f4b348470ad7a5888e3aa
4
- data.tar.gz: fcb51efc5e6673d393f2381a9992b75a6b1bc294ea0a1c319375a812caffdaad
3
+ metadata.gz: c9c833a143a8391a44ebde9b88e149f7d231ecc18fcd2f4a3044b76494e55ff1
4
+ data.tar.gz: 2e262c76502adb4d6523427d1c7cce881bb5c07775ccbc0e4b44d06b89473d48
5
5
  SHA512:
6
- metadata.gz: 9350dfdcd0e2c42f37c000c383263da394bb703497e3eeb0e8576376c45e75e523fd80c8f2131d9ad55072004fbbb237367fd0de18e943adb32619dafd8ca8a8
7
- data.tar.gz: 8c3793b9c8a6ac6c7937d4ce7c0696eba8c979831895a572533f4362631ab08a51b96dadb0663f9a1526f5aab2f3d3e9f2d69a5479738fe34b4eef5442ba313f
6
+ metadata.gz: 016bf4fe6fbc5d50b77775ecc437637bb63dbedd13a7412d4b2fc75459b685b91caa624540eb66830b0cf9fb208384e5afbca6e6226f8cb430bc3385d648bdf0
7
+ data.tar.gz: 2aa8a0bfd3146849efb5fd6269f8fa3711c18ffc39c405b50dd4a6edd7b81d72d3c375cbe985a75df871b37e786542ec2a3eee4eb24786fc917a9a50b7fa8483
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.679
1
+ 1.1.681
data/docs/automation.md CHANGED
@@ -176,6 +176,15 @@ Files::Automation.find(id)
176
176
  * `id` (int64): Required - Automation ID.
177
177
 
178
178
 
179
+ ---
180
+
181
+ ## Show the Automation v2 authoring schema and active node catalog
182
+
183
+ ```
184
+ Files::Automation.get_authoring_schema
185
+ ```
186
+
187
+
179
188
  ---
180
189
 
181
190
  ## Create Automation
@@ -0,0 +1,15 @@
1
+ # AutomationAuthoringSchema
2
+
3
+ ## Example AutomationAuthoringSchema Object
4
+
5
+ ```
6
+ {
7
+ "definition_schema": "example",
8
+ "nodes": [
9
+ "example"
10
+ ]
11
+ }
12
+ ```
13
+
14
+ * `definition_schema` (object): JSON Schema for active Automation v2 graph definitions.
15
+ * `nodes` (array(object)): Active Automation v2 node authoring metadata.
@@ -8,6 +8,7 @@
8
8
  "automation_id": 1,
9
9
  "automation_version_id": 1,
10
10
  "workspace_id": 1,
11
+ "cancel_requested_at": "2000-01-01T01:00:00Z",
11
12
  "completed_at": "2000-01-01T01:00:00Z",
12
13
  "created_at": "2000-01-01T01:00:00Z",
13
14
  "retry_at": "2000-01-01T01:00:00Z",
@@ -19,6 +20,7 @@
19
20
  "successful_operations": 1,
20
21
  "failed_operations": 1,
21
22
  "definition": "example",
23
+ "node_states": "example",
22
24
  "journal_url": "example",
23
25
  "status_messages_url": "https://www.example.com/log_file.txt"
24
26
  }
@@ -28,6 +30,7 @@
28
30
  * `automation_id` (int64): ID of the associated Automation.
29
31
  * `automation_version_id` (int64): ID of the immutable Automation version pinned by this run.
30
32
  * `workspace_id` (int64): Workspace ID.
33
+ * `cancel_requested_at` (date-time): Date/time at which cancellation was requested.
31
34
  * `completed_at` (date-time): Automation run completion/failure date/time.
32
35
  * `created_at` (date-time): Automation run start date/time.
33
36
  * `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 @@
35
38
  * `retried_in_run_id` (int64): ID of the run that is or will be retrying this run.
36
39
  * `retry_of_run_id` (int64): ID of the original run that this run is retrying.
37
40
  * `runtime` (double): Automation run runtime.
38
- * `status` (string): The success status of the AutomationRun. One of `running`, `success`, `partial_failure`, or `failure`.
41
+ * `status` (string): The status of the AutomationRun. One of `queued`, `running`, `success`, `partial_failure`, `failure`, `skipped`, or `canceled`.
39
42
  * `successful_operations` (int64): Count of successful operations.
40
43
  * `failed_operations` (int64): Count of failed operations.
41
44
  * `definition` (object): Automation definition snapshot pinned by this run. For performance reasons, this is not provided when listing Automation runs.
45
+ * `node_states` (object): Status and execution stage for each node in this run. For performance reasons, this is not provided when listing Automation runs.
42
46
  * `journal_url` (string): Link to the run journal artifact.
43
47
  * `status_messages_url` (string): Link to status messages log file.
44
48
 
@@ -75,3 +79,31 @@ Files::AutomationRun.find(id)
75
79
  ### Parameters
76
80
 
77
81
  * `id` (int64): Required - Automation Run ID.
82
+
83
+
84
+ ---
85
+
86
+ ## Cancel Automation Run
87
+
88
+ ```
89
+ Files::AutomationRun.cancel(id)
90
+ ```
91
+
92
+ ### Parameters
93
+
94
+ * `id` (int64): Required - Automation Run ID.
95
+
96
+
97
+ ---
98
+
99
+ ## Cancel Automation Run
100
+
101
+ ```
102
+ automation_run = Files::AutomationRun.find(id)
103
+
104
+ automation_run.cancel
105
+ ```
106
+
107
+ ### Parameters
108
+
109
+ * `id` (int64): Required - Automation Run ID.
@@ -546,6 +546,11 @@ module Files
546
546
  find(id, params, options)
547
547
  end
548
548
 
549
+ def self.get_authoring_schema(params = {}, options = {})
550
+ response, options = Api.send_request("/automations/authoring_schema", :get, params, options)
551
+ AutomationAuthoringSchema.new(response.data, options)
552
+ end
553
+
549
554
  # Parameters:
550
555
  # source - string - Source path/glob. See Automation docs for exact description, but this is used to filter for files in the `path` to find files to operate on. Supports globs, except on remote mounts.
551
556
  # destinations - array(string) - A list of destination paths. Use a trailing slash for folder destinations and omit it for file destinations.
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Files
4
+ class AutomationAuthoringSchema
5
+ attr_reader :options, :attributes
6
+
7
+ def initialize(attributes = {}, options = {})
8
+ @attributes = attributes || {}
9
+ @options = options || {}
10
+ end
11
+
12
+ # object - JSON Schema for active Automation v2 graph definitions.
13
+ def definition_schema
14
+ @attributes[:definition_schema]
15
+ end
16
+
17
+ # array(object) - Active Automation v2 node authoring metadata.
18
+ def nodes
19
+ @attributes[:nodes]
20
+ end
21
+ end
22
+ end
@@ -29,6 +29,11 @@ module Files
29
29
  @attributes[:workspace_id]
30
30
  end
31
31
 
32
+ # date-time - Date/time at which cancellation was requested.
33
+ def cancel_requested_at
34
+ @attributes[:cancel_requested_at]
35
+ end
36
+
32
37
  # date-time - Automation run completion/failure date/time.
33
38
  def completed_at
34
39
  @attributes[:completed_at]
@@ -64,7 +69,7 @@ module Files
64
69
  @attributes[:runtime]
65
70
  end
66
71
 
67
- # string - The success status of the AutomationRun. One of `running`, `success`, `partial_failure`, or `failure`.
72
+ # string - The status of the AutomationRun. One of `queued`, `running`, `success`, `partial_failure`, `failure`, `skipped`, or `canceled`.
68
73
  def status
69
74
  @attributes[:status]
70
75
  end
@@ -84,6 +89,11 @@ module Files
84
89
  @attributes[:definition]
85
90
  end
86
91
 
92
+ # object - Status and execution stage for each node in this run. For performance reasons, this is not provided when listing Automation runs.
93
+ def node_states
94
+ @attributes[:node_states]
95
+ end
96
+
87
97
  # string - Link to the run journal artifact.
88
98
  def journal_url
89
99
  @attributes[:journal_url]
@@ -94,6 +104,17 @@ module Files
94
104
  @attributes[:status_messages_url]
95
105
  end
96
106
 
107
+ # Cancel Automation Run
108
+ def cancel(params = {})
109
+ params ||= {}
110
+ params[:id] = @attributes[:id]
111
+ raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
112
+ raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
113
+ raise MissingParameterError.new("Parameter missing: id") unless params[:id]
114
+
115
+ Api.send_request("/automation_runs/#{@attributes[:id]}/cancel", :post, params, @options)
116
+ end
117
+
97
118
  # Parameters:
98
119
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
99
120
  # 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
134
155
  def self.get(id, params = {}, options = {})
135
156
  find(id, params, options)
136
157
  end
158
+
159
+ # Cancel Automation Run
160
+ def self.cancel(id, params = {}, options = {})
161
+ params ||= {}
162
+ params[:id] = id
163
+ raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
164
+ raise MissingParameterError.new("Parameter missing: id") unless params[:id]
165
+
166
+ response, options = Api.send_request("/automation_runs/#{params[:id]}/cancel", :post, params, options)
167
+ AutomationRun.new(response.data, options)
168
+ end
137
169
  end
138
170
  end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Files
4
- VERSION = "1.1.679"
4
+ VERSION = "1.1.681"
5
5
  end
data/lib/files.com.rb CHANGED
@@ -49,6 +49,7 @@ require "files.com/models/as2_partner"
49
49
  require "files.com/models/as2_station"
50
50
  require "files.com/models/auto"
51
51
  require "files.com/models/automation"
52
+ require "files.com/models/automation_authoring_schema"
52
53
  require "files.com/models/automation_log"
53
54
  require "files.com/models/automation_run"
54
55
  require "files.com/models/bandwidth_snapshot"
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: files.com
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.679
4
+ version: 1.1.681
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-07-13 00:00:00.000000000 Z
11
+ date: 2026-07-14 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable
@@ -187,6 +187,7 @@ files:
187
187
  - docs/as2_station.md
188
188
  - docs/auto.md
189
189
  - docs/automation.md
190
+ - docs/automation_authoring_schema.md
190
191
  - docs/automation_log.md
191
192
  - docs/automation_run.md
192
193
  - docs/bandwidth_snapshot.md
@@ -334,6 +335,7 @@ files:
334
335
  - lib/files.com/models/as2_station.rb
335
336
  - lib/files.com/models/auto.rb
336
337
  - lib/files.com/models/automation.rb
338
+ - lib/files.com/models/automation_authoring_schema.rb
337
339
  - lib/files.com/models/automation_log.rb
338
340
  - lib/files.com/models/automation_run.rb
339
341
  - lib/files.com/models/bandwidth_snapshot.rb