files.com 1.0.225 → 1.0.229

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (97) hide show
  1. checksums.yaml +4 -4
  2. data/_VERSION +1 -1
  3. data/docs/action_notification_export_result.md +1 -1
  4. data/docs/api_key.md +7 -7
  5. data/docs/app.md +8 -8
  6. data/docs/as2_key.md +1 -1
  7. data/docs/automation.md +7 -7
  8. data/docs/automation_run.md +7 -7
  9. data/docs/bandwidth_snapshot.md +7 -7
  10. data/docs/behavior.md +21 -16
  11. data/docs/bundle.md +25 -9
  12. data/docs/bundle_download.md +7 -7
  13. data/docs/bundle_recipient.md +7 -7
  14. data/docs/bundle_registration.md +2 -2
  15. data/docs/clickwrap.md +1 -1
  16. data/docs/dns_record.md +1 -1
  17. data/docs/external_event.md +7 -7
  18. data/docs/file_comment.md +1 -1
  19. data/docs/form_field_set.md +1 -1
  20. data/docs/group.md +7 -7
  21. data/docs/group_user.md +1 -1
  22. data/docs/history.md +11 -11
  23. data/docs/history_export_result.md +1 -1
  24. data/docs/inbox_recipient.md +7 -7
  25. data/docs/inbox_registration.md +2 -2
  26. data/docs/inbox_upload.md +7 -7
  27. data/docs/invoice.md +1 -1
  28. data/docs/ip_address.md +2 -2
  29. data/docs/lock.md +1 -1
  30. data/docs/message.md +1 -1
  31. data/docs/message_comment.md +1 -1
  32. data/docs/message_comment_reaction.md +1 -1
  33. data/docs/message_reaction.md +1 -1
  34. data/docs/notification.md +7 -7
  35. data/docs/payment.md +1 -1
  36. data/docs/permission.md +7 -7
  37. data/docs/priority.md +1 -1
  38. data/docs/project.md +1 -1
  39. data/docs/public_key.md +1 -1
  40. data/docs/remote_server.md +1 -1
  41. data/docs/request.md +2 -2
  42. data/docs/settings_change.md +11 -7
  43. data/docs/sso_strategy.md +1 -1
  44. data/docs/sync_job.md +1 -1
  45. data/docs/usage_daily_snapshot.md +7 -7
  46. data/docs/usage_snapshot.md +1 -1
  47. data/docs/user.md +7 -7
  48. data/docs/user_cipher_use.md +1 -1
  49. data/docs/user_request.md +1 -1
  50. data/lib/files.com/models/action_notification_export_result.rb +1 -1
  51. data/lib/files.com/models/api_key.rb +7 -7
  52. data/lib/files.com/models/app.rb +8 -8
  53. data/lib/files.com/models/as2_key.rb +1 -1
  54. data/lib/files.com/models/automation.rb +7 -7
  55. data/lib/files.com/models/automation_run.rb +7 -7
  56. data/lib/files.com/models/bandwidth_snapshot.rb +7 -7
  57. data/lib/files.com/models/behavior.rb +27 -15
  58. data/lib/files.com/models/bundle.rb +48 -7
  59. data/lib/files.com/models/bundle_download.rb +7 -7
  60. data/lib/files.com/models/bundle_recipient.rb +7 -7
  61. data/lib/files.com/models/bundle_registration.rb +2 -2
  62. data/lib/files.com/models/clickwrap.rb +1 -1
  63. data/lib/files.com/models/dns_record.rb +1 -1
  64. data/lib/files.com/models/external_event.rb +7 -7
  65. data/lib/files.com/models/file_comment.rb +1 -1
  66. data/lib/files.com/models/form_field_set.rb +1 -1
  67. data/lib/files.com/models/group.rb +7 -7
  68. data/lib/files.com/models/group_user.rb +1 -1
  69. data/lib/files.com/models/history.rb +11 -11
  70. data/lib/files.com/models/history_export_result.rb +1 -1
  71. data/lib/files.com/models/inbox_recipient.rb +7 -7
  72. data/lib/files.com/models/inbox_registration.rb +2 -2
  73. data/lib/files.com/models/inbox_upload.rb +7 -7
  74. data/lib/files.com/models/invoice.rb +1 -1
  75. data/lib/files.com/models/ip_address.rb +2 -2
  76. data/lib/files.com/models/lock.rb +1 -1
  77. data/lib/files.com/models/message.rb +1 -1
  78. data/lib/files.com/models/message_comment.rb +1 -1
  79. data/lib/files.com/models/message_comment_reaction.rb +1 -1
  80. data/lib/files.com/models/message_reaction.rb +1 -1
  81. data/lib/files.com/models/notification.rb +7 -7
  82. data/lib/files.com/models/payment.rb +1 -1
  83. data/lib/files.com/models/permission.rb +7 -7
  84. data/lib/files.com/models/priority.rb +1 -1
  85. data/lib/files.com/models/project.rb +1 -1
  86. data/lib/files.com/models/public_key.rb +1 -1
  87. data/lib/files.com/models/remote_server.rb +1 -1
  88. data/lib/files.com/models/request.rb +2 -2
  89. data/lib/files.com/models/settings_change.rb +12 -7
  90. data/lib/files.com/models/sso_strategy.rb +1 -1
  91. data/lib/files.com/models/sync_job.rb +1 -1
  92. data/lib/files.com/models/usage_daily_snapshot.rb +7 -7
  93. data/lib/files.com/models/usage_snapshot.rb +1 -1
  94. data/lib/files.com/models/user.rb +7 -7
  95. data/lib/files.com/models/user_cipher_use.rb +1 -1
  96. data/lib/files.com/models/user_request.rb +1 -1
  97. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1a574f05e44afd663c1075e75c7c2b8dc407c90691e4edb778e81ba399229fdb
4
- data.tar.gz: aa0858a5211a2059a9a8d1d6db80046232ca76850cebf52ddf22d4ab30847611
3
+ metadata.gz: 64c6eb7553e0596fa681bb44f8e5b307aa5d674e50abef7246fabd2bcd420aa0
4
+ data.tar.gz: f1c3505295d41a06fafc09114e4345a24a9bbb67042142dd85a715dc50d25204
5
5
  SHA512:
6
- metadata.gz: c122e4c0f2506817a8ba9a9ddef7689daaee2bdb49f32a96c7c3d2e63bc6958763f7cdfb9c6af6456894e78d17b1f021a342d55b83429d91bd00b71f32725643
7
- data.tar.gz: 84532fba3891c986190dbf086450bfd4257ba60180c3a34b462b8955d875da800e0d55f5bd20768d8353964d453e8bcac71622efec539e1248ab1470640b0f50
6
+ metadata.gz: 43efd46067182e5734c44a21f6b70a06a53d377f0838157d28b1a52bb1c61011f9d5a5531346704d3fdd01c9854d1320bdc7bb404e0046ce2fac5a7f8e71332b
7
+ data.tar.gz: d823c245d34aef45d3ba60888d93ba5c4e87919904b6a1242d88b1b24acf472fadcd1023ab586f7775f979894b31370333f3e881d22f9615b21ce0093950ab41
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.225
1
+ 1.0.229
@@ -44,6 +44,6 @@ Files::ActionNotificationExportResult.list(
44
44
  ### Parameters
45
45
 
46
46
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
47
- * `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 the X-Files-Cursor-Next header.
47
+ * `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.
48
48
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
49
49
  * `action_notification_export_id` (int64): Required - ID of the associated action notification export.
data/docs/api_key.md CHANGED
@@ -45,15 +45,15 @@ Files::ApiKey.list(
45
45
  ### Parameters
46
46
 
47
47
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
48
- * `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 the X-Files-Cursor-Next header.
48
+ * `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.
49
49
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
50
50
  * `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 `expires_at`.
51
- * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `expires_at`.
52
- * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `expires_at`.
53
- * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `expires_at`.
54
- * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `expires_at`.
55
- * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `expires_at`.
56
- * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `expires_at`.
51
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `expires_at`.
52
+ * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `expires_at`.
53
+ * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `expires_at`.
54
+ * `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `expires_at`.
55
+ * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `expires_at`.
56
+ * `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `expires_at`.
57
57
 
58
58
 
59
59
  ---
data/docs/app.md CHANGED
@@ -28,7 +28,7 @@
28
28
  * `name` (string): Name of the App
29
29
  * `extended_description` (string): Long form description of the App
30
30
  * `short_description` (string): Short description of the App
31
- * `documentation_links` (string): Collection of named links to documentation
31
+ * `documentation_links` (object): Collection of named links to documentation
32
32
  * `icon_url` (string): App icon
33
33
  * `logo_url` (string): Full size logo for the App
34
34
  * `screenshot_list_urls` (string): Screenshots of the App
@@ -55,12 +55,12 @@ Files::App.list(
55
55
 
56
56
  ### Parameters
57
57
 
58
- * `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 the X-Files-Cursor-Next header.
58
+ * `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.
59
59
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
60
60
  * `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 `name` and `app_type`.
61
- * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `name` and `app_type`.
62
- * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `name` and `app_type`.
63
- * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `name` and `app_type`.
64
- * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `name` and `app_type`.
65
- * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `name` and `app_type`.
66
- * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `name` and `app_type`.
61
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`.
62
+ * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `name` and `app_type`.
63
+ * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `name` and `app_type`.
64
+ * `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`.
65
+ * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `name` and `app_type`.
66
+ * `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `name` and `app_type`.
data/docs/as2_key.md CHANGED
@@ -33,7 +33,7 @@ Files::As2Key.list(
33
33
  ### Parameters
34
34
 
35
35
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
36
- * `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 the X-Files-Cursor-Next header.
36
+ * `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.
37
37
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
38
38
 
39
39
 
data/docs/automation.md CHANGED
@@ -80,15 +80,15 @@ Files::Automation.list(
80
80
 
81
81
  ### Parameters
82
82
 
83
- * `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 the X-Files-Cursor-Next header.
83
+ * `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.
84
84
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
85
85
  * `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`.
86
- * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `automation`.
87
- * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `automation`.
88
- * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `automation`.
89
- * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `automation`.
90
- * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `automation`.
91
- * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `automation`.
86
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `automation`.
87
+ * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `automation`.
88
+ * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `automation`.
89
+ * `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `automation`.
90
+ * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `automation`.
91
+ * `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `automation`.
92
92
  * `automation` (string): DEPRECATED: Type of automation to filter by. Use `filter[automation]` instead.
93
93
 
94
94
 
@@ -36,15 +36,15 @@ Files::AutomationRun.list(
36
36
  ### Parameters
37
37
 
38
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 the X-Files-Cursor-Next header.
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
40
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
41
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 specifiied field is equal to the supplied value. Valid fields are `status`.
43
- * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `status`.
44
- * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `status`.
45
- * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `status`.
46
- * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `status`.
47
- * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `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
48
  * `automation_id` (int64): Required - ID of the associated Automation.
49
49
 
50
50
 
@@ -43,12 +43,12 @@ Files::BandwidthSnapshot.list(
43
43
 
44
44
  ### Parameters
45
45
 
46
- * `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 the X-Files-Cursor-Next header.
46
+ * `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.
47
47
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
48
48
  * `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`.
49
- * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `logged_at`.
50
- * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `logged_at`.
51
- * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `logged_at`.
52
- * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `logged_at`.
53
- * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `logged_at`.
54
- * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `logged_at`.
49
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
50
+ * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `logged_at`.
51
+ * `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`.
52
+ * `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
53
+ * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `logged_at`.
54
+ * `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`.
data/docs/behavior.md CHANGED
@@ -24,6 +24,7 @@
24
24
  * `description` (string): Description for this behavior.
25
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
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
27
28
 
28
29
 
29
30
  ---
@@ -39,15 +40,15 @@ Files::Behavior.list(
39
40
 
40
41
  ### Parameters
41
42
 
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 the X-Files-Cursor-Next header.
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.
43
44
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
44
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`.
45
- * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `behavior`.
46
- * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `behavior`.
47
- * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `behavior`.
48
- * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `behavior`.
49
- * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `behavior`.
50
- * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. 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`.
51
52
  * `behavior` (string): If set, only shows folder behaviors matching this behavior type.
52
53
 
53
54
 
@@ -77,15 +78,15 @@ Files::Behavior.list_for(path,
77
78
 
78
79
  ### Parameters
79
80
 
80
- * `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 the X-Files-Cursor-Next header.
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.
81
82
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
82
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`.
83
- * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `behavior`.
84
- * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `behavior`.
85
- * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `behavior`.
86
- * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `behavior`.
87
- * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `behavior`.
88
- * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. 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`.
89
90
  * `path` (string): Required - Path to operate on.
90
91
  * `recursive` (string): Show behaviors above this path?
91
92
  * `behavior` (string): DEPRECATED: If set only shows folder behaviors matching this behavior type. Use `filter[behavior]` instead.
@@ -145,7 +146,8 @@ Files::Behavior.webhook_test(
145
146
  ```
146
147
  Files::Behavior.update(id,
147
148
  value: "{\"method\": \"GET\"}",
148
- behavior: "webhook"
149
+ behavior: "webhook",
150
+ attachment_delete: true
149
151
  )
150
152
  ```
151
153
 
@@ -158,6 +160,7 @@ Files::Behavior.update(id,
158
160
  * `description` (string): Description for this behavior.
159
161
  * `behavior` (string): Behavior type.
160
162
  * `path` (string): Folder behaviors path.
163
+ * `attachment_delete` (boolean): If true, will delete the file stored in attachment
161
164
 
162
165
 
163
166
  ---
@@ -182,7 +185,8 @@ behavior = Files::Behavior.list.first
182
185
 
183
186
  behavior.update(
184
187
  value: "{\"method\": \"GET\"}",
185
- behavior: "webhook"
188
+ behavior: "webhook",
189
+ attachment_delete: true
186
190
  )
187
191
  ```
188
192
 
@@ -195,6 +199,7 @@ behavior.update(
195
199
  * `description` (string): Description for this behavior.
196
200
  * `behavior` (string): Behavior type.
197
201
  * `path` (string): Folder behaviors path.
202
+ * `attachment_delete` (boolean): If true, will delete the file stored in attachment
198
203
 
199
204
 
200
205
  ---
data/docs/bundle.md CHANGED
@@ -48,6 +48,11 @@
48
48
  "username": "user",
49
49
  "clickwrap_id": 1,
50
50
  "inbox_id": 1,
51
+ "watermark_attachment": {
52
+ "name": "My logo",
53
+ "uri": "https://mysite.files.com/.../my_image.png"
54
+ },
55
+ "watermark_value": "",
51
56
  "has_inbox": true,
52
57
  "paths": [
53
58
  "file.txt"
@@ -73,10 +78,14 @@
73
78
  * `username` (string): Bundle creator username
74
79
  * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
75
80
  * `inbox_id` (int64): ID of the associated inbox, if available.
81
+ * `watermark_attachment`: Preview watermark image applied to all bundle items.
82
+ * `watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
76
83
  * `has_inbox` (boolean): Does this bundle have an associated inbox?
77
84
  * `paths` (array): A list of paths in this bundle
78
85
  * `password` (string): Password for this bundle.
79
86
  * `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
87
+ * `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
88
+ * `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
80
89
 
81
90
 
82
91
  ---
@@ -93,15 +102,15 @@ Files::Bundle.list(
93
102
  ### Parameters
94
103
 
95
104
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
96
- * `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 the X-Files-Cursor-Next header.
105
+ * `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.
97
106
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
98
107
  * `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 `code`.
99
- * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
100
- * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`.
101
- * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `created_at`.
102
- * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
103
- * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `created_at`.
104
- * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `created_at`.
108
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
109
+ * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
110
+ * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`.
111
+ * `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
112
+ * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
113
+ * `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`.
105
114
 
106
115
 
107
116
  ---
@@ -156,6 +165,7 @@ Files::Bundle.create(
156
165
  * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
157
166
  * `inbox_id` (int64): ID of the associated inbox, if available.
158
167
  * `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
168
+ * `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
159
169
 
160
170
 
161
171
  ---
@@ -196,7 +206,8 @@ Files::Bundle.update(id,
196
206
  note: "The internal note on the bundle.",
197
207
  preview_only: true,
198
208
  require_registration: true,
199
- require_share_recipient: true
209
+ require_share_recipient: true,
210
+ watermark_attachment_delete: true
200
211
  )
201
212
  ```
202
213
 
@@ -216,6 +227,8 @@ Files::Bundle.update(id,
216
227
  * `preview_only` (boolean): Restrict users to previewing files only?
217
228
  * `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
218
229
  * `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
230
+ * `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
231
+ * `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
219
232
 
220
233
 
221
234
  ---
@@ -273,7 +286,8 @@ bundle.update(
273
286
  note: "The internal note on the bundle.",
274
287
  preview_only: true,
275
288
  require_registration: true,
276
- require_share_recipient: true
289
+ require_share_recipient: true,
290
+ watermark_attachment_delete: true
277
291
  )
278
292
  ```
279
293
 
@@ -293,6 +307,8 @@ bundle.update(
293
307
  * `preview_only` (boolean): Restrict users to previewing files only?
294
308
  * `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
295
309
  * `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
310
+ * `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
311
+ * `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
296
312
 
297
313
 
298
314
  ---
@@ -31,14 +31,14 @@ Files::BundleDownload.list(
31
31
 
32
32
  ### Parameters
33
33
 
34
- * `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 the X-Files-Cursor-Next header.
34
+ * `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.
35
35
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
36
36
  * `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`.
37
- * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
38
- * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`.
39
- * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `created_at`.
40
- * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
41
- * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `created_at`.
42
- * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `created_at`.
37
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
38
+ * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
39
+ * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`.
40
+ * `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
41
+ * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
42
+ * `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`.
43
43
  * `bundle_id` (int64): Bundle ID
44
44
  * `bundle_registration_id` (int64): BundleRegistration ID
@@ -37,15 +37,15 @@ Files::BundleRecipient.list(
37
37
  ### Parameters
38
38
 
39
39
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
40
- * `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 the X-Files-Cursor-Next header.
40
+ * `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.
41
41
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
42
42
  * `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 `has_registrations`.
43
- * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `has_registrations`.
44
- * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `has_registrations`.
45
- * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `has_registrations`.
46
- * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `has_registrations`.
47
- * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `has_registrations`.
48
- * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `has_registrations`.
43
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
44
+ * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `has_registrations`.
45
+ * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `has_registrations`.
46
+ * `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
47
+ * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `has_registrations`.
48
+ * `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `has_registrations`.
49
49
  * `bundle_id` (int64): Required - List recipients for the bundle with this ID.
50
50
 
51
51
 
@@ -27,7 +27,7 @@
27
27
  * `inbox_code` (string): InboxRegistration cookie code, if there is an associated InboxRegistration
28
28
  * `clickwrap_body` (string): Clickwrap text that was shown to the registrant
29
29
  * `form_field_set_id` (int64): Id of associated form field set
30
- * `form_field_data` (string): Data for form field set with form field ids as keys and user data as values
30
+ * `form_field_data` (object): Data for form field set with form field ids as keys and user data as values
31
31
  * `bundle_code` (string): Bundle URL code
32
32
  * `bundle_id` (int64): Id of associated bundle
33
33
  * `bundle_recipient_id` (int64): Id of associated bundle recipient
@@ -48,6 +48,6 @@ Files::BundleRegistration.list(
48
48
  ### Parameters
49
49
 
50
50
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
51
- * `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 the X-Files-Cursor-Next header.
51
+ * `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.
52
52
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
53
53
  * `bundle_id` (int64): ID of the associated Bundle
data/docs/clickwrap.md CHANGED
@@ -33,7 +33,7 @@ Files::Clickwrap.list(
33
33
 
34
34
  ### Parameters
35
35
 
36
- * `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 the X-Files-Cursor-Next header.
36
+ * `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.
37
37
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
38
38
 
39
39
 
data/docs/dns_record.md CHANGED
@@ -29,5 +29,5 @@ Files::DnsRecord.list(
29
29
 
30
30
  ### Parameters
31
31
 
32
- * `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 the X-Files-Cursor-Next header.
32
+ * `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.
33
33
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
@@ -43,15 +43,15 @@ Files::ExternalEvent.list(
43
43
 
44
44
  ### Parameters
45
45
 
46
- * `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 the X-Files-Cursor-Next header.
46
+ * `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.
47
47
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
48
48
  * `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 `remote_server_type`, `site_id`, `folder_behavior_id`, `event_type`, `created_at` or `status`.
49
- * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
50
- * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
51
- * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
52
- * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
53
- * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
54
- * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
49
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
50
+ * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
51
+ * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
52
+ * `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
53
+ * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
54
+ * `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
55
55
 
56
56
 
57
57
  ---
data/docs/file_comment.md CHANGED
@@ -31,7 +31,7 @@ Files::FileComment.list_for(path,
31
31
 
32
32
  ### Parameters
33
33
 
34
- * `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 the X-Files-Cursor-Next header.
34
+ * `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.
35
35
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
36
36
  * `path` (string): Required - Path to operate on.
37
37
 
@@ -56,7 +56,7 @@ Files::FormFieldSet.list(
56
56
  ### Parameters
57
57
 
58
58
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
59
- * `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 the X-Files-Cursor-Next header.
59
+ * `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.
60
60
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
61
61
 
62
62
 
data/docs/group.md CHANGED
@@ -39,15 +39,15 @@ Files::Group.list(
39
39
 
40
40
  ### Parameters
41
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 the X-Files-Cursor-Next header.
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
43
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
44
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 `name`.
45
- * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `name`.
46
- * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `name`.
47
- * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `name`.
48
- * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `name`.
49
- * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `name`.
50
- * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `name`.
45
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name`.
46
+ * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `name`.
47
+ * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `name`.
48
+ * `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name`.
49
+ * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `name`.
50
+ * `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `name`.
51
51
  * `ids` (string): Comma-separated list of group ids to include in results.
52
52
 
53
53
 
data/docs/group_user.md CHANGED
@@ -37,7 +37,7 @@ Files::GroupUser.list(
37
37
  ### Parameters
38
38
 
39
39
  * `user_id` (int64): User ID. If provided, will return group_users of this user.
40
- * `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 the X-Files-Cursor-Next header.
40
+ * `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.
41
41
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
42
42
  * `group_id` (int64): Group ID. If provided, will return group_users of this group.
43
43
 
data/docs/history.md CHANGED
@@ -53,7 +53,7 @@ Files::History.list_for_file(path,
53
53
  * `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
54
54
  * `end_at` (string): Leave blank or set to a date/time to filter later entries.
55
55
  * `display` (string): Display format. Leave blank or set to `full` or `parent`.
56
- * `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 the X-Files-Cursor-Next header.
56
+ * `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.
57
57
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
58
58
  * `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 `user_id` and `created_at`.
59
59
  * `path` (string): Required - Path to operate on.
@@ -75,7 +75,7 @@ Files::History.list_for_folder(path,
75
75
  * `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
76
76
  * `end_at` (string): Leave blank or set to a date/time to filter later entries.
77
77
  * `display` (string): Display format. Leave blank or set to `full` or `parent`.
78
- * `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 the X-Files-Cursor-Next header.
78
+ * `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.
79
79
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
80
80
  * `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 `user_id` and `created_at`.
81
81
  * `path` (string): Required - Path to operate on.
@@ -97,7 +97,7 @@ Files::History.list_for_user(user_id,
97
97
  * `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
98
98
  * `end_at` (string): Leave blank or set to a date/time to filter later entries.
99
99
  * `display` (string): Display format. Leave blank or set to `full` or `parent`.
100
- * `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 the X-Files-Cursor-Next header.
100
+ * `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.
101
101
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
102
102
  * `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 `user_id` and `created_at`.
103
103
  * `user_id` (int64): Required - User ID.
@@ -119,7 +119,7 @@ Files::History.list_logins(
119
119
  * `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
120
120
  * `end_at` (string): Leave blank or set to a date/time to filter later entries.
121
121
  * `display` (string): Display format. Leave blank or set to `full` or `parent`.
122
- * `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 the X-Files-Cursor-Next header.
122
+ * `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.
123
123
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
124
124
  * `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 `user_id` and `created_at`.
125
125
 
@@ -140,12 +140,12 @@ Files::History.list(
140
140
  * `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
141
141
  * `end_at` (string): Leave blank or set to a date/time to filter later entries.
142
142
  * `display` (string): Display format. Leave blank or set to `full` or `parent`.
143
- * `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 the X-Files-Cursor-Next header.
143
+ * `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.
144
144
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
145
145
  * `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 `path`, `folder`, `user_id` or `created_at`.
146
- * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
147
- * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `user_id`, `folder` or `path`.
148
- * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
149
- * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
150
- * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `user_id`, `folder` or `path`.
151
- * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
146
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
147
+ * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `user_id`, `folder` or `path`.
148
+ * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
149
+ * `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
150
+ * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `user_id`, `folder` or `path`.
151
+ * `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
@@ -70,6 +70,6 @@ Files::HistoryExportResult.list(
70
70
  ### Parameters
71
71
 
72
72
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
73
- * `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 the X-Files-Cursor-Next header.
73
+ * `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.
74
74
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
75
75
  * `history_export_id` (int64): Required - ID of the associated history export.