files.com 1.0.251 → 1.0.252

Sign up to get free protection for your applications and to get access to all the features.
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 +2 -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 +2 -2
  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 +2 -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
@@ -200,7 +200,7 @@ class As2Partner {
200
200
  }
201
201
 
202
202
  // Parameters:
203
- // 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.
203
+ // 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.
204
204
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
205
205
  static list = async (params = {}, options = {}) => {
206
206
  if (params['cursor'] && !isString(params['cursor'])) {
@@ -221,7 +221,7 @@ class As2Station {
221
221
  }
222
222
 
223
223
  // Parameters:
224
- // 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.
224
+ // 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.
225
225
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
226
226
  static list = async (params = {}, options = {}) => {
227
227
  if (params['cursor'] && !isString(params['cursor'])) {
@@ -306,9 +306,9 @@ class Automation {
306
306
  }
307
307
 
308
308
  // Parameters:
309
- // 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.
309
+ // 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.
310
310
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
311
- // 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`.
311
+ // 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`.
312
312
  // 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 ]`.
313
313
  // 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 ]`.
314
314
  // 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 ]`.
@@ -44,9 +44,9 @@ class AutomationRun {
44
44
 
45
45
  // Parameters:
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
- // 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`.
49
+ // 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`.
50
50
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`.
51
51
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `status`.
52
52
  // filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `status`.
@@ -52,9 +52,9 @@ class BandwidthSnapshot {
52
52
 
53
53
 
54
54
  // Parameters:
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
- // 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`.
57
+ // 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`.
58
58
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
59
59
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `logged_at`.
60
60
  // 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`.
@@ -178,9 +178,9 @@ class Behavior {
178
178
  }
179
179
 
180
180
  // Parameters:
181
- // 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.
181
+ // 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.
182
182
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
183
- // 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`.
183
+ // 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`.
184
184
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
185
185
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `behavior`.
186
186
  // filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `behavior`.
@@ -235,9 +235,9 @@ class Behavior {
235
235
  Behavior.find(id, params, options)
236
236
 
237
237
  // Parameters:
238
- // 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.
238
+ // 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.
239
239
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
240
- // 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`.
240
+ // 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`.
241
241
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
242
242
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `behavior`.
243
243
  // filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `behavior`.
@@ -421,9 +421,9 @@ class Bundle {
421
421
 
422
422
  // Parameters:
423
423
  // user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
424
- // 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.
424
+ // 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.
425
425
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
426
- // 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`.
426
+ // 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`.
427
427
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
428
428
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
429
429
  // 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`.
@@ -37,9 +37,9 @@ class BundleDownload {
37
37
 
38
38
 
39
39
  // Parameters:
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 `created_at`.
42
+ // 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`.
43
43
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
44
44
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
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 `created_at`.
@@ -131,7 +131,7 @@ class BundleNotification {
131
131
 
132
132
  // Parameters:
133
133
  // user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
134
- // 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.
134
+ // 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.
135
135
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
136
136
  // bundle_id - int64 - Bundle ID to notify on
137
137
  static list = async (params = {}, options = {}) => {
@@ -92,9 +92,9 @@ class BundleRecipient {
92
92
 
93
93
  // Parameters:
94
94
  // user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
95
- // 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.
95
+ // 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.
96
96
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
97
- // 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`.
97
+ // 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`.
98
98
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
99
99
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `has_registrations`.
100
100
  // 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`.
@@ -65,7 +65,7 @@ class BundleRegistration {
65
65
 
66
66
  // Parameters:
67
67
  // user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
68
- // 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.
68
+ // 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.
69
69
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
70
70
  // bundle_id - int64 - ID of the associated Bundle
71
71
  static list = async (params = {}, options = {}) => {
@@ -155,7 +155,7 @@ class Clickwrap {
155
155
  }
156
156
 
157
157
  // Parameters:
158
- // 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.
158
+ // 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.
159
159
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
160
160
  static list = async (params = {}, options = {}) => {
161
161
  if (params['cursor'] && !isString(params['cursor'])) {
@@ -37,7 +37,7 @@ class DnsRecord {
37
37
 
38
38
 
39
39
  // Parameters:
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
  static list = async (params = {}, options = {}) => {
43
43
  if (params['cursor'] && !isString(params['cursor'])) {
@@ -108,9 +108,9 @@ class ExternalEvent {
108
108
  }
109
109
 
110
110
  // Parameters:
111
- // 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.
111
+ // 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.
112
112
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
113
- // 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`.
113
+ // 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`.
114
114
  // 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 ]`.
115
115
  // 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 ]`.
116
116
  // 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 ]`.
@@ -133,7 +133,7 @@ class FileComment {
133
133
  }
134
134
 
135
135
  // Parameters:
136
- // 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.
136
+ // 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.
137
137
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
138
138
  // path (required) - string - Path to operate on.
139
139
  static listFor = async (path, params = {}, options = {}) => {
@@ -161,7 +161,7 @@ class FormFieldSet {
161
161
 
162
162
  // Parameters:
163
163
  // user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
164
- // 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.
164
+ // 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.
165
165
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
166
166
  static list = async (params = {}, options = {}) => {
167
167
  if (params['user_id'] && !isInt(params['user_id'])) {
@@ -151,9 +151,9 @@ class Group {
151
151
  }
152
152
 
153
153
  // Parameters:
154
- // 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.
154
+ // 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.
155
155
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
156
- // 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`.
156
+ // 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`.
157
157
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name`.
158
158
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `name`.
159
159
  // filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `name`.
@@ -186,7 +186,7 @@ class GroupUser {
186
186
 
187
187
  // Parameters:
188
188
  // user_id - int64 - User ID. If provided, will return group_users of this user.
189
- // 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.
189
+ // 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.
190
190
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
191
191
  // group_id - int64 - Group ID. If provided, will return group_users of this group.
192
192
  static list = async (params = {}, options = {}) => {
@@ -67,9 +67,9 @@ class History {
67
67
  // start_at - string - Leave blank or set to a date/time to filter earlier entries.
68
68
  // end_at - string - Leave blank or set to a date/time to filter later entries.
69
69
  // display - string - Display format. Leave blank or set to `full` or `parent`.
70
- // 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.
70
+ // 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.
71
71
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
72
- // 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`.
72
+ // 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`.
73
73
  // path (required) - string - Path to operate on.
74
74
  static listForFile = async (path, params = {}, options = {}) => {
75
75
  if (!isObject(params)) {
@@ -115,9 +115,9 @@ class History {
115
115
  // start_at - string - Leave blank or set to a date/time to filter earlier entries.
116
116
  // end_at - string - Leave blank or set to a date/time to filter later entries.
117
117
  // display - string - Display format. Leave blank or set to `full` or `parent`.
118
- // 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.
118
+ // 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.
119
119
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
120
- // 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`.
120
+ // 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`.
121
121
  // path (required) - string - Path to operate on.
122
122
  static listForFolder = async (path, params = {}, options = {}) => {
123
123
  if (!isObject(params)) {
@@ -163,9 +163,9 @@ class History {
163
163
  // start_at - string - Leave blank or set to a date/time to filter earlier entries.
164
164
  // end_at - string - Leave blank or set to a date/time to filter later entries.
165
165
  // display - string - Display format. Leave blank or set to `full` or `parent`.
166
- // 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.
166
+ // 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.
167
167
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
168
- // 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`.
168
+ // 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`.
169
169
  // user_id (required) - int64 - User ID.
170
170
  static listForUser = async (user_id, params = {}, options = {}) => {
171
171
  if (!isObject(params)) {
@@ -211,9 +211,9 @@ class History {
211
211
  // start_at - string - Leave blank or set to a date/time to filter earlier entries.
212
212
  // end_at - string - Leave blank or set to a date/time to filter later entries.
213
213
  // display - string - Display format. Leave blank or set to `full` or `parent`.
214
- // 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.
214
+ // 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.
215
215
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
216
- // 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`.
216
+ // 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`.
217
217
  static listLogins = async (params = {}, options = {}) => {
218
218
  if (params['start_at'] && !isString(params['start_at'])) {
219
219
  throw new errors.InvalidParameterError(`Bad parameter: start_at must be of type String, received ${getType(params['start_at'])}`)
@@ -244,9 +244,9 @@ class History {
244
244
  // start_at - string - Leave blank or set to a date/time to filter earlier entries.
245
245
  // end_at - string - Leave blank or set to a date/time to filter later entries.
246
246
  // display - string - Display format. Leave blank or set to `full` or `parent`.
247
- // 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.
247
+ // 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.
248
248
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
249
- // 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`.
249
+ // 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`.
250
250
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
251
251
  // 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`.
252
252
  // 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`.
@@ -98,7 +98,7 @@ class HistoryExportResult {
98
98
 
99
99
  // Parameters:
100
100
  // user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
101
- // cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
101
+ // 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.
102
102
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
103
103
  // history_export_id (required) - int64 - ID of the associated history export.
104
104
  static list = async (params = {}, options = {}) => {
@@ -92,9 +92,9 @@ class InboxRecipient {
92
92
 
93
93
  // Parameters:
94
94
  // user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
95
- // 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.
95
+ // 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.
96
96
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
97
- // 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`.
97
+ // 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`.
98
98
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
99
99
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `has_registrations`.
100
100
  // 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`.
@@ -58,7 +58,7 @@ class InboxRegistration {
58
58
 
59
59
 
60
60
  // Parameters:
61
- // 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.
61
+ // 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.
62
62
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
63
63
  // folder_behavior_id - int64 - ID of the associated Inbox.
64
64
  static list = async (params = {}, options = {}) => {
@@ -34,9 +34,9 @@ class InboxUpload {
34
34
 
35
35
 
36
36
  // Parameters:
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
- // 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`.
39
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at`.
40
40
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
41
41
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
42
42
  // 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`.
@@ -67,7 +67,7 @@ class Invoice {
67
67
 
68
68
 
69
69
  // Parameters:
70
- // 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.
70
+ // 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.
71
71
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
72
72
  static list = async (params = {}, options = {}) => {
73
73
  if (params['cursor'] && !isString(params['cursor'])) {
@@ -37,7 +37,7 @@ class IpAddress {
37
37
 
38
38
 
39
39
  // Parameters:
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
  static list = async (params = {}, options = {}) => {
43
43
  if (params['cursor'] && !isString(params['cursor'])) {
@@ -57,7 +57,7 @@ class IpAddress {
57
57
  IpAddress.list(params, options)
58
58
 
59
59
  // Parameters:
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
62
  static getExavaultReserved = async (params = {}, options = {}) => {
63
63
  if (params['cursor'] && !isString(params['cursor'])) {
@@ -74,7 +74,7 @@ class IpAddress {
74
74
  }
75
75
 
76
76
  // Parameters:
77
- // 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.
77
+ // 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.
78
78
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
79
79
  static getReserved = async (params = {}, options = {}) => {
80
80
  if (params['cursor'] && !isString(params['cursor'])) {
@@ -158,7 +158,7 @@ class Lock {
158
158
  }
159
159
 
160
160
  // Parameters:
161
- // 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.
161
+ // 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.
162
162
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
163
163
  // path (required) - string - Path to operate on.
164
164
  // include_children - boolean - Include locks from children objects?
@@ -172,7 +172,7 @@ class Message {
172
172
 
173
173
  // Parameters:
174
174
  // user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
175
- // 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.
175
+ // 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.
176
176
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
177
177
  // project_id (required) - int64 - Project for which to return messages.
178
178
  static list = async (params = {}, options = {}) => {
@@ -134,7 +134,7 @@ class MessageComment {
134
134
 
135
135
  // Parameters:
136
136
  // user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
137
- // 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.
137
+ // 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.
138
138
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
139
139
  // message_id (required) - int64 - Message comment to return comments for.
140
140
  static list = async (params = {}, options = {}) => {
@@ -87,7 +87,7 @@ class MessageCommentReaction {
87
87
 
88
88
  // Parameters:
89
89
  // user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
90
- // 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.
90
+ // 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.
91
91
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
92
92
  // message_comment_id (required) - int64 - Message comment to return reactions for.
93
93
  static list = async (params = {}, options = {}) => {
@@ -87,7 +87,7 @@ class MessageReaction {
87
87
 
88
88
  // Parameters:
89
89
  // user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
90
- // 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.
90
+ // 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.
91
91
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
92
92
  // message_id (required) - int64 - Message to return reactions for.
93
93
  static list = async (params = {}, options = {}) => {
@@ -276,9 +276,9 @@ class Notification {
276
276
 
277
277
  // Parameters:
278
278
  // user_id - int64 - DEPRECATED: Show notifications for this User ID. Use `filter[user_id]` instead.
279
- // 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.
279
+ // 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.
280
280
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
281
- // 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`, `user_id` or `group_id`.
281
+ // 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`, `user_id` or `group_id`.
282
282
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
283
283
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `user_id`, `group_id` or `path`.
284
284
  // 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`, `group_id` or `path`.
@@ -67,7 +67,7 @@ class Payment {
67
67
 
68
68
 
69
69
  // Parameters:
70
- // 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.
70
+ // 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.
71
71
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
72
72
  static list = async (params = {}, options = {}) => {
73
73
  if (params['cursor'] && !isString(params['cursor'])) {
@@ -121,9 +121,9 @@ class Permission {
121
121
  }
122
122
 
123
123
  // Parameters:
124
- // 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.
124
+ // 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.
125
125
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
126
- // 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 `group_id`, `path`, `user_id` or `permission`.
126
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[group_id]=desc`). Valid fields are `group_id`, `path`, `user_id` or `permission`.
127
127
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
128
128
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
129
129
  // filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
@@ -31,7 +31,7 @@ class Priority {
31
31
 
32
32
 
33
33
  // Parameters:
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
  // path (required) - string - The path to query for priorities
37
37
  static list = async (path, params = {}, options = {}) => {
@@ -119,7 +119,7 @@ class Project {
119
119
  }
120
120
 
121
121
  // Parameters:
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
124
  static list = async (params = {}, options = {}) => {
125
125
  if (params['cursor'] && !isString(params['cursor'])) {
@@ -144,7 +144,7 @@ class PublicKey {
144
144
 
145
145
  // Parameters:
146
146
  // user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
147
- // 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.
147
+ // 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.
148
148
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
149
149
  static list = async (params = {}, options = {}) => {
150
150
  if (params['user_id'] && !isInt(params['user_id'])) {