files.com 1.1.682 → 1.1.684
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 +4 -4
- data/_VERSION +1 -1
- data/docs/automation.md +40 -4
- data/docs/automation_authoring_schema.md +3 -1
- data/docs/automation_execution_node.md +39 -0
- data/docs/automation_log.md +19 -7
- data/docs/automation_run.md +75 -0
- data/lib/files.com/models/automation.rb +41 -2
- data/lib/files.com/models/automation_authoring_schema.rb +5 -0
- data/lib/files.com/models/automation_execution_node.rb +82 -0
- data/lib/files.com/models/automation_log.rb +37 -7
- data/lib/files.com/models/automation_run.rb +62 -0
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +1 -0
- metadata +4 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c585cb56997090d57b632672c11c2142fe9294c0446c3b9ca62cce492798fc78
|
|
4
|
+
data.tar.gz: a535661a2834a25e631de350fd6013e61b562998c9f9d82d8c93d09803e5337f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 71eeed61969d9fe5b01b869a2656bb961f655bb9428e3bfbd2a49688545aaff5279a7d9f55c453eba61afbd649e696ee44423559afc04c91105bd77a4dff751c
|
|
7
|
+
data.tar.gz: 4912b539b27468e41c5eca7bb15c717e262e9d01e3a4e5179af3536899b32e79f590fdf2110f22b3195f950c93d5ff193424361dfe795fa40423725f89948db1
|
data/_VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.1.
|
|
1
|
+
1.1.684
|
data/docs/automation.md
CHANGED
|
@@ -32,6 +32,7 @@
|
|
|
32
32
|
}
|
|
33
33
|
}
|
|
34
34
|
],
|
|
35
|
+
"inbound_email_address": "example-automation-abc123@inbox.files.com",
|
|
35
36
|
"flatten_destination_structure": true,
|
|
36
37
|
"group_ids": [
|
|
37
38
|
1,
|
|
@@ -112,6 +113,7 @@
|
|
|
112
113
|
* `disabled` (boolean): If true, this automation will not run.
|
|
113
114
|
* `exclude_pattern` (string): If set, this glob pattern will exclude files from the automation. Supports globs, except on remote mounts.
|
|
114
115
|
* `import_urls` (array(object)): List of URLs to be imported and names to be used.
|
|
116
|
+
* `inbound_email_address` (string): If trigger is `email`, this is the address that triggers the Automation.
|
|
115
117
|
* `flatten_destination_structure` (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.
|
|
116
118
|
* `group_ids` (array(int64)): IDs of Groups for the Automation (i.e. who to Request File from)
|
|
117
119
|
* `ignore_locked_folders` (boolean): If true, the Lock Folders behavior will be disregarded for automated actions.
|
|
@@ -268,10 +270,10 @@ Files::Automation.create(
|
|
|
268
270
|
|
|
269
271
|
---
|
|
270
272
|
|
|
271
|
-
##
|
|
273
|
+
## Upgrade a legacy Automation to Automation v2
|
|
272
274
|
|
|
273
275
|
```
|
|
274
|
-
Files::Automation.
|
|
276
|
+
Files::Automation.upgrade(id)
|
|
275
277
|
```
|
|
276
278
|
|
|
277
279
|
### Parameters
|
|
@@ -279,6 +281,22 @@ Files::Automation.manual_run(id)
|
|
|
279
281
|
* `id` (int64): Required - Automation ID.
|
|
280
282
|
|
|
281
283
|
|
|
284
|
+
---
|
|
285
|
+
|
|
286
|
+
## Manually Run Automation. v2 Automations require Site or Workspace Admin permission
|
|
287
|
+
|
|
288
|
+
```
|
|
289
|
+
Files::Automation.manual_run(id,
|
|
290
|
+
items: [{"file":"incoming/report.csv"},{"data":{"customer":"Acme"}}]
|
|
291
|
+
)
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
### Parameters
|
|
295
|
+
|
|
296
|
+
* `id` (int64): Required - Automation ID.
|
|
297
|
+
* `items` (array(object)): Initial items for a v2 manual trigger. Each item contains exactly one `file` path or `data` object.
|
|
298
|
+
|
|
299
|
+
|
|
282
300
|
---
|
|
283
301
|
|
|
284
302
|
## Update Automation
|
|
@@ -374,17 +392,35 @@ Files::Automation.delete(id)
|
|
|
374
392
|
|
|
375
393
|
---
|
|
376
394
|
|
|
377
|
-
##
|
|
395
|
+
## Upgrade a legacy Automation to Automation v2
|
|
396
|
+
|
|
397
|
+
```
|
|
398
|
+
automation = Files::Automation.find(id)
|
|
399
|
+
|
|
400
|
+
automation.upgrade
|
|
401
|
+
```
|
|
402
|
+
|
|
403
|
+
### Parameters
|
|
404
|
+
|
|
405
|
+
* `id` (int64): Required - Automation ID.
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
---
|
|
409
|
+
|
|
410
|
+
## Manually Run Automation. v2 Automations require Site or Workspace Admin permission
|
|
378
411
|
|
|
379
412
|
```
|
|
380
413
|
automation = Files::Automation.find(id)
|
|
381
414
|
|
|
382
|
-
automation.manual_run
|
|
415
|
+
automation.manual_run(
|
|
416
|
+
items: [{"file":"incoming/report.csv"},{"data":{"customer":"Acme"}}]
|
|
417
|
+
)
|
|
383
418
|
```
|
|
384
419
|
|
|
385
420
|
### Parameters
|
|
386
421
|
|
|
387
422
|
* `id` (int64): Required - Automation ID.
|
|
423
|
+
* `items` (array(object)): Initial items for a v2 manual trigger. Each item contains exactly one `file` path or `data` object.
|
|
388
424
|
|
|
389
425
|
|
|
390
426
|
---
|
|
@@ -10,10 +10,12 @@
|
|
|
10
10
|
],
|
|
11
11
|
"nodes": [
|
|
12
12
|
"example"
|
|
13
|
-
]
|
|
13
|
+
],
|
|
14
|
+
"schema_url": "example"
|
|
14
15
|
}
|
|
15
16
|
```
|
|
16
17
|
|
|
17
18
|
* `definition_schema` (object): JSON Schema for active Automation v2 graph definitions.
|
|
18
19
|
* `error_families` (array(object)): Typed error families accepted by Automation v2 on_error rules.
|
|
19
20
|
* `nodes` (array(object)): Active Automation v2 node authoring metadata.
|
|
21
|
+
* `schema_url` (string): Stable public URL for the Automation v2 graph definition JSON Schema.
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# AutomationExecutionNode
|
|
2
|
+
|
|
3
|
+
## Example AutomationExecutionNode Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"node_id": "example",
|
|
8
|
+
"node_type": "example",
|
|
9
|
+
"status": "example",
|
|
10
|
+
"run_stage": "example",
|
|
11
|
+
"reused": true,
|
|
12
|
+
"successful_operations": 1,
|
|
13
|
+
"failed_operations": 1,
|
|
14
|
+
"started_at": "2000-01-01T01:00:00Z",
|
|
15
|
+
"completed_at": "2000-01-01T01:00:00Z",
|
|
16
|
+
"duration_ms": 1,
|
|
17
|
+
"inputs": [
|
|
18
|
+
"example"
|
|
19
|
+
],
|
|
20
|
+
"outputs": "example",
|
|
21
|
+
"input_items": "example",
|
|
22
|
+
"output_items": "example"
|
|
23
|
+
}
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
* `node_id` (string): Node ID from the pinned Automation definition.
|
|
27
|
+
* `node_type` (string): Node type.
|
|
28
|
+
* `status` (string): Node status.
|
|
29
|
+
* `run_stage` (string): Current node execution stage.
|
|
30
|
+
* `reused` (boolean): Whether this node reused persisted output from an earlier run.
|
|
31
|
+
* `successful_operations` (int64): Count of successful operations in this node.
|
|
32
|
+
* `failed_operations` (int64): Count of failed operations in this node.
|
|
33
|
+
* `started_at` (date-time): When this node started.
|
|
34
|
+
* `completed_at` (date-time): When this node completed.
|
|
35
|
+
* `duration_ms` (int64): Node runtime in milliseconds.
|
|
36
|
+
* `inputs` (array(object)): Ordered inbound edge references.
|
|
37
|
+
* `outputs` (object): Output counts, item kinds, and typed-error summaries by outlet.
|
|
38
|
+
* `input_items` (object): Materialized input items currently available, grouped by inlet.
|
|
39
|
+
* `output_items` (object): Materialized output items grouped by outlet.
|