files.com 1.0.185 → 1.0.189

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8595fe01110ecc8a3c1b0a0602d94df7d0203659f1042230b4b5c700643d26b2
-  data.tar.gz: 5543b53337d69e4d02a462b517a7625af1890cbb3cdb8809fc76f233c13cb97e
+  metadata.gz: 40d2d0562111f13b8fb68612cfec2bc9112431838a967c1668bd8306c2171583
+  data.tar.gz: ba800783d0620e2c3a22ead72b2863c6ae091eaa54c94f0348809c25fce1e5c9
 SHA512:
-  metadata.gz: db81909c52f8d91fbdf7170a660d5b90b9bf7a5b3089531d92322f325220f9d5f9ccfd9fb85f8a429fd59ca61e5b7761d879ff9ced0b5e0d6190ebb9aa9d7d75
-  data.tar.gz: 1d5c30443fe25c09039a0c6d6ad200ecf23f3d41e92bcea21a50b67785cf9432025b104812cc919278ce4feaa67745a3d5ed268942c03fad7a9ff7cbc565a012
+  metadata.gz: b8e711b882f506b926006d256d5df91fe41d0f8223c69a4cd3340c17fab90111bf651eacc367f0db443e0754792f1664809c69438c1787d551a45530fb9d5983
+  data.tar.gz: b87a6089bd45463e1f9bcedf6f17c5c8509beb0b20aea3830da765d82e504ecb423551c14f792e44bb2dcece0f67745592b4794b8af30ce908d271eccb46dec5

data/_VERSION

@@ -1 +1 @@
-1.0.185
+1.0.189

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

@@ -35,7 +35,8 @@
   "azure_blob_storage_container": "container-name",
   "s3_compatible_bucket": "my-bucket",
   "s3_compatible_region": "us-east-1",
-  "s3_compatible_endpoint": "mys3platform.com"
+  "s3_compatible_endpoint": "mys3platform.com",
+  "enable_dedicated_ips": true
 }
 ```
 
@@ -71,6 +72,7 @@
 * `s3_compatible_bucket` (string): S3-compatible Bucket name
 * `s3_compatible_region` (string): S3-compatible Bucket name
 * `s3_compatible_endpoint` (string): S3-compatible endpoint
+* `enable_dedicated_ips` (boolean): `true` if remote server only accepts connections from dedicated IPs
 * `aws_access_key` (string): AWS Access Key.
 * `aws_secret_key` (string): AWS secret key.
 * `password` (string): Password if needed.
@@ -149,7 +151,8 @@ Files::RemoteServer.create(
   azure_blob_storage_container: "container-name", 
   s3_compatible_bucket: "my-bucket", 
   s3_compatible_region: "us-east-1", 
-  s3_compatible_endpoint: "mys3platform.com"
+  s3_compatible_endpoint: "mys3platform.com", 
+  enable_dedicated_ips: true
 )
 ```
 
@@ -194,6 +197,7 @@ Files::RemoteServer.create(
 * `s3_compatible_bucket` (string): S3-compatible Bucket name
 * `s3_compatible_region` (string): S3-compatible Bucket name
 * `s3_compatible_endpoint` (string): S3-compatible endpoint
+* `enable_dedicated_ips` (boolean): `true` if remote server only accepts connections from dedicated IPs
 * `s3_compatible_access_key` (string): S3-compatible access key
 * `s3_compatible_secret_key` (string): S3-compatible secret key
 
@@ -230,7 +234,8 @@ Files::RemoteServer.update(id,
   azure_blob_storage_container: "container-name", 
   s3_compatible_bucket: "my-bucket", 
   s3_compatible_region: "us-east-1", 
-  s3_compatible_endpoint: "mys3platform.com"
+  s3_compatible_endpoint: "mys3platform.com", 
+  enable_dedicated_ips: true
 )
 ```
 
@@ -276,6 +281,7 @@ Files::RemoteServer.update(id,
 * `s3_compatible_bucket` (string): S3-compatible Bucket name
 * `s3_compatible_region` (string): S3-compatible Bucket name
 * `s3_compatible_endpoint` (string): S3-compatible endpoint
+* `enable_dedicated_ips` (boolean): `true` if remote server only accepts connections from dedicated IPs
 * `s3_compatible_access_key` (string): S3-compatible access key
 * `s3_compatible_secret_key` (string): S3-compatible secret key
 
@@ -327,7 +333,8 @@ remote_server.update(
   azure_blob_storage_container: "container-name",
   s3_compatible_bucket: "my-bucket",
   s3_compatible_region: "us-east-1",
-  s3_compatible_endpoint: "mys3platform.com"
+  s3_compatible_endpoint: "mys3platform.com",
+  enable_dedicated_ips: true
 )
 ```
 
@@ -373,6 +380,7 @@ remote_server.update(
 * `s3_compatible_bucket` (string): S3-compatible Bucket name
 * `s3_compatible_region` (string): S3-compatible Bucket name
 * `s3_compatible_endpoint` (string): S3-compatible endpoint
+* `enable_dedicated_ips` (boolean): `true` if remote server only accepts connections from dedicated IPs
 * `s3_compatible_access_key` (string): S3-compatible access key
 * `s3_compatible_secret_key` (string): S3-compatible secret key
 

data/lib/files.com.rb

@@ -27,74 +27,75 @@ require "files.com/util"
 require "files.com/list"
 require "files.com/uri"
 
-require "files.com/models/account_line_item"
-require "files.com/models/action"
-require "files.com/models/action_notification_export"
-require "files.com/models/action_notification_export_result"
-require "files.com/models/action_webhook_failure"
-require "files.com/models/api_key"
-require "files.com/models/app"
-require "files.com/models/as2_key"
-require "files.com/models/auto"
-require "files.com/models/automation"
-require "files.com/models/bandwidth_snapshot"
-require "files.com/models/behavior"
-require "files.com/models/bundle"
-require "files.com/models/bundle_download"
-require "files.com/models/bundle_recipient"
-require "files.com/models/bundle_registration"
-require "files.com/models/clickwrap"
-require "files.com/models/dns_record"
-require "files.com/models/errors"
-require "files.com/models/external_event"
-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_upload_part"
-require "files.com/models/folder"
-require "files.com/models/form_field"
-require "files.com/models/form_field_set"
-require "files.com/models/group"
-require "files.com/models/group_user"
-require "files.com/models/history"
-require "files.com/models/history_export"
-require "files.com/models/history_export_result"
-require "files.com/models/image"
-require "files.com/models/inbox_recipient"
-require "files.com/models/inbox_registration"
-require "files.com/models/inbox_upload"
-require "files.com/models/invoice"
-require "files.com/models/invoice_line_item"
-require "files.com/models/ip_address"
-require "files.com/models/lock"
-require "files.com/models/message"
-require "files.com/models/message_comment"
-require "files.com/models/message_comment_reaction"
-require "files.com/models/message_reaction"
-require "files.com/models/notification"
-require "files.com/models/payment"
-require "files.com/models/payment_line_item"
-require "files.com/models/permission"
-require "files.com/models/preview"
-require "files.com/models/project"
-require "files.com/models/public_ip_address"
-require "files.com/models/public_key"
-require "files.com/models/remote_server"
-require "files.com/models/request"
-require "files.com/models/session"
-require "files.com/models/settings_change"
-require "files.com/models/site"
-require "files.com/models/sso_strategy"
-require "files.com/models/status"
-require "files.com/models/style"
-require "files.com/models/sync_job"
-require "files.com/models/usage_daily_snapshot"
-require "files.com/models/usage_snapshot"
-require "files.com/models/user"
-require "files.com/models/user_cipher_use"
-require "files.com/models/user_request"
-require "files.com/models/webhook_test"
+require "files.com/clients/account_line_item"
+require "files.com/clients/action"
+require "files.com/clients/action_notification_export"
+require "files.com/clients/action_notification_export_result"
+require "files.com/clients/action_webhook_failure"
+require "files.com/clients/api_key"
+require "files.com/clients/app"
+require "files.com/clients/as2_key"
+require "files.com/clients/auto"
+require "files.com/clients/automation"
+require "files.com/clients/bandwidth_snapshot"
+require "files.com/clients/behavior"
+require "files.com/clients/bundle"
+require "files.com/clients/bundle_download"
+require "files.com/clients/bundle_recipient"
+require "files.com/clients/bundle_registration"
+require "files.com/clients/clickwrap"
+require "files.com/clients/dns_record"
+require "files.com/clients/errors"
+require "files.com/clients/external_event"
+require "files.com/clients/file"
+require "files.com/clients/file_action"
+require "files.com/clients/file_comment"
+require "files.com/clients/file_comment_reaction"
+require "files.com/clients/file_migration"
+require "files.com/clients/file_upload_part"
+require "files.com/clients/folder"
+require "files.com/clients/form_field"
+require "files.com/clients/form_field_set"
+require "files.com/clients/group"
+require "files.com/clients/group_user"
+require "files.com/clients/history"
+require "files.com/clients/history_export"
+require "files.com/clients/history_export_result"
+require "files.com/clients/image"
+require "files.com/clients/inbox_recipient"
+require "files.com/clients/inbox_registration"
+require "files.com/clients/inbox_upload"
+require "files.com/clients/invoice"
+require "files.com/clients/invoice_line_item"
+require "files.com/clients/ip_address"
+require "files.com/clients/lock"
+require "files.com/clients/message"
+require "files.com/clients/message_comment"
+require "files.com/clients/message_comment_reaction"
+require "files.com/clients/message_reaction"
+require "files.com/clients/notification"
+require "files.com/clients/payment"
+require "files.com/clients/payment_line_item"
+require "files.com/clients/permission"
+require "files.com/clients/preview"
+require "files.com/clients/project"
+require "files.com/clients/public_ip_address"
+require "files.com/clients/public_key"
+require "files.com/clients/remote_server"
+require "files.com/clients/request"
+require "files.com/clients/session"
+require "files.com/clients/settings_change"
+require "files.com/clients/site"
+require "files.com/clients/sso_strategy"
+require "files.com/clients/status"
+require "files.com/clients/style"
+require "files.com/clients/sync_job"
+require "files.com/clients/usage_daily_snapshot"
+require "files.com/clients/usage_snapshot"
+require "files.com/clients/user"
+require "files.com/clients/user_cipher_use"
+require "files.com/clients/user_request"
+require "files.com/clients/webhook_test"
 
 require "files.com/models/dir"
 require "files.com/models/file_utils"

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)
 

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

@@ -297,6 +297,15 @@ module Files
       @attributes[:s3_compatible_endpoint] = value
     end
 
+    # boolean - `true` if remote server only accepts connections from dedicated IPs
+    def enable_dedicated_ips
+      @attributes[:enable_dedicated_ips]
+    end
+
+    def enable_dedicated_ips=(value)
+      @attributes[:enable_dedicated_ips] = value
+    end
+
     # string - AWS Access Key.
     def aws_access_key
       @attributes[:aws_access_key]
@@ -472,6 +481,7 @@ module Files
     #   s3_compatible_bucket - string - S3-compatible Bucket name
     #   s3_compatible_region - string - S3-compatible Bucket name
     #   s3_compatible_endpoint - string - S3-compatible endpoint
+    #   enable_dedicated_ips - boolean - `true` if remote server only accepts connections from dedicated IPs
     #   s3_compatible_access_key - string - S3-compatible access key
     #   s3_compatible_secret_key - string - S3-compatible secret key
     def update(params = {})
@@ -619,6 +629,7 @@ module Files
     #   s3_compatible_bucket - string - S3-compatible Bucket name
     #   s3_compatible_region - string - S3-compatible Bucket name
     #   s3_compatible_endpoint - string - S3-compatible endpoint
+    #   enable_dedicated_ips - boolean - `true` if remote server only accepts connections from dedicated IPs
     #   s3_compatible_access_key - string - S3-compatible access key
     #   s3_compatible_secret_key - string - S3-compatible secret key
     def self.create(params = {}, options = {})
@@ -707,6 +718,7 @@ module Files
     #   s3_compatible_bucket - string - S3-compatible Bucket name
     #   s3_compatible_region - string - S3-compatible Bucket name
     #   s3_compatible_endpoint - string - S3-compatible endpoint
+    #   enable_dedicated_ips - boolean - `true` if remote server only accepts connections from dedicated IPs
     #   s3_compatible_access_key - string - S3-compatible access key
     #   s3_compatible_secret_key - string - S3-compatible secret key
     def self.update(id, params = {}, options = {})

metadata

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