files.com 1.0.182 → 1.0.186

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e075ac53f4e6168ab7f7344bc46638ca88fbf5cc175b599832fc721511d9a441
-  data.tar.gz: c5a4ef80a09077c19ce44f371a8562576b1cd2a6204acaccd1076c6f54c3620a
+  metadata.gz: dd6b8cb725740fa166bbc1ce206311927d47ff2b8e31646f2d8f42f0c2cbceb9
+  data.tar.gz: 72b86fe34d261f24fd19893434d5876fb2f556d11968cf617ec51a5d948acced
 SHA512:
-  metadata.gz: da69ba3af21444e628a5daaaa89ceb05628f3f245cf4f07474629c9451e077128705857e4c8aff3a7aeaf2deb9d3549086ea472dac2bd92367466036e7d2d1f0
-  data.tar.gz: a94b7ad26a242d308818e494aa02fb9356347311254618a2fa5889f4d83fc4f5072d6569fc76a7a83024d999cd051df0b53dacfc53a2765ab4b9b0701bfec57d
+  metadata.gz: 8c58e5414b8d30902338b6d2e0f6419ba591190d48bf34344718170a7155191f0b4e6aa4655683219b78e8c900e1f008993dddd94dc276c855c528439b013ae2
+  data.tar.gz: '0887f3a898073aeb880648cde030f192056660213bfce7f725cc31927b7b4a95b803b48dff42b7cfa3524373167094fd36850ca142a42454a2dbfbc8ce7ab542'

data/_VERSION

@@ -1 +1 @@
-1.0.182
+1.0.186

data/docs/external_event.md

@@ -9,7 +9,12 @@
   "status": "",
   "body": "",
   "created_at": "2000-01-01T01:00:00Z",
-  "body_url": ""
+  "body_url": "",
+  "folder_behavior_id": 1,
+  "successful_files": 1,
+  "errored_files": 1,
+  "bytes_synced": 1,
+  "remote_server_type": ""
 }
 ```
 
@@ -19,6 +24,11 @@
 * `body` (string): Event body
 * `created_at` (date-time): External event create date/time
 * `body_url` (string): Link to log file.
+* `folder_behavior_id` (int64): Folder Behavior ID
+* `successful_files` (int64): For sync events, the number of files handled successfully.
+* `errored_files` (int64): For sync events, the number of files that encountered errors.
+* `bytes_synced` (int64): For sync events, the total number of bytes synced.
+* `remote_server_type` (string): Associated Remote Server type, if any
 
 
 ---
@@ -35,13 +45,13 @@ Files::ExternalEvent.list(
 
 * `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `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 (e.g. sort_by[last_login_at]=desc). Valid fields are `remote_server_type`, `event_type`, `created_at` or `status`.
-* `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
-* `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
-* `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
-* `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
-* `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
-* `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
+* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `remote_server_type`, `event_type`, `created_at`, `status`, `site_id` or `folder_behavior_id`.
+* `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
+* `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
+* `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
+* `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
+* `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
+* `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
 
 
 ---

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/external_event.rb

@@ -59,6 +59,51 @@ module Files
       @attributes[:body_url] = value
     end
 
+    # int64 - Folder Behavior ID
+    def folder_behavior_id
+      @attributes[:folder_behavior_id]
+    end
+
+    def folder_behavior_id=(value)
+      @attributes[:folder_behavior_id] = value
+    end
+
+    # int64 - For sync events, the number of files handled successfully.
+    def successful_files
+      @attributes[:successful_files]
+    end
+
+    def successful_files=(value)
+      @attributes[:successful_files] = value
+    end
+
+    # int64 - For sync events, the number of files that encountered errors.
+    def errored_files
+      @attributes[:errored_files]
+    end
+
+    def errored_files=(value)
+      @attributes[:errored_files] = value
+    end
+
+    # int64 - For sync events, the total number of bytes synced.
+    def bytes_synced
+      @attributes[:bytes_synced]
+    end
+
+    def bytes_synced=(value)
+      @attributes[:bytes_synced] = value
+    end
+
+    # string - Associated Remote Server type, if any
+    def remote_server_type
+      @attributes[:remote_server_type]
+    end
+
+    def remote_server_type=(value)
+      @attributes[:remote_server_type] = value
+    end
+
     def save
       if @attributes[:id]
         raise NotImplementedError.new("The ExternalEvent object doesn't support updates.")
@@ -71,13 +116,13 @@ module Files
     # Parameters:
     #   cursor - string - Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
     #   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 (e.g. sort_by[last_login_at]=desc). Valid fields are `remote_server_type`, `event_type`, `created_at` or `status`.
-    #   filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
-    #   filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
-    #   filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
-    #   filter_like - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
-    #   filter_lt - object - If set, return records where the specifiied field is less than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
-    #   filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
+    #   sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `remote_server_type`, `event_type`, `created_at`, `status`, `site_id` or `folder_behavior_id`.
+    #   filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
+    #   filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
+    #   filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
+    #   filter_like - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
+    #   filter_lt - object - If set, return records where the specifiied field is less than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
+    #   filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
     def self.list(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)

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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.182
+  version: 1.0.186
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-19 00:00:00.000000000 Z
+date: 2021-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -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