files.com 1.0.254 → 1.0.255

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (74) hide show
  1. package/_VERSION +1 -1
  2. package/docs/Errors.md +1 -0
  3. package/docs/models/ApiKey.md +2 -3
  4. package/docs/models/App.md +1 -5
  5. package/docs/models/As2IncomingMessage.md +2 -3
  6. package/docs/models/As2OutgoingMessage.md +2 -3
  7. package/docs/models/Automation.md +7 -8
  8. package/docs/models/AutomationRun.md +0 -5
  9. package/docs/models/BandwidthSnapshot.md +2 -3
  10. package/docs/models/Behavior.md +3 -11
  11. package/docs/models/Bundle.md +2 -3
  12. package/docs/models/BundleDownload.md +2 -3
  13. package/docs/models/BundleNotification.md +3 -1
  14. package/docs/models/BundleRecipient.md +0 -5
  15. package/docs/models/ExternalEvent.md +5 -5
  16. package/docs/models/Group.md +1 -5
  17. package/docs/models/History.md +1 -5
  18. package/docs/models/InboxRecipient.md +0 -5
  19. package/docs/models/InboxUpload.md +2 -3
  20. package/docs/models/Notification.md +3 -7
  21. package/docs/models/Permission.md +1 -5
  22. package/docs/models/RemoteBandwidthSnapshot.md +2 -3
  23. package/docs/models/SettingsChange.md +3 -5
  24. package/docs/models/UsageDailySnapshot.md +4 -5
  25. package/docs/models/User.md +5 -5
  26. package/lib/Errors.js +713 -699
  27. package/lib/models/ApiKey.js +2 -3
  28. package/lib/models/App.js +1 -5
  29. package/lib/models/As2IncomingMessage.js +2 -3
  30. package/lib/models/As2OutgoingMessage.js +2 -3
  31. package/lib/models/Automation.js +6 -7
  32. package/lib/models/AutomationRun.js +0 -5
  33. package/lib/models/BandwidthSnapshot.js +2 -3
  34. package/lib/models/Behavior.js +3 -11
  35. package/lib/models/Bundle.js +2 -3
  36. package/lib/models/BundleDownload.js +2 -3
  37. package/lib/models/BundleNotification.js +5 -3
  38. package/lib/models/BundleRecipient.js +0 -5
  39. package/lib/models/ExternalEvent.js +5 -5
  40. package/lib/models/Group.js +1 -5
  41. package/lib/models/History.js +1 -5
  42. package/lib/models/InboxRecipient.js +0 -5
  43. package/lib/models/InboxUpload.js +2 -3
  44. package/lib/models/Notification.js +5 -9
  45. package/lib/models/Permission.js +1 -5
  46. package/lib/models/RemoteBandwidthSnapshot.js +2 -3
  47. package/lib/models/SettingsChange.js +17 -8
  48. package/lib/models/UsageDailySnapshot.js +4 -5
  49. package/lib/models/User.js +5 -5
  50. package/package.json +1 -1
  51. package/src/Errors.js +1 -0
  52. package/src/models/ApiKey.js +2 -3
  53. package/src/models/App.js +1 -5
  54. package/src/models/As2IncomingMessage.js +2 -3
  55. package/src/models/As2OutgoingMessage.js +2 -3
  56. package/src/models/Automation.js +6 -7
  57. package/src/models/AutomationRun.js +0 -5
  58. package/src/models/BandwidthSnapshot.js +2 -3
  59. package/src/models/Behavior.js +3 -11
  60. package/src/models/Bundle.js +2 -3
  61. package/src/models/BundleDownload.js +2 -3
  62. package/src/models/BundleNotification.js +5 -3
  63. package/src/models/BundleRecipient.js +0 -5
  64. package/src/models/ExternalEvent.js +5 -5
  65. package/src/models/Group.js +1 -5
  66. package/src/models/History.js +1 -5
  67. package/src/models/InboxRecipient.js +0 -5
  68. package/src/models/InboxUpload.js +2 -3
  69. package/src/models/Notification.js +5 -9
  70. package/src/models/Permission.js +1 -5
  71. package/src/models/RemoteBandwidthSnapshot.js +2 -3
  72. package/src/models/SettingsChange.js +10 -5
  73. package/src/models/UsageDailySnapshot.js +4 -5
  74. package/src/models/User.js +5 -5
@@ -48,11 +48,6 @@ class AutomationRun {
48
48
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
49
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
- // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `status`.
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`.
53
- // filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`.
54
- // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `status`.
55
- // filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `status`.
56
51
  // automation_id (required) - int64 - ID of the associated Automation.
57
52
  static list = async (params = {}, options = {}) => {
58
53
  if (!params['automation_id']) {
@@ -57,10 +57,9 @@ class BandwidthSnapshot {
57
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
- // 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`.
61
- // filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
60
+ // filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `logged_at`.
62
61
  // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `logged_at`.
63
- // filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `logged_at`.
62
+ // filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `logged_at`.
64
63
  static list = async (params = {}, options = {}) => {
65
64
  if (params['cursor'] && !isString(params['cursor'])) {
66
65
  throw new errors.InvalidParameterError(`Bad parameter: cursor must be of type String, received ${getType(params['cursor'])}`)
@@ -181,13 +181,9 @@ class Behavior {
181
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
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
+ // behavior - string - If set, return records where the specified field is equal to the supplied value.
184
185
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
185
- // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `behavior`.
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`.
187
- // filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
188
- // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `behavior`.
189
- // filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `behavior`.
190
- // behavior - string - If set, only shows folder behaviors matching this behavior type.
186
+ // filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `behavior`.
191
187
  static list = async (params = {}, options = {}) => {
192
188
  if (params['cursor'] && !isString(params['cursor'])) {
193
189
  throw new errors.InvalidParameterError(`Bad parameter: cursor must be of type String, received ${getType(params['cursor'])}`)
@@ -239,11 +235,7 @@ class Behavior {
239
235
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
240
236
  // 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
237
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
242
- // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `behavior`.
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`.
244
- // filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
245
- // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `behavior`.
246
- // filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `behavior`.
238
+ // filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `behavior`.
247
239
  // path (required) - string - Path to operate on.
248
240
  // recursive - string - Show behaviors above this path?
249
241
  // behavior - string - DEPRECATED: If set only shows folder behaviors matching this behavior type. Use `filter[behavior]` instead.
@@ -426,10 +426,9 @@ class Bundle {
426
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
- // 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`.
430
- // filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
429
+ // filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
431
430
  // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
432
- // filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`.
431
+ // filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
433
432
  static list = async (params = {}, options = {}) => {
434
433
  if (params['user_id'] && !isInt(params['user_id'])) {
435
434
  throw new errors.InvalidParameterError(`Bad parameter: user_id must be of type Int, received ${getType(params['user_id'])}`)
@@ -42,10 +42,9 @@ class BundleDownload {
42
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
- // filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`.
46
- // filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
45
+ // filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
47
46
  // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
48
- // filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`.
47
+ // filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
49
48
  // bundle_id - int64 - Bundle ID
50
49
  // bundle_registration_id - int64 - BundleRegistration ID
51
50
  static list = async (params = {}, options = {}) => {
@@ -133,7 +133,9 @@ class BundleNotification {
133
133
  // user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
134
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
- // bundle_id - int64 - Bundle ID to notify on
136
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[bundle_id]=desc`). Valid fields are `bundle_id`.
137
+ // bundle_id - string - If set, return records where the specified field is equal to the supplied value.
138
+ // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `bundle_id`.
137
139
  static list = async (params = {}, options = {}) => {
138
140
  if (params['user_id'] && !isInt(params['user_id'])) {
139
141
  throw new errors.InvalidParameterError(`Bad parameter: user_id must be of type Int, received ${getType(params['user_id'])}`)
@@ -147,8 +149,8 @@ class BundleNotification {
147
149
  throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params['per_page'])}`)
148
150
  }
149
151
 
150
- if (params['bundle_id'] && !isInt(params['bundle_id'])) {
151
- throw new errors.InvalidParameterError(`Bad parameter: bundle_id must be of type Int, received ${getType(params['bundle_id'])}`)
152
+ if (params['bundle_id'] && !isString(params['bundle_id'])) {
153
+ throw new errors.InvalidParameterError(`Bad parameter: bundle_id must be of type String, received ${getType(params['bundle_id'])}`)
152
154
  }
153
155
 
154
156
  const response = await Api.sendRequest(`/bundle_notifications`, 'GET', params, options)
@@ -96,11 +96,6 @@ class BundleRecipient {
96
96
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
97
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
- // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `has_registrations`.
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`.
101
- // filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
102
- // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `has_registrations`.
103
- // filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `has_registrations`.
104
99
  // bundle_id (required) - int64 - List recipients for the bundle with this ID.
105
100
  static list = async (params = {}, options = {}) => {
106
101
  if (!params['bundle_id']) {
@@ -112,11 +112,11 @@ class ExternalEvent {
112
112
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
113
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
- // 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
- // 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 ]`.
117
- // filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
118
- // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
119
- // filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
115
+ // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
116
+ // filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
117
+ // filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `remote_server_type`.
118
+ // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
119
+ // filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
120
120
  static list = async (params = {}, options = {}) => {
121
121
  if (params['cursor'] && !isString(params['cursor'])) {
122
122
  throw new errors.InvalidParameterError(`Bad parameter: cursor must be of type String, received ${getType(params['cursor'])}`)
@@ -155,11 +155,7 @@ class Group {
155
155
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
156
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
- // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `name`.
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`.
160
- // filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name`.
161
- // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `name`.
162
- // filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `name`.
158
+ // filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`.
163
159
  // ids - string - Comma-separated list of group ids to include in results.
164
160
  static list = async (params = {}, options = {}) => {
165
161
  if (params['cursor'] && !isString(params['cursor'])) {
@@ -248,11 +248,7 @@ class History {
248
248
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
249
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
- // 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
- // 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`.
253
- // filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
254
- // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `user_id`, `folder` or `path`.
255
- // filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
251
+ // filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
256
252
  static list = async (params = {}, options = {}) => {
257
253
  if (params['start_at'] && !isString(params['start_at'])) {
258
254
  throw new errors.InvalidParameterError(`Bad parameter: start_at must be of type String, received ${getType(params['start_at'])}`)
@@ -96,11 +96,6 @@ class InboxRecipient {
96
96
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
97
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
- // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `has_registrations`.
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`.
101
- // filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
102
- // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `has_registrations`.
103
- // filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `has_registrations`.
104
99
  // inbox_id (required) - int64 - List recipients for the inbox with this ID.
105
100
  static list = async (params = {}, options = {}) => {
106
101
  if (!params['inbox_id']) {
@@ -39,10 +39,9 @@ class InboxUpload {
39
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
- // 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`.
43
- // filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
42
+ // filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
44
43
  // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
45
- // filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`.
44
+ // filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
46
45
  // inbox_registration_id - int64 - InboxRegistration ID
47
46
  // inbox_id - int64 - Inbox ID
48
47
  static list = async (params = {}, options = {}) => {
@@ -279,13 +279,9 @@ class Notification {
279
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
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
- // 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
- // 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
- // 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`.
285
- // filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
286
- // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `user_id`, `group_id` or `path`.
287
- // filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
288
- // group_id - int64 - DEPRECATED: Show notifications for this Group ID. Use `filter[group_id]` instead.
282
+ // group_id - string - If set, return records where the specified field is equal to the supplied value.
283
+ // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `user_id` or `group_id`.
284
+ // filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
289
285
  // path - string - Show notifications for this Path.
290
286
  // include_ancestors - boolean - If `include_ancestors` is `true` and `path` is specified, include notifications for any parent paths. Ignored if `path` is not specified.
291
287
  static list = async (params = {}, options = {}) => {
@@ -301,8 +297,8 @@ class Notification {
301
297
  throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params['per_page'])}`)
302
298
  }
303
299
 
304
- if (params['group_id'] && !isInt(params['group_id'])) {
305
- throw new errors.InvalidParameterError(`Bad parameter: group_id must be of type Int, received ${getType(params['group_id'])}`)
300
+ if (params['group_id'] && !isString(params['group_id'])) {
301
+ throw new errors.InvalidParameterError(`Bad parameter: group_id must be of type String, received ${getType(params['group_id'])}`)
306
302
  }
307
303
 
308
304
  if (params['path'] && !isString(params['path'])) {
@@ -125,11 +125,7 @@ class Permission {
125
125
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
126
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
- // 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
- // 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 ]`.
130
- // filter_like - 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 ]`.
131
- // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
132
- // filter_lteq - object - If set, return records where the specified field is less 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 ]`.
128
+ // filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
133
129
  // path - string - DEPRECATED: Permission path. If provided, will scope permissions to this path. Use `filter[path]` instead.
134
130
  // group_id - string - DEPRECATED: Group ID. If provided, will scope permissions to this group. Use `filter[group_id]` instead.`
135
131
  // user_id - string - DEPRECATED: User ID. If provided, will scope permissions to this user. Use `filter[user_id]` instead.`
@@ -45,10 +45,9 @@ class RemoteBandwidthSnapshot {
45
45
  // 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`.
46
46
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
47
47
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `logged_at`.
48
- // 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`.
49
- // filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
48
+ // filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `logged_at`.
50
49
  // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `logged_at`.
51
- // filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `logged_at`.
50
+ // filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `logged_at`.
52
51
  static list = async (params = {}, options = {}) => {
53
52
  if (params['cursor'] && !isString(params['cursor'])) {
54
53
  throw new errors.InvalidParameterError(`Bad parameter: cursor must be of type String, received ${getType(params['cursor'])}`)
@@ -43,12 +43,9 @@ class SettingsChange {
43
43
  // cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
44
44
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
45
45
  // 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`.
46
+ // api_key_id - string - If set, return records where the specified field is equal to the supplied value.
47
+ // user_id - string - If set, return records where the specified field is equal to the supplied value.
46
48
  // 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`.
47
- // 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`.
48
- // 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`.
49
- // filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
50
- // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `api_key_id` and `user_id`.
51
- // filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
52
49
  static list = async (params = {}, options = {}) => {
53
50
  if (params['cursor'] && !isString(params['cursor'])) {
54
51
  throw new errors.InvalidParameterError(`Bad parameter: cursor must be of type String, received ${getType(params['cursor'])}`)
@@ -58,6 +55,14 @@ class SettingsChange {
58
55
  throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params['per_page'])}`)
59
56
  }
60
57
 
58
+ if (params['api_key_id'] && !isString(params['api_key_id'])) {
59
+ throw new errors.InvalidParameterError(`Bad parameter: api_key_id must be of type String, received ${getType(params['api_key_id'])}`)
60
+ }
61
+
62
+ if (params['user_id'] && !isString(params['user_id'])) {
63
+ throw new errors.InvalidParameterError(`Bad parameter: user_id must be of type String, received ${getType(params['user_id'])}`)
64
+ }
65
+
61
66
  const response = await Api.sendRequest(`/settings_changes`, 'GET', params, options)
62
67
 
63
68
  return response?.data?.map(obj => new SettingsChange(obj, options)) || []
@@ -62,11 +62,10 @@ class UsageDailySnapshot {
62
62
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
63
63
  // 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`.
64
64
  // 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 ]`.
65
- // 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 ]`.
66
- // 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 ]`.
67
- // filter_like - 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 ]`.
68
- // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
69
- // filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
65
+ // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `date`.
66
+ // filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `date`.
67
+ // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `date`.
68
+ // filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `date`.
70
69
  static list = async (params = {}, options = {}) => {
71
70
  if (params['cursor'] && !isString(params['cursor'])) {
72
71
  throw new errors.InvalidParameterError(`Bad parameter: cursor must be of type String, received ${getType(params['cursor'])}`)
@@ -779,11 +779,11 @@ class User {
779
779
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
780
780
  // 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`.
781
781
  // 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 ]`.
782
- // 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 ]`.
783
- // 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 ]`.
784
- // filter_like - 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 ]`.
785
- // filter_lt - object - If set, return records where the specified field is less 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 ]`.
786
- // filter_lteq - object - If set, return records where the specified field is less 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 ]`.
782
+ // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
783
+ // filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
784
+ // filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `username`, `email` or `company`.
785
+ // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
786
+ // filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
787
787
  // ids - string - comma-separated list of User IDs
788
788
  // q[username] - string - List users matching username.
789
789
  // q[email] - string - List users matching email.