files.com 1.1.426 → 1.1.427

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: deb5cfa450dd6091f1cac32fa2968ee1496e3e9c9a633b3ded728b2fb08106c2
-  data.tar.gz: 79afabe81f376f94b69c6f8ed7f04ecd5aa10f89558a98aebe9392e2b61df413
+  metadata.gz: e07bbb52c463863de73e66d6dce898a9ad66d76cb99f37b175785269fc9d1a85
+  data.tar.gz: 5f0464edc7853c274c45e2b9db9e15bb42f20fb5e884390a5e4df89598c55a26
 SHA512:
-  metadata.gz: 32fe5f53e92790f7d38f102e83d531212c8b4cfd783767300f0a1b96daa1a44f8c13f57fe671df79b91a1d6fe128f4c64d4818cea48f020a1d5a90d457ee4868
-  data.tar.gz: f7ab73d8e7c20b68e948b5c6dea8e264585c8e232a8b6fa034f6e694fc54094b84f6e6ecd27f88ea95018e9e3eef5268d190b0d5fe22211cf906a7aaddde9517
+  metadata.gz: 6d644dc5d27d6e2cf7c1c38bf44c0a28d207f2be1ba290c25e4c707ed1bf7919775b4bc55f03a29706cfc79b0b5862aa813df796628d82f47b44cafaa23bb6d6
+  data.tar.gz: ba18a4ad3b20d259f530c4d19b6025a7d86d8de033124b2a7416c6ae42bc12c11481fef1bb3095237c86388f79b15bbc25ed011aa58bbb5504c3c6210a666dcc

data/_VERSION

@@ -1 +1 @@
-1.1.426
+1.1.427

data/docs/bundle.md

@@ -152,7 +152,7 @@ Files::Bundle.list(
 * `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.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
 * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `expires_at`.
-* `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 ]`.
+* `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 ]`.
 * `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`.
 * `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`.
 * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `code`.

data/docs/restore.md

@@ -13,8 +13,15 @@
   "files_errored": 1,
   "files_total": 1,
   "prefix": "foo/bar/baz.txt",
+  "restoration_type": "files",
   "restore_in_place": true,
   "restore_deleted_permissions": true,
+  "users_restored": 1,
+  "users_errored": 1,
+  "users_total": 1,
+  "api_keys_restored": 1,
+  "public_keys_restored": 1,
+  "two_factor_authentication_methods_restored": 1,
   "status": "pending",
   "update_timestamps": true,
   "error_messages": [
@@ -32,8 +39,15 @@
 * `files_errored` (int64): Number of files that were not able to be restored.
 * `files_total` (int64): Total number of files processed.
 * `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.
+* `restoration_type` (string): Type of restoration to perform. `files` restores deleted filesystem items. `users` restores deleted users and associated access/authentication records.
 * `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.
 * `restore_deleted_permissions` (boolean): If true, we will also restore any Permissions that match the same path prefix from the same dates.
+* `users_restored` (int64): Number of users successfully restored (only present for `restoration_type=users`).
+* `users_errored` (int64): Number of users that failed to restore (only present for `restoration_type=users`).
+* `users_total` (int64): Total number of users processed (only present for `restoration_type=users`).
+* `api_keys_restored` (int64): Number of API keys restored (only present for `restoration_type=users`).
+* `public_keys_restored` (int64): Number of public keys restored (only present for `restoration_type=users`).
+* `two_factor_authentication_methods_restored` (int64): Number of two factor authentication methods restored (only present for `restoration_type=users`).
 * `status` (string): Status of the restoration process.
 * `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.
 * `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
 Files::Restore.create(
   earliest_date: "2000-01-01T01:00:00Z", 
   prefix: "foo/bar/baz.txt", 
+  restoration_type: "files", 
   restore_deleted_permissions: true, 
   restore_in_place: true, 
   update_timestamps: true
@@ -71,6 +86,7 @@ Files::Restore.create(
 
 * `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.
 * `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.
+* `restoration_type` (string): Type of restoration to perform. `files` restores deleted filesystem items. `users` restores deleted users and associated access/authentication records.
 * `restore_deleted_permissions` (boolean): If true, we will also restore any Permissions that match the same path prefix from the same dates.
 * `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.
 * `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.

data/lib/files.com/models/bundle.rb

@@ -521,7 +521,7 @@ module Files
     #   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.
     #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
     #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `expires_at`.
-    #   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 ]`.
+    #   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 ]`.
     #   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`.
     #   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`.
     #   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `code`.

data/lib/files.com/models/restore.rb

@@ -90,6 +90,15 @@ module Files
       @attributes[:prefix] = value
     end
 
+    # string - Type of restoration to perform. `files` restores deleted filesystem items. `users` restores deleted users and associated access/authentication records.
+    def restoration_type
+      @attributes[:restoration_type]
+    end
+
+    def restoration_type=(value)
+      @attributes[:restoration_type] = value
+    end
+
     # 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.
     def restore_in_place
       @attributes[:restore_in_place]
@@ -108,6 +117,60 @@ module Files
       @attributes[:restore_deleted_permissions] = value
     end
 
+    # int64 - Number of users successfully restored (only present for `restoration_type=users`).
+    def users_restored
+      @attributes[:users_restored]
+    end
+
+    def users_restored=(value)
+      @attributes[:users_restored] = value
+    end
+
+    # int64 - Number of users that failed to restore (only present for `restoration_type=users`).
+    def users_errored
+      @attributes[:users_errored]
+    end
+
+    def users_errored=(value)
+      @attributes[:users_errored] = value
+    end
+
+    # int64 - Total number of users processed (only present for `restoration_type=users`).
+    def users_total
+      @attributes[:users_total]
+    end
+
+    def users_total=(value)
+      @attributes[:users_total] = value
+    end
+
+    # int64 - Number of API keys restored (only present for `restoration_type=users`).
+    def api_keys_restored
+      @attributes[:api_keys_restored]
+    end
+
+    def api_keys_restored=(value)
+      @attributes[:api_keys_restored] = value
+    end
+
+    # int64 - Number of public keys restored (only present for `restoration_type=users`).
+    def public_keys_restored
+      @attributes[:public_keys_restored]
+    end
+
+    def public_keys_restored=(value)
+      @attributes[:public_keys_restored] = value
+    end
+
+    # int64 - Number of two factor authentication methods restored (only present for `restoration_type=users`).
+    def two_factor_authentication_methods_restored
+      @attributes[:two_factor_authentication_methods_restored]
+    end
+
+    def two_factor_authentication_methods_restored=(value)
+      @attributes[:two_factor_authentication_methods_restored] = value
+    end
+
     # string - Status of the restoration process.
     def status
       @attributes[:status]
@@ -165,12 +228,14 @@ module Files
     # Parameters:
     #   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.
     #   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.
+    #   restoration_type - string - Type of restoration to perform. `files` restores deleted filesystem items. `users` restores deleted users and associated access/authentication records.
     #   restore_deleted_permissions - boolean - If true, we will also restore any Permissions that match the same path prefix from the same dates.
     #   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.
     #   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.
     def self.create(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: earliest_date must be an String") if params[:earliest_date] and !params[:earliest_date].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: prefix must be an String") if params[:prefix] and !params[:prefix].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: restoration_type must be an String") if params[:restoration_type] and !params[:restoration_type].is_a?(String)
       raise MissingParameterError.new("Parameter missing: earliest_date") unless params[:earliest_date]
 
       response, options = Api.send_request("/restores", :post, params, options)

data/lib/files.com/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Files
-  VERSION = "1.1.426"
+  VERSION = "1.1.427"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.426
+  version: 1.1.427
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-12-18 00:00:00.000000000 Z
+date: 2025-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable