files.com 1.2.156 → 1.2.158

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.
package/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.2.156
1
+ 1.2.158
@@ -89,7 +89,7 @@
89
89
  * `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
90
90
  * `schedule_times_of_day` (array(string)): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. Times of day in HH:MM format.
91
91
  * `schedule_time_zone` (string): If trigger is `custom_schedule`, Custom schedule Time Zone for when the automation should be run.
92
- * `source` (string): Source path. Supports globs, except on remote mounts.
92
+ * `source` (string): Source path/glob. See Automation docs for exact description, but this is used to filter for files in the `path` to find files to operate on. Supports globs, except on remote mounts.
93
93
  * `sync_ids` (array(int64)): IDs of remote sync folder behaviors to run by this Automation
94
94
  * `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
95
95
  * `trigger` (string): How this automation is triggered to run.
@@ -137,7 +137,7 @@ await Automation.find(id)
137
137
 
138
138
  ```
139
139
  await Automation.create({
140
- 'source': "source",
140
+ 'source': "example",
141
141
  'destinations': ["folder_a/file_a.txt",{"folder_path":"folder_b","file_path":"file_b.txt"},{"folder_path":"folder_c"}],
142
142
  'destination_replace_from': "example",
143
143
  'destination_replace_to': "example",
@@ -170,12 +170,12 @@ await Automation.create({
170
170
 
171
171
  ### Parameters
172
172
 
173
- * `source` (string): Source Path
173
+ * `source` (string): Source path/glob. See Automation docs for exact description, but this is used to filter for files in the `path` to find files to operate on. Supports globs, except on remote mounts.
174
174
  * `destinations` (array(string)): A list of String destination paths or Hash of folder_path and optional file_path.
175
175
  * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
176
176
  * `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.
177
177
  * `interval` (string): How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
178
- * `path` (string): Path on which this Automation runs. Supports globs.
178
+ * `path` (string): Path on which this Automation runs. Supports globs, except on remote mounts.
179
179
  * `sync_ids` (string): A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
180
180
  * `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
181
181
  * `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
@@ -221,7 +221,7 @@ await automation.manual_run()
221
221
  const automation = await Automation.find(id)
222
222
 
223
223
  await automation.update({
224
- 'source': "source",
224
+ 'source': "example",
225
225
  'destinations': ["folder_a/file_a.txt",{"folder_path":"folder_b","file_path":"file_b.txt"},{"folder_path":"folder_c"}],
226
226
  'destination_replace_from': "example",
227
227
  'destination_replace_to': "example",
@@ -254,12 +254,12 @@ await automation.update({
254
254
  ### Parameters
255
255
 
256
256
  * `id` (int64): Required - Automation ID.
257
- * `source` (string): Source Path
257
+ * `source` (string): Source path/glob. See Automation docs for exact description, but this is used to filter for files in the `path` to find files to operate on. Supports globs, except on remote mounts.
258
258
  * `destinations` (array(string)): A list of String destination paths or Hash of folder_path and optional file_path.
259
259
  * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
260
260
  * `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.
261
261
  * `interval` (string): How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
262
- * `path` (string): Path on which this Automation runs. Supports globs.
262
+ * `path` (string): Path on which this Automation runs. Supports globs, except on remote mounts.
263
263
  * `sync_ids` (string): A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
264
264
  * `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
265
265
  * `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
@@ -43,7 +43,7 @@ await Behavior.list
43
43
 
44
44
  * `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.
45
45
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
46
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `behavior` and `impacts_ui`.
46
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `behavior`.
47
47
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `impacts_ui` and `behavior`.
48
48
  * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `behavior`.
49
49
 
@@ -75,7 +75,7 @@ await Behavior.listFor(path, {
75
75
 
76
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. Valid fields are `behavior` and `impacts_ui`.
78
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `behavior`.
79
79
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `impacts_ui` and `behavior`.
80
80
  * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `behavior`.
81
81
  * `path` (string): Required - Path to operate on.
@@ -52,7 +52,7 @@ await BundleAction.list({
52
52
 
53
53
  * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
54
54
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
55
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `bundle_registration_id` and `created_at`.
55
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
56
56
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
57
57
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
58
58
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
@@ -35,7 +35,7 @@ await BundleRecipient.list({
35
35
 
36
36
  * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
37
37
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
38
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `has_registrations`.
38
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
39
39
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
40
40
  * `bundle_id` (int64): Required - List recipients for the bundle with this ID.
41
41
 
@@ -49,7 +49,7 @@ await ExternalEvent.list
49
49
 
50
50
  * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
51
51
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
52
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `remote_server_type`, `site_id`, `folder_behavior_id`, `siem_http_destination_id`, `created_at`, `event_type` or `status`.
52
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `remote_server_type`, `folder_behavior_id`, `siem_http_destination_id`, `created_at`, `event_type` or `status`.
53
53
  * `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`, `folder_behavior_id` or `siem_http_destination_id`. Valid field combinations are `[ created_at, event_type ]`, `[ created_at, remote_server_type ]`, `[ created_at, status ]`, `[ event_type, status ]` or `[ created_at, event_type, status ]`.
54
54
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
55
55
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
@@ -56,7 +56,7 @@ await History.listForFile(path, {
56
56
  * `display` (string): Display format. Leave blank or set to `full` or `parent`.
57
57
  * `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.
58
58
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
59
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `path` or `created_at`.
59
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `path` and `created_at`.
60
60
  * `path` (string): Required - Path to operate on.
61
61
 
62
62
  ---
@@ -77,7 +77,7 @@ await History.listForFolder(path, {
77
77
  * `display` (string): Display format. Leave blank or set to `full` or `parent`.
78
78
  * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
79
79
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
80
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `folder` or `created_at`.
80
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
81
81
  * `path` (string): Required - Path to operate on.
82
82
 
83
83
  ---
@@ -119,7 +119,7 @@ await History.listLogins({
119
119
  * `display` (string): Display format. Leave blank or set to `full` or `parent`.
120
120
  * `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.
121
121
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
122
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `action_login` or `created_at`.
122
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
123
123
 
124
124
  ---
125
125
 
@@ -139,6 +139,6 @@ await History.list({
139
139
  * `display` (string): Display format. Leave blank or set to `full` or `parent`.
140
140
  * `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.
141
141
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
142
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `path`, `folder`, `user_id` or `created_at`.
143
- * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
142
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `path`, `created_at` or `user_id`.
143
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`. Valid field combinations are `[ user_id, folder ]`, `[ user_id, path ]`, `[ folder, path ]` or `[ user_id, folder, path ]`.
144
144
  * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
@@ -35,7 +35,7 @@ await InboxRecipient.list({
35
35
 
36
36
  * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
37
37
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
38
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `has_registrations`.
38
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
39
39
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
40
40
  * `inbox_id` (int64): Required - List recipients for the inbox with this ID.
41
41
 
@@ -42,7 +42,7 @@ await Permission.list({
42
42
 
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
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `group_id`, `path`, `user_id` or `permission`.
45
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `group_id`, `path` or `user_id`.
46
46
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `group_id` or `user_id`. Valid field combinations are `[ path, group_id ]`, `[ path, user_id ]` or `[ group_id, user_id ]`.
47
47
  * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
48
48
  * `path` (string): Permission path. If provided, will scope all permissions(including upward) to this path.
@@ -38,7 +38,7 @@ await Request.list({
38
38
 
39
39
  * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
40
40
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
41
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `destination`.
41
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
42
42
  * `mine` (boolean): Only show requests of the current user? (Defaults to true if current user is not a site admin.)
43
43
  * `path` (string): Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.
44
44
 
@@ -57,7 +57,7 @@ await Request.getFolder(path, {
57
57
 
58
58
  * `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.
59
59
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
60
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `destination`.
60
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
61
61
  * `mine` (boolean): Only show requests of the current user? (Defaults to true if current user is not a site admin.)
62
62
  * `path` (string): Required - Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.
63
63
 
@@ -45,7 +45,7 @@ await UsageDailySnapshot.list
45
45
 
46
46
  * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
47
47
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
48
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `date` and `usage_snapshot_id`.
48
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `date`.
49
49
  * `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 `[ date, usage_snapshot_id ]`.
50
50
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `date`.
51
51
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `date`.
@@ -163,7 +163,7 @@ await User.list
163
163
 
164
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
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `name`, `company`, `site_admin`, `receive_admin_alerts`, `password_validity_days`, `ssl_required` or `not_site_admin`.
166
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `name`, `company`, `site_admin`, `password_validity_days` or `ssl_required`.
167
167
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ username, not_site_admin ]` and `[ name, company ]`.
168
168
  * `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`.
169
169
  * `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`.
package/lib/Files.js CHANGED
@@ -11,7 +11,7 @@ var endpointPrefix = '/api/rest/v1';
11
11
  var apiKey;
12
12
  var baseUrl = 'https://app.files.com';
13
13
  var sessionId = null;
14
- var version = '1.2.156';
14
+ var version = '1.2.158';
15
15
  var userAgent = "Files.com JavaScript SDK v".concat(version);
16
16
  var logLevel = _Logger.LogLevel.INFO;
17
17
  var debugRequest = false;
@@ -215,7 +215,7 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
215
215
  (0, _defineProperty2.default)(this, "setScheduleTimeZone", function (value) {
216
216
  _this.attributes.schedule_time_zone = value;
217
217
  });
218
- // string # Source path. Supports globs, except on remote mounts.
218
+ // string # Source path/glob. See Automation docs for exact description, but this is used to filter for files in the `path` to find files to operate on. Supports globs, except on remote mounts.
219
219
  (0, _defineProperty2.default)(this, "getSource", function () {
220
220
  return _this.attributes.source;
221
221
  });
@@ -321,12 +321,12 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
321
321
  }, _callee);
322
322
  })));
323
323
  // Parameters:
324
- // source - string - Source Path
324
+ // source - string - Source path/glob. See Automation docs for exact description, but this is used to filter for files in the `path` to find files to operate on. Supports globs, except on remote mounts.
325
325
  // destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
326
326
  // destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
327
327
  // 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.
328
328
  // interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
329
- // path - string - Path on which this Automation runs. Supports globs.
329
+ // path - string - Path on which this Automation runs. Supports globs, except on remote mounts.
330
330
  // sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
331
331
  // user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
332
332
  // group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
@@ -717,12 +717,12 @@ _Automation = Automation;
717
717
  return _Automation.find(id, params, options);
718
718
  });
719
719
  // Parameters:
720
- // source - string - Source Path
720
+ // source - string - Source path/glob. See Automation docs for exact description, but this is used to filter for files in the `path` to find files to operate on. Supports globs, except on remote mounts.
721
721
  // destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
722
722
  // destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
723
723
  // 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.
724
724
  // interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
725
- // path - string - Path on which this Automation runs. Supports globs.
725
+ // path - string - Path on which this Automation runs. Supports globs, except on remote mounts.
726
726
  // sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
727
727
  // user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
728
728
  // group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
@@ -285,7 +285,7 @@ _Behavior = Behavior;
285
285
  // Parameters:
286
286
  // 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.
287
287
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
288
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `behavior` and `impacts_ui`.
288
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `behavior`.
289
289
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `impacts_ui` and `behavior`.
290
290
  // filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `behavior`.
291
291
  (0, _defineProperty2.default)(Behavior, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee4() {
@@ -384,7 +384,7 @@ _Behavior = Behavior;
384
384
  // Parameters:
385
385
  // 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.
386
386
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
387
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `behavior` and `impacts_ui`.
387
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `behavior`.
388
388
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `impacts_ui` and `behavior`.
389
389
  // filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `behavior`.
390
390
  // path (required) - string - Path to operate on.
@@ -74,7 +74,7 @@ _BundleAction = BundleAction;
74
74
  // Parameters:
75
75
  // cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
76
76
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
77
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `bundle_registration_id` and `created_at`.
77
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
78
78
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
79
79
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
80
80
  // filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
@@ -122,7 +122,7 @@ _BundleRecipient = BundleRecipient;
122
122
  // Parameters:
123
123
  // 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.
124
124
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
125
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `has_registrations`.
125
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
126
126
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
127
127
  // bundle_id (required) - int64 - List recipients for the bundle with this ID.
128
128
  (0, _defineProperty2.default)(BundleRecipient, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee2() {
@@ -168,7 +168,7 @@ _ExternalEvent = ExternalEvent;
168
168
  // Parameters:
169
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. Valid fields are `remote_server_type`, `site_id`, `folder_behavior_id`, `siem_http_destination_id`, `created_at`, `event_type` or `status`.
171
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `remote_server_type`, `folder_behavior_id`, `siem_http_destination_id`, `created_at`, `event_type` or `status`.
172
172
  // 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`, `folder_behavior_id` or `siem_http_destination_id`. Valid field combinations are `[ created_at, event_type ]`, `[ created_at, remote_server_type ]`, `[ created_at, status ]`, `[ event_type, status ]` or `[ created_at, event_type, status ]`.
173
173
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
174
174
  // filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
@@ -109,7 +109,7 @@ _History = History;
109
109
  // display - string - Display format. Leave blank or set to `full` or `parent`.
110
110
  // 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.
111
111
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
112
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `path` or `created_at`.
112
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `path` and `created_at`.
113
113
  // path (required) - string - Path to operate on.
114
114
  (0, _defineProperty2.default)(History, "listForFile", /*#__PURE__*/function () {
115
115
  var _ref3 = (0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee(path) {
@@ -197,7 +197,7 @@ _History = History;
197
197
  // display - string - Display format. Leave blank or set to `full` or `parent`.
198
198
  // 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.
199
199
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
200
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `folder` or `created_at`.
200
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
201
201
  // path (required) - string - Path to operate on.
202
202
  (0, _defineProperty2.default)(History, "listForFolder", /*#__PURE__*/function () {
203
203
  var _ref4 = (0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee2(path) {
@@ -373,7 +373,7 @@ _History = History;
373
373
  // display - string - Display format. Leave blank or set to `full` or `parent`.
374
374
  // 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.
375
375
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
376
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `action_login` or `created_at`.
376
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
377
377
  (0, _defineProperty2.default)(History, "listLogins", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee4() {
378
378
  var _response$data4;
379
379
  var params,
@@ -436,8 +436,8 @@ _History = History;
436
436
  // display - string - Display format. Leave blank or set to `full` or `parent`.
437
437
  // 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.
438
438
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
439
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `path`, `folder`, `user_id` or `created_at`.
440
- // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
439
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `path`, `created_at` or `user_id`.
440
+ // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`. Valid field combinations are `[ user_id, folder ]`, `[ user_id, path ]`, `[ folder, path ]` or `[ user_id, folder, path ]`.
441
441
  // filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
442
442
  (0, _defineProperty2.default)(History, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee5() {
443
443
  var _response$data5;
@@ -122,7 +122,7 @@ _InboxRecipient = InboxRecipient;
122
122
  // Parameters:
123
123
  // 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.
124
124
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
125
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `has_registrations`.
125
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
126
126
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
127
127
  // inbox_id (required) - int64 - List recipients for the inbox with this ID.
128
128
  (0, _defineProperty2.default)(InboxRecipient, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee2() {
@@ -181,7 +181,7 @@ _Permission = Permission;
181
181
  // Parameters:
182
182
  // 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.
183
183
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
184
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `group_id`, `path`, `user_id` or `permission`.
184
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `group_id`, `path` or `user_id`.
185
185
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `group_id` or `user_id`. Valid field combinations are `[ path, group_id ]`, `[ path, user_id ]` or `[ group_id, user_id ]`.
186
186
  // filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
187
187
  // path - string - Permission path. If provided, will scope all permissions(including upward) to this path.
@@ -181,7 +181,7 @@ _Request = Request;
181
181
  // Parameters:
182
182
  // 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.
183
183
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
184
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `destination`.
184
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
185
185
  // mine - boolean - Only show requests of the current user? (Defaults to true if current user is not a site admin.)
186
186
  // path - string - Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.
187
187
  (0, _defineProperty2.default)(Request, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee3() {
@@ -234,7 +234,7 @@ _Request = Request;
234
234
  // Parameters:
235
235
  // 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.
236
236
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
237
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `destination`.
237
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
238
238
  // mine - boolean - Only show requests of the current user? (Defaults to true if current user is not a site admin.)
239
239
  // path (required) - string - Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.
240
240
  (0, _defineProperty2.default)(Request, "getFolder", /*#__PURE__*/function () {
@@ -94,7 +94,7 @@ _UsageDailySnapshot = UsageDailySnapshot;
94
94
  // Parameters:
95
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. Valid fields are `date` and `usage_snapshot_id`.
97
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `date`.
98
98
  // 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 `[ date, usage_snapshot_id ]`.
99
99
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `date`.
100
100
  // filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `date`.
@@ -1061,7 +1061,7 @@ _User = User;
1061
1061
  // Parameters:
1062
1062
  // 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.
1063
1063
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
1064
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `name`, `company`, `site_admin`, `receive_admin_alerts`, `password_validity_days`, `ssl_required` or `not_site_admin`.
1064
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `name`, `company`, `site_admin`, `password_validity_days` or `ssl_required`.
1065
1065
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ username, not_site_admin ]` and `[ name, company ]`.
1066
1066
  // 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`.
1067
1067
  // 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`.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "files.com",
3
- "version": "1.2.156",
3
+ "version": "1.2.158",
4
4
  "description": "Files.com SDK for JavaScript",
5
5
  "keywords": [
6
6
  "files.com",
package/src/Files.js CHANGED
@@ -5,7 +5,7 @@ const endpointPrefix = '/api/rest/v1'
5
5
  let apiKey
6
6
  let baseUrl = 'https://app.files.com'
7
7
  let sessionId = null
8
- const version = '1.2.156'
8
+ const version = '1.2.158'
9
9
  let userAgent = `Files.com JavaScript SDK v${version}`
10
10
 
11
11
  let logLevel = LogLevel.INFO
@@ -210,7 +210,7 @@ class Automation {
210
210
  this.attributes.schedule_time_zone = value
211
211
  }
212
212
 
213
- // string # Source path. Supports globs, except on remote mounts.
213
+ // string # Source path/glob. See Automation docs for exact description, but this is used to filter for files in the `path` to find files to operate on. Supports globs, except on remote mounts.
214
214
  getSource = () => this.attributes.source
215
215
 
216
216
  setSource = value => {
@@ -293,12 +293,12 @@ class Automation {
293
293
  }
294
294
 
295
295
  // Parameters:
296
- // source - string - Source Path
296
+ // source - string - Source path/glob. See Automation docs for exact description, but this is used to filter for files in the `path` to find files to operate on. Supports globs, except on remote mounts.
297
297
  // destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
298
298
  // destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
299
299
  // 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.
300
300
  // interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
301
- // path - string - Path on which this Automation runs. Supports globs.
301
+ // path - string - Path on which this Automation runs. Supports globs, except on remote mounts.
302
302
  // sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
303
303
  // user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
304
304
  // group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
@@ -519,12 +519,12 @@ class Automation {
519
519
  Automation.find(id, params, options)
520
520
 
521
521
  // Parameters:
522
- // source - string - Source Path
522
+ // source - string - Source path/glob. See Automation docs for exact description, but this is used to filter for files in the `path` to find files to operate on. Supports globs, except on remote mounts.
523
523
  // destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
524
524
  // destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
525
525
  // 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.
526
526
  // interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
527
- // path - string - Path on which this Automation runs. Supports globs.
527
+ // path - string - Path on which this Automation runs. Supports globs, except on remote mounts.
528
528
  // sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
529
529
  // user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
530
530
  // group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
@@ -195,7 +195,7 @@ class Behavior {
195
195
  // Parameters:
196
196
  // 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.
197
197
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
198
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `behavior` and `impacts_ui`.
198
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `behavior`.
199
199
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `impacts_ui` and `behavior`.
200
200
  // filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `behavior`.
201
201
  static list = async (params = {}, options = {}) => {
@@ -243,7 +243,7 @@ class Behavior {
243
243
  // Parameters:
244
244
  // 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.
245
245
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
246
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `behavior` and `impacts_ui`.
246
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `behavior`.
247
247
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `impacts_ui` and `behavior`.
248
248
  // filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `behavior`.
249
249
  // path (required) - string - Path to operate on.
@@ -49,7 +49,7 @@ class BundleAction {
49
49
  // Parameters:
50
50
  // cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
51
51
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
52
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `bundle_registration_id` and `created_at`.
52
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
53
53
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
54
54
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
55
55
  // filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
@@ -90,7 +90,7 @@ class BundleRecipient {
90
90
  // Parameters:
91
91
  // cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
92
92
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
93
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `has_registrations`.
93
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
94
94
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
95
95
  // bundle_id (required) - int64 - List recipients for the bundle with this ID.
96
96
  static list = async (params = {}, options = {}) => {
@@ -135,7 +135,7 @@ class ExternalEvent {
135
135
  // Parameters:
136
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
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `remote_server_type`, `site_id`, `folder_behavior_id`, `siem_http_destination_id`, `created_at`, `event_type` or `status`.
138
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `remote_server_type`, `folder_behavior_id`, `siem_http_destination_id`, `created_at`, `event_type` or `status`.
139
139
  // 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`, `folder_behavior_id` or `siem_http_destination_id`. Valid field combinations are `[ created_at, event_type ]`, `[ created_at, remote_server_type ]`, `[ created_at, status ]`, `[ event_type, status ]` or `[ created_at, event_type, status ]`.
140
140
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
141
141
  // filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
@@ -76,7 +76,7 @@ class History {
76
76
  // display - string - Display format. Leave blank or set to `full` or `parent`.
77
77
  // cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
78
78
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
79
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `path` or `created_at`.
79
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `path` and `created_at`.
80
80
  // path (required) - string - Path to operate on.
81
81
  static listForFile = async (path, params = {}, options = {}) => {
82
82
  if (!isObject(params)) {
@@ -125,7 +125,7 @@ class History {
125
125
  // display - string - Display format. Leave blank or set to `full` or `parent`.
126
126
  // 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.
127
127
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
128
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `folder` or `created_at`.
128
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
129
129
  // path (required) - string - Path to operate on.
130
130
  static listForFolder = async (path, params = {}, options = {}) => {
131
131
  if (!isObject(params)) {
@@ -223,7 +223,7 @@ class History {
223
223
  // display - string - Display format. Leave blank or set to `full` or `parent`.
224
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
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `action_login` or `created_at`.
226
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
227
227
  static listLogins = async (params = {}, options = {}) => {
228
228
  if (params.start_at && !isString(params.start_at)) {
229
229
  throw new errors.InvalidParameterError(`Bad parameter: start_at must be of type String, received ${getType(params.start_at)}`)
@@ -257,8 +257,8 @@ class History {
257
257
  // display - string - Display format. Leave blank or set to `full` or `parent`.
258
258
  // 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.
259
259
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
260
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `path`, `folder`, `user_id` or `created_at`.
261
- // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
260
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `path`, `created_at` or `user_id`.
261
+ // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`. Valid field combinations are `[ user_id, folder ]`, `[ user_id, path ]`, `[ folder, path ]` or `[ user_id, folder, path ]`.
262
262
  // filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
263
263
  static list = async (params = {}, options = {}) => {
264
264
  if (params.start_at && !isString(params.start_at)) {
@@ -90,7 +90,7 @@ class InboxRecipient {
90
90
  // Parameters:
91
91
  // cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
92
92
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
93
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `has_registrations`.
93
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
94
94
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
95
95
  // inbox_id (required) - int64 - List recipients for the inbox with this ID.
96
96
  static list = async (params = {}, options = {}) => {
@@ -125,7 +125,7 @@ class Permission {
125
125
  // Parameters:
126
126
  // 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.
127
127
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
128
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `group_id`, `path`, `user_id` or `permission`.
128
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `group_id`, `path` or `user_id`.
129
129
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `group_id` or `user_id`. Valid field combinations are `[ path, group_id ]`, `[ path, user_id ]` or `[ group_id, user_id ]`.
130
130
  // filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
131
131
  // path - string - Permission path. If provided, will scope all permissions(including upward) to this path.
@@ -125,7 +125,7 @@ class Request {
125
125
  // Parameters:
126
126
  // 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.
127
127
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
128
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `destination`.
128
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
129
129
  // mine - boolean - Only show requests of the current user? (Defaults to true if current user is not a site admin.)
130
130
  // path - string - Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.
131
131
  static list = async (params = {}, options = {}) => {
@@ -152,7 +152,7 @@ class Request {
152
152
  // Parameters:
153
153
  // 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.
154
154
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
155
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `destination`.
155
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
156
156
  // mine - boolean - Only show requests of the current user? (Defaults to true if current user is not a site admin.)
157
157
  // path (required) - string - Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.
158
158
  static getFolder = async (path, params = {}, options = {}) => {
@@ -64,7 +64,7 @@ class UsageDailySnapshot {
64
64
  // Parameters:
65
65
  // 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.
66
66
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
67
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `date` and `usage_snapshot_id`.
67
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `date`.
68
68
  // 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 `[ date, usage_snapshot_id ]`.
69
69
  // filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `date`.
70
70
  // filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `date`.
@@ -853,7 +853,7 @@ class User {
853
853
  // Parameters:
854
854
  // 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.
855
855
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
856
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `name`, `company`, `site_admin`, `receive_admin_alerts`, `password_validity_days`, `ssl_required` or `not_site_admin`.
856
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `name`, `company`, `site_admin`, `password_validity_days` or `ssl_required`.
857
857
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ username, not_site_admin ]` and `[ name, company ]`.
858
858
  // 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`.
859
859
  // 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`.