files.com 1.1.425 → 1.1.427

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: f1aa899b3ef24b3c97cda33710444c22587f077d9405bc428895fc4011525e09
4
- data.tar.gz: ef47dd4fe033230135af5732e71b28901127ca63787b33185c9052daf82c9dac
3
+ metadata.gz: e07bbb52c463863de73e66d6dce898a9ad66d76cb99f37b175785269fc9d1a85
4
+ data.tar.gz: 5f0464edc7853c274c45e2b9db9e15bb42f20fb5e884390a5e4df89598c55a26
5
5
  SHA512:
6
- metadata.gz: 814c0379ba803494be7207df2e2efd19dd28849b22392434682cf10832431f874deb674ec28f643a31b7d9409b5bd03a810731d61c03f94627a4140bbe499019
7
- data.tar.gz: 97dd1347352397df2f132456b73a2909d4f29b75a9af2b45ef957d58cf0ecc675e721bde1139f191d99e311ddf01dd49793a5c59ea169e19477d3e1ffa463d25
6
+ metadata.gz: 6d644dc5d27d6e2cf7c1c38bf44c0a28d207f2be1ba290c25e4c707ed1bf7919775b4bc55f03a29706cfc79b0b5862aa813df796628d82f47b44cafaa23bb6d6
7
+ data.tar.gz: ba18a4ad3b20d259f530c4d19b6025a7d86d8de033124b2a7416c6ae42bc12c11481fef1bb3095237c86388f79b15bbc25ed011aa58bbb5504c3c6210a666dcc
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.425
1
+ 1.1.427
data/docs/bundle.md CHANGED
@@ -152,7 +152,7 @@ Files::Bundle.list(
152
152
  * `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.
153
153
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
154
154
  * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `expires_at`.
155
- * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id, created_at ]` and `[ user_id, expires_at ]`.
155
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id, expires_at ]`.
156
156
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at` and `expires_at`.
157
157
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at` and `expires_at`.
158
158
  * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `code`.
@@ -286,6 +286,7 @@ Files::Bundle.update(id,
286
286
  start_access_on_date: "2000-01-01T01:00:00Z",
287
287
  skip_email: true,
288
288
  skip_name: true,
289
+ user_id: 1,
289
290
  watermark_attachment_delete: false
290
291
  )
291
292
  ```
@@ -316,6 +317,7 @@ Files::Bundle.update(id,
316
317
  * `start_access_on_date` (string): Date when share will start to be accessible. If `nil` access granted right after create.
317
318
  * `skip_email` (boolean): BundleRegistrations can be saved without providing email?
318
319
  * `skip_name` (boolean): BundleRegistrations can be saved without providing name?
320
+ * `user_id` (int64): The owning user id. Only site admins can set this.
319
321
  * `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
320
322
  * `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
321
323
 
@@ -386,6 +388,7 @@ bundle.update(
386
388
  start_access_on_date: "2000-01-01T01:00:00Z",
387
389
  skip_email: true,
388
390
  skip_name: true,
391
+ user_id: 1,
389
392
  watermark_attachment_delete: false
390
393
  )
391
394
  ```
@@ -416,6 +419,7 @@ bundle.update(
416
419
  * `start_access_on_date` (string): Date when share will start to be accessible. If `nil` access granted right after create.
417
420
  * `skip_email` (boolean): BundleRegistrations can be saved without providing email?
418
421
  * `skip_name` (boolean): BundleRegistrations can be saved without providing name?
422
+ * `user_id` (int64): The owning user id. Only site admins can set this.
419
423
  * `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
420
424
  * `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
421
425
 
data/docs/restore.md CHANGED
@@ -13,8 +13,15 @@
13
13
  "files_errored": 1,
14
14
  "files_total": 1,
15
15
  "prefix": "foo/bar/baz.txt",
16
+ "restoration_type": "files",
16
17
  "restore_in_place": true,
17
18
  "restore_deleted_permissions": true,
19
+ "users_restored": 1,
20
+ "users_errored": 1,
21
+ "users_total": 1,
22
+ "api_keys_restored": 1,
23
+ "public_keys_restored": 1,
24
+ "two_factor_authentication_methods_restored": 1,
18
25
  "status": "pending",
19
26
  "update_timestamps": true,
20
27
  "error_messages": [
@@ -32,8 +39,15 @@
32
39
  * `files_errored` (int64): Number of files that were not able to be restored.
33
40
  * `files_total` (int64): Total number of files processed.
34
41
  * `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.
42
+ * `restoration_type` (string): Type of restoration to perform. `files` restores deleted filesystem items. `users` restores deleted users and associated access/authentication records.
35
43
  * `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.
36
44
  * `restore_deleted_permissions` (boolean): If true, we will also restore any Permissions that match the same path prefix from the same dates.
45
+ * `users_restored` (int64): Number of users successfully restored (only present for `restoration_type=users`).
46
+ * `users_errored` (int64): Number of users that failed to restore (only present for `restoration_type=users`).
47
+ * `users_total` (int64): Total number of users processed (only present for `restoration_type=users`).
48
+ * `api_keys_restored` (int64): Number of API keys restored (only present for `restoration_type=users`).
49
+ * `public_keys_restored` (int64): Number of public keys restored (only present for `restoration_type=users`).
50
+ * `two_factor_authentication_methods_restored` (int64): Number of two factor authentication methods restored (only present for `restoration_type=users`).
37
51
  * `status` (string): Status of the restoration process.
38
52
  * `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.
39
53
  * `error_messages` (array(string)): Error messages received while restoring files and/or directories. Only present if there were errors.
@@ -61,6 +75,7 @@ Files::Restore.list
61
75
  Files::Restore.create(
62
76
  earliest_date: "2000-01-01T01:00:00Z",
63
77
  prefix: "foo/bar/baz.txt",
78
+ restoration_type: "files",
64
79
  restore_deleted_permissions: true,
65
80
  restore_in_place: true,
66
81
  update_timestamps: true
@@ -71,6 +86,7 @@ Files::Restore.create(
71
86
 
72
87
  * `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.
73
88
  * `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.
89
+ * `restoration_type` (string): Type of restoration to perform. `files` restores deleted filesystem items. `users` restores deleted users and associated access/authentication records.
74
90
  * `restore_deleted_permissions` (boolean): If true, we will also restore any Permissions that match the same path prefix from the same dates.
75
91
  * `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.
76
92
  * `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.
@@ -462,6 +462,7 @@ module Files
462
462
  # start_access_on_date - string - Date when share will start to be accessible. If `nil` access granted right after create.
463
463
  # skip_email - boolean - BundleRegistrations can be saved without providing email?
464
464
  # skip_name - boolean - BundleRegistrations can be saved without providing name?
465
+ # user_id - int64 - The owning user id. Only site admins can set this.
465
466
  # watermark_attachment_delete - boolean - If true, will delete the file stored in watermark_attachment
466
467
  # watermark_attachment_file - file - Preview watermark image applied to all bundle items.
467
468
  def update(params = {})
@@ -483,6 +484,7 @@ module Files
483
484
  raise InvalidParameterError.new("Bad parameter: path_template_time_zone must be an String") if params[:path_template_time_zone] and !params[:path_template_time_zone].is_a?(String)
484
485
  raise InvalidParameterError.new("Bad parameter: permissions must be an String") if params[:permissions] and !params[:permissions].is_a?(String)
485
486
  raise InvalidParameterError.new("Bad parameter: start_access_on_date must be an String") if params[:start_access_on_date] and !params[:start_access_on_date].is_a?(String)
487
+ raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
486
488
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
487
489
 
488
490
  Api.send_request("/bundles/#{@attributes[:id]}", :patch, params, @options)
@@ -519,7 +521,7 @@ module Files
519
521
  # 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.
520
522
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
521
523
  # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `expires_at`.
522
- # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id, created_at ]` and `[ user_id, expires_at ]`.
524
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id, expires_at ]`.
523
525
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at` and `expires_at`.
524
526
  # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at` and `expires_at`.
525
527
  # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `code`.
@@ -655,6 +657,7 @@ module Files
655
657
  # start_access_on_date - string - Date when share will start to be accessible. If `nil` access granted right after create.
656
658
  # skip_email - boolean - BundleRegistrations can be saved without providing email?
657
659
  # skip_name - boolean - BundleRegistrations can be saved without providing name?
660
+ # user_id - int64 - The owning user id. Only site admins can set this.
658
661
  # watermark_attachment_delete - boolean - If true, will delete the file stored in watermark_attachment
659
662
  # watermark_attachment_file - file - Preview watermark image applied to all bundle items.
660
663
  def self.update(id, params = {}, options = {})
@@ -675,6 +678,7 @@ module Files
675
678
  raise InvalidParameterError.new("Bad parameter: path_template_time_zone must be an String") if params[:path_template_time_zone] and !params[:path_template_time_zone].is_a?(String)
676
679
  raise InvalidParameterError.new("Bad parameter: permissions must be an String") if params[:permissions] and !params[:permissions].is_a?(String)
677
680
  raise InvalidParameterError.new("Bad parameter: start_access_on_date must be an String") if params[:start_access_on_date] and !params[:start_access_on_date].is_a?(String)
681
+ raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
678
682
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
679
683
 
680
684
  response, options = Api.send_request("/bundles/#{params[:id]}", :patch, params, options)
@@ -90,6 +90,15 @@ 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.
94
+ def restoration_type
95
+ @attributes[:restoration_type]
96
+ end
97
+
98
+ def restoration_type=(value)
99
+ @attributes[:restoration_type] = value
100
+ end
101
+
93
102
  # 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.
94
103
  def restore_in_place
95
104
  @attributes[:restore_in_place]
@@ -108,6 +117,60 @@ module Files
108
117
  @attributes[:restore_deleted_permissions] = value
109
118
  end
110
119
 
120
+ # int64 - Number of users successfully restored (only present for `restoration_type=users`).
121
+ def users_restored
122
+ @attributes[:users_restored]
123
+ end
124
+
125
+ def users_restored=(value)
126
+ @attributes[:users_restored] = value
127
+ end
128
+
129
+ # int64 - Number of users that failed to restore (only present for `restoration_type=users`).
130
+ def users_errored
131
+ @attributes[:users_errored]
132
+ end
133
+
134
+ def users_errored=(value)
135
+ @attributes[:users_errored] = value
136
+ end
137
+
138
+ # int64 - Total number of users processed (only present for `restoration_type=users`).
139
+ def users_total
140
+ @attributes[:users_total]
141
+ end
142
+
143
+ def users_total=(value)
144
+ @attributes[:users_total] = value
145
+ end
146
+
147
+ # int64 - Number of API keys restored (only present for `restoration_type=users`).
148
+ def api_keys_restored
149
+ @attributes[:api_keys_restored]
150
+ end
151
+
152
+ def api_keys_restored=(value)
153
+ @attributes[:api_keys_restored] = value
154
+ end
155
+
156
+ # int64 - Number of public keys restored (only present for `restoration_type=users`).
157
+ def public_keys_restored
158
+ @attributes[:public_keys_restored]
159
+ end
160
+
161
+ def public_keys_restored=(value)
162
+ @attributes[:public_keys_restored] = value
163
+ end
164
+
165
+ # int64 - Number of two factor authentication methods restored (only present for `restoration_type=users`).
166
+ def two_factor_authentication_methods_restored
167
+ @attributes[:two_factor_authentication_methods_restored]
168
+ end
169
+
170
+ def two_factor_authentication_methods_restored=(value)
171
+ @attributes[:two_factor_authentication_methods_restored] = value
172
+ end
173
+
111
174
  # string - Status of the restoration process.
112
175
  def status
113
176
  @attributes[:status]
@@ -165,12 +228,14 @@ module Files
165
228
  # Parameters:
166
229
  # 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.
167
230
  # 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.
231
+ # restoration_type - string - Type of restoration to perform. `files` restores deleted filesystem items. `users` restores deleted users and associated access/authentication records.
168
232
  # restore_deleted_permissions - boolean - If true, we will also restore any Permissions that match the same path prefix from the same dates.
169
233
  # 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.
170
234
  # 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.
171
235
  def self.create(params = {}, options = {})
172
236
  raise InvalidParameterError.new("Bad parameter: earliest_date must be an String") if params[:earliest_date] and !params[:earliest_date].is_a?(String)
173
237
  raise InvalidParameterError.new("Bad parameter: prefix must be an String") if params[:prefix] and !params[:prefix].is_a?(String)
238
+ raise InvalidParameterError.new("Bad parameter: restoration_type must be an String") if params[:restoration_type] and !params[:restoration_type].is_a?(String)
174
239
  raise MissingParameterError.new("Parameter missing: earliest_date") unless params[:earliest_date]
175
240
 
176
241
  response, options = Api.send_request("/restores", :post, params, options)
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Files
4
- VERSION = "1.1.425"
4
+ VERSION = "1.1.427"
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.425
4
+ version: 1.1.427
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-12-18 00:00:00.000000000 Z
11
+ date: 2025-12-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable