files.com 1.1.678 → 1.1.680

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: 4ef7bf9cde3f8d5da53a59f84147b250576de0cd29611b5c879ad1d4f09cf124
4
- data.tar.gz: 211ea1233c6828c9db8c2e1ecc71858d992e5c1074218f22e5580eae75a60007
3
+ metadata.gz: a3ed7783348dc256c9b8494234c6aa30ef8ebb741823ef5b448c73a8914a08a2
4
+ data.tar.gz: 518d591f6f1058bfaf127a7780d7510a5702019288d9f155ecca8155f4ac9c53
5
5
  SHA512:
6
- metadata.gz: c7f54f058a1b201d599fc754fe7a0e68e48e15a96c092b8646d6cf8a27108306a1f496ba93c92cfef404e039fab060855b1c5416f7ad4c41e08f6b1b180bc477
7
- data.tar.gz: 447a0a28591ab4dcb73261bdbaf5266c8700d02240c2e09f8fd5fd769cc73931fcddc9885a026dcdce81fa006e24f9a0b44280762ea5575a5d17e43ccc07a7da
6
+ metadata.gz: 100499f45577b4cfa4c24bf8c8624709fe65c96628aeca54026d8b660af6bd776da5978feb054f2825fbb73d1b5b87f85cd06e8269d1eb766dface24d8de774f
7
+ data.tar.gz: 95413d3720645e247e3f686bf29b28c0e7aaf364d9390eb109fcc40bd1fe4223a1ee08d8902970cf9f13a872ded2ce81073c6181eca0c8279b66edc3cb9ad805
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.678
1
+ 1.1.680
data/docs/automation.md CHANGED
@@ -11,6 +11,7 @@
11
11
  "automation": "create_folder",
12
12
  "deleted": true,
13
13
  "description": "example",
14
+ "definition": "example",
14
15
  "destination_replace_from": "example",
15
16
  "destination_replace_to": "example",
16
17
  "destinations": [
@@ -44,6 +45,7 @@
44
45
  "overwrite_files": true,
45
46
  "path": "example",
46
47
  "path_time_zone": "Eastern Time (US & Canada)",
48
+ "version": 1,
47
49
  "recurring_day": 25,
48
50
  "retry_on_failure_interval_in_minutes": 60,
49
51
  "retry_on_failure_number_of_attempts": 10,
@@ -103,6 +105,7 @@
103
105
  * `automation` (string): Automation type
104
106
  * `deleted` (boolean): Indicates if the automation has been deleted.
105
107
  * `description` (string): Description for the this Automation.
108
+ * `definition` (object): Automation v2 graph definition.
106
109
  * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
107
110
  * `destination_replace_to` (string): If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
108
111
  * `destinations` (array(string)): Destination Paths
@@ -119,6 +122,7 @@
119
122
  * `overwrite_files` (boolean): If true, existing files will be overwritten with new files on Move/Copy automations. Note: by default files will not be overwritten on Copy automations if they appear to be the same file size as the newly incoming file. Use the `always_overwrite_size_matching_files` option in conjunction with `overwrite_files` to override this behavior and overwrite files no matter what.
120
123
  * `path` (string): Path on which this Automation runs. Supports globs, except on remote mounts. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
121
124
  * `path_time_zone` (string): Timezone to use when rendering timestamps in paths.
125
+ * `version` (int64): Current Automation v2 definition version.
122
126
  * `recurring_day` (int64): If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
123
127
  * `retry_on_failure_interval_in_minutes` (int64): If the Automation fails, retry at this interval (in minutes). Acceptable values are 5 through 1440 (one day). Set to null to disable.
124
128
  * `retry_on_failure_number_of_attempts` (int64): If the Automation fails, retry at most this many times. Maximum allowed value: 10. Set to null to disable.
@@ -6,7 +6,9 @@
6
6
  {
7
7
  "id": 1,
8
8
  "automation_id": 1,
9
+ "automation_version_id": 1,
9
10
  "workspace_id": 1,
11
+ "cancel_requested_at": "2000-01-01T01:00:00Z",
10
12
  "completed_at": "2000-01-01T01:00:00Z",
11
13
  "created_at": "2000-01-01T01:00:00Z",
12
14
  "retry_at": "2000-01-01T01:00:00Z",
@@ -17,13 +19,18 @@
17
19
  "status": "success",
18
20
  "successful_operations": 1,
19
21
  "failed_operations": 1,
22
+ "definition": "example",
23
+ "node_states": "example",
24
+ "journal_url": "example",
20
25
  "status_messages_url": "https://www.example.com/log_file.txt"
21
26
  }
22
27
  ```
23
28
 
24
29
  * `id` (int64): ID.
25
30
  * `automation_id` (int64): ID of the associated Automation.
31
+ * `automation_version_id` (int64): ID of the immutable Automation version pinned by this run.
26
32
  * `workspace_id` (int64): Workspace ID.
33
+ * `cancel_requested_at` (date-time): Date/time at which cancellation was requested.
27
34
  * `completed_at` (date-time): Automation run completion/failure date/time.
28
35
  * `created_at` (date-time): Automation run start date/time.
29
36
  * `retry_at` (date-time): If set, this automation will be retried at this date/time due to `failure` or `partial_failure`.
@@ -31,9 +38,12 @@
31
38
  * `retried_in_run_id` (int64): ID of the run that is or will be retrying this run.
32
39
  * `retry_of_run_id` (int64): ID of the original run that this run is retrying.
33
40
  * `runtime` (double): Automation run runtime.
34
- * `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`.
35
42
  * `successful_operations` (int64): Count of successful operations.
36
43
  * `failed_operations` (int64): Count of failed operations.
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.
46
+ * `journal_url` (string): Link to the run journal artifact.
37
47
  * `status_messages_url` (string): Link to status messages log file.
38
48
 
39
49
 
@@ -69,3 +79,31 @@ Files::AutomationRun.find(id)
69
79
  ### Parameters
70
80
 
71
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.
@@ -72,6 +72,15 @@ module Files
72
72
  @attributes[:description] = value
73
73
  end
74
74
 
75
+ # object - Automation v2 graph definition.
76
+ def definition
77
+ @attributes[:definition]
78
+ end
79
+
80
+ def definition=(value)
81
+ @attributes[:definition] = value
82
+ end
83
+
75
84
  # string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
76
85
  def destination_replace_from
77
86
  @attributes[:destination_replace_from]
@@ -216,6 +225,15 @@ module Files
216
225
  @attributes[:path_time_zone] = value
217
226
  end
218
227
 
228
+ # int64 - Current Automation v2 definition version.
229
+ def version
230
+ @attributes[:version]
231
+ end
232
+
233
+ def version=(value)
234
+ @attributes[:version] = value
235
+ end
236
+
219
237
  # int64 - If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
220
238
  def recurring_day
221
239
  @attributes[:recurring_day]
@@ -19,11 +19,21 @@ module Files
19
19
  @attributes[:automation_id]
20
20
  end
21
21
 
22
+ # int64 - ID of the immutable Automation version pinned by this run.
23
+ def automation_version_id
24
+ @attributes[:automation_version_id]
25
+ end
26
+
22
27
  # int64 - Workspace ID.
23
28
  def workspace_id
24
29
  @attributes[:workspace_id]
25
30
  end
26
31
 
32
+ # date-time - Date/time at which cancellation was requested.
33
+ def cancel_requested_at
34
+ @attributes[:cancel_requested_at]
35
+ end
36
+
27
37
  # date-time - Automation run completion/failure date/time.
28
38
  def completed_at
29
39
  @attributes[:completed_at]
@@ -59,7 +69,7 @@ module Files
59
69
  @attributes[:runtime]
60
70
  end
61
71
 
62
- # 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`.
63
73
  def status
64
74
  @attributes[:status]
65
75
  end
@@ -74,11 +84,37 @@ module Files
74
84
  @attributes[:failed_operations]
75
85
  end
76
86
 
87
+ # object - Automation definition snapshot pinned by this run. For performance reasons, this is not provided when listing Automation runs.
88
+ def definition
89
+ @attributes[:definition]
90
+ end
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
+
97
+ # string - Link to the run journal artifact.
98
+ def journal_url
99
+ @attributes[:journal_url]
100
+ end
101
+
77
102
  # string - Link to status messages log file.
78
103
  def status_messages_url
79
104
  @attributes[:status_messages_url]
80
105
  end
81
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
+
82
118
  # Parameters:
83
119
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
84
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.
@@ -119,5 +155,16 @@ module Files
119
155
  def self.get(id, params = {}, options = {})
120
156
  find(id, params, options)
121
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
122
169
  end
123
170
  end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Files
4
- VERSION = "1.1.678"
4
+ VERSION = "1.1.680"
5
5
  end
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.678
4
+ version: 1.1.680
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-12 00:00:00.000000000 Z
11
+ date: 2026-07-13 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable