files.com 1.0.326 → 1.0.328

Sign up to get free protection for your applications and to get access to all the features.
Files changed (109) 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 +2 -2
  5. data/docs/app.md +2 -2
  6. data/docs/as2_incoming_message.md +2 -2
  7. data/docs/as2_outgoing_message.md +2 -2
  8. data/docs/as2_partner.md +1 -1
  9. data/docs/as2_station.md +1 -1
  10. data/docs/automation.md +13 -2
  11. data/docs/automation_run.md +2 -2
  12. data/docs/bandwidth_snapshot.md +2 -2
  13. data/docs/behavior.md +4 -4
  14. data/docs/bundle.md +2 -2
  15. data/docs/bundle_download.md +2 -2
  16. data/docs/bundle_notification.md +1 -1
  17. data/docs/bundle_recipient.md +2 -2
  18. data/docs/bundle_registration.md +1 -1
  19. data/docs/clickwrap.md +1 -1
  20. data/docs/dns_record.md +1 -1
  21. data/docs/external_event.md +2 -2
  22. data/docs/file_comment.md +1 -1
  23. data/docs/form_field_set.md +1 -1
  24. data/docs/group.md +2 -2
  25. data/docs/group_user.md +1 -1
  26. data/docs/history.md +10 -10
  27. data/docs/history_export_result.md +1 -1
  28. data/docs/inbox_recipient.md +2 -2
  29. data/docs/inbox_registration.md +1 -1
  30. data/docs/inbox_upload.md +2 -2
  31. data/docs/invoice.md +1 -1
  32. data/docs/ip_address.md +3 -3
  33. data/docs/lock.md +1 -1
  34. data/docs/message.md +1 -1
  35. data/docs/message_comment.md +1 -1
  36. data/docs/message_comment_reaction.md +1 -1
  37. data/docs/message_reaction.md +1 -1
  38. data/docs/notification.md +2 -2
  39. data/docs/payment.md +1 -1
  40. data/docs/permission.md +2 -2
  41. data/docs/priority.md +1 -1
  42. data/docs/project.md +1 -1
  43. data/docs/public_key.md +1 -1
  44. data/docs/remote_bandwidth_snapshot.md +2 -2
  45. data/docs/remote_server.md +1 -1
  46. data/docs/request.md +4 -4
  47. data/docs/settings_change.md +2 -2
  48. data/docs/sftp_host_key.md +1 -1
  49. data/docs/site.md +4 -0
  50. data/docs/sso_strategy.md +1 -1
  51. data/docs/usage_daily_snapshot.md +2 -2
  52. data/docs/usage_snapshot.md +1 -1
  53. data/docs/user.md +2 -2
  54. data/docs/user_cipher_use.md +1 -1
  55. data/docs/user_request.md +1 -1
  56. data/lib/files.com/models/action_notification_export_result.rb +1 -1
  57. data/lib/files.com/models/api_key.rb +2 -2
  58. data/lib/files.com/models/app.rb +2 -2
  59. data/lib/files.com/models/as2_incoming_message.rb +2 -2
  60. data/lib/files.com/models/as2_outgoing_message.rb +2 -2
  61. data/lib/files.com/models/as2_partner.rb +1 -1
  62. data/lib/files.com/models/as2_station.rb +1 -1
  63. data/lib/files.com/models/automation.rb +17 -2
  64. data/lib/files.com/models/automation_run.rb +2 -2
  65. data/lib/files.com/models/bandwidth_snapshot.rb +2 -2
  66. data/lib/files.com/models/behavior.rb +4 -4
  67. data/lib/files.com/models/bundle.rb +2 -2
  68. data/lib/files.com/models/bundle_download.rb +2 -2
  69. data/lib/files.com/models/bundle_notification.rb +1 -1
  70. data/lib/files.com/models/bundle_recipient.rb +2 -2
  71. data/lib/files.com/models/bundle_registration.rb +1 -1
  72. data/lib/files.com/models/clickwrap.rb +1 -1
  73. data/lib/files.com/models/dns_record.rb +1 -1
  74. data/lib/files.com/models/external_event.rb +2 -2
  75. data/lib/files.com/models/file_comment.rb +1 -1
  76. data/lib/files.com/models/form_field_set.rb +1 -1
  77. data/lib/files.com/models/group.rb +2 -2
  78. data/lib/files.com/models/group_user.rb +1 -1
  79. data/lib/files.com/models/history.rb +10 -10
  80. data/lib/files.com/models/history_export_result.rb +1 -1
  81. data/lib/files.com/models/inbox_recipient.rb +2 -2
  82. data/lib/files.com/models/inbox_registration.rb +1 -1
  83. data/lib/files.com/models/inbox_upload.rb +2 -2
  84. data/lib/files.com/models/invoice.rb +1 -1
  85. data/lib/files.com/models/ip_address.rb +3 -3
  86. data/lib/files.com/models/lock.rb +1 -1
  87. data/lib/files.com/models/message.rb +1 -1
  88. data/lib/files.com/models/message_comment.rb +1 -1
  89. data/lib/files.com/models/message_comment_reaction.rb +1 -1
  90. data/lib/files.com/models/message_reaction.rb +1 -1
  91. data/lib/files.com/models/notification.rb +2 -2
  92. data/lib/files.com/models/payment.rb +1 -1
  93. data/lib/files.com/models/permission.rb +2 -2
  94. data/lib/files.com/models/priority.rb +1 -1
  95. data/lib/files.com/models/project.rb +1 -1
  96. data/lib/files.com/models/public_key.rb +1 -1
  97. data/lib/files.com/models/remote_bandwidth_snapshot.rb +2 -2
  98. data/lib/files.com/models/remote_server.rb +1 -1
  99. data/lib/files.com/models/request.rb +4 -4
  100. data/lib/files.com/models/settings_change.rb +2 -2
  101. data/lib/files.com/models/sftp_host_key.rb +1 -1
  102. data/lib/files.com/models/site.rb +6 -0
  103. data/lib/files.com/models/sso_strategy.rb +1 -1
  104. data/lib/files.com/models/usage_daily_snapshot.rb +2 -2
  105. data/lib/files.com/models/usage_snapshot.rb +1 -1
  106. data/lib/files.com/models/user.rb +2 -2
  107. data/lib/files.com/models/user_cipher_use.rb +1 -1
  108. data/lib/files.com/models/user_request.rb +1 -1
  109. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 24ec6c715aef08b6e75d74ba0ddfb1fd28785a6ea6b68210a6a4d077839a1004
4
- data.tar.gz: 4593732c5205d0af252a83b004272bdc3f82520cf795da4cea36e4b58978d451
3
+ metadata.gz: 46531dedd8ba834b387fb9c1d3c5ed556704b5979a16423a87960ff2c9a50385
4
+ data.tar.gz: e446c914bcb7f7a2075f2806fb4460f1b30fd4514e8ea8f0dc687bc6e3412d46
5
5
  SHA512:
6
- metadata.gz: b36108729a379c509d32d34ca19b28fea28ba5125ee14f6b27805e2018bf88a0f883fcc9755d12ff2c6df05b153d68291ab54a8116fe8511b473a67ab23c767c
7
- data.tar.gz: 65e6f78ab91663444db07d0954a3d747c50a87d8fa925975b41ba66dc2304be395a103db3963571c11ff67749d2789034cd36d8953e7dc430adffddb88dfa167
6
+ metadata.gz: 9b165ae1cfeee1c19b6c1fe3e53db7e36339ace322026cc928cad8c62ae5486025f5058554b2ba6e575a7ff301a4f5262869449ccb01e8b42862375d523eb962
7
+ data.tar.gz: 4b66a5a040eb18c220a7813fdb9e208537bb68f9689e23fe5f69c5c8683e6b6c4ed583506295535b1d2c766070006f3ee8b5352bffd03718c8cec40d2313e23e
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.326
1
+ 1.0.328
@@ -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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
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.
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
@@ -49,9 +49,9 @@ Files::ApiKey.list(
49
49
  ### Parameters
50
50
 
51
51
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
52
- * `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
+ * `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.
53
53
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
54
- * `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`.
54
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[expires_at]=desc`). Valid fields are `expires_at`.
55
55
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `expires_at`.
56
56
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `expires_at`.
57
57
  * `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`.
data/docs/app.md CHANGED
@@ -57,9 +57,9 @@ Files::App.list(
57
57
 
58
58
  ### Parameters
59
59
 
60
- * `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
+ * `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.
61
61
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
62
- * `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`.
62
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[name]=desc`). Valid fields are `name` and `app_type`.
63
63
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
64
64
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
65
65
  * `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`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
@@ -96,9 +96,9 @@ Files::As2IncomingMessage.list(
96
96
 
97
97
  ### Parameters
98
98
 
99
- * `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.
99
+ * `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.
100
100
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
101
- * `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 `as2_partner_id`.
101
+ * `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 `as2_partner_id`.
102
102
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
103
103
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
104
104
  * `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`.
@@ -88,9 +88,9 @@ Files::As2OutgoingMessage.list(
88
88
 
89
89
  ### Parameters
90
90
 
91
- * `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.
91
+ * `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.
92
92
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
93
- * `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 `as2_partner_id`.
93
+ * `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 `as2_partner_id`.
94
94
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
95
95
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
96
96
  * `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`.
data/docs/as2_partner.md CHANGED
@@ -46,7 +46,7 @@ Files::As2Partner.list(
46
46
 
47
47
  ### Parameters
48
48
 
49
- * `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
+ * `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.
50
50
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
51
51
 
52
52
 
data/docs/as2_station.md CHANGED
@@ -50,7 +50,7 @@ Files::As2Station.list(
50
50
 
51
51
  ### Parameters
52
52
 
53
- * `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.
53
+ * `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
54
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
55
55
 
56
56
 
data/docs/automation.md CHANGED
@@ -22,6 +22,10 @@
22
22
  "description": "example",
23
23
  "path": "example",
24
24
  "user_id": 1,
25
+ "sync_ids": [
26
+ 1,
27
+ 2
28
+ ],
25
29
  "user_ids": [
26
30
  1,
27
31
  2
@@ -56,6 +60,7 @@
56
60
  * `description` (string): Description for the this Automation.
57
61
  * `path` (string): Path on which this Automation runs. Supports globs. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
58
62
  * `user_id` (int64): User ID of the Automation's creator.
63
+ * `sync_ids` (array): IDs of remote sync folder behaviors to run by this Automation
59
64
  * `user_ids` (array): IDs of Users for the Automation (i.e. who to Request File from)
60
65
  * `group_ids` (array): IDs of Groups for the Automation (i.e. who to Request File from)
61
66
  * `webhook_url` (string): If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
@@ -78,9 +83,9 @@ Files::Automation.list(
78
83
 
79
84
  ### Parameters
80
85
 
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.
86
+ * `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.
82
87
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
83
- * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `automation`, `disabled` or `last_modified_at`.
88
+ * `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`.
84
89
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
85
90
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
86
91
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
@@ -116,6 +121,7 @@ Files::Automation.create(
116
121
  destination_replace_to: "example",
117
122
  interval: "year",
118
123
  path: "example",
124
+ sync_ids: [1,2],
119
125
  user_ids: [1,2],
120
126
  group_ids: [1,2],
121
127
  schedule: {"days_of_week":[0,1,3],"times_of_day":["7:30","11:30"],"time_zone":"Eastern Time (US & Canada)"},
@@ -138,6 +144,7 @@ Files::Automation.create(
138
144
  * `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.
139
145
  * `interval` (string): How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
140
146
  * `path` (string): Path on which this Automation runs. Supports globs.
147
+ * `sync_ids` (string): A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
141
148
  * `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
142
149
  * `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
143
150
  * `schedule` (object): Custom schedule for running this automation.
@@ -162,6 +169,7 @@ Files::Automation.update(id,
162
169
  destination_replace_to: "example",
163
170
  interval: "year",
164
171
  path: "example",
172
+ sync_ids: [1,2],
165
173
  user_ids: [1,2],
166
174
  group_ids: [1,2],
167
175
  schedule: {"days_of_week":[0,1,3],"times_of_day":["7:30","11:30"],"time_zone":"Eastern Time (US & Canada)"},
@@ -185,6 +193,7 @@ Files::Automation.update(id,
185
193
  * `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.
186
194
  * `interval` (string): How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
187
195
  * `path` (string): Path on which this Automation runs. Supports globs.
196
+ * `sync_ids` (string): A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
188
197
  * `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
189
198
  * `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
190
199
  * `schedule` (object): Custom schedule for running this automation.
@@ -224,6 +233,7 @@ automation.update(
224
233
  destination_replace_to: "example",
225
234
  interval: "year",
226
235
  path: "example",
236
+ sync_ids: [1,2],
227
237
  user_ids: [1,2],
228
238
  group_ids: [1,2],
229
239
  schedule: {"days_of_week":[0,1,3],"times_of_day":["7:30","11:30"],"time_zone":"Eastern Time (US & Canada)"},
@@ -247,6 +257,7 @@ automation.update(
247
257
  * `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.
248
258
  * `interval` (string): How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
249
259
  * `path` (string): Path on which this Automation runs. Supports globs.
260
+ * `sync_ids` (string): A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
250
261
  * `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
251
262
  * `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
252
263
  * `schedule` (object): Custom schedule for running this automation.
@@ -36,9 +36,9 @@ 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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
39
+ * `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.
40
40
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
41
- * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `created_at` and `status`.
41
+ * `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 `status`.
42
42
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`.
43
43
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `status`.
44
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`.
@@ -39,9 +39,9 @@ Files::BandwidthSnapshot.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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
42
+ * `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
43
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
44
- * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `logged_at`.
44
+ * `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
45
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
46
46
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `logged_at`.
47
47
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `logged_at`.
data/docs/behavior.md CHANGED
@@ -40,9 +40,9 @@ Files::Behavior.list(
40
40
 
41
41
  ### Parameters
42
42
 
43
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
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.
44
44
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
45
- * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `behavior`.
45
+ * `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`.
46
46
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
47
47
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `behavior`.
48
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`.
@@ -78,9 +78,9 @@ Files::Behavior.list_for(path,
78
78
 
79
79
  ### Parameters
80
80
 
81
- * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
81
+ * `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.
82
82
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
83
- * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `behavior`.
83
+ * `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`.
84
84
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
85
85
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `behavior`.
86
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`.
data/docs/bundle.md CHANGED
@@ -89,9 +89,9 @@ Files::Bundle.list(
89
89
  ### Parameters
90
90
 
91
91
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
92
- * `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.
92
+ * `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.
93
93
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
94
- * `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`.
94
+ * `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`.
95
95
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
96
96
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
97
97
  * `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`.
@@ -31,9 +31,9 @@ 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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
34
+ * `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
35
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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`.
36
+ * `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
37
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
38
38
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
39
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`.
@@ -34,7 +34,7 @@ Files::BundleNotification.list(
34
34
  ### Parameters
35
35
 
36
36
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
37
- * `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
+ * `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
38
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
39
39
  * `bundle_id` (int64): Bundle ID to notify on
40
40
 
@@ -37,9 +37,9 @@ 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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
40
+ * `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.
41
41
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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`.
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`.
43
43
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
44
44
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `has_registrations`.
45
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`.
@@ -52,6 +52,6 @@ Files::BundleRegistration.list(
52
52
  ### Parameters
53
53
 
54
54
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
55
- * `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.
55
+ * `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.
56
56
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
57
57
  * `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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
36
+ * `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
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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
32
+ * `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
33
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
@@ -43,9 +43,9 @@ 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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
46
+ * `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
47
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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`.
48
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[remote_server_type]=desc`). Valid fields are `remote_server_type`, `site_id`, `folder_behavior_id`, `event_type`, `created_at` or `status`.
49
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`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
50
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`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
51
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`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
data/docs/file_comment.md CHANGED
@@ -30,7 +30,7 @@ Files::FileComment.list_for(path,
30
30
 
31
31
  ### Parameters
32
32
 
33
- * `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
+ * `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.
34
34
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
35
35
  * `path` (string): Required - Path to operate on.
36
36
 
@@ -45,7 +45,7 @@ Files::FormFieldSet.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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
48
+ * `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.
49
49
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
50
50
 
51
51
 
data/docs/group.md CHANGED
@@ -33,9 +33,9 @@ Files::Group.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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
36
+ * `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
37
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
38
- * `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`.
38
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[name]=desc`). Valid fields are `name`.
39
39
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name`.
40
40
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `name`.
41
41
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `name`.
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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
40
+ * `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.
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,9 +53,9 @@ 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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
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.
57
57
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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`.
58
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[user_id]=desc`). Valid fields are `user_id` and `created_at`.
59
59
  * `path` (string): Required - Path to operate on.
60
60
 
61
61
 
@@ -75,9 +75,9 @@ 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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
78
+ * `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.
79
79
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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`.
80
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[user_id]=desc`). Valid fields are `user_id` and `created_at`.
81
81
  * `path` (string): Required - Path to operate on.
82
82
 
83
83
 
@@ -97,9 +97,9 @@ 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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
100
+ * `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.
101
101
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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`.
102
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[user_id]=desc`). Valid fields are `user_id` and `created_at`.
103
103
  * `user_id` (int64): Required - User ID.
104
104
 
105
105
 
@@ -119,9 +119,9 @@ 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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
122
+ * `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.
123
123
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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`.
124
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[user_id]=desc`). Valid fields are `user_id` and `created_at`.
125
125
 
126
126
 
127
127
  ---
@@ -140,9 +140,9 @@ 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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
143
+ * `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.
144
144
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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`.
145
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[path]=desc`). Valid fields are `path`, `folder`, `user_id` or `created_at`.
146
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
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
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`.
@@ -72,6 +72,6 @@ Files::HistoryExportResult.list(
72
72
  ### Parameters
73
73
 
74
74
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
75
- * `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.
75
+ * `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.
76
76
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
77
77
  * `history_export_id` (int64): Required - ID of the associated history export.
@@ -37,9 +37,9 @@ Files::InboxRecipient.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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
40
+ * `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.
41
41
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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`.
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`.
43
43
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
44
44
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `has_registrations`.
45
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,6 +46,6 @@ Files::InboxRegistration.list(
46
46
 
47
47
  ### Parameters
48
48
 
49
- * `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
+ * `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.
50
50
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
51
51
  * `folder_behavior_id` (int64): ID of the associated Inbox.
data/docs/inbox_upload.md CHANGED
@@ -29,9 +29,9 @@ Files::InboxUpload.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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
32
+ * `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
33
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
34
- * `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`.
34
+ * `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`.
35
35
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
36
36
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
37
37
  * `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`.
data/docs/invoice.md CHANGED
@@ -53,7 +53,7 @@ Files::Invoice.list(
53
53
 
54
54
  ### Parameters
55
55
 
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.
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.
57
57
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
58
58
 
59
59
 
data/docs/ip_address.md CHANGED
@@ -31,7 +31,7 @@ Files::IpAddress.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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
34
+ * `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
35
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
36
36
 
37
37
 
@@ -47,7 +47,7 @@ Files::IpAddress.get_exavault_reserved(
47
47
 
48
48
  ### Parameters
49
49
 
50
- * `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.
50
+ * `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.
51
51
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
52
52
 
53
53
 
@@ -63,5 +63,5 @@ Files::IpAddress.get_reserved(
63
63
 
64
64
  ### Parameters
65
65
 
66
- * `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.
66
+ * `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.
67
67
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
data/docs/lock.md CHANGED
@@ -46,7 +46,7 @@ Files::Lock.list_for(path,
46
46
 
47
47
  ### Parameters
48
48
 
49
- * `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
+ * `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.
50
50
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
51
51
  * `path` (string): Required - Path to operate on.
52
52
  * `include_children` (boolean): Include locks from children objects?