files.com 1.1.165 → 1.1.167

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cfe2a65cafc8a527f4459e5039500977f75f0bc3c5704fca5c540d1895faef3f
4
- data.tar.gz: 073fa534e4a5952679057c7373aadd31e32fdca69971f2abbbae93378411d1ce
3
+ metadata.gz: eb49f5bdfe74a55f62155d1dffa22f498aa2a3db48eaf5d6f12f538eb64be331
4
+ data.tar.gz: c1bb382e52c5b48119dd6df7803e11e1de4cac30f8776d8ce66a1affec6b8958
5
5
  SHA512:
6
- metadata.gz: ec565831fcaf5164ca26bafd49d171a5c63121cc5093711d1d162bb53f22670be3c02ebeef9209519a4ebef6ac7e76a03cd1ed05c80af4932bd21f9d9ba74a93
7
- data.tar.gz: 54688f985bd2abef600ebe160cd5840b1155df5fb73a0e95f1e1acff7af086a9c66b5ea28d2faf63d6ab07b5c1ad1d3941497b8e804d2ac06aef8657b178e246
6
+ metadata.gz: '097904be7961b17798bbea6fb8113e77151e894004e0fa7209bcdecbf6fdf9d3e83641493c51d8832d41ff14eb54248c294c5241e0089d5e6695ebc5286a1544'
7
+ data.tar.gz: 612f50a7d928a702e9b01df77f4910fb035f72ae962ae792df92842175d8f2d2607df6d5aeaf373d21dfdc7ae52143fa122cc2ba82d227d1ec946f0b44c04978
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.165
1
+ 1.1.167
data/docs/automation.md CHANGED
@@ -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.
@@ -138,7 +138,7 @@ Files::Automation.find(id)
138
138
 
139
139
  ```
140
140
  Files::Automation.create(
141
- source: "source",
141
+ source: "example",
142
142
  destinations: ["folder_a/file_a.txt",{"folder_path":"folder_b","file_path":"file_b.txt"},{"folder_path":"folder_c"}],
143
143
  destination_replace_from: "example",
144
144
  destination_replace_to: "example",
@@ -170,12 +170,12 @@ Files::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.
@@ -218,7 +218,7 @@ Files::Automation.manual_run(id)
218
218
 
219
219
  ```
220
220
  Files::Automation.update(id,
221
- source: "source",
221
+ source: "example",
222
222
  destinations: ["folder_a/file_a.txt",{"folder_path":"folder_b","file_path":"file_b.txt"},{"folder_path":"folder_c"}],
223
223
  destination_replace_from: "example",
224
224
  destination_replace_to: "example",
@@ -251,12 +251,12 @@ Files::Automation.update(id,
251
251
  ### Parameters
252
252
 
253
253
  * `id` (int64): Required - Automation ID.
254
- * `source` (string): Source Path
254
+ * `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.
255
255
  * `destinations` (array(string)): A list of String destination paths or Hash of folder_path and optional file_path.
256
256
  * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
257
257
  * `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.
258
258
  * `interval` (string): How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
259
- * `path` (string): Path on which this Automation runs. Supports globs.
259
+ * `path` (string): Path on which this Automation runs. Supports globs, except on remote mounts.
260
260
  * `sync_ids` (string): A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
261
261
  * `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
262
262
  * `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
@@ -316,7 +316,7 @@ automation.manual_run
316
316
  automation = Files::Automation.find(id)
317
317
 
318
318
  automation.update(
319
- source: "source",
319
+ source: "example",
320
320
  destinations: ["folder_a/file_a.txt",{"folder_path":"folder_b","file_path":"file_b.txt"},{"folder_path":"folder_c"}],
321
321
  destination_replace_from: "example",
322
322
  destination_replace_to: "example",
@@ -349,12 +349,12 @@ automation.update(
349
349
  ### Parameters
350
350
 
351
351
  * `id` (int64): Required - Automation ID.
352
- * `source` (string): Source Path
352
+ * `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.
353
353
  * `destinations` (array(string)): A list of String destination paths or Hash of folder_path and optional file_path.
354
354
  * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
355
355
  * `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.
356
356
  * `interval` (string): How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
357
- * `path` (string): Path on which this Automation runs. Supports globs.
357
+ * `path` (string): Path on which this Automation runs. Supports globs, except on remote mounts.
358
358
  * `sync_ids` (string): A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
359
359
  * `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
360
360
  * `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
data/docs/behavior.md CHANGED
@@ -43,7 +43,7 @@ Files::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 @@ Files::Behavior.list_for(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 @@ Files::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 @@ Files::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 @@ Files::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`.
data/docs/history.md CHANGED
@@ -56,7 +56,7 @@ Files::History.list_for_file(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 @@ Files::History.list_for_folder(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 @@ Files::History.list_logins(
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 @@ Files::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 @@ Files::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
 
data/docs/permission.md CHANGED
@@ -42,7 +42,7 @@ Files::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.
data/docs/request.md CHANGED
@@ -38,7 +38,7 @@ Files::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 @@ Files::Request.get_folder(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 @@ Files::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`.
data/docs/user.md CHANGED
@@ -163,7 +163,7 @@ Files::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`.
@@ -243,7 +243,7 @@ module Files
243
243
  @attributes[:schedule_time_zone] = value
244
244
  end
245
245
 
246
- # string - Source path. Supports globs, except on remote mounts.
246
+ # 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.
247
247
  def source
248
248
  @attributes[:source]
249
249
  end
@@ -327,12 +327,12 @@ module Files
327
327
  end
328
328
 
329
329
  # Parameters:
330
- # source - string - Source Path
330
+ # 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.
331
331
  # destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
332
332
  # destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
333
333
  # 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.
334
334
  # interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
335
- # path - string - Path on which this Automation runs. Supports globs.
335
+ # path - string - Path on which this Automation runs. Supports globs, except on remote mounts.
336
336
  # sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
337
337
  # user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
338
338
  # group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
@@ -455,12 +455,12 @@ module Files
455
455
  end
456
456
 
457
457
  # Parameters:
458
- # source - string - Source Path
458
+ # 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.
459
459
  # destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
460
460
  # destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
461
461
  # 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.
462
462
  # interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
463
- # path - string - Path on which this Automation runs. Supports globs.
463
+ # path - string - Path on which this Automation runs. Supports globs, except on remote mounts.
464
464
  # sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
465
465
  # user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
466
466
  # group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
@@ -522,12 +522,12 @@ module Files
522
522
  end
523
523
 
524
524
  # Parameters:
525
- # source - string - Source Path
525
+ # 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.
526
526
  # destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
527
527
  # destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
528
528
  # 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.
529
529
  # interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
530
- # path - string - Path on which this Automation runs. Supports globs.
530
+ # path - string - Path on which this Automation runs. Supports globs, except on remote mounts.
531
531
  # sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
532
532
  # user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
533
533
  # group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
@@ -158,7 +158,7 @@ module Files
158
158
  # Parameters:
159
159
  # 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.
160
160
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
161
- # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `behavior` and `impacts_ui`.
161
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `behavior`.
162
162
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `impacts_ui` and `behavior`.
163
163
  # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `behavior`.
164
164
  def self.list(params = {}, options = {})
@@ -196,7 +196,7 @@ module Files
196
196
  # Parameters:
197
197
  # 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.
198
198
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
199
- # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `behavior` and `impacts_ui`.
199
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `behavior`.
200
200
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `impacts_ui` and `behavior`.
201
201
  # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `behavior`.
202
202
  # path (required) - string - Path to operate on.
@@ -42,7 +42,7 @@ module Files
42
42
  # Parameters:
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 `bundle_registration_id` and `created_at`.
45
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
46
46
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
47
47
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
48
48
  # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
@@ -86,7 +86,7 @@ module Files
86
86
  # Parameters:
87
87
  # 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.
88
88
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
89
- # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `has_registrations`.
89
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
90
90
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
91
91
  # bundle_id (required) - int64 - List recipients for the bundle with this ID.
92
92
  def self.list(params = {}, options = {})
@@ -145,7 +145,7 @@ module Files
145
145
  # Parameters:
146
146
  # 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.
147
147
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
148
- # 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`.
148
+ # 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`.
149
149
  # 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 ]`.
150
150
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
151
151
  # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
@@ -85,7 +85,7 @@ module Files
85
85
  # display - string - Display format. Leave blank or set to `full` or `parent`.
86
86
  # cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
87
87
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
88
- # 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`.
88
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `path` and `created_at`.
89
89
  # path (required) - string - Path to operate on.
90
90
  def self.list_for_file(path, params = {}, options = {})
91
91
  params ||= {}
@@ -110,7 +110,7 @@ module Files
110
110
  # display - string - Display format. Leave blank or set to `full` or `parent`.
111
111
  # cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
112
112
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
113
- # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `folder` or `created_at`.
113
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
114
114
  # path (required) - string - Path to operate on.
115
115
  def self.list_for_folder(path, params = {}, options = {})
116
116
  params ||= {}
@@ -160,7 +160,7 @@ module Files
160
160
  # display - string - Display format. Leave blank or set to `full` or `parent`.
161
161
  # cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
162
162
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
163
- # 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`.
163
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
164
164
  def self.list_logins(params = {}, options = {})
165
165
  raise InvalidParameterError.new("Bad parameter: start_at must be an String") if params[:start_at] and !params[:start_at].is_a?(String)
166
166
  raise InvalidParameterError.new("Bad parameter: end_at must be an String") if params[:end_at] and !params[:end_at].is_a?(String)
@@ -180,8 +180,8 @@ module Files
180
180
  # display - string - Display format. Leave blank or set to `full` or `parent`.
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
- # 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`.
184
- # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
183
+ # 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`.
184
+ # 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 ]`.
185
185
  # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
186
186
  def self.list(params = {}, options = {})
187
187
  raise InvalidParameterError.new("Bad parameter: start_at must be an String") if params[:start_at] and !params[:start_at].is_a?(String)
@@ -86,7 +86,7 @@ module Files
86
86
  # Parameters:
87
87
  # 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.
88
88
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
89
- # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `has_registrations`.
89
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
90
90
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
91
91
  # inbox_id (required) - int64 - List recipients for the inbox with this ID.
92
92
  def self.list(params = {}, options = {})
@@ -110,7 +110,7 @@ module Files
110
110
  # Parameters:
111
111
  # cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
112
112
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
113
- # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `group_id`, `path`, `user_id` or `permission`.
113
+ # 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`.
114
114
  # 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 ]`.
115
115
  # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
116
116
  # path - string - Permission path. If provided, will scope all permissions(including upward) to this path.
@@ -110,7 +110,7 @@ module Files
110
110
  # Parameters:
111
111
  # cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
112
112
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
113
- # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `destination`.
113
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
114
114
  # mine - boolean - Only show requests of the current user? (Defaults to true if current user is not a site admin.)
115
115
  # path - string - Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.
116
116
  def self.list(params = {}, options = {})
@@ -131,7 +131,7 @@ module Files
131
131
  # Parameters:
132
132
  # 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.
133
133
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
134
- # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `destination`.
134
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
135
135
  # mine - boolean - Only show requests of the current user? (Defaults to true if current user is not a site admin.)
136
136
  # path (required) - string - Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.
137
137
  def self.get_folder(path, params = {}, options = {})
@@ -67,7 +67,7 @@ module Files
67
67
  # Parameters:
68
68
  # cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
69
69
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
70
- # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `date` and `usage_snapshot_id`.
70
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `date`.
71
71
  # 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 ]`.
72
72
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `date`.
73
73
  # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `date`.
@@ -827,7 +827,7 @@ module Files
827
827
  # Parameters:
828
828
  # 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.
829
829
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
830
- # 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`.
830
+ # 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`.
831
831
  # 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 ]`.
832
832
  # 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`.
833
833
  # 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`.
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Files
4
- VERSION = "1.1.165"
4
+ VERSION = "1.1.167"
5
5
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: files.com
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.165
4
+ version: 1.1.167
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-10-29 00:00:00.000000000 Z
11
+ date: 2024-10-30 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable