files.com 1.0.207 → 1.0.211

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fb5bf67fe8213a1de5aa3b43f60fb3875b1fc333ecc25c5f1acce2c43bbcf49
-  data.tar.gz: 8672f2d39b9755942ad5be5f5644b07501ee70eae7227feb54130cfbf8f64df0
+  metadata.gz: 67f2512d48c8972612804b1fa4847652a4b4cc28ad3fd1720c15ecc525d92ab0
+  data.tar.gz: e36e60d409ad93cdd6038c8ef7bbd38f383517e9d2e7dc64e17fa93050f576a9
 SHA512:
-  metadata.gz: e00145f208ffb4f09ccc526d1afc1b00b76655322b59ed9d10b618e9f6037861550f79ccd2e220bfc3ede08fd34832c2ba34ffb367bd00280be4d5d88d219a23
-  data.tar.gz: ebdbe0cd84102d13ea513a1a2cd7039bb6cd6a9092d73f11a2b8599f3a087990e7323df61b6fb83ccefb8f4b16abea0a62ed030828c8365f330b1090dad1d4a9
+  metadata.gz: 33e9d96ca582e97d1b91f3af0022433a2aa967b96ca6d13d20ec518ae86603540dd7ede9e5a9abb8bbff0e9a7cd6c6e542f7b7ff57901a7cf1d685a4d0ba4c25
+  data.tar.gz: e41dc8e333884f93d9b7f76dffb71d6358f6729b56d936147d2cabf49bdcf9b28f41bb35a23af70f4acea5e29a47bce6f00a9f50c29a0dc7479528c9dcc8d12a

data/_VERSION

@@ -1 +1 @@
-1.0.207
+1.0.211

data/docs/automation_run.md

@@ -0,0 +1,35 @@
+# AutomationRun
+
+## Example AutomationRun Object
+
+```
+{
+  "automation_id": 1,
+  "status": "success",
+  "status_messages_url": "https://www.example.com/log_file.txt"
+}
+```
+
+* `automation_id` (int64): ID of the associated Automation.
+* `status` (string): The success status of the AutomationRun. One of `running`, `success`, `partial_failure`, or `failure`.
+* `status_messages_url` (string): Link to status messages log file.
+
+
+---
+
+## List Automation Runs
+
+```
+Files::AutomationRun.list(
+  user_id: 1, 
+  per_page: 1, 
+  automation_id: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `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).
+* `automation_id` (int64): Required - ID of the associated Automation.

data/docs/file.md

@@ -153,7 +153,7 @@ Files::File.delete(path,
 ## Return metadata for file/folder
 
 ```
-Files::File.metadata(path, 
+Files::File.find_by(path, 
   with_previews: true, 
   with_priority_color: true
 )
@@ -287,27 +287,6 @@ file.delete(
 * `recursive` (boolean): If true, will recursively delete folers.  Otherwise, will error on non-empty folders.
 
 
----
-
-## Return metadata for file/folder
-
-```
-file = Files::File.list_for(path).first
-
-file.metadata(
-  with_previews: true,
-  with_priority_color: true
-)
-```
-
-### Parameters
-
-* `path` (string): Required - Path to operate on.
-* `preview_size` (string): Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
-* `with_previews` (boolean): Include file preview information?
-* `with_priority_color` (boolean): Include file priority color information?
-
-
 ---
 
 ## Copy file/folder

data/docs/priority.md

@@ -0,0 +1,30 @@
+# Priority
+
+## Example Priority Object
+
+```
+{
+  "path": "foo/bar",
+  "color": "pink"
+}
+```
+
+* `path` (string): The path corresponding to the priority color This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `color` (string): The priority color
+
+
+---
+
+## List Priorities
+
+```
+Files::Priority.list(path, 
+  per_page: 1
+)
+```
+
+### 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).
+* `path` (string): Required - The path to query for priorities

data/docs/remote_server.md

@@ -34,7 +34,6 @@
   "azure_blob_storage_account": "storage-account-name",
   "azure_blob_storage_container": "container-name",
   "s3_compatible_bucket": "my-bucket",
-  "s3_compatible_region": "us-east-1",
   "s3_compatible_endpoint": "mys3platform.com",
   "enable_dedicated_ips": true
 }
@@ -70,7 +69,6 @@
 * `azure_blob_storage_account` (string): Azure Blob Storage Account name
 * `azure_blob_storage_container` (string): Azure Blob Storage Container name
 * `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.
@@ -150,7 +148,6 @@ Files::RemoteServer.create(
   azure_blob_storage_account: "storage-account-name", 
   azure_blob_storage_container: "container-name", 
   s3_compatible_bucket: "my-bucket", 
-  s3_compatible_region: "us-east-1", 
   s3_compatible_endpoint: "mys3platform.com", 
   enable_dedicated_ips: true
 )
@@ -195,7 +192,6 @@ Files::RemoteServer.create(
 * `azure_blob_storage_account` (string): Azure Blob Storage Account name
 * `azure_blob_storage_container` (string): Azure Blob Storage Container name
 * `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
@@ -233,7 +229,6 @@ Files::RemoteServer.update(id,
   azure_blob_storage_account: "storage-account-name", 
   azure_blob_storage_container: "container-name", 
   s3_compatible_bucket: "my-bucket", 
-  s3_compatible_region: "us-east-1", 
   s3_compatible_endpoint: "mys3platform.com", 
   enable_dedicated_ips: true
 )
@@ -279,7 +274,6 @@ Files::RemoteServer.update(id,
 * `azure_blob_storage_account` (string): Azure Blob Storage Account name
 * `azure_blob_storage_container` (string): Azure Blob Storage Container name
 * `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
@@ -332,7 +326,6 @@ remote_server.update(
   azure_blob_storage_account: "storage-account-name",
   azure_blob_storage_container: "container-name",
   s3_compatible_bucket: "my-bucket",
-  s3_compatible_region: "us-east-1",
   s3_compatible_endpoint: "mys3platform.com",
   enable_dedicated_ips: true
 )
@@ -378,7 +371,6 @@ remote_server.update(
 * `azure_blob_storage_account` (string): Azure Blob Storage Account name
 * `azure_blob_storage_container` (string): Azure Blob Storage Container name
 * `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

data/lib/files.com/errors.rb

@@ -191,6 +191,9 @@ module Files
   class TooManyLoginAttemptsError < RateLimitedError; end
   class TooManyRequestsError < RateLimitedError; end
 
+  class ServiceUnavailableError < APIError; end
+  class UploadsUnavailableError < ServiceUnavailableError; end
+
   class SiteConfigurationError < APIError; end
   class AccountAlreadyExistsError < SiteConfigurationError; end
   class AccountOverdueError < SiteConfigurationError; end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Files
+  class AutomationRun
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - ID of the associated Automation.
+    def automation_id
+      @attributes[:automation_id]
+    end
+
+    # string - The success status of the AutomationRun. One of `running`, `success`, `partial_failure`, or `failure`.
+    def status
+      @attributes[:status]
+    end
+
+    # string - Link to status messages log file.
+    def status_messages_url
+      @attributes[:status_messages_url]
+    end
+
+    # Parameters:
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    #   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).
+    #   automation_id (required) - int64 - ID of the associated Automation.
+    def self.list(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
+      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)
+      raise InvalidParameterError.new("Bad parameter: automation_id must be an Integer") if params.dig(:automation_id) and !params.dig(:automation_id).is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: automation_id") unless params.dig(:automation_id)
+
+      List.new(AutomationRun, params) do
+        Api.send_request("/automation_runs", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+  end
+end

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

@@ -867,23 +867,6 @@ module Files
       delete(params)
     end
 
-    # Return metadata for file/folder
-    #
-    # Parameters:
-    #   preview_size - string - Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
-    #   with_previews - boolean - Include file preview information?
-    #   with_priority_color - boolean - Include file priority color information?
-    def metadata(params = {})
-      params ||= {}
-      params[:path] = @attributes[:path]
-      raise MissingParameterError.new("Current object doesn't have a path") unless @attributes[: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: preview_size must be an String") if params.dig(:preview_size) and !params.dig(:preview_size).is_a?(String)
-      raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
-
-      Api.send_request("/file_actions/metadata/#{@attributes[:path]}", :get, params, @options)
-    end
-
     # Copy file/folder
     #
     # Parameters:
@@ -1029,13 +1012,12 @@ module Files
       delete(path, params, options)
     end
 
-    # Return metadata for file/folder
-    #
     # Parameters:
+    #   path (required) - string - Path to operate on.
     #   preview_size - string - Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
     #   with_previews - boolean - Include file preview information?
     #   with_priority_color - boolean - Include file priority color information?
-    def self.metadata(path, params = {}, options = {})
+    def self.find_by(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)

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Files
+  class Priority
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # string - The path corresponding to the priority color 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 - The priority color
+    def color
+      @attributes[:color]
+    end
+
+    # 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).
+    #   path (required) - string - The path to query for priorities
+    def self.list(path, params = {}, options = {})
+      params ||= {}
+      params[:path] = path
+      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)
+      raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
+
+      List.new(Priority, params) do
+        Api.send_request("/priorities", :get, params, options)
+      end
+    end
+
+    def self.all(path, params = {}, options = {})
+      list(path, params, options)
+    end
+  end
+end

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

@@ -279,15 +279,6 @@ module Files
       @attributes[:s3_compatible_bucket] = value
     end
 
-    # string - S3-compatible Bucket name
-    def s3_compatible_region
-      @attributes[:s3_compatible_region]
-    end
-
-    def s3_compatible_region=(value)
-      @attributes[:s3_compatible_region] = value
-    end
-
     # string - S3-compatible endpoint
     def s3_compatible_endpoint
       @attributes[:s3_compatible_endpoint]
@@ -479,7 +470,6 @@ module Files
     #   azure_blob_storage_account - string - Azure Blob Storage Account name
     #   azure_blob_storage_container - string - Azure Blob Storage Container name
     #   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
@@ -525,7 +515,6 @@ module Files
       raise InvalidParameterError.new("Bad parameter: azure_blob_storage_account must be an String") if params.dig(:azure_blob_storage_account) and !params.dig(:azure_blob_storage_account).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: azure_blob_storage_container must be an String") if params.dig(:azure_blob_storage_container) and !params.dig(:azure_blob_storage_container).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: s3_compatible_bucket must be an String") if params.dig(:s3_compatible_bucket) and !params.dig(:s3_compatible_bucket).is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: s3_compatible_region must be an String") if params.dig(:s3_compatible_region) and !params.dig(:s3_compatible_region).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: s3_compatible_endpoint must be an String") if params.dig(:s3_compatible_endpoint) and !params.dig(:s3_compatible_endpoint).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: s3_compatible_access_key must be an String") if params.dig(:s3_compatible_access_key) and !params.dig(:s3_compatible_access_key).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: s3_compatible_secret_key must be an String") if params.dig(:s3_compatible_secret_key) and !params.dig(:s3_compatible_secret_key).is_a?(String)
@@ -627,7 +616,6 @@ module Files
     #   azure_blob_storage_account - string - Azure Blob Storage Account name
     #   azure_blob_storage_container - string - Azure Blob Storage Container name
     #   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
@@ -669,7 +657,6 @@ module Files
       raise InvalidParameterError.new("Bad parameter: azure_blob_storage_account must be an String") if params.dig(:azure_blob_storage_account) and !params.dig(:azure_blob_storage_account).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: azure_blob_storage_container must be an String") if params.dig(:azure_blob_storage_container) and !params.dig(:azure_blob_storage_container).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: s3_compatible_bucket must be an String") if params.dig(:s3_compatible_bucket) and !params.dig(:s3_compatible_bucket).is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: s3_compatible_region must be an String") if params.dig(:s3_compatible_region) and !params.dig(:s3_compatible_region).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: s3_compatible_endpoint must be an String") if params.dig(:s3_compatible_endpoint) and !params.dig(:s3_compatible_endpoint).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: s3_compatible_access_key must be an String") if params.dig(:s3_compatible_access_key) and !params.dig(:s3_compatible_access_key).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: s3_compatible_secret_key must be an String") if params.dig(:s3_compatible_secret_key) and !params.dig(:s3_compatible_secret_key).is_a?(String)
@@ -716,7 +703,6 @@ module Files
     #   azure_blob_storage_account - string - Azure Blob Storage Account name
     #   azure_blob_storage_container - string - Azure Blob Storage Container name
     #   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
@@ -761,7 +747,6 @@ module Files
       raise InvalidParameterError.new("Bad parameter: azure_blob_storage_account must be an String") if params.dig(:azure_blob_storage_account) and !params.dig(:azure_blob_storage_account).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: azure_blob_storage_container must be an String") if params.dig(:azure_blob_storage_container) and !params.dig(:azure_blob_storage_container).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: s3_compatible_bucket must be an String") if params.dig(:s3_compatible_bucket) and !params.dig(:s3_compatible_bucket).is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: s3_compatible_region must be an String") if params.dig(:s3_compatible_region) and !params.dig(:s3_compatible_region).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: s3_compatible_endpoint must be an String") if params.dig(:s3_compatible_endpoint) and !params.dig(:s3_compatible_endpoint).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: s3_compatible_access_key must be an String") if params.dig(:s3_compatible_access_key) and !params.dig(:s3_compatible_access_key).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: s3_compatible_secret_key must be an String") if params.dig(:s3_compatible_secret_key) and !params.dig(:s3_compatible_secret_key).is_a?(String)

data/lib/files.com.rb

@@ -37,6 +37,7 @@ 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/automation_run"
 require "files.com/models/bandwidth_snapshot"
 require "files.com/models/behavior"
 require "files.com/models/bundle"
@@ -78,6 +79,7 @@ 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/priority"
 require "files.com/models/project"
 require "files.com/models/public_ip_address"
 require "files.com/models/public_key"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.207
+  version: 1.0.211
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-14 00:00:00.000000000 Z
+date: 2021-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -96,6 +96,7 @@ files:
 - docs/as2_key.md
 - docs/auto.md
 - docs/automation.md
+- docs/automation_run.md
 - docs/bandwidth_snapshot.md
 - docs/behavior.md
 - docs/bundle.md
@@ -138,6 +139,7 @@ files:
 - docs/payment_line_item.md
 - docs/permission.md
 - docs/preview.md
+- docs/priority.md
 - docs/project.md
 - docs/public_ip_address.md
 - docs/public_key.md
@@ -172,6 +174,7 @@ files:
 - lib/files.com/models/as2_key.rb
 - lib/files.com/models/auto.rb
 - lib/files.com/models/automation.rb
+- lib/files.com/models/automation_run.rb
 - lib/files.com/models/bandwidth_snapshot.rb
 - lib/files.com/models/behavior.rb
 - lib/files.com/models/bundle.rb
@@ -215,6 +218,7 @@ files:
 - lib/files.com/models/payment_line_item.rb
 - lib/files.com/models/permission.rb
 - lib/files.com/models/preview.rb
+- lib/files.com/models/priority.rb
 - lib/files.com/models/project.rb
 - lib/files.com/models/public_ip_address.rb
 - lib/files.com/models/public_key.rb