files.com 1.1.240 → 1.1.241

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 770d66009a81073c4c0b5f3bac9e65b62fba85474690ca1324aa4c83e742bcbf
-  data.tar.gz: db15326917ebeec54c148a2b149a35dc42d1691e2096e92bc7a5f5f49d8048d3
+  metadata.gz: 3b03f1103df65bb6aa042eb7f58f8170a85657ff137cd9b7e7fb2a56f50a9528
+  data.tar.gz: d07a940ae43ac8987bf60a812e780a6e2d024da5141f250160ce98a990c6931b
 SHA512:
-  metadata.gz: a83854c2ff94592e7f034370f347f75eee91143559daf1e2a0a46298adc8c6f02844fc7fd8bc28bcbc523c8337817c64d5d9805f6669a351220f30bd4f7526e2
-  data.tar.gz: 42a538314c97c29bddf19e2be62b96286d5e0b9f1af7f02a50630e518acf938e0fb949cf2d95060b4eb50ebac8b5be731ea8da4293da4d442cbfdbfbba537d3e
+  metadata.gz: 8530df6b0d1fbd62a3ae2fa120129ee70e67768a919f566f64078626cd29962d43c0ce36680957c6e1c6f3b30f3a8c5aefb2766c944c72f481af9511da166486
+  data.tar.gz: 5b0d219382629d066669656734f287615a2a8849205de544d3e835770e43143f66a21de9e2a5360a1bc22719649baeafe48b14b912b289d5d70b267c310c5ffd

data/_VERSION

@@ -1 +1 @@
-1.1.240
+1.1.241

data/docs/restore.md

@@ -23,7 +23,7 @@
 }
 ```
 
-* `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
+* `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.
 * `id` (int64): Restore Record ID.
 * `dirs_restored` (int64): Number of directories that were successfully restored.
 * `dirs_errored` (int64): Number of directories that were not able to be restored.
@@ -31,11 +31,11 @@
 * `files_restored` (int64): Number of files successfully restored.
 * `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.
+* `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.
 * `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.
 * `status` (string): Status of the restoration process.
-* `update_timestamps` (boolean): If trie, 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.
+* `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.
 
 
@@ -60,15 +60,17 @@ Files::Restore.list
 ```
 Files::Restore.create(
   earliest_date: "2000-01-01T01:00:00Z", 
+  prefix: "foo/bar/baz.txt", 
   restore_deleted_permissions: true, 
   restore_in_place: true, 
-  prefix: "foo/bar/baz.txt"
+  update_timestamps: true
 )
 ```
 
 ### Parameters
 
-* `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
+* `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.
 * `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.
-* `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.
+* `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/restore.rb

@@ -9,7 +9,7 @@ module Files
       @options = options || {}
     end
 
-    # date-time - Restore all files deleted after this date/time. Don't set this earlier than you need. Can not be greater than 365
+    # 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.
     def earliest_date
       @attributes[:earliest_date]
     end
@@ -81,7 +81,7 @@ module Files
       @attributes[:files_total] = value
     end
 
-    # 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.
+    # 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.
     def prefix
       @attributes[:prefix]
     end
@@ -117,7 +117,7 @@ module Files
       @attributes[:status] = value
     end
 
-    # boolean - If trie, 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.
+    # 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 update_timestamps
       @attributes[:update_timestamps]
     end
@@ -163,10 +163,11 @@ module Files
     end
 
     # 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
+    #   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.
     #   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.
-    #   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.
+    #   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)

data/lib/files.com/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.240
+  version: 1.1.241
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-04-11 00:00:00.000000000 Z
+date: 2025-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable