files.com 1.0.251 → 1.0.253

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 +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
@@ -166,9 +166,9 @@ var Request = /*#__PURE__*/(0, _createClass2.default)(function Request() {
166
166
  this.options = _objectSpread({}, options);
167
167
  });
168
168
  // Parameters:
169
- // 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.
169
+ // 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.
170
170
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
171
- // 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 `destination`.
171
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[destination]=desc`). Valid fields are `destination`.
172
172
  // mine - boolean - Only show requests of the current user? (Defaults to true if current user is not a site admin.)
173
173
  // path - string - Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.
174
174
  (0, _defineProperty2.default)(Request, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
@@ -219,9 +219,9 @@ var Request = /*#__PURE__*/(0, _createClass2.default)(function Request() {
219
219
  return Request.list(params, options);
220
220
  });
221
221
  // Parameters:
222
- // 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.
222
+ // 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.
223
223
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
224
- // 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 `destination`.
224
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[destination]=desc`). Valid fields are `destination`.
225
225
  // mine - boolean - Only show requests of the current user? (Defaults to true if current user is not a site admin.)
226
226
  // path (required) - string - Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.
227
227
  (0, _defineProperty2.default)(Request, "getFolder", /*#__PURE__*/function () {
@@ -65,9 +65,9 @@ var SettingsChange = /*#__PURE__*/(0, _createClass2.default)(function SettingsCh
65
65
  this.options = _objectSpread({}, options);
66
66
  });
67
67
  // Parameters:
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
- // 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 `api_key_id`, `created_at` or `user_id`.
70
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[api_key_id]=desc`). Valid fields are `api_key_id`, `created_at` or `user_id`.
71
71
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
72
72
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `api_key_id` and `user_id`.
73
73
  // filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
@@ -212,7 +212,7 @@ var SftpHostKey = /*#__PURE__*/(0, _createClass2.default)(function SftpHostKey()
212
212
  this.options = _objectSpread({}, options);
213
213
  });
214
214
  // Parameters:
215
- // 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.
215
+ // 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.
216
216
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
217
217
  (0, _defineProperty2.default)(SftpHostKey, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
218
218
  var _response$data;
@@ -270,7 +270,7 @@ var SsoStrategy = /*#__PURE__*/(0, _createClass2.default)(function SsoStrategy()
270
270
  this.options = _objectSpread({}, options);
271
271
  });
272
272
  // Parameters:
273
- // 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.
273
+ // 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.
274
274
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
275
275
  (0, _defineProperty2.default)(SsoStrategy, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
276
276
  var _response$data;
@@ -89,9 +89,9 @@ var UsageDailySnapshot = /*#__PURE__*/(0, _createClass2.default)(function UsageD
89
89
  this.options = _objectSpread({}, options);
90
90
  });
91
91
  // Parameters:
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 `date` and `usage_snapshot_id`.
94
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[date]=desc`). Valid fields are `date` and `usage_snapshot_id`.
95
95
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
96
96
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
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 `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
@@ -105,7 +105,7 @@ var UsageSnapshot = /*#__PURE__*/(0, _createClass2.default)(function UsageSnapsh
105
105
  this.options = _objectSpread({}, options);
106
106
  });
107
107
  // Parameters:
108
- // 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.
108
+ // 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.
109
109
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
110
110
  (0, _defineProperty2.default)(UsageSnapshot, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
111
111
  var _response$data;
@@ -996,9 +996,9 @@ var User = /*#__PURE__*/(0, _createClass2.default)(function User() {
996
996
  this.options = _objectSpread({}, options);
997
997
  });
998
998
  // Parameters:
999
- // 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.
999
+ // 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.
1000
1000
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
1001
- // 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 `authenticate_until`, `active`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `company`, `name`, `site_admin`, `receive_admin_alerts`, `password_validity_days`, `ssl_required` or `not_site_admin`.
1001
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[authenticate_until]=desc`). Valid fields are `authenticate_until`, `active`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `company`, `name`, `site_admin`, `receive_admin_alerts`, `password_validity_days`, `ssl_required` or `not_site_admin`.
1002
1002
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ not_site_admin, username ]`.
1003
1003
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `username`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ not_site_admin, username ]`.
1004
1004
  // filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `username`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ not_site_admin, username ]`.
@@ -70,7 +70,7 @@ var UserCipherUse = /*#__PURE__*/(0, _createClass2.default)(function UserCipherU
70
70
  });
71
71
  // Parameters:
72
72
  // user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
73
- // cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
73
+ // 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.
74
74
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
75
75
  (0, _defineProperty2.default)(UserCipherUse, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
76
76
  var _response$data;
@@ -138,7 +138,7 @@ var UserRequest = /*#__PURE__*/(0, _createClass2.default)(function UserRequest()
138
138
  this.options = _objectSpread({}, options);
139
139
  });
140
140
  // Parameters:
141
- // 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.
141
+ // 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.
142
142
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
143
143
  (0, _defineProperty2.default)(UserRequest, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
144
144
  var _response$data;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "files.com",
3
- "version": "1.0.251",
3
+ "version": "1.0.253",
4
4
  "description": "Files.com SDK for JavaScript",
5
5
  "keywords": [
6
6
  "files.com",
@@ -56,7 +56,7 @@ class ActionNotificationExportResult {
56
56
 
57
57
  // Parameters:
58
58
  // user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
59
- // cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
59
+ // 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.
60
60
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
61
61
  // action_notification_export_id (required) - int64 - ID of the associated action notification export.
62
62
  static list = async (params = {}, options = {}) => {
@@ -197,9 +197,9 @@ class ApiKey {
197
197
 
198
198
  // Parameters:
199
199
  // user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
200
- // 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.
200
+ // 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.
201
201
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
202
- // 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`.
202
+ // 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`.
203
203
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `expires_at`.
204
204
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `expires_at`.
205
205
  // 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`.
package/src/models/App.js CHANGED
@@ -73,9 +73,9 @@ class App {
73
73
 
74
74
 
75
75
  // Parameters:
76
- // 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.
76
+ // 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.
77
77
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
78
- // 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`.
78
+ // 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`.
79
79
  // 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 ]`.
80
80
  // 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 ]`.
81
81
  // 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 ]`.
@@ -130,9 +130,9 @@ class As2IncomingMessage {
130
130
 
131
131
 
132
132
  // Parameters:
133
- // 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.
133
+ // 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.
134
134
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
135
- // 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`.
135
+ // 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`.
136
136
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
137
137
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
138
138
  // 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`.
@@ -118,9 +118,9 @@ class As2OutgoingMessage {
118
118
 
119
119
 
120
120
  // Parameters:
121
- // 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.
121
+ // 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.
122
122
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
123
- // 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`.
123
+ // 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`.
124
124
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
125
125
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
126
126
  // 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`.
@@ -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'])) {
@@ -135,6 +135,13 @@ class Automation {
135
135
  this.attributes.user_id = value
136
136
  }
137
137
 
138
+ // array # IDs of remote sync folder behaviors to run by this Automation
139
+ getSyncIds = () => this.attributes.sync_ids
140
+
141
+ setSyncIds = value => {
142
+ this.attributes.sync_ids = value
143
+ }
144
+
138
145
  // array # IDs of Users for the Automation (i.e. who to Request File from)
139
146
  getUserIds = () => this.attributes.user_ids
140
147
 
@@ -186,6 +193,7 @@ class Automation {
186
193
  // destination_replace_to - string - If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
187
194
  // interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
188
195
  // path - string - Path on which this Automation runs. Supports globs.
196
+ // sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
189
197
  // user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
190
198
  // group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
191
199
  // schedule - object - Custom schedule for running this automation.
@@ -230,6 +238,9 @@ class Automation {
230
238
  if (params['path'] && !isString(params['path'])) {
231
239
  throw new errors.InvalidParameterError(`Bad parameter: path must be of type String, received ${getType(path)}`)
232
240
  }
241
+ if (params['sync_ids'] && !isString(params['sync_ids'])) {
242
+ throw new errors.InvalidParameterError(`Bad parameter: sync_ids must be of type String, received ${getType(sync_ids)}`)
243
+ }
233
244
  if (params['user_ids'] && !isString(params['user_ids'])) {
234
245
  throw new errors.InvalidParameterError(`Bad parameter: user_ids must be of type String, received ${getType(user_ids)}`)
235
246
  }
@@ -306,9 +317,9 @@ class Automation {
306
317
  }
307
318
 
308
319
  // 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.
320
+ // 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
321
  // 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`.
322
+ // 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
323
  // 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
324
  // 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
325
  // 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 ]`.
@@ -371,6 +382,7 @@ class Automation {
371
382
  // 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.
372
383
  // interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
373
384
  // path - string - Path on which this Automation runs. Supports globs.
385
+ // sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
374
386
  // user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
375
387
  // group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
376
388
  // schedule - object - Custom schedule for running this automation.
@@ -414,6 +426,10 @@ class Automation {
414
426
  throw new errors.InvalidParameterError(`Bad parameter: path must be of type String, received ${getType(params['path'])}`)
415
427
  }
416
428
 
429
+ if (params['sync_ids'] && !isString(params['sync_ids'])) {
430
+ throw new errors.InvalidParameterError(`Bad parameter: sync_ids must be of type String, received ${getType(params['sync_ids'])}`)
431
+ }
432
+
417
433
  if (params['user_ids'] && !isString(params['user_ids'])) {
418
434
  throw new errors.InvalidParameterError(`Bad parameter: user_ids must be of type String, received ${getType(params['user_ids'])}`)
419
435
  }
@@ -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 = {}) => {