files.com 1.0.53 → 1.0.58

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a363686b90e3e1673bf9f7b47d9368dd514f05d680000195651de99f0889b310
-  data.tar.gz: d73ee31b349dc91f5a5b92b76a2acc94f52b4622509df03afdfc3caf76c4a337
+  metadata.gz: 95ef0f5e3fcf334ae2d2abecebcf49f85fe6b6527e5d8b5d8553480a0d794395
+  data.tar.gz: 32bf7c269933adf563c492162df9a1d2ed234187623549ae1076144c540cc311
 SHA512:
-  metadata.gz: 55bef934d42e9c1d2843b4d9a84851d1bb2c64e3fb5f2ed53d61b06936abd8ca0199f87345acf9820985ceca6d9952be51ede738e906fb219e762f81d5cce4b5
-  data.tar.gz: 4f4bb4f7af296041691fdc12f84e51a1751cb0ca6ec8a6f890ba20b919ced709fc3dce9a5399a967d2ec86a6f9c73046def7ebcb8f2d0ef50db3015ff3886fb3
+  metadata.gz: f257bdbe6e08c15938be2b3009c83c1127194d24d5fd93b4b3427a9a3f32046376ed91ea318890904170a258aa5644169db0af2c9c4fd5a49a745dd4015a62bb
+  data.tar.gz: 7151db08884f1cd7aa4d33f18e25112abf3beaff0750c16212a3c6185836ec4aa5b900bc3707f80144e2eac057d2f8e4d8773a56136ab98ba89ce54b6bb4ed4d

data/_VERSION

@@ -1 +1 @@
-1.0.53
+1.0.58

data/docs/bundle.md

@@ -77,8 +77,8 @@ Files::Bundle.create(
   paths: ["file.txt"], 
   password: "Password", 
   expires_at: "2000-01-01T01:00:00Z", 
-  description: "Public description", 
-  note: "Internal Note", 
+  description: "The public description of the bundle.", 
+  note: "The internal note on the bundle.", 
   code: "abc123"
 )
 ```
@@ -88,10 +88,10 @@ Files::Bundle.create(
 * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
 * `paths` (array(string)): Required - A list of paths to include in this bundle.
 * `password` (string): Password for this bundle.
-* `expires_at` (string): Bundle expiration date/time.
-* `description` (string): Bundle public description
+* `expires_at` (string): Bundle expiration date/time
+* `description` (string): Public description
 * `note` (string): Bundle internal note
-* `code` (string): Bundle name
+* `code` (string): Bundle code.  This code forms the end part of the Public URL.
 
 
 ---
@@ -112,6 +112,30 @@ Files::Bundle.share(id,
 * `note` (string): Note to include in email.
 
 
+---
+
+## Update Bundle
+
+```
+Files::Bundle.update(id, 
+  password: "Password", 
+  expires_at: "2000-01-01T01:00:00Z", 
+  description: "The public description of the bundle.", 
+  note: "The internal note on the bundle.", 
+  code: "abc123"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Bundle ID.
+* `password` (string): Password for this bundle.
+* `expires_at` (string): Bundle expiration date/time
+* `description` (string): Public description
+* `note` (string): Bundle internal note
+* `code` (string): Bundle code.  This code forms the end part of the Public URL.
+
+
 ---
 
 ## Delete Bundle
@@ -144,6 +168,31 @@ bundle.share(
 * `note` (string): Note to include in email.
 
 
+---
+
+## Update Bundle
+
+```
+bundle = Files::Bundle.find(1)
+bundle.update(
+  password: "Password",
+  expires_at: "2000-01-01T01:00:00Z",
+  description: "The public description of the bundle.",
+  note: "The internal note on the bundle.",
+  code: "abc123"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Bundle ID.
+* `password` (string): Password for this bundle.
+* `expires_at` (string): Bundle expiration date/time
+* `description` (string): Public description
+* `note` (string): Bundle internal note
+* `code` (string): Bundle code.  This code forms the end part of the Public URL.
+
+
 ---
 
 ## Delete Bundle

data/docs/site.md

@@ -11,7 +11,6 @@
   "allowed_2fa_method_yubi": true,
   "admin_user_id": 1,
   "allow_bundle_names": true,
-  "allowed_file_types": "",
   "allowed_ips": "",
   "ask_about_overwrites": true,
   "bundle_expiration": 1,
@@ -120,7 +119,6 @@
 * `allowed_2fa_method_yubi` (boolean): Is yubikey two factor authentication allowed?
 * `admin_user_id` (int64): User ID for the main site administrator
 * `allow_bundle_names` (boolean): Are manual Bundle names allowed?
-* `allowed_file_types` (string): List of allowed file types
 * `allowed_ips` (string): List of allowed IP addresses
 * `ask_about_overwrites` (boolean): If false, rename conflicting files instead of asking for overwrite confirmation.  Only applies to web interface.
 * `bundle_expiration` (int64): Site-wide Bundle expiration in days
@@ -264,7 +262,7 @@ Files::Site.update(
   desktop_app_session_lifetime: 1, 
   folder_permissions_groups_only: true, 
   welcome_screen: "user_controlled", 
-  session_expiry: 6.0, 
+  session_expiry: 1.0, 
   ssl_required: true, 
   tls_disabled: true, 
   user_lockout: true, 
@@ -351,7 +349,7 @@ Files::Site.update(
 * `desktop_app_session_lifetime` (int64): Desktop app session lifetime (in hours)
 * `folder_permissions_groups_only` (boolean): If true, permissions for this site must be bound to a group (not a user). Otherwise, permissions must be bound to a user.
 * `welcome_screen` (string): Does the welcome screen appear?
-* `session_expiry` (number): Session expiry in hours
+* `session_expiry` (double): Session expiry in hours
 * `ssl_required` (boolean): Is SSL required?  Disabling this is insecure.
 * `tls_disabled` (boolean): Is TLS disabled(site setting)?
 * `user_lockout` (boolean): Will users be locked out after incorrect login attempts?
@@ -359,7 +357,6 @@ Files::Site.update(
 * `user_lockout_within` (int64): Number of hours for user lockout window
 * `user_lockout_lock_period` (int64): How many hours to lock user out for failed password?
 * `include_password_in_welcome_email` (boolean): Include password in emails to new users?
-* `allowed_file_types` (string): List of allowed file types
 * `allowed_ips` (string): List of allowed IP addresses
 * `days_to_retain_backups` (int64): Number of days to keep deleted files
 * `max_prior_passwords` (int64): Number of prior passwords to disallow

data/docs/sso_strategy.md

@@ -6,6 +6,8 @@
 {
   "protocol": "okta",
   "provider": "okta",
+  "label": "My Corporate SSO Provider",
+  "logo_url": "https://mysite.files.com/.../logo.png",
   "id": 1,
   "saml_provider_cert_fingerprint": "",
   "saml_provider_issuer_url": "",
@@ -31,6 +33,8 @@
 
 * `protocol` (string): SSO Protocol
 * `provider` (string): Provider name
+* `label` (string): Custom label for the SSO provider on the login page.
+* `logo_url` (string): URL holding a custom logo for the SSO provider on the login page.
 * `id` (int64): ID
 * `saml_provider_cert_fingerprint` (string): Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
 * `saml_provider_issuer_url` (string): Identity provider issuer url

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

@@ -136,9 +136,9 @@ module Files
     end
 
     # Parameters:
-    #   user_id - integer - User ID.  Provide a value of `0` to operate the current session's user.
-    #   page - integer - Current page number.
-    #   per_page - integer - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    #   page - int64 - Current page number.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
     #   action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
     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)
@@ -159,7 +159,7 @@ module Files
     end
 
     # Parameters:
-    #   id (required) - integer - Api Key ID.
+    #   id (required) - int64 - Api Key ID.
     def self.find(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -175,7 +175,7 @@ module Files
     end
 
     # Parameters:
-    #   user_id - integer - User ID.  Provide a value of `0` to operate the current session's user.
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
     #   name - string - Internal name for key.  For your reference only.
     #   permission_set - string - Leave blank, or set to 'desktop_app' to restrict the key to only desktop app functions.
     #   expires_at - string - Have the key expire at this date/time.

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

@@ -97,9 +97,9 @@ module Files
     end
 
     # Parameters:
-    #   user_id - integer - User ID.  Provide a value of `0` to operate the current session's user.
-    #   page - integer - Current page number.
-    #   per_page - integer - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    #   page - int64 - Current page number.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
     #   action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
     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)
@@ -115,7 +115,7 @@ module Files
     end
 
     # Parameters:
-    #   id (required) - integer - As2 Key ID.
+    #   id (required) - int64 - As2 Key ID.
     def self.find(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -131,7 +131,7 @@ module Files
     end
 
     # Parameters:
-    #   user_id - integer - User ID.  Provide a value of `0` to operate the current session's user.
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
     #   as2_partnership_name (required) - string - AS2 Partnership Name
     #   public_key (required) - string - Actual contents of Public key.
     def self.create(params = {}, options = {})

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

@@ -180,8 +180,8 @@ module Files
     end
 
     # Parameters:
-    #   page - integer - Current page number.
-    #   per_page - integer - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    #   page - int64 - Current page number.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
     #   action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
     #   automation - string - Type of automation to filter by.
     def self.list(params = {}, options = {})
@@ -198,7 +198,7 @@ module Files
     end
 
     # Parameters:
-    #   id (required) - integer - Automation ID.
+    #   id (required) - int64 - Automation ID.
     def self.find(id, params = {}, options = {})
       params ||= {}
       params[:id] = id

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

@@ -101,8 +101,8 @@ module Files
     end
 
     # Parameters:
-    #   page - integer - Current page number.
-    #   per_page - integer - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    #   page - int64 - Current page number.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
     #   action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
     #   behavior - string - If set, only shows folder behaviors matching this behavior type.
     def self.list(params = {}, options = {})
@@ -119,8 +119,8 @@ module Files
     end
 
     # Parameters:
-    #   page - integer - Current page number.
-    #   per_page - integer - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    #   page - int64 - Current page number.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
     #   action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
     #   path (required) - string - Path to operate on.
     #   recursive - string - Show behaviors below this path?
@@ -140,7 +140,7 @@ module Files
     end
 
     # Parameters:
-    #   id (required) - integer - Behavior ID.
+    #   id (required) - int64 - Behavior ID.
     def self.find(id, params = {}, options = {})
       params ||= {}
       params[:id] = id

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

@@ -116,7 +116,7 @@ module Files
     # Send email(s) with a link to bundle
     #
     # Parameters:
-    #   to (required) - array - A list of email addresses to share this bundle with.
+    #   to (required) - array(string) - A list of email addresses to share this bundle with.
     #   note - string - Note to include in email.
     def share(params = {})
       params ||= {}
@@ -131,6 +131,27 @@ module Files
       Api.send_request("/bundles/#{@attributes[:id]}/share", :post, params, @options)
     end
 
+    # Parameters:
+    #   password - string - Password for this bundle.
+    #   expires_at - string - Bundle expiration date/time
+    #   description - string - Public description
+    #   note - string - Bundle internal note
+    #   code - string - Bundle code.  This code forms the end part of the Public URL.
+    def update(params = {})
+      params ||= {}
+      params[:id] = @attributes[:id]
+      raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: description must be an String") if params.dig(:description) and !params.dig(:description).is_a?(String)
+      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: code must be an String") if params.dig(:code) and !params.dig(:code).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      Api.send_request("/bundles/#{@attributes[:id]}", :patch, params, @options)
+    end
+
     def delete(params = {})
       params ||= {}
       params[:id] = @attributes[:id]
@@ -147,7 +168,7 @@ module Files
 
     def save
       if @attributes[:id]
-        raise NotImplementedError.new("The Bundle object doesn't support updates.")
+        update(@attributes)
       else
         new_obj = Bundle.create(@attributes, @options)
         @attributes = new_obj.attributes
@@ -155,9 +176,9 @@ module Files
     end
 
     # Parameters:
-    #   user_id - integer - User ID.  Provide a value of `0` to operate the current session's user.
-    #   page - integer - Current page number.
-    #   per_page - integer - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    #   page - int64 - Current page number.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
     #   action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
     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)
@@ -173,7 +194,7 @@ module Files
     end
 
     # Parameters:
-    #   id (required) - integer - Bundle ID.
+    #   id (required) - int64 - Bundle ID.
     def self.find(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -189,13 +210,13 @@ module Files
     end
 
     # Parameters:
-    #   user_id - integer - User ID.  Provide a value of `0` to operate the current session's user.
-    #   paths (required) - array - A list of paths to include in this bundle.
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    #   paths (required) - array(string) - A list of paths to include in this bundle.
     #   password - string - Password for this bundle.
-    #   expires_at - string - Bundle expiration date/time.
-    #   description - string - Bundle public description
+    #   expires_at - string - Bundle expiration date/time
+    #   description - string - Public description
     #   note - string - Bundle internal note
-    #   code - string - Bundle name
+    #   code - string - Bundle code.  This code forms the end part of the Public URL.
     def self.create(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: paths must be an Array") if params.dig(:paths) and !params.dig(:paths).is_a?(Array)
@@ -213,7 +234,7 @@ module Files
     # Send email(s) with a link to bundle
     #
     # Parameters:
-    #   to (required) - array - A list of email addresses to share this bundle with.
+    #   to (required) - array(string) - A list of email addresses to share this bundle with.
     #   note - string - Note to include in email.
     def self.share(id, params = {}, options = {})
       params ||= {}
@@ -228,6 +249,27 @@ module Files
       response.data
     end
 
+    # Parameters:
+    #   password - string - Password for this bundle.
+    #   expires_at - string - Bundle expiration date/time
+    #   description - string - Public description
+    #   note - string - Bundle internal note
+    #   code - string - Bundle code.  This code forms the end part of the Public URL.
+    def self.update(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 InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: description must be an String") if params.dig(:description) and !params.dig(:description).is_a?(String)
+      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: code must be an String") if params.dig(:code) and !params.dig(:code).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      response, options = Api.send_request("/bundles/#{params[:id]}", :patch, params, options)
+      Bundle.new(response.data, options)
+    end
+
     def self.delete(id, params = {}, options = {})
       params ||= {}
       params[:id] = id

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

@@ -30,8 +30,8 @@ module Files
     end
 
     # Parameters:
-    #   page - integer - Current page number.
-    #   per_page - integer - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    #   page - int64 - Current page number.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
     #   action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
     def self.list(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)

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

@@ -825,7 +825,7 @@ module Files
     #
     # Parameters:
     #   action - string - Can be blank, `redirect` or `stat`.  If set to `stat`, we will return file information but without a download URL, and without logging a download.  If set to `redirect` we will serve a 302 redirect directly to the file.  This is used for integrations with Zapier, and is not recommended for most integrations.
-    #   id - integer - If provided, lookup the file by id instead of path.
+    #   id - int64 - If provided, lookup the file by id instead of path.
     #   with_previews - boolean - Include file preview information?
     #   with_priority_color - boolean - Include file priority color information?
     def download(params = {})
@@ -884,7 +884,7 @@ module Files
     #
     # Parameters:
     #   action - string - Can be blank, `redirect` or `stat`.  If set to `stat`, we will return file information but without a download URL, and without logging a download.  If set to `redirect` we will serve a 302 redirect directly to the file.  This is used for integrations with Zapier, and is not recommended for most integrations.
-    #   id - integer - If provided, lookup the file by id instead of path.
+    #   id - int64 - If provided, lookup the file by id instead of path.
     #   with_previews - boolean - Include file preview information?
     #   with_priority_color - boolean - Include file priority color information?
     def self.download(path, params = {}, options = {})
@@ -902,16 +902,16 @@ module Files
     # Parameters:
     #   path (required) - string - Path to operate on.
     #   action - string - The action to perform.  Can be `append`, `attachment`, `end`, `upload`, `put`, or may not exist
-    #   etags[etag] (required) - array - etag identifier.
-    #   etags[part] (required) - array - Part number.
-    #   length - integer - Length of file.
+    #   etags[etag] (required) - array(string) - etag identifier.
+    #   etags[part] (required) - array(int64) - Part number.
+    #   length - int64 - Length of file.
     #   mkdir_parents - boolean - Create parent directories if they do not exist?
-    #   part - integer - Part if uploading a part.
-    #   parts - integer - How many parts to fetch?
+    #   part - int64 - Part if uploading a part.
+    #   parts - int64 - How many parts to fetch?
     #   provided_mtime - string - User provided modification time.
     #   ref - string -
-    #   restart - integer - File byte offset to restart from.
-    #   size - integer - Size of file.
+    #   restart - int64 - File byte offset to restart from.
+    #   size - int64 - Size of file.
     #   structure - string - If copying folder, copy just the structure?
     #   with_rename - boolean - Allow file rename instead of overwrite?
     def self.create(path, params = {}, options = {})