files.com 1.1.93 → 1.1.95
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/docs/action_notification_export_result.md +3 -0
- data/docs/api_key.md +8 -2
- data/docs/api_request_log.md +4 -1
- data/docs/app.md +4 -1
- data/docs/as2_incoming_message.md +3 -0
- data/docs/as2_outgoing_message.md +3 -0
- data/docs/as2_partner.md +56 -41
- data/docs/as2_station.md +4 -1
- data/docs/automation.md +21 -4
- data/docs/automation_log.md +4 -1
- data/docs/automation_run.md +3 -0
- data/docs/bandwidth_snapshot.md +4 -1
- data/docs/behavior.md +32 -25
- data/docs/bundle.md +5 -8
- data/docs/bundle_action.md +4 -0
- data/docs/bundle_download.md +3 -0
- data/docs/bundle_notification.md +4 -1
- data/docs/bundle_recipient.md +3 -0
- data/docs/bundle_registration.md +3 -0
- data/docs/clickwrap.md +4 -1
- data/docs/dns_record.md +4 -1
- data/docs/email_incoming_message.md +4 -1
- data/docs/email_log.md +4 -1
- data/docs/exavault_api_request_log.md +4 -1
- data/docs/external_event.md +4 -1
- data/docs/file_comment.md +4 -1
- data/docs/file_migration.md +1 -1
- data/docs/file_migration_log.md +4 -1
- data/docs/folder.md +2 -0
- data/docs/form_field_set.md +4 -1
- data/docs/ftp_action_log.md +4 -1
- data/docs/gpg_key.md +4 -1
- data/docs/group.md +4 -1
- data/docs/group_user.md +3 -0
- data/docs/history.md +25 -5
- data/docs/history_export_result.md +4 -0
- data/docs/inbox_recipient.md +3 -0
- data/docs/inbox_registration.md +3 -0
- data/docs/inbox_upload.md +3 -0
- data/docs/invoice.md +4 -1
- data/docs/ip_address.md +16 -4
- data/docs/lock.md +6 -3
- data/docs/message.md +3 -0
- data/docs/message_comment.md +3 -0
- data/docs/message_comment_reaction.md +3 -0
- data/docs/message_reaction.md +3 -0
- data/docs/notification.md +4 -1
- data/docs/outbound_connection_log.md +56 -0
- data/docs/payment.md +4 -1
- data/docs/permission.md +3 -0
- data/docs/priority.md +4 -1
- data/docs/project.md +4 -1
- data/docs/public_hosting_request_log.md +4 -1
- data/docs/public_key.md +4 -1
- data/docs/remote_bandwidth_snapshot.md +4 -1
- data/docs/remote_server.md +4 -1
- data/docs/request.md +6 -0
- data/docs/settings_change.md +4 -1
- data/docs/sftp_action_log.md +4 -1
- data/docs/sftp_host_key.md +4 -1
- data/docs/share_group.md +4 -1
- data/docs/snapshot.md +4 -1
- data/docs/sso_strategy.md +5 -2
- data/docs/sync_log.md +4 -1
- data/docs/usage_daily_snapshot.md +4 -1
- data/docs/usage_snapshot.md +4 -1
- data/docs/user.md +8 -5
- data/docs/user_cipher_use.md +4 -1
- data/docs/user_request.md +4 -1
- data/docs/web_dav_action_log.md +4 -1
- data/lib/files.com/models/action_notification_export_result.rb +4 -0
- data/lib/files.com/models/api_key.rb +15 -0
- data/lib/files.com/models/api_request_log.rb +4 -0
- data/lib/files.com/models/app.rb +4 -0
- data/lib/files.com/models/as2_incoming_message.rb +4 -0
- data/lib/files.com/models/as2_outgoing_message.rb +4 -0
- data/lib/files.com/models/as2_partner.rb +68 -34
- data/lib/files.com/models/as2_station.rb +4 -0
- data/lib/files.com/models/automation.rb +25 -4
- data/lib/files.com/models/automation_log.rb +4 -0
- data/lib/files.com/models/automation_run.rb +4 -0
- data/lib/files.com/models/bandwidth_snapshot.rb +4 -0
- data/lib/files.com/models/behavior.rb +32 -25
- data/lib/files.com/models/bundle.rb +5 -4
- data/lib/files.com/models/bundle_action.rb +4 -0
- data/lib/files.com/models/bundle_download.rb +4 -0
- data/lib/files.com/models/bundle_notification.rb +4 -0
- data/lib/files.com/models/bundle_recipient.rb +4 -0
- data/lib/files.com/models/bundle_registration.rb +4 -0
- data/lib/files.com/models/clickwrap.rb +4 -0
- data/lib/files.com/models/dns_record.rb +4 -0
- data/lib/files.com/models/email_incoming_message.rb +4 -0
- data/lib/files.com/models/email_log.rb +4 -0
- data/lib/files.com/models/exavault_api_request_log.rb +4 -0
- data/lib/files.com/models/external_event.rb +4 -0
- data/lib/files.com/models/file_comment.rb +4 -0
- data/lib/files.com/models/file_migration.rb +1 -1
- data/lib/files.com/models/file_migration_log.rb +4 -0
- data/lib/files.com/models/folder.rb +2 -0
- data/lib/files.com/models/form_field_set.rb +4 -0
- data/lib/files.com/models/ftp_action_log.rb +4 -0
- data/lib/files.com/models/gpg_key.rb +4 -0
- data/lib/files.com/models/group.rb +4 -0
- data/lib/files.com/models/group_user.rb +4 -0
- data/lib/files.com/models/history.rb +20 -0
- data/lib/files.com/models/history_export_result.rb +4 -0
- data/lib/files.com/models/inbox_recipient.rb +4 -0
- data/lib/files.com/models/inbox_registration.rb +4 -0
- data/lib/files.com/models/inbox_upload.rb +4 -0
- data/lib/files.com/models/invoice.rb +4 -0
- data/lib/files.com/models/ip_address.rb +16 -0
- data/lib/files.com/models/lock.rb +7 -3
- data/lib/files.com/models/message.rb +4 -0
- data/lib/files.com/models/message_comment.rb +4 -0
- data/lib/files.com/models/message_comment_reaction.rb +4 -0
- data/lib/files.com/models/message_reaction.rb +4 -0
- data/lib/files.com/models/notification.rb +5 -1
- data/lib/files.com/models/outbound_connection_log.rb +101 -0
- data/lib/files.com/models/payment.rb +4 -0
- data/lib/files.com/models/permission.rb +4 -0
- data/lib/files.com/models/priority.rb +4 -0
- data/lib/files.com/models/project.rb +4 -0
- data/lib/files.com/models/public_hosting_request_log.rb +4 -0
- data/lib/files.com/models/public_key.rb +4 -0
- data/lib/files.com/models/remote_bandwidth_snapshot.rb +4 -0
- data/lib/files.com/models/remote_server.rb +4 -0
- data/lib/files.com/models/request.rb +8 -0
- data/lib/files.com/models/settings_change.rb +4 -0
- data/lib/files.com/models/sftp_action_log.rb +4 -0
- data/lib/files.com/models/sftp_host_key.rb +4 -0
- data/lib/files.com/models/share_group.rb +4 -0
- data/lib/files.com/models/snapshot.rb +4 -0
- data/lib/files.com/models/sso_strategy.rb +5 -1
- data/lib/files.com/models/sync_log.rb +4 -0
- data/lib/files.com/models/usage_daily_snapshot.rb +4 -0
- data/lib/files.com/models/usage_snapshot.rb +4 -0
- data/lib/files.com/models/user.rb +8 -4
- data/lib/files.com/models/user_cipher_use.rb +4 -0
- data/lib/files.com/models/user_request.rb +4 -0
- data/lib/files.com/models/web_dav_action_log.rb +4 -0
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +1 -0
- metadata +4 -2
data/docs/automation.md
CHANGED
@@ -23,6 +23,7 @@
|
|
23
23
|
"ignore_locked_folders": true,
|
24
24
|
"interval": "week",
|
25
25
|
"last_modified_at": "2000-01-01T01:00:00Z",
|
26
|
+
"legacy_folder_matching": true,
|
26
27
|
"name": "example",
|
27
28
|
"overwrite_files": true,
|
28
29
|
"path": "example",
|
@@ -75,6 +76,7 @@
|
|
75
76
|
* `ignore_locked_folders` (boolean): If true, the Lock Folders behavior will be disregarded for automated actions.
|
76
77
|
* `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`
|
77
78
|
* `last_modified_at` (date-time): Time when automation was last modified. Does not change for name or description updates.
|
79
|
+
* `legacy_folder_matching` (boolean): If `true`, use the legacy behavior for this automation, where it can operate on folders in addition to just files. This behavior no longer works and should not be used.
|
78
80
|
* `name` (string): Name for this automation.
|
79
81
|
* `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 if they appear to be the same file size as the newly incoming file. Use the `:always_overwrite_size_matching_files` option to override this.
|
80
82
|
* `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.
|
@@ -93,7 +95,7 @@
|
|
93
95
|
* `user_ids` (array(int64)): IDs of Users for the Automation (i.e. who to Request File from)
|
94
96
|
* `value` (object): A Hash of attributes specific to the automation type.
|
95
97
|
* `webhook_url` (string): If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
|
96
|
-
* `destination` (string):
|
98
|
+
* `destination` (string):
|
97
99
|
|
98
100
|
|
99
101
|
---
|
@@ -103,6 +105,7 @@
|
|
103
105
|
```
|
104
106
|
Files::Automation.list(
|
105
107
|
per_page: 1,
|
108
|
+
page: 1,
|
106
109
|
with_deleted: true
|
107
110
|
)
|
108
111
|
```
|
@@ -111,6 +114,8 @@ Files::Automation.list(
|
|
111
114
|
|
112
115
|
* `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.
|
113
116
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
117
|
+
* `action` (string):
|
118
|
+
* `page` (int64):
|
114
119
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[automation]=desc`). Valid fields are `automation`, `disabled`, `last_modified_at` or `name`.
|
115
120
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `disabled`, `last_modified_at` or `automation`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
|
116
121
|
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `last_modified_at`.
|
@@ -148,6 +153,7 @@ Files::Automation.create(
|
|
148
153
|
sync_ids: [1,2],
|
149
154
|
user_ids: [1,2],
|
150
155
|
group_ids: [1,2],
|
156
|
+
schedule: "example",
|
151
157
|
schedule_days_of_week: [0,1,3],
|
152
158
|
schedule_times_of_day: ["7:30","11:30"],
|
153
159
|
schedule_time_zone: "Eastern Time (US & Canada)",
|
@@ -156,6 +162,7 @@ Files::Automation.create(
|
|
156
162
|
disabled: true,
|
157
163
|
flatten_destination_structure: true,
|
158
164
|
ignore_locked_folders: true,
|
165
|
+
legacy_folder_matching: true,
|
159
166
|
name: "example",
|
160
167
|
overwrite_files: true,
|
161
168
|
path_time_zone: "Eastern Time (US & Canada)",
|
@@ -170,7 +177,7 @@ Files::Automation.create(
|
|
170
177
|
### Parameters
|
171
178
|
|
172
179
|
* `source` (string): Source Path
|
173
|
-
* `destination` (string):
|
180
|
+
* `destination` (string):
|
174
181
|
* `destinations` (array(string)): A list of String destination paths or Hash of folder_path and optional file_path.
|
175
182
|
* `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
176
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.
|
@@ -179,6 +186,7 @@ Files::Automation.create(
|
|
179
186
|
* `sync_ids` (string): A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
180
187
|
* `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
181
188
|
* `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
189
|
+
* `schedule` (object):
|
182
190
|
* `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`. A list of days of the week to run this automation. 0 is Sunday, 1 is Monday, etc.
|
183
191
|
* `schedule_times_of_day` (array(string)): If trigger is `custom_schedule`. A list of times of day to run this automation. 24-hour time format.
|
184
192
|
* `schedule_time_zone` (string): If trigger is `custom_schedule`. Time zone for the schedule.
|
@@ -187,6 +195,7 @@ Files::Automation.create(
|
|
187
195
|
* `disabled` (boolean): If true, this automation will not run.
|
188
196
|
* `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.
|
189
197
|
* `ignore_locked_folders` (boolean): If true, the Lock Folders behavior will be disregarded for automated actions.
|
198
|
+
* `legacy_folder_matching` (boolean): DEPRECATED: If `true`, use the legacy behavior for this automation, where it can operate on folders in addition to just files. This behavior no longer works and should not be used.
|
190
199
|
* `name` (string): Name for this automation.
|
191
200
|
* `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 if they appear to be the same file size as the newly incoming file. Use the `:always_overwrite_size_matching_files` option to override this.
|
192
201
|
* `path_time_zone` (string): Timezone to use when rendering timestamps in paths.
|
@@ -225,6 +234,7 @@ Files::Automation.update(id,
|
|
225
234
|
sync_ids: [1,2],
|
226
235
|
user_ids: [1,2],
|
227
236
|
group_ids: [1,2],
|
237
|
+
schedule: "example",
|
228
238
|
schedule_days_of_week: [0,1,3],
|
229
239
|
schedule_times_of_day: ["7:30","11:30"],
|
230
240
|
schedule_time_zone: "Eastern Time (US & Canada)",
|
@@ -233,6 +243,7 @@ Files::Automation.update(id,
|
|
233
243
|
disabled: true,
|
234
244
|
flatten_destination_structure: true,
|
235
245
|
ignore_locked_folders: true,
|
246
|
+
legacy_folder_matching: true,
|
236
247
|
name: "example",
|
237
248
|
overwrite_files: true,
|
238
249
|
path_time_zone: "Eastern Time (US & Canada)",
|
@@ -248,7 +259,7 @@ Files::Automation.update(id,
|
|
248
259
|
|
249
260
|
* `id` (int64): Required - Automation ID.
|
250
261
|
* `source` (string): Source Path
|
251
|
-
* `destination` (string):
|
262
|
+
* `destination` (string):
|
252
263
|
* `destinations` (array(string)): A list of String destination paths or Hash of folder_path and optional file_path.
|
253
264
|
* `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
254
265
|
* `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.
|
@@ -257,6 +268,7 @@ Files::Automation.update(id,
|
|
257
268
|
* `sync_ids` (string): A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
258
269
|
* `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
259
270
|
* `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
271
|
+
* `schedule` (object):
|
260
272
|
* `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`. A list of days of the week to run this automation. 0 is Sunday, 1 is Monday, etc.
|
261
273
|
* `schedule_times_of_day` (array(string)): If trigger is `custom_schedule`. A list of times of day to run this automation. 24-hour time format.
|
262
274
|
* `schedule_time_zone` (string): If trigger is `custom_schedule`. Time zone for the schedule.
|
@@ -265,6 +277,7 @@ Files::Automation.update(id,
|
|
265
277
|
* `disabled` (boolean): If true, this automation will not run.
|
266
278
|
* `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.
|
267
279
|
* `ignore_locked_folders` (boolean): If true, the Lock Folders behavior will be disregarded for automated actions.
|
280
|
+
* `legacy_folder_matching` (boolean): DEPRECATED: If `true`, use the legacy behavior for this automation, where it can operate on folders in addition to just files. This behavior no longer works and should not be used.
|
268
281
|
* `name` (string): Name for this automation.
|
269
282
|
* `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 if they appear to be the same file size as the newly incoming file. Use the `:always_overwrite_size_matching_files` option to override this.
|
270
283
|
* `path_time_zone` (string): Timezone to use when rendering timestamps in paths.
|
@@ -320,6 +333,7 @@ automation.update(
|
|
320
333
|
sync_ids: [1,2],
|
321
334
|
user_ids: [1,2],
|
322
335
|
group_ids: [1,2],
|
336
|
+
schedule: "example",
|
323
337
|
schedule_days_of_week: [0,1,3],
|
324
338
|
schedule_times_of_day: ["7:30","11:30"],
|
325
339
|
schedule_time_zone: "Eastern Time (US & Canada)",
|
@@ -328,6 +342,7 @@ automation.update(
|
|
328
342
|
disabled: true,
|
329
343
|
flatten_destination_structure: true,
|
330
344
|
ignore_locked_folders: true,
|
345
|
+
legacy_folder_matching: true,
|
331
346
|
name: "example",
|
332
347
|
overwrite_files: true,
|
333
348
|
path_time_zone: "Eastern Time (US & Canada)",
|
@@ -343,7 +358,7 @@ automation.update(
|
|
343
358
|
|
344
359
|
* `id` (int64): Required - Automation ID.
|
345
360
|
* `source` (string): Source Path
|
346
|
-
* `destination` (string):
|
361
|
+
* `destination` (string):
|
347
362
|
* `destinations` (array(string)): A list of String destination paths or Hash of folder_path and optional file_path.
|
348
363
|
* `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
349
364
|
* `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.
|
@@ -352,6 +367,7 @@ automation.update(
|
|
352
367
|
* `sync_ids` (string): A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
353
368
|
* `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
354
369
|
* `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
370
|
+
* `schedule` (object):
|
355
371
|
* `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`. A list of days of the week to run this automation. 0 is Sunday, 1 is Monday, etc.
|
356
372
|
* `schedule_times_of_day` (array(string)): If trigger is `custom_schedule`. A list of times of day to run this automation. 24-hour time format.
|
357
373
|
* `schedule_time_zone` (string): If trigger is `custom_schedule`. Time zone for the schedule.
|
@@ -360,6 +376,7 @@ automation.update(
|
|
360
376
|
* `disabled` (boolean): If true, this automation will not run.
|
361
377
|
* `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.
|
362
378
|
* `ignore_locked_folders` (boolean): If true, the Lock Folders behavior will be disregarded for automated actions.
|
379
|
+
* `legacy_folder_matching` (boolean): DEPRECATED: If `true`, use the legacy behavior for this automation, where it can operate on folders in addition to just files. This behavior no longer works and should not be used.
|
363
380
|
* `name` (string): Name for this automation.
|
364
381
|
* `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 if they appear to be the same file size as the newly incoming file. Use the `:always_overwrite_size_matching_files` option to override this.
|
365
382
|
* `path_time_zone` (string): Timezone to use when rendering timestamps in paths.
|
data/docs/automation_log.md
CHANGED
@@ -33,7 +33,8 @@
|
|
33
33
|
|
34
34
|
```
|
35
35
|
Files::AutomationLog.list(
|
36
|
-
per_page: 1
|
36
|
+
per_page: 1,
|
37
|
+
page: 1
|
37
38
|
)
|
38
39
|
```
|
39
40
|
|
@@ -41,5 +42,7 @@ Files::AutomationLog.list(
|
|
41
42
|
|
42
43
|
* `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.
|
43
44
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
45
|
+
* `action` (string):
|
46
|
+
* `page` (int64):
|
44
47
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `start_date`, `end_date`, `automation_id`, `automation_run_id`, `operation`, `path` or `status`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ automation_id ]`, `[ automation_run_id ]`, `[ operation ]`, `[ path ]`, `[ status ]`, `[ start_date, end_date ]`, `[ start_date, automation_id ]`, `[ start_date, automation_run_id ]`, `[ start_date, operation ]`, `[ start_date, path ]`, `[ start_date, status ]`, `[ end_date, automation_id ]`, `[ end_date, automation_run_id ]`, `[ end_date, operation ]`, `[ end_date, path ]`, `[ end_date, status ]`, `[ automation_id, automation_run_id ]`, `[ automation_id, operation ]`, `[ automation_id, path ]`, `[ automation_id, status ]`, `[ automation_run_id, operation ]`, `[ automation_run_id, path ]`, `[ automation_run_id, status ]`, `[ operation, path ]`, `[ operation, status ]`, `[ path, status ]`, `[ start_date, end_date, automation_id ]`, `[ start_date, end_date, automation_run_id ]`, `[ start_date, end_date, operation ]`, `[ start_date, end_date, path ]`, `[ start_date, end_date, status ]`, `[ start_date, automation_id, automation_run_id ]`, `[ start_date, automation_id, operation ]`, `[ start_date, automation_id, path ]`, `[ start_date, automation_id, status ]`, `[ start_date, automation_run_id, operation ]`, `[ start_date, automation_run_id, path ]`, `[ start_date, automation_run_id, status ]`, `[ start_date, operation, path ]`, `[ start_date, operation, status ]`, `[ start_date, path, status ]`, `[ end_date, automation_id, automation_run_id ]`, `[ end_date, automation_id, operation ]`, `[ end_date, automation_id, path ]`, `[ end_date, automation_id, status ]`, `[ end_date, automation_run_id, operation ]`, `[ end_date, automation_run_id, path ]`, `[ end_date, automation_run_id, status ]`, `[ end_date, operation, path ]`, `[ end_date, operation, status ]`, `[ end_date, path, status ]`, `[ automation_id, automation_run_id, operation ]`, `[ automation_id, automation_run_id, path ]`, `[ automation_id, automation_run_id, status ]`, `[ automation_id, operation, path ]`, `[ automation_id, operation, status ]`, `[ automation_id, path, status ]`, `[ automation_run_id, operation, path ]`, `[ automation_run_id, operation, status ]`, `[ automation_run_id, path, status ]`, `[ operation, path, status ]`, `[ start_date, end_date, automation_id, automation_run_id ]`, `[ start_date, end_date, automation_id, operation ]`, `[ start_date, end_date, automation_id, path ]`, `[ start_date, end_date, automation_id, status ]`, `[ start_date, end_date, automation_run_id, operation ]`, `[ start_date, end_date, automation_run_id, path ]`, `[ start_date, end_date, automation_run_id, status ]`, `[ start_date, end_date, operation, path ]`, `[ start_date, end_date, operation, status ]`, `[ start_date, end_date, path, status ]`, `[ start_date, automation_id, automation_run_id, operation ]`, `[ start_date, automation_id, automation_run_id, path ]`, `[ start_date, automation_id, automation_run_id, status ]`, `[ start_date, automation_id, operation, path ]`, `[ start_date, automation_id, operation, status ]`, `[ start_date, automation_id, path, status ]`, `[ start_date, automation_run_id, operation, path ]`, `[ start_date, automation_run_id, operation, status ]`, `[ start_date, automation_run_id, path, status ]`, `[ start_date, operation, path, status ]`, `[ end_date, automation_id, automation_run_id, operation ]`, `[ end_date, automation_id, automation_run_id, path ]`, `[ end_date, automation_id, automation_run_id, status ]`, `[ end_date, automation_id, operation, path ]`, `[ end_date, automation_id, operation, status ]`, `[ end_date, automation_id, path, status ]`, `[ end_date, automation_run_id, operation, path ]`, `[ end_date, automation_run_id, operation, status ]`, `[ end_date, automation_run_id, path, status ]`, `[ end_date, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path ]`, `[ automation_id, automation_run_id, operation, status ]`, `[ automation_id, automation_run_id, path, status ]`, `[ automation_id, operation, path, status ]`, `[ automation_run_id, operation, path, status ]`, `[ start_date, end_date, automation_id, automation_run_id, operation ]`, `[ start_date, end_date, automation_id, automation_run_id, path ]`, `[ start_date, end_date, automation_id, automation_run_id, status ]`, `[ start_date, end_date, automation_id, operation, path ]`, `[ start_date, end_date, automation_id, operation, status ]`, `[ start_date, end_date, automation_id, path, status ]`, `[ start_date, end_date, automation_run_id, operation, path ]`, `[ start_date, end_date, automation_run_id, operation, status ]`, `[ start_date, end_date, automation_run_id, path, status ]`, `[ start_date, end_date, operation, path, status ]`, `[ start_date, automation_id, automation_run_id, operation, path ]`, `[ start_date, automation_id, automation_run_id, operation, status ]`, `[ start_date, automation_id, automation_run_id, path, status ]`, `[ start_date, automation_id, operation, path, status ]`, `[ start_date, automation_run_id, operation, path, status ]`, `[ end_date, automation_id, automation_run_id, operation, path ]`, `[ end_date, automation_id, automation_run_id, operation, status ]`, `[ end_date, automation_id, automation_run_id, path, status ]`, `[ end_date, automation_id, operation, path, status ]`, `[ end_date, automation_run_id, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path, status ]`, `[ start_date, end_date, automation_id, automation_run_id, operation, path ]`, `[ start_date, end_date, automation_id, automation_run_id, operation, status ]`, `[ start_date, end_date, automation_id, automation_run_id, path, status ]`, `[ start_date, end_date, automation_id, operation, path, status ]`, `[ start_date, end_date, automation_run_id, operation, path, status ]`, `[ start_date, automation_id, automation_run_id, operation, path, status ]` or `[ end_date, automation_id, automation_run_id, operation, path, status ]`.
|
45
48
|
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `operation`, `path` or `status`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ automation_id ]`, `[ automation_run_id ]`, `[ operation ]`, `[ path ]`, `[ status ]`, `[ start_date, end_date ]`, `[ start_date, automation_id ]`, `[ start_date, automation_run_id ]`, `[ start_date, operation ]`, `[ start_date, path ]`, `[ start_date, status ]`, `[ end_date, automation_id ]`, `[ end_date, automation_run_id ]`, `[ end_date, operation ]`, `[ end_date, path ]`, `[ end_date, status ]`, `[ automation_id, automation_run_id ]`, `[ automation_id, operation ]`, `[ automation_id, path ]`, `[ automation_id, status ]`, `[ automation_run_id, operation ]`, `[ automation_run_id, path ]`, `[ automation_run_id, status ]`, `[ operation, path ]`, `[ operation, status ]`, `[ path, status ]`, `[ start_date, end_date, automation_id ]`, `[ start_date, end_date, automation_run_id ]`, `[ start_date, end_date, operation ]`, `[ start_date, end_date, path ]`, `[ start_date, end_date, status ]`, `[ start_date, automation_id, automation_run_id ]`, `[ start_date, automation_id, operation ]`, `[ start_date, automation_id, path ]`, `[ start_date, automation_id, status ]`, `[ start_date, automation_run_id, operation ]`, `[ start_date, automation_run_id, path ]`, `[ start_date, automation_run_id, status ]`, `[ start_date, operation, path ]`, `[ start_date, operation, status ]`, `[ start_date, path, status ]`, `[ end_date, automation_id, automation_run_id ]`, `[ end_date, automation_id, operation ]`, `[ end_date, automation_id, path ]`, `[ end_date, automation_id, status ]`, `[ end_date, automation_run_id, operation ]`, `[ end_date, automation_run_id, path ]`, `[ end_date, automation_run_id, status ]`, `[ end_date, operation, path ]`, `[ end_date, operation, status ]`, `[ end_date, path, status ]`, `[ automation_id, automation_run_id, operation ]`, `[ automation_id, automation_run_id, path ]`, `[ automation_id, automation_run_id, status ]`, `[ automation_id, operation, path ]`, `[ automation_id, operation, status ]`, `[ automation_id, path, status ]`, `[ automation_run_id, operation, path ]`, `[ automation_run_id, operation, status ]`, `[ automation_run_id, path, status ]`, `[ operation, path, status ]`, `[ start_date, end_date, automation_id, automation_run_id ]`, `[ start_date, end_date, automation_id, operation ]`, `[ start_date, end_date, automation_id, path ]`, `[ start_date, end_date, automation_id, status ]`, `[ start_date, end_date, automation_run_id, operation ]`, `[ start_date, end_date, automation_run_id, path ]`, `[ start_date, end_date, automation_run_id, status ]`, `[ start_date, end_date, operation, path ]`, `[ start_date, end_date, operation, status ]`, `[ start_date, end_date, path, status ]`, `[ start_date, automation_id, automation_run_id, operation ]`, `[ start_date, automation_id, automation_run_id, path ]`, `[ start_date, automation_id, automation_run_id, status ]`, `[ start_date, automation_id, operation, path ]`, `[ start_date, automation_id, operation, status ]`, `[ start_date, automation_id, path, status ]`, `[ start_date, automation_run_id, operation, path ]`, `[ start_date, automation_run_id, operation, status ]`, `[ start_date, automation_run_id, path, status ]`, `[ start_date, operation, path, status ]`, `[ end_date, automation_id, automation_run_id, operation ]`, `[ end_date, automation_id, automation_run_id, path ]`, `[ end_date, automation_id, automation_run_id, status ]`, `[ end_date, automation_id, operation, path ]`, `[ end_date, automation_id, operation, status ]`, `[ end_date, automation_id, path, status ]`, `[ end_date, automation_run_id, operation, path ]`, `[ end_date, automation_run_id, operation, status ]`, `[ end_date, automation_run_id, path, status ]`, `[ end_date, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path ]`, `[ automation_id, automation_run_id, operation, status ]`, `[ automation_id, automation_run_id, path, status ]`, `[ automation_id, operation, path, status ]`, `[ automation_run_id, operation, path, status ]`, `[ start_date, end_date, automation_id, automation_run_id, operation ]`, `[ start_date, end_date, automation_id, automation_run_id, path ]`, `[ start_date, end_date, automation_id, automation_run_id, status ]`, `[ start_date, end_date, automation_id, operation, path ]`, `[ start_date, end_date, automation_id, operation, status ]`, `[ start_date, end_date, automation_id, path, status ]`, `[ start_date, end_date, automation_run_id, operation, path ]`, `[ start_date, end_date, automation_run_id, operation, status ]`, `[ start_date, end_date, automation_run_id, path, status ]`, `[ start_date, end_date, operation, path, status ]`, `[ start_date, automation_id, automation_run_id, operation, path ]`, `[ start_date, automation_id, automation_run_id, operation, status ]`, `[ start_date, automation_id, automation_run_id, path, status ]`, `[ start_date, automation_id, operation, path, status ]`, `[ start_date, automation_run_id, operation, path, status ]`, `[ end_date, automation_id, automation_run_id, operation, path ]`, `[ end_date, automation_id, automation_run_id, operation, status ]`, `[ end_date, automation_id, automation_run_id, path, status ]`, `[ end_date, automation_id, operation, path, status ]`, `[ end_date, automation_run_id, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path, status ]`, `[ start_date, end_date, automation_id, automation_run_id, operation, path ]`, `[ start_date, end_date, automation_id, automation_run_id, operation, status ]`, `[ start_date, end_date, automation_id, automation_run_id, path, status ]`, `[ start_date, end_date, automation_id, operation, path, status ]`, `[ start_date, end_date, automation_run_id, operation, path, status ]`, `[ start_date, automation_id, automation_run_id, operation, path, status ]` or `[ end_date, automation_id, automation_run_id, operation, path, status ]`.
|
data/docs/automation_run.md
CHANGED
@@ -34,6 +34,7 @@
|
|
34
34
|
```
|
35
35
|
Files::AutomationRun.list(
|
36
36
|
per_page: 1,
|
37
|
+
page: 1,
|
37
38
|
automation_id: 1
|
38
39
|
)
|
39
40
|
```
|
@@ -42,6 +43,8 @@ Files::AutomationRun.list(
|
|
42
43
|
|
43
44
|
* `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.
|
44
45
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
46
|
+
* `action` (string):
|
47
|
+
* `page` (int64):
|
45
48
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[automation_id]=desc`). Valid fields are `automation_id`, `created_at` or `status`.
|
46
49
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status` and `automation_id`. Valid field combinations are `[ automation_id, status ]`.
|
47
50
|
* `automation_id` (int64): Required - ID of the associated Automation.
|
data/docs/bandwidth_snapshot.md
CHANGED
@@ -33,7 +33,8 @@
|
|
33
33
|
|
34
34
|
```
|
35
35
|
Files::BandwidthSnapshot.list(
|
36
|
-
per_page: 1
|
36
|
+
per_page: 1,
|
37
|
+
page: 1
|
37
38
|
)
|
38
39
|
```
|
39
40
|
|
@@ -41,6 +42,8 @@ Files::BandwidthSnapshot.list(
|
|
41
42
|
|
42
43
|
* `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.
|
43
44
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
45
|
+
* `action` (string):
|
46
|
+
* `page` (int64):
|
44
47
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[logged_at]=desc`). Valid fields are `logged_at`.
|
45
48
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
|
46
49
|
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `logged_at`.
|
data/docs/behavior.md
CHANGED
@@ -27,8 +27,8 @@
|
|
27
27
|
* `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.
|
28
28
|
* `disable_parent_folder_behavior` (boolean): If true, the parent folder's behavior will be disabled for this folder and its children.
|
29
29
|
* `recursive` (boolean): Is behavior recursive?
|
30
|
-
* `attachment_file` (file): Certain behaviors may require a file, for instance, the
|
31
|
-
* `attachment_delete` (boolean): If true
|
30
|
+
* `attachment_file` (file): Certain behaviors may require a file, for instance, the `watermark` behavior requires a watermark image. Attach that file here.
|
31
|
+
* `attachment_delete` (boolean): If `true`, delete the file stored in `attachment`.
|
32
32
|
|
33
33
|
|
34
34
|
---
|
@@ -37,7 +37,8 @@
|
|
37
37
|
|
38
38
|
```
|
39
39
|
Files::Behavior.list(
|
40
|
-
per_page: 1
|
40
|
+
per_page: 1,
|
41
|
+
page: 1
|
41
42
|
)
|
42
43
|
```
|
43
44
|
|
@@ -45,6 +46,8 @@ Files::Behavior.list(
|
|
45
46
|
|
46
47
|
* `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.
|
47
48
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
49
|
+
* `action` (string):
|
50
|
+
* `page` (int64):
|
48
51
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[behavior]=desc`). Valid fields are `behavior` and `impacts_ui`.
|
49
52
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `impacts_ui` and `behavior`.
|
50
53
|
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `behavior`.
|
@@ -70,6 +73,8 @@ Files::Behavior.find(id)
|
|
70
73
|
```
|
71
74
|
Files::Behavior.list_for(path,
|
72
75
|
per_page: 1,
|
76
|
+
page: 1,
|
77
|
+
ancestor_behaviors: true,
|
73
78
|
behavior: "webhook"
|
74
79
|
)
|
75
80
|
```
|
@@ -78,12 +83,14 @@ Files::Behavior.list_for(path,
|
|
78
83
|
|
79
84
|
* `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.
|
80
85
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
86
|
+
* `action` (string):
|
87
|
+
* `page` (int64):
|
81
88
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[behavior]=desc`). Valid fields are `behavior` and `impacts_ui`.
|
82
89
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `impacts_ui` and `behavior`.
|
83
90
|
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `behavior`.
|
84
91
|
* `path` (string): Required - Path to operate on.
|
85
|
-
* `ancestor_behaviors` (
|
86
|
-
* `behavior` (string):
|
92
|
+
* `ancestor_behaviors` (boolean): If `true`, behaviors above this path are shown.
|
93
|
+
* `behavior` (string):
|
87
94
|
|
88
95
|
|
89
96
|
---
|
@@ -104,13 +111,13 @@ Files::Behavior.create(
|
|
104
111
|
|
105
112
|
### Parameters
|
106
113
|
|
107
|
-
* `value` (string):
|
108
|
-
* `attachment_file` (file): Certain behaviors may require a file, for instance, the
|
109
|
-
* `disable_parent_folder_behavior` (boolean): If true
|
110
|
-
* `recursive` (boolean):
|
114
|
+
* `value` (string): This field stores a hash of data specific to the type of behavior. See The Behavior Types section for example values for each type of behavior.
|
115
|
+
* `attachment_file` (file): Certain behaviors may require a file, for instance, the `watermark` behavior requires a watermark image. Attach that file here.
|
116
|
+
* `disable_parent_folder_behavior` (boolean): If `true`, the parent folder's behavior will be disabled for this folder and its children. This is the main mechanism for canceling out a `recursive` behavior higher in the folder tree.
|
117
|
+
* `recursive` (boolean): If `true`, behavior is treated as recursive, meaning that it impacts child folders as well.
|
111
118
|
* `name` (string): Name for this behavior.
|
112
119
|
* `description` (string): Description for this behavior.
|
113
|
-
* `path` (string): Required -
|
120
|
+
* `path` (string): Required - Path where this behavior should apply.
|
114
121
|
* `behavior` (string): Required - Behavior type.
|
115
122
|
|
116
123
|
|
@@ -132,11 +139,11 @@ Files::Behavior.webhook_test(
|
|
132
139
|
### Parameters
|
133
140
|
|
134
141
|
* `url` (string): Required - URL for testing the webhook.
|
135
|
-
* `method` (string): HTTP method(GET or POST).
|
136
|
-
* `encoding` (string):
|
137
|
-
* `headers` (object): Additional request headers.
|
138
|
-
* `body` (object): Additional body parameters.
|
139
|
-
* `action` (string):
|
142
|
+
* `method` (string): HTTP request method (GET or POST).
|
143
|
+
* `encoding` (string): Encoding type for the webhook payload. Can be JSON, XML, or RAW (form data).
|
144
|
+
* `headers` (object): Additional request headers to send via HTTP.
|
145
|
+
* `body` (object): Additional body parameters to include in the webhook payload.
|
146
|
+
* `action` (string): Action for test body.
|
140
147
|
|
141
148
|
|
142
149
|
---
|
@@ -157,13 +164,13 @@ Files::Behavior.update(id,
|
|
157
164
|
### Parameters
|
158
165
|
|
159
166
|
* `id` (int64): Required - Behavior ID.
|
160
|
-
* `value` (string):
|
161
|
-
* `attachment_file` (file): Certain behaviors may require a file, for instance, the
|
162
|
-
* `disable_parent_folder_behavior` (boolean): If true
|
163
|
-
* `recursive` (boolean):
|
167
|
+
* `value` (string): This field stores a hash of data specific to the type of behavior. See The Behavior Types section for example values for each type of behavior.
|
168
|
+
* `attachment_file` (file): Certain behaviors may require a file, for instance, the `watermark` behavior requires a watermark image. Attach that file here.
|
169
|
+
* `disable_parent_folder_behavior` (boolean): If `true`, the parent folder's behavior will be disabled for this folder and its children. This is the main mechanism for canceling out a `recursive` behavior higher in the folder tree.
|
170
|
+
* `recursive` (boolean): If `true`, behavior is treated as recursive, meaning that it impacts child folders as well.
|
164
171
|
* `name` (string): Name for this behavior.
|
165
172
|
* `description` (string): Description for this behavior.
|
166
|
-
* `attachment_delete` (boolean): If true
|
173
|
+
* `attachment_delete` (boolean): If `true`, delete the file stored in `attachment`.
|
167
174
|
|
168
175
|
|
169
176
|
---
|
@@ -199,13 +206,13 @@ behavior.update(
|
|
199
206
|
### Parameters
|
200
207
|
|
201
208
|
* `id` (int64): Required - Behavior ID.
|
202
|
-
* `value` (string):
|
203
|
-
* `attachment_file` (file): Certain behaviors may require a file, for instance, the
|
204
|
-
* `disable_parent_folder_behavior` (boolean): If true
|
205
|
-
* `recursive` (boolean):
|
209
|
+
* `value` (string): This field stores a hash of data specific to the type of behavior. See The Behavior Types section for example values for each type of behavior.
|
210
|
+
* `attachment_file` (file): Certain behaviors may require a file, for instance, the `watermark` behavior requires a watermark image. Attach that file here.
|
211
|
+
* `disable_parent_folder_behavior` (boolean): If `true`, the parent folder's behavior will be disabled for this folder and its children. This is the main mechanism for canceling out a `recursive` behavior higher in the folder tree.
|
212
|
+
* `recursive` (boolean): If `true`, behavior is treated as recursive, meaning that it impacts child folders as well.
|
206
213
|
* `name` (string): Name for this behavior.
|
207
214
|
* `description` (string): Description for this behavior.
|
208
|
-
* `attachment_delete` (boolean): If true
|
215
|
+
* `attachment_delete` (boolean): If `true`, delete the file stored in `attachment`.
|
209
216
|
|
210
217
|
|
211
218
|
---
|
data/docs/bundle.md
CHANGED
@@ -97,7 +97,7 @@
|
|
97
97
|
* `expires_at` (date-time): Bundle expiration date/time
|
98
98
|
* `password_protected` (boolean): Is this bundle password protected?
|
99
99
|
* `permissions` (string): Permissions that apply to Folders in this Share Link.
|
100
|
-
* `preview_only` (boolean):
|
100
|
+
* `preview_only` (boolean):
|
101
101
|
* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
|
102
102
|
* `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
103
103
|
* `require_logout` (boolean): If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
|
@@ -140,7 +140,8 @@
|
|
140
140
|
```
|
141
141
|
Files::Bundle.list(
|
142
142
|
user_id: 1,
|
143
|
-
per_page: 1
|
143
|
+
per_page: 1,
|
144
|
+
page: 1
|
144
145
|
)
|
145
146
|
```
|
146
147
|
|
@@ -149,6 +150,8 @@ Files::Bundle.list(
|
|
149
150
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
150
151
|
* `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.
|
151
152
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
153
|
+
* `action` (string):
|
154
|
+
* `page` (int64):
|
152
155
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at` and `code`.
|
153
156
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
154
157
|
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
@@ -191,7 +194,6 @@ Files::Bundle.create(
|
|
191
194
|
path_template: "{{name}}_{{ip}}",
|
192
195
|
path_template_time_zone: "Eastern Time (US & Canada)",
|
193
196
|
permissions: "read",
|
194
|
-
preview_only: true,
|
195
197
|
require_registration: true,
|
196
198
|
clickwrap_id: 1,
|
197
199
|
inbox_id: 1,
|
@@ -222,7 +224,6 @@ Files::Bundle.create(
|
|
222
224
|
* `path_template` (string): Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, `strftime` directives, and any custom form data.
|
223
225
|
* `path_template_time_zone` (string): Timezone to use when rendering timestamps in path templates.
|
224
226
|
* `permissions` (string): Permissions that apply to Folders in this Share Link.
|
225
|
-
* `preview_only` (boolean): DEPRECATED: Restrict users to previewing files only. Use `permissions` instead.
|
226
227
|
* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
|
227
228
|
* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
|
228
229
|
* `inbox_id` (int64): ID of the associated inbox, if available.
|
@@ -278,7 +279,6 @@ Files::Bundle.update(id,
|
|
278
279
|
path_template: "{{name}}_{{ip}}",
|
279
280
|
path_template_time_zone: "Eastern Time (US & Canada)",
|
280
281
|
permissions: "read",
|
281
|
-
preview_only: true,
|
282
282
|
require_registration: true,
|
283
283
|
require_share_recipient: true,
|
284
284
|
send_email_receipt_to_uploader: true,
|
@@ -309,7 +309,6 @@ Files::Bundle.update(id,
|
|
309
309
|
* `path_template` (string): Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, `strftime` directives, and any custom form data.
|
310
310
|
* `path_template_time_zone` (string): Timezone to use when rendering timestamps in path templates.
|
311
311
|
* `permissions` (string): Permissions that apply to Folders in this Share Link.
|
312
|
-
* `preview_only` (boolean): DEPRECATED: Restrict users to previewing files only. Use `permissions` instead.
|
313
312
|
* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
|
314
313
|
* `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
315
314
|
* `send_email_receipt_to_uploader` (boolean): Send delivery receipt to the uploader. Note: For writable share only
|
@@ -380,7 +379,6 @@ bundle.update(
|
|
380
379
|
path_template: "{{name}}_{{ip}}",
|
381
380
|
path_template_time_zone: "Eastern Time (US & Canada)",
|
382
381
|
permissions: "read",
|
383
|
-
preview_only: true,
|
384
382
|
require_registration: true,
|
385
383
|
require_share_recipient: true,
|
386
384
|
send_email_receipt_to_uploader: true,
|
@@ -411,7 +409,6 @@ bundle.update(
|
|
411
409
|
* `path_template` (string): Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, `strftime` directives, and any custom form data.
|
412
410
|
* `path_template_time_zone` (string): Timezone to use when rendering timestamps in path templates.
|
413
411
|
* `permissions` (string): Permissions that apply to Folders in this Share Link.
|
414
|
-
* `preview_only` (boolean): DEPRECATED: Restrict users to previewing files only. Use `permissions` instead.
|
415
412
|
* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
|
416
413
|
* `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
417
414
|
* `send_email_receipt_to_uploader` (boolean): Send delivery receipt to the uploader. Note: For writable share only
|
data/docs/bundle_action.md
CHANGED
@@ -44,6 +44,8 @@
|
|
44
44
|
```
|
45
45
|
Files::BundleAction.list(
|
46
46
|
per_page: 1,
|
47
|
+
action: "create",
|
48
|
+
page: 1,
|
47
49
|
bundle_id: 1,
|
48
50
|
bundle_registration_id: 1
|
49
51
|
)
|
@@ -53,6 +55,8 @@ Files::BundleAction.list(
|
|
53
55
|
|
54
56
|
* `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.
|
55
57
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
58
|
+
* `action` (string):
|
59
|
+
* `page` (int64):
|
56
60
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[bundle_registration_id]=desc`). Valid fields are `bundle_registration_id` and `created_at`.
|
57
61
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
58
62
|
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
data/docs/bundle_download.md
CHANGED
@@ -24,6 +24,7 @@
|
|
24
24
|
```
|
25
25
|
Files::BundleDownload.list(
|
26
26
|
per_page: 1,
|
27
|
+
page: 1,
|
27
28
|
bundle_id: 1,
|
28
29
|
bundle_registration_id: 1
|
29
30
|
)
|
@@ -33,6 +34,8 @@ Files::BundleDownload.list(
|
|
33
34
|
|
34
35
|
* `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.
|
35
36
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
37
|
+
* `action` (string):
|
38
|
+
* `page` (int64):
|
36
39
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at`.
|
37
40
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
38
41
|
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
data/docs/bundle_notification.md
CHANGED
@@ -25,7 +25,8 @@
|
|
25
25
|
|
26
26
|
```
|
27
27
|
Files::BundleNotification.list(
|
28
|
-
per_page: 1
|
28
|
+
per_page: 1,
|
29
|
+
page: 1
|
29
30
|
)
|
30
31
|
```
|
31
32
|
|
@@ -33,6 +34,8 @@ Files::BundleNotification.list(
|
|
33
34
|
|
34
35
|
* `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.
|
35
36
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
37
|
+
* `action` (string):
|
38
|
+
* `page` (int64):
|
36
39
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[bundle_id]=desc`). Valid fields are `bundle_id`.
|
37
40
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `bundle_id`.
|
38
41
|
|
data/docs/bundle_recipient.md
CHANGED
@@ -28,6 +28,7 @@
|
|
28
28
|
```
|
29
29
|
Files::BundleRecipient.list(
|
30
30
|
per_page: 1,
|
31
|
+
page: 1,
|
31
32
|
bundle_id: 1
|
32
33
|
)
|
33
34
|
```
|
@@ -36,6 +37,8 @@ Files::BundleRecipient.list(
|
|
36
37
|
|
37
38
|
* `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.
|
38
39
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
40
|
+
* `action` (string):
|
41
|
+
* `page` (int64):
|
39
42
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[has_registrations]=desc`). Valid fields are `has_registrations`.
|
40
43
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
|
41
44
|
* `bundle_id` (int64): Required - List recipients for the bundle with this ID.
|
data/docs/bundle_registration.md
CHANGED
@@ -44,6 +44,7 @@
|
|
44
44
|
```
|
45
45
|
Files::BundleRegistration.list(
|
46
46
|
per_page: 1,
|
47
|
+
page: 1,
|
47
48
|
bundle_id: 1
|
48
49
|
)
|
49
50
|
```
|
@@ -52,4 +53,6 @@ Files::BundleRegistration.list(
|
|
52
53
|
|
53
54
|
* `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.
|
54
55
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
56
|
+
* `action` (string):
|
57
|
+
* `page` (int64):
|
55
58
|
* `bundle_id` (int64): ID of the associated Bundle
|
data/docs/clickwrap.md
CHANGED
@@ -27,7 +27,8 @@
|
|
27
27
|
|
28
28
|
```
|
29
29
|
Files::Clickwrap.list(
|
30
|
-
per_page: 1
|
30
|
+
per_page: 1,
|
31
|
+
page: 1
|
31
32
|
)
|
32
33
|
```
|
33
34
|
|
@@ -35,6 +36,8 @@ Files::Clickwrap.list(
|
|
35
36
|
|
36
37
|
* `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.
|
37
38
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
39
|
+
* `action` (string):
|
40
|
+
* `page` (int64):
|
38
41
|
|
39
42
|
|
40
43
|
---
|
data/docs/dns_record.md
CHANGED
@@ -23,7 +23,8 @@
|
|
23
23
|
|
24
24
|
```
|
25
25
|
Files::DnsRecord.list(
|
26
|
-
per_page: 1
|
26
|
+
per_page: 1,
|
27
|
+
page: 1
|
27
28
|
)
|
28
29
|
```
|
29
30
|
|
@@ -31,3 +32,5 @@ Files::DnsRecord.list(
|
|
31
32
|
|
32
33
|
* `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.
|
33
34
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
35
|
+
* `action` (string):
|
36
|
+
* `page` (int64):
|
@@ -33,7 +33,8 @@
|
|
33
33
|
|
34
34
|
```
|
35
35
|
Files::EmailIncomingMessage.list(
|
36
|
-
per_page: 1
|
36
|
+
per_page: 1,
|
37
|
+
page: 1
|
37
38
|
)
|
38
39
|
```
|
39
40
|
|
@@ -41,6 +42,8 @@ Files::EmailIncomingMessage.list(
|
|
41
42
|
|
42
43
|
* `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.
|
43
44
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
45
|
+
* `action` (string):
|
46
|
+
* `page` (int64):
|
44
47
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at`, `sender`, `status` or `inbox_id`.
|
45
48
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `inbox_id`, `sender` or `status`. Valid field combinations are `[ sender, created_at ]`, `[ status, created_at ]`, `[ inbox_id, created_at ]`, `[ inbox_id, status, created_at ]` or `[ inbox_id, status, sender, created_at ]`.
|
46
49
|
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
data/docs/email_log.md
CHANGED
@@ -33,7 +33,8 @@
|
|
33
33
|
|
34
34
|
```
|
35
35
|
Files::EmailLog.list(
|
36
|
-
per_page: 1
|
36
|
+
per_page: 1,
|
37
|
+
page: 1
|
37
38
|
)
|
38
39
|
```
|
39
40
|
|
@@ -41,5 +42,7 @@ Files::EmailLog.list(
|
|
41
42
|
|
42
43
|
* `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.
|
43
44
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
45
|
+
* `action` (string):
|
46
|
+
* `page` (int64):
|
44
47
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `start_date`, `end_date` or `status`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ status ]`, `[ start_date, end_date ]`, `[ start_date, status ]` or `[ end_date, status ]`.
|
45
48
|
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `status`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ status ]`, `[ start_date, end_date ]`, `[ start_date, status ]` or `[ end_date, status ]`.
|