files.com 1.0.251 → 1.0.253

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 (158) hide show
  1. package/_VERSION +1 -1
  2. package/docs/models/ActionNotificationExportResult.md +1 -1
  3. package/docs/models/ApiKey.md +2 -2
  4. package/docs/models/App.md +2 -2
  5. package/docs/models/As2IncomingMessage.md +2 -2
  6. package/docs/models/As2OutgoingMessage.md +2 -2
  7. package/docs/models/As2Partner.md +1 -1
  8. package/docs/models/As2Station.md +1 -1
  9. package/docs/models/Automation.md +15 -2
  10. package/docs/models/AutomationRun.md +2 -2
  11. package/docs/models/BandwidthSnapshot.md +2 -2
  12. package/docs/models/Behavior.md +4 -4
  13. package/docs/models/Bundle.md +2 -2
  14. package/docs/models/BundleDownload.md +2 -2
  15. package/docs/models/BundleNotification.md +1 -1
  16. package/docs/models/BundleRecipient.md +2 -2
  17. package/docs/models/BundleRegistration.md +1 -1
  18. package/docs/models/Clickwrap.md +1 -1
  19. package/docs/models/DnsRecord.md +1 -1
  20. package/docs/models/ExternalEvent.md +2 -2
  21. package/docs/models/FileComment.md +1 -1
  22. package/docs/models/FormFieldSet.md +1 -1
  23. package/docs/models/Group.md +2 -2
  24. package/docs/models/GroupUser.md +1 -1
  25. package/docs/models/History.md +10 -10
  26. package/docs/models/HistoryExportResult.md +1 -1
  27. package/docs/models/InboxRecipient.md +2 -2
  28. package/docs/models/InboxRegistration.md +1 -1
  29. package/docs/models/InboxUpload.md +2 -2
  30. package/docs/models/Invoice.md +1 -1
  31. package/docs/models/IpAddress.md +3 -3
  32. package/docs/models/Lock.md +1 -1
  33. package/docs/models/Message.md +1 -1
  34. package/docs/models/MessageComment.md +1 -1
  35. package/docs/models/MessageCommentReaction.md +1 -1
  36. package/docs/models/MessageReaction.md +1 -1
  37. package/docs/models/Notification.md +2 -2
  38. package/docs/models/Payment.md +1 -1
  39. package/docs/models/Permission.md +2 -2
  40. package/docs/models/Priority.md +1 -1
  41. package/docs/models/Project.md +1 -1
  42. package/docs/models/PublicKey.md +1 -1
  43. package/docs/models/RemoteBandwidthSnapshot.md +2 -2
  44. package/docs/models/RemoteServer.md +1 -1
  45. package/docs/models/Request.md +4 -4
  46. package/docs/models/SettingsChange.md +2 -2
  47. package/docs/models/SftpHostKey.md +1 -1
  48. package/docs/models/SsoStrategy.md +1 -1
  49. package/docs/models/UsageDailySnapshot.md +2 -2
  50. package/docs/models/UsageSnapshot.md +1 -1
  51. package/docs/models/User.md +2 -2
  52. package/docs/models/UserCipherUse.md +1 -1
  53. package/docs/models/UserRequest.md +1 -1
  54. package/lib/models/ActionNotificationExportResult.js +1 -1
  55. package/lib/models/ApiKey.js +2 -2
  56. package/lib/models/App.js +2 -2
  57. package/lib/models/As2IncomingMessage.js +2 -2
  58. package/lib/models/As2OutgoingMessage.js +2 -2
  59. package/lib/models/As2Partner.js +1 -1
  60. package/lib/models/As2Station.js +1 -1
  61. package/lib/models/Automation.js +62 -41
  62. package/lib/models/AutomationRun.js +2 -2
  63. package/lib/models/BandwidthSnapshot.js +2 -2
  64. package/lib/models/Behavior.js +4 -4
  65. package/lib/models/Bundle.js +2 -2
  66. package/lib/models/BundleDownload.js +2 -2
  67. package/lib/models/BundleNotification.js +1 -1
  68. package/lib/models/BundleRecipient.js +2 -2
  69. package/lib/models/BundleRegistration.js +1 -1
  70. package/lib/models/Clickwrap.js +1 -1
  71. package/lib/models/DnsRecord.js +1 -1
  72. package/lib/models/ExternalEvent.js +2 -2
  73. package/lib/models/FileComment.js +1 -1
  74. package/lib/models/FormFieldSet.js +1 -1
  75. package/lib/models/Group.js +2 -2
  76. package/lib/models/GroupUser.js +1 -1
  77. package/lib/models/History.js +10 -10
  78. package/lib/models/HistoryExportResult.js +1 -1
  79. package/lib/models/InboxRecipient.js +2 -2
  80. package/lib/models/InboxRegistration.js +1 -1
  81. package/lib/models/InboxUpload.js +2 -2
  82. package/lib/models/Invoice.js +1 -1
  83. package/lib/models/IpAddress.js +3 -3
  84. package/lib/models/Lock.js +1 -1
  85. package/lib/models/Message.js +1 -1
  86. package/lib/models/MessageComment.js +1 -1
  87. package/lib/models/MessageCommentReaction.js +1 -1
  88. package/lib/models/MessageReaction.js +1 -1
  89. package/lib/models/Notification.js +2 -2
  90. package/lib/models/Payment.js +1 -1
  91. package/lib/models/Permission.js +2 -2
  92. package/lib/models/Priority.js +1 -1
  93. package/lib/models/Project.js +1 -1
  94. package/lib/models/PublicKey.js +1 -1
  95. package/lib/models/RemoteBandwidthSnapshot.js +2 -2
  96. package/lib/models/RemoteServer.js +1 -1
  97. package/lib/models/Request.js +4 -4
  98. package/lib/models/SettingsChange.js +2 -2
  99. package/lib/models/SftpHostKey.js +1 -1
  100. package/lib/models/SsoStrategy.js +1 -1
  101. package/lib/models/UsageDailySnapshot.js +2 -2
  102. package/lib/models/UsageSnapshot.js +1 -1
  103. package/lib/models/User.js +2 -2
  104. package/lib/models/UserCipherUse.js +1 -1
  105. package/lib/models/UserRequest.js +1 -1
  106. package/package.json +1 -1
  107. package/src/models/ActionNotificationExportResult.js +1 -1
  108. package/src/models/ApiKey.js +2 -2
  109. package/src/models/App.js +2 -2
  110. package/src/models/As2IncomingMessage.js +2 -2
  111. package/src/models/As2OutgoingMessage.js +2 -2
  112. package/src/models/As2Partner.js +1 -1
  113. package/src/models/As2Station.js +1 -1
  114. package/src/models/Automation.js +18 -2
  115. package/src/models/AutomationRun.js +2 -2
  116. package/src/models/BandwidthSnapshot.js +2 -2
  117. package/src/models/Behavior.js +4 -4
  118. package/src/models/Bundle.js +2 -2
  119. package/src/models/BundleDownload.js +2 -2
  120. package/src/models/BundleNotification.js +1 -1
  121. package/src/models/BundleRecipient.js +2 -2
  122. package/src/models/BundleRegistration.js +1 -1
  123. package/src/models/Clickwrap.js +1 -1
  124. package/src/models/DnsRecord.js +1 -1
  125. package/src/models/ExternalEvent.js +2 -2
  126. package/src/models/FileComment.js +1 -1
  127. package/src/models/FormFieldSet.js +1 -1
  128. package/src/models/Group.js +2 -2
  129. package/src/models/GroupUser.js +1 -1
  130. package/src/models/History.js +10 -10
  131. package/src/models/HistoryExportResult.js +1 -1
  132. package/src/models/InboxRecipient.js +2 -2
  133. package/src/models/InboxRegistration.js +1 -1
  134. package/src/models/InboxUpload.js +2 -2
  135. package/src/models/Invoice.js +1 -1
  136. package/src/models/IpAddress.js +3 -3
  137. package/src/models/Lock.js +1 -1
  138. package/src/models/Message.js +1 -1
  139. package/src/models/MessageComment.js +1 -1
  140. package/src/models/MessageCommentReaction.js +1 -1
  141. package/src/models/MessageReaction.js +1 -1
  142. package/src/models/Notification.js +2 -2
  143. package/src/models/Payment.js +1 -1
  144. package/src/models/Permission.js +2 -2
  145. package/src/models/Priority.js +1 -1
  146. package/src/models/Project.js +1 -1
  147. package/src/models/PublicKey.js +1 -1
  148. package/src/models/RemoteBandwidthSnapshot.js +2 -2
  149. package/src/models/RemoteServer.js +1 -1
  150. package/src/models/Request.js +4 -4
  151. package/src/models/SettingsChange.js +2 -2
  152. package/src/models/SftpHostKey.js +1 -1
  153. package/src/models/SsoStrategy.js +1 -1
  154. package/src/models/UsageDailySnapshot.js +2 -2
  155. package/src/models/UsageSnapshot.js +1 -1
  156. package/src/models/User.js +2 -2
  157. package/src/models/UserCipherUse.js +1 -1
  158. package/src/models/UserRequest.js +1 -1
package/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.251
1
+ 1.0.253
@@ -44,6 +44,6 @@ await 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.
@@ -49,9 +49,9 @@ await 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`.
@@ -57,9 +57,9 @@ await 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 @@ await 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 @@ await 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`.
@@ -46,7 +46,7 @@ await 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
  ---
@@ -50,7 +50,7 @@ await 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
  ---
@@ -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 @@ await 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 ]`.
@@ -115,6 +120,7 @@ await Automation.create({
115
120
  'destination_replace_to': "example",
116
121
  'interval': "year",
117
122
  'path': "example",
123
+ 'sync_ids': [1,2],
118
124
  'user_ids': [1,2],
119
125
  'group_ids': [1,2],
120
126
  'schedule': {"days_of_week":[0,1,3],"times_of_day":["7:30","11:30"],"time_zone":"Eastern Time (US & Canada)"},
@@ -138,6 +144,7 @@ await 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.
@@ -163,6 +170,7 @@ await automation.update({
163
170
  'destination_replace_to': "example",
164
171
  'interval': "year",
165
172
  'path': "example",
173
+ 'sync_ids': [1,2],
166
174
  'user_ids': [1,2],
167
175
  'group_ids': [1,2],
168
176
  'schedule': {"days_of_week":[0,1,3],"times_of_day":["7:30","11:30"],"time_zone":"Eastern Time (US & Canada)"},
@@ -186,6 +194,7 @@ await automation.update({
186
194
  * `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.
187
195
  * `interval` (string): How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
188
196
  * `path` (string): Path on which this Automation runs. Supports globs.
197
+ * `sync_ids` (string): A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
189
198
  * `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
190
199
  * `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
191
200
  * `schedule` (object): Custom schedule for running this automation.
@@ -219,6 +228,10 @@ await automation.update({
219
228
  "description": "example",
220
229
  "path": "example",
221
230
  "user_id": 1,
231
+ "sync_ids": [
232
+ 1,
233
+ 2
234
+ ],
222
235
  "user_ids": [
223
236
  1,
224
237
  2
@@ -36,9 +36,9 @@ await 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 @@ await 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`.
@@ -40,9 +40,9 @@ await 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 @@ await Behavior.listFor(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`.
@@ -89,9 +89,9 @@ await 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 @@ await 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 @@ await 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 @@ await 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 @@ await 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
@@ -33,7 +33,7 @@ await 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
  ---
@@ -29,5 +29,5 @@ await 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 @@ await 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 ]`.
@@ -30,7 +30,7 @@ await FileComment.listFor(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 @@ await 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
  ---
@@ -33,9 +33,9 @@ await 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`.
@@ -37,7 +37,7 @@ await 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
 
@@ -53,9 +53,9 @@ await History.listForFile(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 @@ await History.listForFolder(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 @@ await History.listForUser(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 @@ await History.listLogins({
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 @@ await 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 @@ await 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 @@ await 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 @@ await 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.
@@ -29,9 +29,9 @@ await 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`.
@@ -53,7 +53,7 @@ await 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
  ---
@@ -31,7 +31,7 @@ await 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 @@ await IpAddress.getExavaultReserved({
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 @@ await IpAddress.getReserved({
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).
@@ -46,7 +46,7 @@ await Lock.listFor(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?
@@ -36,7 +36,7 @@ await Message.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
41
  * `project_id` (int64): Required - Project for which to return messages.
42
42