files.com 1.0.190 → 1.0.191
Sign up to get free protection for your applications and to get access to all the features.
- package/_VERSION +1 -1
- package/docs/Errors.md +186 -0
- package/docs/models/AccountLineItem.md +53 -0
- package/docs/models/Action.md +37 -0
- package/docs/models/ActionNotificationExport.md +82 -0
- package/docs/models/ActionNotificationExportResult.md +49 -0
- package/docs/models/ActionWebhookFailure.md +16 -0
- package/docs/models/ApiKey.md +183 -0
- package/docs/models/App.md +66 -0
- package/docs/models/As2IncomingMessage.md +104 -0
- package/docs/models/As2OutgoingMessage.md +96 -0
- package/docs/models/As2Partner.md +141 -0
- package/docs/models/As2Station.md +142 -0
- package/docs/models/Auto.md +11 -0
- package/docs/models/Automation.md +257 -0
- package/docs/models/AutomationRun.md +61 -0
- package/docs/models/BandwidthSnapshot.md +50 -0
- package/docs/models/Behavior.md +195 -0
- package/docs/models/Bundle.md +330 -0
- package/docs/models/BundleDownload.md +44 -0
- package/docs/models/BundleRecipient.md +76 -0
- package/docs/models/BundleRegistration.md +53 -0
- package/docs/models/Clickwrap.md +120 -0
- package/docs/models/DnsRecord.md +33 -0
- package/docs/models/Errors.md +17 -0
- package/docs/models/ExternalEvent.md +84 -0
- package/docs/models/File.md +339 -0
- package/docs/models/FileAction.md +13 -0
- package/docs/models/FileComment.md +98 -0
- package/docs/models/FileCommentReaction.md +50 -0
- package/docs/models/FileMigration.md +40 -0
- package/docs/models/FileUploadPart.md +39 -0
- package/docs/models/Folder.md +90 -0
- package/docs/models/FormField.md +29 -0
- package/docs/models/FormFieldSet.md +170 -0
- package/docs/models/Group.md +140 -0
- package/docs/models/GroupUser.md +116 -0
- package/docs/models/History.md +151 -0
- package/docs/models/HistoryExport.md +130 -0
- package/docs/models/HistoryExportResult.md +75 -0
- package/docs/models/Image.md +13 -0
- package/docs/models/InboxRecipient.md +76 -0
- package/docs/models/InboxRegistration.md +47 -0
- package/docs/models/InboxUpload.md +42 -0
- package/docs/models/Invoice.md +82 -0
- package/docs/models/InvoiceLineItem.md +27 -0
- package/docs/models/IpAddress.md +51 -0
- package/docs/models/Lock.md +92 -0
- package/docs/models/Message.md +134 -0
- package/docs/models/MessageComment.md +114 -0
- package/docs/models/MessageCommentReaction.md +79 -0
- package/docs/models/MessageReaction.md +79 -0
- package/docs/models/Notification.md +241 -0
- package/docs/models/Payment.md +82 -0
- package/docs/models/PaymentLineItem.md +19 -0
- package/docs/models/Permission.md +94 -0
- package/docs/models/Preview.md +19 -0
- package/docs/models/Priority.md +30 -0
- package/docs/models/Project.md +98 -0
- package/docs/models/PublicIpAddress.md +17 -0
- package/docs/models/PublicKey.md +112 -0
- package/docs/models/RemoteBandwidthSnapshot.md +42 -0
- package/docs/models/RemoteServer.md +385 -0
- package/docs/models/Request.md +97 -0
- package/docs/models/Session.md +50 -0
- package/docs/models/SettingsChange.md +44 -0
- package/docs/models/Site.md +607 -0
- package/docs/models/SsoStrategy.md +139 -0
- package/docs/models/Status.md +30 -0
- package/docs/models/Style.md +76 -0
- package/docs/models/UsageDailySnapshot.md +56 -0
- package/docs/models/UsageSnapshot.md +63 -0
- package/docs/models/User.md +465 -0
- package/docs/models/UserCipherUse.md +39 -0
- package/docs/models/UserRequest.md +80 -0
- package/docs/models/WebhookTest.md +59 -0
- package/lib/Api.js +12 -11
- package/lib/Errors.js +3126 -0
- package/lib/models/AccountLineItem.js +8 -0
- package/lib/models/Action.js +8 -0
- package/lib/models/ActionNotificationExport.js +21 -13
- package/lib/models/ActionNotificationExportResult.js +13 -5
- package/lib/models/ActionWebhookFailure.js +12 -4
- package/lib/models/ApiKey.js +33 -25
- package/lib/models/App.js +10 -2
- package/lib/models/As2IncomingMessage.js +11 -3
- package/lib/models/As2OutgoingMessage.js +11 -3
- package/lib/models/As2Partner.js +34 -26
- package/lib/models/As2Station.js +32 -24
- package/lib/models/Auto.js +8 -0
- package/lib/models/Automation.js +51 -43
- package/lib/models/AutomationRun.js +16 -8
- package/lib/models/BandwidthSnapshot.js +10 -2
- package/lib/models/Behavior.js +46 -38
- package/lib/models/Bundle.js +51 -43
- package/lib/models/BundleDownload.js +12 -4
- package/lib/models/BundleRecipient.js +22 -14
- package/lib/models/BundleRegistration.js +12 -4
- package/lib/models/Clickwrap.js +31 -23
- package/lib/models/DnsRecord.js +10 -2
- package/lib/models/Errors.js +8 -0
- package/lib/models/ExternalEvent.js +18 -10
- package/lib/models/File.js +68 -60
- package/lib/models/FileAction.js +8 -0
- package/lib/models/FileComment.js +27 -19
- package/lib/models/FileCommentReaction.js +18 -10
- package/lib/models/FileMigration.js +11 -3
- package/lib/models/FileUploadPart.js +8 -0
- package/lib/models/Folder.js +19 -11
- package/lib/models/FormField.js +8 -0
- package/lib/models/FormFieldSet.js +27 -19
- package/lib/models/Group.js +30 -22
- package/lib/models/GroupUser.js +32 -24
- package/lib/models/History.js +42 -34
- package/lib/models/HistoryExport.js +34 -26
- package/lib/models/HistoryExportResult.js +13 -5
- package/lib/models/Image.js +8 -0
- package/lib/models/InboxRecipient.js +22 -14
- package/lib/models/InboxRegistration.js +11 -3
- package/lib/models/InboxUpload.js +12 -4
- package/lib/models/Invoice.js +13 -5
- package/lib/models/InvoiceLineItem.js +8 -0
- package/lib/models/IpAddress.js +12 -4
- package/lib/models/Lock.js +24 -16
- package/lib/models/Message.js +37 -29
- package/lib/models/MessageComment.js +29 -21
- package/lib/models/MessageCommentReaction.js +24 -16
- package/lib/models/MessageReaction.js +24 -16
- package/lib/models/Notification.js +38 -30
- package/lib/models/Payment.js +13 -5
- package/lib/models/PaymentLineItem.js +8 -0
- package/lib/models/Permission.js +23 -15
- package/lib/models/Preview.js +8 -0
- package/lib/models/Priority.js +13 -5
- package/lib/models/Project.js +25 -17
- package/lib/models/PublicIpAddress.js +8 -0
- package/lib/models/PublicKey.js +29 -21
- package/lib/models/RemoteBandwidthSnapshot.js +10 -2
- package/lib/models/RemoteServer.js +113 -105
- package/lib/models/Request.js +27 -19
- package/lib/models/Session.js +13 -5
- package/lib/models/SettingsChange.js +10 -2
- package/lib/models/Site.js +65 -57
- package/lib/models/SsoStrategy.js +17 -9
- package/lib/models/Status.js +8 -0
- package/lib/models/Style.js +20 -12
- package/lib/models/UsageDailySnapshot.js +10 -2
- package/lib/models/UsageSnapshot.js +10 -2
- package/lib/models/User.js +85 -77
- package/lib/models/UserCipherUse.js +11 -3
- package/lib/models/UserRequest.js +24 -16
- package/lib/models/WebhookTest.js +16 -8
- package/package.json +1 -1
- package/src/Api.js +4 -8
- package/src/Errors.js +222 -0
- package/src/models/AccountLineItem.js +1 -0
- package/src/models/Action.js +1 -0
- package/src/models/ActionNotificationExport.js +14 -13
- package/src/models/ActionNotificationExportResult.js +6 -5
- package/src/models/ActionWebhookFailure.js +5 -4
- package/src/models/ApiKey.js +26 -25
- package/src/models/App.js +3 -2
- package/src/models/As2IncomingMessage.js +4 -3
- package/src/models/As2OutgoingMessage.js +4 -3
- package/src/models/As2Partner.js +27 -26
- package/src/models/As2Station.js +25 -24
- package/src/models/Auto.js +1 -0
- package/src/models/Automation.js +44 -43
- package/src/models/AutomationRun.js +9 -8
- package/src/models/BandwidthSnapshot.js +3 -2
- package/src/models/Behavior.js +39 -38
- package/src/models/Bundle.js +44 -43
- package/src/models/BundleDownload.js +5 -4
- package/src/models/BundleRecipient.js +15 -14
- package/src/models/BundleRegistration.js +5 -4
- package/src/models/Clickwrap.js +24 -23
- package/src/models/DnsRecord.js +3 -2
- package/src/models/Errors.js +1 -0
- package/src/models/ExternalEvent.js +11 -10
- package/src/models/File.js +61 -60
- package/src/models/FileAction.js +1 -0
- package/src/models/FileComment.js +20 -19
- package/src/models/FileCommentReaction.js +11 -10
- package/src/models/FileMigration.js +4 -3
- package/src/models/FileUploadPart.js +1 -0
- package/src/models/Folder.js +12 -11
- package/src/models/FormField.js +1 -0
- package/src/models/FormFieldSet.js +20 -19
- package/src/models/Group.js +23 -22
- package/src/models/GroupUser.js +25 -24
- package/src/models/History.js +35 -34
- package/src/models/HistoryExport.js +27 -26
- package/src/models/HistoryExportResult.js +6 -5
- package/src/models/Image.js +1 -0
- package/src/models/InboxRecipient.js +15 -14
- package/src/models/InboxRegistration.js +4 -3
- package/src/models/InboxUpload.js +5 -4
- package/src/models/Invoice.js +6 -5
- package/src/models/InvoiceLineItem.js +1 -0
- package/src/models/IpAddress.js +5 -4
- package/src/models/Lock.js +17 -16
- package/src/models/Message.js +30 -29
- package/src/models/MessageComment.js +22 -21
- package/src/models/MessageCommentReaction.js +17 -16
- package/src/models/MessageReaction.js +17 -16
- package/src/models/Notification.js +31 -30
- package/src/models/Payment.js +6 -5
- package/src/models/PaymentLineItem.js +1 -0
- package/src/models/Permission.js +16 -15
- package/src/models/Preview.js +1 -0
- package/src/models/Priority.js +6 -5
- package/src/models/Project.js +18 -17
- package/src/models/PublicIpAddress.js +1 -0
- package/src/models/PublicKey.js +22 -21
- package/src/models/RemoteBandwidthSnapshot.js +3 -2
- package/src/models/RemoteServer.js +106 -105
- package/src/models/Request.js +20 -19
- package/src/models/Session.js +6 -5
- package/src/models/SettingsChange.js +3 -2
- package/src/models/Site.js +58 -57
- package/src/models/SsoStrategy.js +10 -9
- package/src/models/Status.js +1 -0
- package/src/models/Style.js +13 -12
- package/src/models/UsageDailySnapshot.js +3 -2
- package/src/models/UsageSnapshot.js +3 -2
- package/src/models/User.js +78 -77
- package/src/models/UserCipherUse.js +4 -3
- package/src/models/UserRequest.js +17 -16
- package/src/models/WebhookTest.js +9 -8
- package/test/src/index.js +46 -0
@@ -0,0 +1,257 @@
|
|
1
|
+
# Automation
|
2
|
+
|
3
|
+
## Example Automation Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"id": 1,
|
8
|
+
"automation": "create_folder",
|
9
|
+
"deleted": true,
|
10
|
+
"disabled": true,
|
11
|
+
"trigger": "realtime",
|
12
|
+
"interval": "week",
|
13
|
+
"last_modified_at": "2000-01-01T01:00:00Z",
|
14
|
+
"name": "",
|
15
|
+
"schedule": {
|
16
|
+
"days_of_week": [
|
17
|
+
0,
|
18
|
+
2,
|
19
|
+
4
|
20
|
+
],
|
21
|
+
"times_of_day": [
|
22
|
+
"6:30",
|
23
|
+
"14:30"
|
24
|
+
],
|
25
|
+
"time_zone": "Eastern Time (US & Canada)"
|
26
|
+
},
|
27
|
+
"source": "",
|
28
|
+
"destinations": [
|
29
|
+
"destination"
|
30
|
+
],
|
31
|
+
"destination_replace_from": "",
|
32
|
+
"destination_replace_to": "",
|
33
|
+
"description": "",
|
34
|
+
"path": "",
|
35
|
+
"user_id": 1,
|
36
|
+
"user_ids": [
|
37
|
+
1,
|
38
|
+
2
|
39
|
+
],
|
40
|
+
"group_ids": [
|
41
|
+
1,
|
42
|
+
2
|
43
|
+
],
|
44
|
+
"webhook_url": "https://app.files.com/api/webhooks/abc123",
|
45
|
+
"trigger_actions": "[ \"create\" ]",
|
46
|
+
"value": "{\"limit\": \"1\"}"
|
47
|
+
}
|
48
|
+
```
|
49
|
+
|
50
|
+
* `id` (int64): Automation ID
|
51
|
+
* `automation` (string): Automation type
|
52
|
+
* `deleted` (boolean): Indicates if the automation has been deleted.
|
53
|
+
* `disabled` (boolean): If true, this automation will not run.
|
54
|
+
* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
55
|
+
* `interval` (string): If trigger is `daily`, this specifies how often to run this automation. One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
|
56
|
+
* `last_modified_at` (date-time): Time when automation was last modified. Does not change for name or description updates.
|
57
|
+
* `name` (string): Name for this automation.
|
58
|
+
* `schedule` (object): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run.
|
59
|
+
* `source` (string): Source Path
|
60
|
+
* `destinations` (string): Destination Path
|
61
|
+
* `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
62
|
+
* `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.
|
63
|
+
* `description` (string): Description for the this Automation.
|
64
|
+
* `path` (string): Path on which this Automation runs. Supports globs. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
65
|
+
* `user_id` (int64): User ID of the Automation's creator.
|
66
|
+
* `user_ids` (array): IDs of Users for the Automation (i.e. who to Request File from)
|
67
|
+
* `group_ids` (array): IDs of Groups for the Automation (i.e. who to Request File from)
|
68
|
+
* `webhook_url` (string): If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
|
69
|
+
* `trigger_actions` (string): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
|
70
|
+
* `value` (object): A Hash of attributes specific to the automation type.
|
71
|
+
* `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
|
72
|
+
|
73
|
+
---
|
74
|
+
|
75
|
+
## List Automations
|
76
|
+
|
77
|
+
```
|
78
|
+
await Automation.list({
|
79
|
+
'per_page': 1,
|
80
|
+
'with_deleted': true,
|
81
|
+
'automation': "create_folder",
|
82
|
+
})
|
83
|
+
```
|
84
|
+
|
85
|
+
|
86
|
+
### Parameters
|
87
|
+
|
88
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
89
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
90
|
+
* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `automation`, `disabled` or `last_modified_at`.
|
91
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
|
92
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
|
93
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
|
94
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
|
95
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
|
96
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
|
97
|
+
* `with_deleted` (boolean): Set to true to include deleted automations in the results.
|
98
|
+
* `automation` (string): DEPRECATED: Type of automation to filter by. Use `filter[automation]` instead.
|
99
|
+
|
100
|
+
---
|
101
|
+
|
102
|
+
## Show Automation
|
103
|
+
|
104
|
+
```
|
105
|
+
await Automation.find(id)
|
106
|
+
```
|
107
|
+
|
108
|
+
|
109
|
+
### Parameters
|
110
|
+
|
111
|
+
* `id` (int64): Required - Automation ID.
|
112
|
+
|
113
|
+
---
|
114
|
+
|
115
|
+
## Create Automation
|
116
|
+
|
117
|
+
```
|
118
|
+
await Automation.create({
|
119
|
+
'source': "source",
|
120
|
+
'destinations': "[\"folder_a/file_a.txt\", {\"folder_path\":\"folder_b\", \"file_path\":\"file_b.txt\"}, {\"folder_path\":\"folder_c\"}]",
|
121
|
+
'interval': "year",
|
122
|
+
'user_ids': [1,2],
|
123
|
+
'group_ids': [1,2],
|
124
|
+
'schedule': "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
|
125
|
+
'disabled': true,
|
126
|
+
'trigger': "realtime",
|
127
|
+
'trigger_actions': "[ \"create\" ]",
|
128
|
+
'value': "{\"limit\": \"1\"}",
|
129
|
+
'automation': "create_folder",
|
130
|
+
})
|
131
|
+
```
|
132
|
+
|
133
|
+
|
134
|
+
### Parameters
|
135
|
+
|
136
|
+
* `source` (string): Source Path
|
137
|
+
* `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
|
138
|
+
* `destinations` (array(string)): A list of String destination paths or Hash of folder_path and optional file_path.
|
139
|
+
* `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
140
|
+
* `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.
|
141
|
+
* `interval` (string): How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
|
142
|
+
* `path` (string): Path on which this Automation runs. Supports globs.
|
143
|
+
* `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
144
|
+
* `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
145
|
+
* `schedule` (object): Custom schedule for running this automation.
|
146
|
+
* `description` (string): Description for the this Automation.
|
147
|
+
* `disabled` (boolean): If true, this automation will not run.
|
148
|
+
* `name` (string): Name for this automation.
|
149
|
+
* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
150
|
+
* `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
|
151
|
+
* `value` (object): A Hash of attributes specific to the automation type.
|
152
|
+
* `automation` (string): Required - Automation type
|
153
|
+
|
154
|
+
---
|
155
|
+
|
156
|
+
## Update Automation
|
157
|
+
|
158
|
+
```
|
159
|
+
const [automation] = await Automation.list()
|
160
|
+
|
161
|
+
await automation.update({
|
162
|
+
'source': "source",
|
163
|
+
'destinations': "[\"folder_a/file_a.txt\", {\"folder_path\":\"folder_b\", \"file_path\":\"file_b.txt\"}, {\"folder_path\":\"folder_c\"}]",
|
164
|
+
'interval': "year",
|
165
|
+
'user_ids': [1,2],
|
166
|
+
'group_ids': [1,2],
|
167
|
+
'schedule': "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
|
168
|
+
'disabled': true,
|
169
|
+
'trigger': "realtime",
|
170
|
+
'trigger_actions': "[ \"create\" ]",
|
171
|
+
'value': "{\"limit\": \"1\"}",
|
172
|
+
'automation': "create_folder",
|
173
|
+
})
|
174
|
+
```
|
175
|
+
|
176
|
+
### Parameters
|
177
|
+
|
178
|
+
* `id` (int64): Required - Automation ID.
|
179
|
+
* `source` (string): Source Path
|
180
|
+
* `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
|
181
|
+
* `destinations` (array(string)): A list of String destination paths or Hash of folder_path and optional file_path.
|
182
|
+
* `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
183
|
+
* `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.
|
184
|
+
* `interval` (string): How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
|
185
|
+
* `path` (string): Path on which this Automation runs. Supports globs.
|
186
|
+
* `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
187
|
+
* `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
188
|
+
* `schedule` (object): Custom schedule for running this automation.
|
189
|
+
* `description` (string): Description for the this Automation.
|
190
|
+
* `disabled` (boolean): If true, this automation will not run.
|
191
|
+
* `name` (string): Name for this automation.
|
192
|
+
* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
193
|
+
* `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
|
194
|
+
* `value` (object): A Hash of attributes specific to the automation type.
|
195
|
+
* `automation` (string): Automation type
|
196
|
+
|
197
|
+
### Example Response
|
198
|
+
|
199
|
+
```json
|
200
|
+
{
|
201
|
+
"id": 1,
|
202
|
+
"automation": "create_folder",
|
203
|
+
"deleted": true,
|
204
|
+
"disabled": true,
|
205
|
+
"trigger": "realtime",
|
206
|
+
"interval": "week",
|
207
|
+
"last_modified_at": "2000-01-01T01:00:00Z",
|
208
|
+
"name": "",
|
209
|
+
"schedule": {
|
210
|
+
"days_of_week": [
|
211
|
+
0,
|
212
|
+
2,
|
213
|
+
4
|
214
|
+
],
|
215
|
+
"times_of_day": [
|
216
|
+
"6:30",
|
217
|
+
"14:30"
|
218
|
+
],
|
219
|
+
"time_zone": "Eastern Time (US & Canada)"
|
220
|
+
},
|
221
|
+
"source": "",
|
222
|
+
"destinations": [
|
223
|
+
"destination"
|
224
|
+
],
|
225
|
+
"destination_replace_from": "",
|
226
|
+
"destination_replace_to": "",
|
227
|
+
"description": "",
|
228
|
+
"path": "",
|
229
|
+
"user_id": 1,
|
230
|
+
"user_ids": [
|
231
|
+
1,
|
232
|
+
2
|
233
|
+
],
|
234
|
+
"group_ids": [
|
235
|
+
1,
|
236
|
+
2
|
237
|
+
],
|
238
|
+
"webhook_url": "https://app.files.com/api/webhooks/abc123",
|
239
|
+
"trigger_actions": "[ \"create\" ]",
|
240
|
+
"value": "{\"limit\": \"1\"}"
|
241
|
+
}
|
242
|
+
```
|
243
|
+
|
244
|
+
---
|
245
|
+
|
246
|
+
## Delete Automation
|
247
|
+
|
248
|
+
```
|
249
|
+
const [automation] = await Automation.list()
|
250
|
+
|
251
|
+
await automation.delete()
|
252
|
+
```
|
253
|
+
|
254
|
+
### Parameters
|
255
|
+
|
256
|
+
* `id` (int64): Required - Automation ID.
|
257
|
+
|
@@ -0,0 +1,61 @@
|
|
1
|
+
# AutomationRun
|
2
|
+
|
3
|
+
## Example AutomationRun Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"id": 1,
|
8
|
+
"automation_id": 1,
|
9
|
+
"completed_at": "2000-01-01T01:00:00Z",
|
10
|
+
"created_at": "2000-01-01T01:00:00Z",
|
11
|
+
"status": "success",
|
12
|
+
"status_messages_url": "https://www.example.com/log_file.txt"
|
13
|
+
}
|
14
|
+
```
|
15
|
+
|
16
|
+
* `id` (int64): ID.
|
17
|
+
* `automation_id` (int64): ID of the associated Automation.
|
18
|
+
* `completed_at` (date-time): Automation run completion/failure date/time.
|
19
|
+
* `created_at` (date-time): Automation run start date/time.
|
20
|
+
* `status` (string): The success status of the AutomationRun. One of `running`, `success`, `partial_failure`, or `failure`.
|
21
|
+
* `status_messages_url` (string): Link to status messages log file.
|
22
|
+
|
23
|
+
---
|
24
|
+
|
25
|
+
## List Automation Runs
|
26
|
+
|
27
|
+
```
|
28
|
+
await AutomationRun.list({
|
29
|
+
'user_id': 1,
|
30
|
+
'per_page': 1,
|
31
|
+
'automation_id': 1,
|
32
|
+
})
|
33
|
+
```
|
34
|
+
|
35
|
+
|
36
|
+
### Parameters
|
37
|
+
|
38
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
39
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
40
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
41
|
+
* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `created_at` and `status`.
|
42
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`.
|
43
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `status`.
|
44
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `status`.
|
45
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`.
|
46
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `status`.
|
47
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `status`.
|
48
|
+
* `automation_id` (int64): Required - ID of the associated Automation.
|
49
|
+
|
50
|
+
---
|
51
|
+
|
52
|
+
## Show Automation Run
|
53
|
+
|
54
|
+
```
|
55
|
+
await AutomationRun.find(id)
|
56
|
+
```
|
57
|
+
|
58
|
+
|
59
|
+
### Parameters
|
60
|
+
|
61
|
+
* `id` (int64): Required - Automation Run ID.
|
@@ -0,0 +1,50 @@
|
|
1
|
+
# BandwidthSnapshot
|
2
|
+
|
3
|
+
## Example BandwidthSnapshot Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"id": 1,
|
8
|
+
"bytes_received": 1.0,
|
9
|
+
"bytes_sent": 1.0,
|
10
|
+
"sync_bytes_received": 1.0,
|
11
|
+
"sync_bytes_sent": 1.0,
|
12
|
+
"requests_get": 1.0,
|
13
|
+
"requests_put": 1.0,
|
14
|
+
"requests_other": 1.0,
|
15
|
+
"logged_at": "2000-01-01T01:00:00Z"
|
16
|
+
}
|
17
|
+
```
|
18
|
+
|
19
|
+
* `id` (int64): Site bandwidth ID
|
20
|
+
* `bytes_received` (double): Site bandwidth report bytes received
|
21
|
+
* `bytes_sent` (double): Site bandwidth report bytes sent
|
22
|
+
* `sync_bytes_received` (double): Site sync bandwidth report bytes received
|
23
|
+
* `sync_bytes_sent` (double): Site sync bandwidth report bytes sent
|
24
|
+
* `requests_get` (double): Site bandwidth report get requests
|
25
|
+
* `requests_put` (double): Site bandwidth report put requests
|
26
|
+
* `requests_other` (double): Site bandwidth report other requests
|
27
|
+
* `logged_at` (date-time): Time the site bandwidth report was logged
|
28
|
+
|
29
|
+
---
|
30
|
+
|
31
|
+
## List Bandwidth Snapshots
|
32
|
+
|
33
|
+
```
|
34
|
+
await BandwidthSnapshot.list({
|
35
|
+
'per_page': 1,
|
36
|
+
})
|
37
|
+
```
|
38
|
+
|
39
|
+
|
40
|
+
### Parameters
|
41
|
+
|
42
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
43
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
44
|
+
* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `logged_at`.
|
45
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
|
46
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `logged_at`.
|
47
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `logged_at`.
|
48
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
|
49
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `logged_at`.
|
50
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `logged_at`.
|
@@ -0,0 +1,195 @@
|
|
1
|
+
# Behavior
|
2
|
+
|
3
|
+
## Example Behavior Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"id": 1,
|
8
|
+
"path": "",
|
9
|
+
"attachment_url": "",
|
10
|
+
"behavior": "webhook",
|
11
|
+
"name": "",
|
12
|
+
"description": "",
|
13
|
+
"value": {
|
14
|
+
"method": "GET"
|
15
|
+
}
|
16
|
+
}
|
17
|
+
```
|
18
|
+
|
19
|
+
* `id` (int64): Folder behavior ID
|
20
|
+
* `path` (string): Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
21
|
+
* `attachment_url` (string): URL for attached file
|
22
|
+
* `behavior` (string): Behavior type.
|
23
|
+
* `name` (string): Name for this behavior.
|
24
|
+
* `description` (string): Description for this behavior.
|
25
|
+
* `value` (object): Settings for this behavior. See the section above for an example value to provide here. Formatting is different for each Behavior type. May be sent as nested JSON or a single JSON-encoded string. If using XML encoding for the API call, this data must be sent as a JSON-encoded string.
|
26
|
+
* `attachment_file` (file): Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
|
27
|
+
* `attachment_delete` (boolean): If true, will delete the file stored in attachment
|
28
|
+
|
29
|
+
---
|
30
|
+
|
31
|
+
## List Behaviors
|
32
|
+
|
33
|
+
```
|
34
|
+
await Behavior.list({
|
35
|
+
'per_page': 1,
|
36
|
+
'behavior': "webhook",
|
37
|
+
})
|
38
|
+
```
|
39
|
+
|
40
|
+
|
41
|
+
### Parameters
|
42
|
+
|
43
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
44
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
45
|
+
* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `behavior`.
|
46
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
|
47
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `behavior`.
|
48
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `behavior`.
|
49
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
|
50
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `behavior`.
|
51
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `behavior`.
|
52
|
+
* `behavior` (string): If set, only shows folder behaviors matching this behavior type.
|
53
|
+
|
54
|
+
---
|
55
|
+
|
56
|
+
## Show Behavior
|
57
|
+
|
58
|
+
```
|
59
|
+
await Behavior.find(id)
|
60
|
+
```
|
61
|
+
|
62
|
+
|
63
|
+
### Parameters
|
64
|
+
|
65
|
+
* `id` (int64): Required - Behavior ID.
|
66
|
+
|
67
|
+
---
|
68
|
+
|
69
|
+
## List Behaviors by path
|
70
|
+
|
71
|
+
```
|
72
|
+
await Behavior.listFor(path, {
|
73
|
+
'per_page': 1,
|
74
|
+
'behavior': "webhook",
|
75
|
+
})
|
76
|
+
```
|
77
|
+
|
78
|
+
|
79
|
+
### Parameters
|
80
|
+
|
81
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
82
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
83
|
+
* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `behavior`.
|
84
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
|
85
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `behavior`.
|
86
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `behavior`.
|
87
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
|
88
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `behavior`.
|
89
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `behavior`.
|
90
|
+
* `path` (string): Required - Path to operate on.
|
91
|
+
* `recursive` (string): Show behaviors above this path?
|
92
|
+
* `behavior` (string): DEPRECATED: If set only shows folder behaviors matching this behavior type. Use `filter[behavior]` instead.
|
93
|
+
|
94
|
+
---
|
95
|
+
|
96
|
+
## Create Behavior
|
97
|
+
|
98
|
+
```
|
99
|
+
await Behavior.create({
|
100
|
+
'value': "{\"method\": \"GET\"}",
|
101
|
+
'path': "path",
|
102
|
+
'behavior': "webhook",
|
103
|
+
})
|
104
|
+
```
|
105
|
+
|
106
|
+
|
107
|
+
### Parameters
|
108
|
+
|
109
|
+
* `value` (string): The value of the folder behavior. Can be a integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.
|
110
|
+
* `attachment_file` (file): Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
|
111
|
+
* `name` (string): Name for this behavior.
|
112
|
+
* `description` (string): Description for this behavior.
|
113
|
+
* `path` (string): Required - Folder behaviors path.
|
114
|
+
* `behavior` (string): Required - Behavior type.
|
115
|
+
|
116
|
+
---
|
117
|
+
|
118
|
+
## Test webhook
|
119
|
+
|
120
|
+
```
|
121
|
+
await Behavior.webhookTest({
|
122
|
+
'url': "https://www.site.com/...",
|
123
|
+
'method': "GET",
|
124
|
+
'encoding': "RAW",
|
125
|
+
'headers': "x-test-header => testvalue",
|
126
|
+
'body': "test-param => testvalue",
|
127
|
+
'action': "test",
|
128
|
+
})
|
129
|
+
```
|
130
|
+
|
131
|
+
|
132
|
+
### Parameters
|
133
|
+
|
134
|
+
* `url` (string): Required - URL for testing the webhook.
|
135
|
+
* `method` (string): HTTP method(GET or POST).
|
136
|
+
* `encoding` (string): HTTP encoding method. Can be JSON, XML, or RAW (form data).
|
137
|
+
* `headers` (object): Additional request headers.
|
138
|
+
* `body` (object): Additional body parameters.
|
139
|
+
* `action` (string): action for test body
|
140
|
+
|
141
|
+
---
|
142
|
+
|
143
|
+
## Update Behavior
|
144
|
+
|
145
|
+
```
|
146
|
+
const [behavior] = await Behavior.list()
|
147
|
+
|
148
|
+
await behavior.update({
|
149
|
+
'value': "{\"method\": \"GET\"}",
|
150
|
+
'behavior': "webhook",
|
151
|
+
'attachment_delete': true,
|
152
|
+
})
|
153
|
+
```
|
154
|
+
|
155
|
+
### Parameters
|
156
|
+
|
157
|
+
* `id` (int64): Required - Behavior ID.
|
158
|
+
* `value` (string): The value of the folder behavior. Can be a integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.
|
159
|
+
* `attachment_file` (file): Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
|
160
|
+
* `name` (string): Name for this behavior.
|
161
|
+
* `description` (string): Description for this behavior.
|
162
|
+
* `behavior` (string): Behavior type.
|
163
|
+
* `path` (string): Folder behaviors path.
|
164
|
+
* `attachment_delete` (boolean): If true, will delete the file stored in attachment
|
165
|
+
|
166
|
+
### Example Response
|
167
|
+
|
168
|
+
```json
|
169
|
+
{
|
170
|
+
"id": 1,
|
171
|
+
"path": "",
|
172
|
+
"attachment_url": "",
|
173
|
+
"behavior": "webhook",
|
174
|
+
"name": "",
|
175
|
+
"description": "",
|
176
|
+
"value": {
|
177
|
+
"method": "GET"
|
178
|
+
}
|
179
|
+
}
|
180
|
+
```
|
181
|
+
|
182
|
+
---
|
183
|
+
|
184
|
+
## Delete Behavior
|
185
|
+
|
186
|
+
```
|
187
|
+
const [behavior] = await Behavior.list()
|
188
|
+
|
189
|
+
await behavior.delete()
|
190
|
+
```
|
191
|
+
|
192
|
+
### Parameters
|
193
|
+
|
194
|
+
* `id` (int64): Required - Behavior ID.
|
195
|
+
|