files.com 1.0.183 → 1.0.187

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff4d0d6063f70dcebe0716be9be58576674d1dd9557a6fa361d6b3f0379f102a
-  data.tar.gz: e7b4ab3e3c558ed2c39de94a3af1abcd13003c56dcd9bc8d7464a360a2e51a61
+  metadata.gz: 4d5bb31875a4586b91754ab369dcc86a3c2fa37eeddca9dda476087512aed6a1
+  data.tar.gz: ad6d4e2eca2914934aa18edeca1eeee889e0166b3cc8dd1086aa3a320f070bad
 SHA512:
-  metadata.gz: 8769075d23e196ac9bf65bbf57a3a0254591c6ffebd3f05aaaeeafc1630762beebcfdb25858b82d8f765d0d2071c9d2e32410e545fd3decfc7fdae45dac472a3
-  data.tar.gz: 7fe7e57189cf669a367b1d4e63d8a2a3cabd56369afe601717cf454969947205417c94bb9ca3a13b6478d2357559d253f6e22a59d851fe7d4f52582bad238be1
+  metadata.gz: 9b514f80a52e9294e7c83ffd9b54ead85793adfb0d6072b1891893c1380beea2c02043208a099f87969fe890a93c4fc90f324d4fbdc27e3927eaa53eeaa7f660
+  data.tar.gz: 54ef9dde013fa812864094a5aeed693792e719c1fc3288b8ea134504af316bcd5bc737f3a6ef764ffcdee313d3024975bb9a941d5ff1112e7b74d05f423181b1

data/_VERSION

@@ -1 +1 @@
-1.0.183
+1.0.187

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/docs/lock.md

@@ -7,22 +7,28 @@
   "path": "locked_file",
   "timeout": 43200,
   "depth": "infinity",
+  "recursive": true,
   "owner": "user",
   "scope": "shared",
+  "exclusive": true,
   "token": "17c54824e9931a4688ca032d03f6663c",
   "type": "write",
+  "allow_access_by_any_user": true,
   "user_id": 1,
   "username": ""
 }
 ```
 
 * `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
-* `timeout` (int64): Lock timeout
-* `depth` (string): Lock depth (0 or infinity)
-* `owner` (string): Owner of lock.  This can be any arbitrary string.
-* `scope` (string): Lock scope(shared or exclusive)
+* `timeout` (int64): Lock timeout in seconds
+* `depth` (string): DEPRECATED: Lock depth
+* `recursive` (boolean): Does lock apply to subfolders?
+* `owner` (string): Owner of the lock.  This can be any arbitrary string.
+* `scope` (string): DEPRECATED: Lock scope
+* `exclusive` (boolean): Is lock exclusive?
 * `token` (string): Lock token.  Use to release lock.
-* `type` (string): Lock type
+* `type` (string): DEPRECATED: Lock type
+* `allow_access_by_any_user` (boolean): Can lock be modified by users other than its creator?
 * `user_id` (int64): Lock creator user ID
 * `username` (string): Lock creator username
 
@@ -52,6 +58,9 @@ Files::Lock.list_for(path,
 
 ```
 Files::Lock.create(path, 
+  allow_access_by_any_user: true, 
+  exclusive: true, 
+  recursive: true, 
   timeout: 1
 )
 ```
@@ -59,6 +68,9 @@ Files::Lock.create(path,
 ### Parameters
 
 * `path` (string): Required - Path
+* `allow_access_by_any_user` (boolean): Allow lock to be updated by any user?
+* `exclusive` (boolean): Is lock exclusive?
+* `recursive` (string): Does lock apply to subfolders?
 * `timeout` (int64): Lock timeout length
 
 

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

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

@@ -18,7 +18,7 @@ module Files
       @attributes[:path] = value
     end
 
-    # int64 - Lock timeout
+    # int64 - Lock timeout in seconds
     def timeout
       @attributes[:timeout]
     end
@@ -27,7 +27,7 @@ module Files
       @attributes[:timeout] = value
     end
 
-    # string - Lock depth (0 or infinity)
+    # string - DEPRECATED: Lock depth
     def depth
       @attributes[:depth]
     end
@@ -36,7 +36,16 @@ module Files
       @attributes[:depth] = value
     end
 
-    # string - Owner of lock.  This can be any arbitrary string.
+    # boolean - Does lock apply to subfolders?
+    def recursive
+      @attributes[:recursive]
+    end
+
+    def recursive=(value)
+      @attributes[:recursive] = value
+    end
+
+    # string - Owner of the lock.  This can be any arbitrary string.
     def owner
       @attributes[:owner]
     end
@@ -45,7 +54,7 @@ module Files
       @attributes[:owner] = value
     end
 
-    # string - Lock scope(shared or exclusive)
+    # string - DEPRECATED: Lock scope
     def scope
       @attributes[:scope]
     end
@@ -54,6 +63,15 @@ module Files
       @attributes[:scope] = value
     end
 
+    # boolean - Is lock exclusive?
+    def exclusive
+      @attributes[:exclusive]
+    end
+
+    def exclusive=(value)
+      @attributes[:exclusive] = value
+    end
+
     # string - Lock token.  Use to release lock.
     def token
       @attributes[:token]
@@ -63,7 +81,7 @@ module Files
       @attributes[:token] = value
     end
 
-    # string - Lock type
+    # string - DEPRECATED: Lock type
     def type
       @attributes[:type]
     end
@@ -72,6 +90,15 @@ module Files
       @attributes[:type] = value
     end
 
+    # boolean - Can lock be modified by users other than its creator?
+    def allow_access_by_any_user
+      @attributes[:allow_access_by_any_user]
+    end
+
+    def allow_access_by_any_user=(value)
+      @attributes[:allow_access_by_any_user] = value
+    end
+
     # int64 - Lock creator user ID
     def user_id
       @attributes[:user_id]
@@ -133,11 +160,15 @@ module Files
 
     # Parameters:
     #   path (required) - string - Path
+    #   allow_access_by_any_user - boolean - Allow lock to be updated by any user?
+    #   exclusive - boolean - Is lock exclusive?
+    #   recursive - string - Does lock apply to subfolders?
     #   timeout - int64 - Lock timeout length
     def self.create(path, params = {}, options = {})
       params ||= {}
       params[:path] = path
       raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: recursive must be an String") if params.dig(:recursive) and !params.dig(:recursive).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: timeout must be an Integer") if params.dig(:timeout) and !params.dig(:timeout).is_a?(Integer)
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
 

metadata

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