files.com 1.1.759 → 1.1.761

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: 844199f222c0d7a81f7a17742192f06608db347a37872ff38e1cb6d07998c1ee
4
- data.tar.gz: b84c2d7340036beafea02c69321fe1b718ff7370f847dff54af10d587572b276
3
+ metadata.gz: 70eb87b154c75bdd0e5e0b1400eaf10e2c7c375890c60a6ac19e37d43c1b1905
4
+ data.tar.gz: 11a8a18817d44f14e45cf0ad245eb8206e261fa4e08a244e50264ed29f2e1760
5
5
  SHA512:
6
- metadata.gz: 773fa097b3fdbf512cbb946d82a367bf220606f3743b68c00cab6af1f2ed5ae011fa678d3d963a46384a301e86f605c2bdf9934488d37d0719c06a77236de6e0
7
- data.tar.gz: ff3a484319e8e215f48ab3241f09d3dd9e548858f3e04441b3cff3f998e4233fa3971c07fd7241c3950d83f819648e6d85f1ff5a493c29a165d81ad2c6a51162
6
+ metadata.gz: b7246637ce8c0a6757471590692615cbf7746911bc43691054e5a1752ff57a611fc420d8ccc02d4da8904c02a30afa57f0ed3270c86e27ab0f828f1a0db1dc4d
7
+ data.tar.gz: ac784118649ef9ed5b7421ad19a206d916bc716162af295319e5b7689e315d1f111f6d565ddaa974ee5c9faafbe919feef03dcf3f4f8b710a5345d89d5498a64
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.759
1
+ 1.1.761
data/docs/folder.md CHANGED
@@ -125,7 +125,7 @@ Files::Folder.list_for(path,
125
125
  * `path` (string): Required - Path to operate on.
126
126
  * `preview_size` (string): Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`.
127
127
  * `sort_by` (object): Search by field and direction. Valid fields are `path`, `size`, `modified_at_datetime`, `provided_modified_at`. Valid directions are `asc` and `desc`. Defaults to `{"path":"asc"}`.
128
- * `search` (string): If specified, will search the folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'. Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing. Results may be truncated if more than 1,000 possible matches exist. This field should only be used for ad-hoc (human) searching, and not as part of an automated process. During scheduled search maintenance, indexed searches return HTTP 422 with error type `service-unavailable/search-unavailable`; retry after maintenance ends. Folder listing without `search` remains available.
128
+ * `search` (string): If specified, will search the folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'. Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing. Results may be truncated if more than 1,000 possible matches exist. This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
129
129
  * `search_custom_metadata_key` (string): If provided, the search string in `search` will search for files where this custom metadata key matches the value sent in `search`. Set this to `*` to allow any metadata key to match the value sent in `search`.
130
130
  * `search_all` (boolean): Search entire site? If true, we will search the entire site. Do not provide a path when using this parameter. This is the same API used by the search bar in the web UI when running 'Search All Files'. Search results are a best effort, not real time, and not guaranteed to match every file. This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
131
131
  * `with_previews` (boolean): Include file previews?
data/docs/restore.md CHANGED
@@ -31,7 +31,7 @@
31
31
  }
32
32
  ```
33
33
 
34
- * `earliest_date` (date-time): Restore all files deleted after this date/time. Don't set this earlier than you need. Can not be greater than 365 days prior to the restore request.
34
+ * `earliest_date` (date-time): Restore files or users deleted on or after this date/time. Don't set this earlier than you need. Can not be greater than 365 days prior to the restore request.
35
35
  * `id` (int64): Restore Record ID.
36
36
  * `dirs_restored` (int64): Number of directories that were successfully restored.
37
37
  * `dirs_errored` (int64): Number of directories that were not able to be restored.
@@ -39,10 +39,10 @@
39
39
  * `files_restored` (int64): Number of files successfully restored.
40
40
  * `files_errored` (int64): Number of files that were not able to be restored.
41
41
  * `files_total` (int64): Total number of files processed.
42
- * `prefix` (string): Prefix of the files/folders to restore. To restore a folder, add a trailing slash to the folder name. Do not use a leading slash. To restore all deleted items, specify an empty string (`''`) in the prefix field or omit the field from the request.
43
- * `restoration_type` (string): Type of restoration to perform. `files` restores deleted filesystem items. `users` restores deleted users and associated access/authentication records.
42
+ * `prefix` (string): Prefix of the files/folders to restore, or a case-insensitive username prefix for a user restore. To restore a folder, add a trailing slash to the folder name. Do not use a leading slash. To restore all deleted items of the selected restoration type, specify an empty string (`''`) in the prefix field or omit the field from the request.
43
+ * `restoration_type` (string): Type of restoration to perform. `files` restores deleted filesystem items. `users` restores deleted users and associated access/authentication records removed as part of deleting those users.
44
44
  * `restore_in_place` (boolean): If true, we will restore the files in place (into their original paths). If false, we will create a new restoration folder in the root and restore files there.
45
- * `restore_deleted_permissions` (boolean): If true, we will also restore any Permissions that match the same path prefix from the same dates.
45
+ * `restore_deleted_permissions` (boolean): If true, restore permissions removed as part of deleting the selected users for a user restore, or permissions matching the selected path prefix and deletion dates for a file restore.
46
46
  * `users_restored` (int64): Number of users successfully restored (only present for `restoration_type=users`).
47
47
  * `users_errored` (int64): Number of users that failed to restore (only present for `restoration_type=users`).
48
48
  * `users_total` (int64): Total number of users processed (only present for `restoration_type=users`).
@@ -89,10 +89,10 @@ Files::Restore.create(
89
89
 
90
90
  ### Parameters
91
91
 
92
- * `earliest_date` (string): Required - Restore all files deleted after this date/time. Don't set this earlier than you need. Can not be greater than 365 days prior to the restore request.
93
- * `prefix` (string): Prefix of the files/folders to restore. To restore a folder, add a trailing slash to the folder name. Do not use a leading slash. To restore all deleted items, specify an empty string (`''`) in the prefix field or omit the field from the request.
94
- * `restoration_type` (string): Type of restoration to perform. `files` restores deleted filesystem items. `users` restores deleted users and associated access/authentication records.
95
- * `restore_deleted_permissions` (boolean): If true, we will also restore any Permissions that match the same path prefix from the same dates.
92
+ * `earliest_date` (string): Required - Restore files or users deleted on or after this date/time. Don't set this earlier than you need. Can not be greater than 365 days prior to the restore request.
93
+ * `prefix` (string): Prefix of the files/folders to restore, or a case-insensitive username prefix for a user restore. To restore a folder, add a trailing slash to the folder name. Do not use a leading slash. To restore all deleted items of the selected restoration type, specify an empty string (`''`) in the prefix field or omit the field from the request.
94
+ * `restoration_type` (string): Type of restoration to perform. `files` restores deleted filesystem items. `users` restores deleted users and associated access/authentication records removed as part of deleting those users.
95
+ * `restore_deleted_permissions` (boolean): If true, restore permissions removed as part of deleting the selected users for a user restore, or permissions matching the selected path prefix and deletion dates for a file restore.
96
96
  * `restore_in_place` (boolean): If true, we will restore the files in place (into their original paths). If false, we will create a new restoration folder in the root and restore files there.
97
97
  * `update_timestamps` (boolean): If true, we will update the last modified timestamp of restored files to today's date. If false, we might trigger File Expiration to delete the file again.
98
98
  * `workspace_id` (int64): Workspace ID for a workspace-scoped restore. `0` means the default site-wide scope.
@@ -491,7 +491,7 @@ module Files
491
491
  # path (required) - string - Path to operate on.
492
492
  # preview_size - string - Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`.
493
493
  # sort_by - object - Search by field and direction. Valid fields are `path`, `size`, `modified_at_datetime`, `provided_modified_at`. Valid directions are `asc` and `desc`. Defaults to `{"path":"asc"}`.
494
- # search - string - If specified, will search the folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'. Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing. Results may be truncated if more than 1,000 possible matches exist. This field should only be used for ad-hoc (human) searching, and not as part of an automated process. During scheduled search maintenance, indexed searches return HTTP 422 with error type `service-unavailable/search-unavailable`; retry after maintenance ends. Folder listing without `search` remains available.
494
+ # search - string - If specified, will search the folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'. Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing. Results may be truncated if more than 1,000 possible matches exist. This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
495
495
  # search_custom_metadata_key - string - If provided, the search string in `search` will search for files where this custom metadata key matches the value sent in `search`. Set this to `*` to allow any metadata key to match the value sent in `search`.
496
496
  # search_all - boolean - Search entire site? If true, we will search the entire site. Do not provide a path when using this parameter. This is the same API used by the search bar in the web UI when running 'Search All Files'. Search results are a best effort, not real time, and not guaranteed to match every file. This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
497
497
  # with_previews - boolean - Include file previews?
@@ -9,7 +9,7 @@ module Files
9
9
  @options = options || {}
10
10
  end
11
11
 
12
- # date-time - Restore all files deleted after this date/time. Don't set this earlier than you need. Can not be greater than 365 days prior to the restore request.
12
+ # date-time - Restore files or users deleted on or after this date/time. Don't set this earlier than you need. Can not be greater than 365 days prior to the restore request.
13
13
  def earliest_date
14
14
  @attributes[:earliest_date]
15
15
  end
@@ -81,7 +81,7 @@ module Files
81
81
  @attributes[:files_total] = value
82
82
  end
83
83
 
84
- # string - Prefix of the files/folders to restore. To restore a folder, add a trailing slash to the folder name. Do not use a leading slash. To restore all deleted items, specify an empty string (`''`) in the prefix field or omit the field from the request.
84
+ # string - Prefix of the files/folders to restore, or a case-insensitive username prefix for a user restore. To restore a folder, add a trailing slash to the folder name. Do not use a leading slash. To restore all deleted items of the selected restoration type, specify an empty string (`''`) in the prefix field or omit the field from the request.
85
85
  def prefix
86
86
  @attributes[:prefix]
87
87
  end
@@ -90,7 +90,7 @@ module Files
90
90
  @attributes[:prefix] = value
91
91
  end
92
92
 
93
- # string - Type of restoration to perform. `files` restores deleted filesystem items. `users` restores deleted users and associated access/authentication records.
93
+ # string - Type of restoration to perform. `files` restores deleted filesystem items. `users` restores deleted users and associated access/authentication records removed as part of deleting those users.
94
94
  def restoration_type
95
95
  @attributes[:restoration_type]
96
96
  end
@@ -108,7 +108,7 @@ module Files
108
108
  @attributes[:restore_in_place] = value
109
109
  end
110
110
 
111
- # boolean - If true, we will also restore any Permissions that match the same path prefix from the same dates.
111
+ # boolean - If true, restore permissions removed as part of deleting the selected users for a user restore, or permissions matching the selected path prefix and deletion dates for a file restore.
112
112
  def restore_deleted_permissions
113
113
  @attributes[:restore_deleted_permissions]
114
114
  end
@@ -239,10 +239,10 @@ module Files
239
239
  end
240
240
 
241
241
  # Parameters:
242
- # earliest_date (required) - string - Restore all files deleted after this date/time. Don't set this earlier than you need. Can not be greater than 365 days prior to the restore request.
243
- # prefix - string - Prefix of the files/folders to restore. To restore a folder, add a trailing slash to the folder name. Do not use a leading slash. To restore all deleted items, specify an empty string (`''`) in the prefix field or omit the field from the request.
244
- # restoration_type - string - Type of restoration to perform. `files` restores deleted filesystem items. `users` restores deleted users and associated access/authentication records.
245
- # restore_deleted_permissions - boolean - If true, we will also restore any Permissions that match the same path prefix from the same dates.
242
+ # earliest_date (required) - string - Restore files or users deleted on or after this date/time. Don't set this earlier than you need. Can not be greater than 365 days prior to the restore request.
243
+ # prefix - string - Prefix of the files/folders to restore, or a case-insensitive username prefix for a user restore. To restore a folder, add a trailing slash to the folder name. Do not use a leading slash. To restore all deleted items of the selected restoration type, specify an empty string (`''`) in the prefix field or omit the field from the request.
244
+ # restoration_type - string - Type of restoration to perform. `files` restores deleted filesystem items. `users` restores deleted users and associated access/authentication records removed as part of deleting those users.
245
+ # restore_deleted_permissions - boolean - If true, restore permissions removed as part of deleting the selected users for a user restore, or permissions matching the selected path prefix and deletion dates for a file restore.
246
246
  # restore_in_place - boolean - If true, we will restore the files in place (into their original paths). If false, we will create a new restoration folder in the root and restore files there.
247
247
  # update_timestamps - boolean - If true, we will update the last modified timestamp of restored files to today's date. If false, we might trigger File Expiration to delete the file again.
248
248
  # workspace_id - int64 - Workspace ID for a workspace-scoped restore. `0` means the default site-wide scope.
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Files
4
- VERSION = "1.1.759"
4
+ VERSION = "1.1.761"
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.759
4
+ version: 1.1.761
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-09-30 00:00:00.000000000 Z
11
+ date: 2026-10-01 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable