files.com 1.0.152 → 1.0.157

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80890845ebda55975f177b54c85c82f1ed106086e750eded6907488daf879cce
-  data.tar.gz: bf99ca9501f9813393e23dba23a54acdedaf70528f6d24bc3fa6a94adcda7757
+  metadata.gz: b0e2eda4242ae65c148cd2ee69e2871bdd647c63ee349d0866ec5726611021f7
+  data.tar.gz: 73ba063ec212d51ed014ce83e468027ec82aaa06c9a28e93a93c4cc1d8d9bf60
 SHA512:
-  metadata.gz: 9cc02ddb3685c4ccb7c980ba891f171c354dfd0f122fd2779d02d7259bd7a96b661a84f01e06e617d8637475c4daa35b4513795a58b0f9a269f3f2f782fbd6a3
-  data.tar.gz: 5c499037e94937095e8a52b0811398a341b81dd8f3cbd33ed7345b30028403060043faea5692be969388d1923a3c8ff1d34f1ff03c122684fcebe5cfb0b3e8cc
+  metadata.gz: 75692aadbde4b0b91b6530f1bd961219d9f450eb704c08fbd8317635fe7aaa7d1898863898c97664e8c79cb61fae29a5afbdeea260347fbcec4a025a2af6d5b7
+  data.tar.gz: 482a93a97bdb177af3597e3143d30b1d8fc0be92ab91245954ed5b307084daafaba0419d6ad35231762126fec66f15cfc3d1a7dc3b8264a138938ce235c8206c

data/_VERSION

@@ -1 +1 @@
-1.0.152
+1.0.157

data/docs/api_key.md

@@ -61,17 +61,9 @@ Files::ApiKey.list(
 ## Show information about current API key.  (Requires current API connection to be using an API key.)
 
 ```
-Files::ApiKey.find_current(
-  format: "", 
-  api_key: ""
-)
+Files::ApiKey.find_current
 ```
 
-### Parameters
-
-* `format` (string): 
-* `api_key` (object): 
-
 
 ---
 
@@ -153,17 +145,9 @@ Files::ApiKey.update(id,
 ## Delete current API key.  (Requires current API connection to be using an API key.)
 
 ```
-Files::ApiKey.delete_current(
-  format: "", 
-  api_key: ""
-)
+Files::ApiKey.delete_current
 ```
 
-### Parameters
-
-* `format` (string): 
-* `api_key` (object): 
-
 
 ---
 

data/docs/bundle.md

@@ -171,9 +171,9 @@ Files::Bundle.share(id,
 ### Parameters
 
 * `id` (int64): Required - Bundle ID.
-* `to` (array(string)): Required - A list of email addresses to share this bundle with.
+* `to` (array(string)): A list of email addresses to share this bundle with. Required unless `recipients` is used.
 * `note` (string): Note to include in email.
-* `recipients` (array(object)): A list of recipients to share this bundle with.
+* `recipients` (array(object)): A list of recipients to share this bundle with. Required unless `to` is used.
 
 
 ---
@@ -244,9 +244,9 @@ bundle.share(
 ### Parameters
 
 * `id` (int64): Required - Bundle ID.
-* `to` (array(string)): Required - A list of email addresses to share this bundle with.
+* `to` (array(string)): A list of email addresses to share this bundle with. Required unless `recipients` is used.
 * `note` (string): Note to include in email.
-* `recipients` (array(object)): A list of recipients to share this bundle with.
+* `recipients` (array(object)): A list of recipients to share this bundle with. Required unless `to` is used.
 
 
 ---

data/docs/bundle_download.md

@@ -33,5 +33,12 @@ Files::BundleDownload.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 `created_at`.
+* `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
+* `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`.
+* `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`.
+* `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
+* `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `created_at`.
+* `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`.
 * `bundle_id` (int64): Bundle ID
 * `bundle_registration_id` (int64): BundleRegistration ID

data/docs/inbox_recipient.md

@@ -69,7 +69,7 @@ Files::InboxRecipient.create(
 
 * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
 * `inbox_id` (int64): Required - Inbox to share.
-* `recipient` (string): Required - Email addresses to share this inbox with.
+* `recipient` (string): Required - Email address to share this inbox with.
 * `name` (string): Name of recipient.
 * `company` (string): Company of recipient.
 * `note` (string): Note to include in email.

data/docs/inbox_upload.md

@@ -31,5 +31,12 @@ Files::InboxUpload.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 `created_at`.
+* `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
+* `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`.
+* `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`.
+* `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
+* `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `created_at`.
+* `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`.
 * `inbox_registration_id` (int64): InboxRegistration ID
 * `inbox_id` (int64): Inbox ID

data/docs/session.md

@@ -74,13 +74,5 @@ Files::Session.create(
 ## Delete user session (log out)
 
 ```
-Files::Session.delete(
-  format: "", 
-  session: ""
-)
+Files::Session.delete
 ```
-
-### Parameters
-
-* `format` (string): 
-* `session` (object): 

data/docs/site.md

@@ -324,34 +324,18 @@
 ## Show site settings
 
 ```
-Files::Site.get(
-  format: "", 
-  site: ""
-)
+Files::Site.get
 ```
 
-### Parameters
-
-* `format` (string): 
-* `site` (object): 
-
 
 ---
 
 ## Get the most recent usage snapshot (usage data for billing purposes) for a Site
 
 ```
-Files::Site.get_usage(
-  format: "", 
-  site: ""
-)
+Files::Site.get_usage
 ```
 
-### Parameters
-
-* `format` (string): 
-* `site` (object): 
-
 
 ---
 

data/lib/files.com/errors.rb

@@ -175,6 +175,7 @@ module Files
   class ModelSaveErrorError < ProcessingFailureError; end
   class MultipartUploadsRequiredForRemotesError < ProcessingFailureError; end
   class MultipleProcessingErrorsError < ProcessingFailureError; end
+  class RecipientAlreadySharedError < ProcessingFailureError; end
   class RemoteServerErrorError < ProcessingFailureError; end
   class ResourceLockedError < ProcessingFailureError; end
   class SubfolderLockedError < ProcessingFailureError; end

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

@@ -176,13 +176,7 @@ module Files
       list(params, options)
     end
 
-    # Parameters:
-    #   format - string
-    #   api_key - object
     def self.find_current(params = {}, options = {})
-      raise InvalidParameterError.new("Bad parameter: format must be an String") if params.dig(:format) and !params.dig(:format).is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: api_key must be an Hash") if params.dig(:api_key) and !params.dig(:api_key).is_a?(Hash)
-
       response, options = Api.send_request("/api_key", :get, params, options)
       ApiKey.new(response.data, options)
     end
@@ -250,13 +244,7 @@ module Files
       ApiKey.new(response.data, options)
     end
 
-    # Parameters:
-    #   format - string
-    #   api_key - object
     def self.delete_current(params = {}, options = {})
-      raise InvalidParameterError.new("Bad parameter: format must be an String") if params.dig(:format) and !params.dig(:format).is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: api_key must be an Hash") if params.dig(:api_key) and !params.dig(:api_key).is_a?(Hash)
-
       response, _options = Api.send_request("/api_key", :delete, params, options)
       response.data
     end

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

@@ -197,9 +197,9 @@ module Files
     # Send email(s) with a link to bundle
     #
     # Parameters:
-    #   to (required) - array(string) - A list of email addresses to share this bundle with.
+    #   to - array(string) - A list of email addresses to share this bundle with. Required unless `recipients` is used.
     #   note - string - Note to include in email.
-    #   recipients - array(object) - A list of recipients to share this bundle with.
+    #   recipients - array(object) - A list of recipients to share this bundle with. Required unless `to` is used.
     def share(params = {})
       params ||= {}
       params[:id] = @attributes[:id]
@@ -209,7 +209,6 @@ module Files
       raise InvalidParameterError.new("Bad parameter: note must be an String") if params.dig(:note) and !params.dig(:note).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: recipients must be an Array") if params.dig(:recipients) and !params.dig(:recipients).is_a?(Array)
       raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
-      raise MissingParameterError.new("Parameter missing: to") unless params.dig(:to)
 
       Api.send_request("/bundles/#{@attributes[:id]}/share", :post, params, @options)
     end
@@ -353,9 +352,9 @@ module Files
     # Send email(s) with a link to bundle
     #
     # Parameters:
-    #   to (required) - array(string) - A list of email addresses to share this bundle with.
+    #   to - array(string) - A list of email addresses to share this bundle with. Required unless `recipients` is used.
     #   note - string - Note to include in email.
-    #   recipients - array(object) - A list of recipients to share this bundle with.
+    #   recipients - array(object) - A list of recipients to share this bundle with. Required unless `to` is used.
     def self.share(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -364,7 +363,6 @@ module Files
       raise InvalidParameterError.new("Bad parameter: note must be an String") if params.dig(:note) and !params.dig(:note).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: recipients must be an Array") if params.dig(:recipients) and !params.dig(:recipients).is_a?(Array)
       raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
-      raise MissingParameterError.new("Parameter missing: to") unless params.dig(:to)
 
       response, _options = Api.send_request("/bundles/#{params[:id]}/share", :post, params, options)
       response.data

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

@@ -31,11 +31,25 @@ 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 `created_at`.
+    #   filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
+    #   filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`.
+    #   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`.
+    #   filter_like - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
+    #   filter_lt - object - If set, return records where the specifiied field is less than the supplied value. Valid fields are `created_at`.
+    #   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`.
     #   bundle_id - int64 - Bundle ID
     #   bundle_registration_id - int64 - BundleRegistration 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)
+      raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params.dig(:filter_gteq) and !params.dig(:filter_gteq).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_like must be an Hash") if params.dig(:filter_like) and !params.dig(:filter_like).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params.dig(:filter_lt) and !params.dig(:filter_lt).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params.dig(:filter_lteq) and !params.dig(:filter_lteq).is_a?(Hash)
       raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params.dig(:bundle_id) and !params.dig(:bundle_id).is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: bundle_registration_id must be an Integer") if params.dig(:bundle_registration_id) and !params.dig(:bundle_registration_id).is_a?(Integer)
 

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

@@ -128,7 +128,7 @@ module Files
     # Parameters:
     #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
     #   inbox_id (required) - int64 - Inbox to share.
-    #   recipient (required) - string - Email addresses to share this inbox with.
+    #   recipient (required) - string - Email address to share this inbox with.
     #   name - string - Name of recipient.
     #   company - string - Company of recipient.
     #   note - string - Note to include in email.

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

@@ -26,11 +26,25 @@ 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 `created_at`.
+    #   filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
+    #   filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`.
+    #   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`.
+    #   filter_like - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
+    #   filter_lt - object - If set, return records where the specifiied field is less than the supplied value. Valid fields are `created_at`.
+    #   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`.
     #   inbox_registration_id - int64 - InboxRegistration ID
     #   inbox_id - int64 - Inbox 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)
+      raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params.dig(:filter_gteq) and !params.dig(:filter_gteq).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_like must be an Hash") if params.dig(:filter_like) and !params.dig(:filter_like).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params.dig(:filter_lt) and !params.dig(:filter_lt).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params.dig(:filter_lteq) and !params.dig(:filter_lteq).is_a?(Hash)
       raise InvalidParameterError.new("Bad parameter: inbox_registration_id must be an Integer") if params.dig(:inbox_registration_id) and !params.dig(:inbox_registration_id).is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: inbox_id must be an Integer") if params.dig(:inbox_id) and !params.dig(:inbox_id).is_a?(Integer)
 

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

@@ -235,13 +235,7 @@ module Files
       Session.new(response.data, options)
     end
 
-    # Parameters:
-    #   format - string
-    #   session - object
     def self.delete(params = {}, options = {})
-      raise InvalidParameterError.new("Bad parameter: format must be an String") if params.dig(:format) and !params.dig(:format).is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: session must be an Hash") if params.dig(:session) and !params.dig(:session).is_a?(Hash)
-
       response, _options = Api.send_request("/sessions", :delete, params, options)
       response.data
     end

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

@@ -574,24 +574,12 @@ module Files
       @attributes[:disable_users_from_inactivity_period_days]
     end
 
-    # Parameters:
-    #   format - string
-    #   site - object
     def self.get(params = {}, options = {})
-      raise InvalidParameterError.new("Bad parameter: format must be an String") if params.dig(:format) and !params.dig(:format).is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: site must be an Hash") if params.dig(:site) and !params.dig(:site).is_a?(Hash)
-
       response, options = Api.send_request("/site", :get, params, options)
       Site.new(response.data, options)
     end
 
-    # Parameters:
-    #   format - string
-    #   site - object
     def self.get_usage(params = {}, options = {})
-      raise InvalidParameterError.new("Bad parameter: format must be an String") if params.dig(:format) and !params.dig(:format).is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: site must be an Hash") if params.dig(:site) and !params.dig(:site).is_a?(Hash)
-
       response, options = Api.send_request("/site/usage", :get, params, options)
       UsageSnapshot.new(response.data, options)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.152
+  version: 1.0.157
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-26 00:00:00.000000000 Z
+date: 2021-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable