files.com 1.1.238 → 1.1.239

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cd0bf1cec7d070c09c839522a19b7a9b00895f5973039fab81bb200f8f47180
-  data.tar.gz: 0eabb13dd584c3ee1cd96ad4bd3443d36a5f4c4052342596c0b7e136df605920
+  metadata.gz: 48b8f69e129f0389268f653134ab32d345a8ae7e7fd4be67a0e85edfbba71741
+  data.tar.gz: 518fb6dc6a7e747c65e3bd5a873df8a2cc0b5ad84009b6759f79e6e473f790db
 SHA512:
-  metadata.gz: ecc252df442785579376265818ec6ebfbbcf36e14dc6f42c3ac9091dc9a62361a49d65b337b8eac2720edcc62cf9d08bb07839e94d85dd3e2564195ff377ac0d
-  data.tar.gz: 03bbdfd923e9faa4fa9a6a2283b2098de72ff0dfed1a8e8e535d03466771cf567917e79b0b6e52d705ce8eb9a261c37b4b49dd3e0a6858dbb19df745a8803bb2
+  metadata.gz: 3d0799e9f4a800bf86253482e55a48fd415afaf6b19cd9f7e152db32365fccf5ea2f035a1f44d4fc27faa593813114f211c8875f524bc98d162614adf92146b6
+  data.tar.gz: 9a0470c243e9717aebd655a72e563ac6cd0d096caeed43e5ced6e1a7c8fcf60285cca60e8fa4dabe97efcb0f9978a3082eedc348448dfa34d688f13bef0ab6dd

data/_VERSION

@@ -1 +1 @@
-1.1.238
+1.1.239

data/docs/restore.md

@@ -0,0 +1,74 @@
+# Restore
+
+## Example Restore Object
+
+```
+{
+  "earliest_date": "2000-01-01T01:00:00Z",
+  "id": 1,
+  "dirs_restored": 1,
+  "dirs_errored": 1,
+  "dirs_total": 1,
+  "files_restored": 1,
+  "files_errored": 1,
+  "files_total": 1,
+  "prefix": "foo/bar/baz.txt",
+  "restore_in_place": true,
+  "restore_deleted_permissions": true,
+  "status": "pending",
+  "update_timestamps": true,
+  "error_messages": [
+    "example"
+  ]
+}
+```
+
+* `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
+* `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.
+* `dirs_total` (int64): Total number of directories processed.
+* `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.
+* `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.
+* `error_messages` (array(string)): Error messages received while restoring files and/or directories. Only present if there were errors.
+
+
+---
+
+## List Restores
+
+```
+Files::Restore.list
+```
+
+### Parameters
+
+* `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).
+
+
+---
+
+## Create Restore
+
+```
+Files::Restore.create(
+  earliest_date: "2000-01-01T01:00:00Z", 
+  restore_deleted_permissions: true, 
+  restore_in_place: true, 
+  prefix: "foo/bar/baz.txt"
+)
+```
+
+### 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
+* `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.

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

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+module Files
+  class Restore
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @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
+    def earliest_date
+      @attributes[:earliest_date]
+    end
+
+    def earliest_date=(value)
+      @attributes[:earliest_date] = value
+    end
+
+    # int64 - Restore Record ID.
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
+    # int64 - Number of directories that were successfully restored.
+    def dirs_restored
+      @attributes[:dirs_restored]
+    end
+
+    def dirs_restored=(value)
+      @attributes[:dirs_restored] = value
+    end
+
+    # int64 - Number of directories that were not able to be restored.
+    def dirs_errored
+      @attributes[:dirs_errored]
+    end
+
+    def dirs_errored=(value)
+      @attributes[:dirs_errored] = value
+    end
+
+    # int64 - Total number of directories processed.
+    def dirs_total
+      @attributes[:dirs_total]
+    end
+
+    def dirs_total=(value)
+      @attributes[:dirs_total] = value
+    end
+
+    # int64 - Number of files successfully restored.
+    def files_restored
+      @attributes[:files_restored]
+    end
+
+    def files_restored=(value)
+      @attributes[:files_restored] = value
+    end
+
+    # int64 - Number of files that were not able to be restored.
+    def files_errored
+      @attributes[:files_errored]
+    end
+
+    def files_errored=(value)
+      @attributes[:files_errored] = value
+    end
+
+    # int64 - Total number of files processed.
+    def files_total
+      @attributes[:files_total]
+    end
+
+    def files_total=(value)
+      @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.
+    def prefix
+      @attributes[:prefix]
+    end
+
+    def prefix=(value)
+      @attributes[:prefix] = 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]
+    end
+
+    def restore_in_place=(value)
+      @attributes[:restore_in_place] = value
+    end
+
+    # boolean - If true, we will also restore any Permissions that match the same path prefix from the same dates.
+    def restore_deleted_permissions
+      @attributes[:restore_deleted_permissions]
+    end
+
+    def restore_deleted_permissions=(value)
+      @attributes[:restore_deleted_permissions] = value
+    end
+
+    # string - Status of the restoration process.
+    def status
+      @attributes[:status]
+    end
+
+    def status=(value)
+      @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.
+    def update_timestamps
+      @attributes[:update_timestamps]
+    end
+
+    def update_timestamps=(value)
+      @attributes[:update_timestamps] = value
+    end
+
+    # array(string) - Error messages received while restoring files and/or directories. Only present if there were errors.
+    def error_messages
+      @attributes[:error_messages]
+    end
+
+    def error_messages=(value)
+      @attributes[:error_messages] = value
+    end
+
+    def save
+      if @attributes[:id]
+        raise NotImplementedError.new("The Restore object doesn't support updates.")
+      else
+        new_obj = Restore.create(@attributes, @options)
+      end
+
+      @attributes = new_obj.attributes
+      true
+    end
+
+    # Parameters:
+    #   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).
+    def self.list(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
+
+      List.new(Restore, params) do
+        Api.send_request("/restores", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    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
+    #   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.
+    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 MissingParameterError.new("Parameter missing: earliest_date") unless params[:earliest_date]
+
+      response, options = Api.send_request("/restores", :post, params, options)
+      Restore.new(response.data, options)
+    end
+  end
+end

data/lib/files.com/version.rb

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

data/lib/files.com.rb

@@ -107,6 +107,7 @@ require "files.com/models/remote_bandwidth_snapshot"
 require "files.com/models/remote_server"
 require "files.com/models/remote_server_configuration_file"
 require "files.com/models/request"
+require "files.com/models/restore"
 require "files.com/models/session"
 require "files.com/models/settings_change"
 require "files.com/models/sftp_action_log"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.238
+  version: 1.1.239
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-04-09 00:00:00.000000000 Z
+date: 2025-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -190,6 +190,7 @@ files:
 - docs/remote_server.md
 - docs/remote_server_configuration_file.md
 - docs/request.md
+- docs/restore.md
 - docs/session.md
 - docs/settings_change.md
 - docs/sftp_action_log.md
@@ -295,6 +296,7 @@ files:
 - lib/files.com/models/remote_server.rb
 - lib/files.com/models/remote_server_configuration_file.rb
 - lib/files.com/models/request.rb
+- lib/files.com/models/restore.rb
 - lib/files.com/models/session.rb
 - lib/files.com/models/settings_change.rb
 - lib/files.com/models/sftp_action_log.rb