files.com 1.0.185 → 1.0.186

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8595fe01110ecc8a3c1b0a0602d94df7d0203659f1042230b4b5c700643d26b2
-  data.tar.gz: 5543b53337d69e4d02a462b517a7625af1890cbb3cdb8809fc76f233c13cb97e
+  metadata.gz: dd6b8cb725740fa166bbc1ce206311927d47ff2b8e31646f2d8f42f0c2cbceb9
+  data.tar.gz: 72b86fe34d261f24fd19893434d5876fb2f556d11968cf617ec51a5d948acced
 SHA512:
-  metadata.gz: db81909c52f8d91fbdf7170a660d5b90b9bf7a5b3089531d92322f325220f9d5f9ccfd9fb85f8a429fd59ca61e5b7761d879ff9ced0b5e0d6190ebb9aa9d7d75
-  data.tar.gz: 1d5c30443fe25c09039a0c6d6ad200ecf23f3d41e92bcea21a50b67785cf9432025b104812cc919278ce4feaa67745a3d5ed268942c03fad7a9ff7cbc565a012
+  metadata.gz: 8c58e5414b8d30902338b6d2e0f6419ba591190d48bf34344718170a7155191f0b4e6aa4655683219b78e8c900e1f008993dddd94dc276c855c528439b013ae2
+  data.tar.gz: '0887f3a898073aeb880648cde030f192056660213bfce7f725cc31927b7b4a95b803b48dff42b7cfa3524373167094fd36850ca142a42454a2dbfbc8ce7ab542'

data/_VERSION

@@ -1 +1 @@
-1.0.185
+1.0.186

data/docs/file_migration.md

@@ -0,0 +1,38 @@
+# FileMigration
+
+## Example FileMigration Object
+
+```
+{
+  "id": 1,
+  "path": "MyFolder",
+  "dest_path": "MyFolder",
+  "files_moved": 1,
+  "files_total": 1,
+  "operation": "move",
+  "region": "USA",
+  "status": "complete"
+}
+```
+
+* `id` (int64): File migration ID
+* `path` (string): Source path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `dest_path` (string): Destination path
+* `files_moved` (int64): Number of files processed
+* `files_total` (int64): Total number of files to process
+* `operation` (string): The type of operation
+* `region` (string): Region
+* `status` (string): Status
+
+
+---
+
+## Show File Migration
+
+```
+Files::FileMigration.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - File Migration ID.

data/lib/files.com.rb

@@ -51,6 +51,7 @@ require "files.com/models/file"
 require "files.com/models/file_action"
 require "files.com/models/file_comment"
 require "files.com/models/file_comment_reaction"
+require "files.com/models/file_migration"
 require "files.com/models/file_upload_part"
 require "files.com/models/folder"
 require "files.com/models/form_field"

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Files
+  class FileMigration
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - File migration ID
+    def id
+      @attributes[:id]
+    end
+
+    # string - Source path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+    def path
+      @attributes[:path]
+    end
+
+    # string - Destination path
+    def dest_path
+      @attributes[:dest_path]
+    end
+
+    # int64 - Number of files processed
+    def files_moved
+      @attributes[:files_moved]
+    end
+
+    # int64 - Total number of files to process
+    def files_total
+      @attributes[:files_total]
+    end
+
+    # string - The type of operation
+    def operation
+      @attributes[:operation]
+    end
+
+    # string - Region
+    def region
+      @attributes[:region]
+    end
+
+    # string - Status
+    def status
+      @attributes[:status]
+    end
+
+    # Parameters:
+    #   id (required) - int64 - File Migration ID.
+    def self.find(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      response, options = Api.send_request("/file_migrations/#{params[:id]}", :get, params, options)
+      FileMigration.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.185
+  version: 1.0.186
 platform: ruby
 authors:
 - files.com
@@ -110,6 +110,7 @@ files:
 - docs/file_action.md
 - docs/file_comment.md
 - docs/file_comment_reaction.md
+- docs/file_migration.md
 - docs/file_upload_part.md
 - docs/file_utils.md
 - docs/folder.md
@@ -186,6 +187,7 @@ files:
 - lib/files.com/models/file_action.rb
 - lib/files.com/models/file_comment.rb
 - lib/files.com/models/file_comment_reaction.rb
+- lib/files.com/models/file_migration.rb
 - lib/files.com/models/file_upload_part.rb
 - lib/files.com/models/file_utils.rb
 - lib/files.com/models/folder.rb