files.com 1.0.57 → 1.0.62

data/docs/request.md

@@ -101,7 +101,8 @@ Files::Request.delete(id)
 ## List Requests
 
 ```
-request = Files::Request.find(1)
+request = Files::Request.list_for(path).first
+
 request.folders(
   page: 1,
   per_page: 1,

data/docs/site.md

@@ -262,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, 
@@ -349,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?

data/docs/sso_strategy.md

@@ -26,8 +26,21 @@
   "provision_attachments_permission": true,
   "provision_dav_permission": true,
   "provision_ftp_permission": true,
+  "provision_group_action": "disabled",
   "provision_sftp_permission": true,
-  "provision_time_zone": "Eastern Time (US & Canada)"
+  "provision_time_zone": "Eastern Time (US & Canada)",
+  "provision_user_action": "disabled",
+  "ldap_base_dn": "",
+  "ldap_domain": "mysite.com",
+  "enabled": true,
+  "ldap_host": "ldap.site.com",
+  "ldap_host_2": "ldap2.site.com",
+  "ldap_host_3": "ldap3.site.com",
+  "ldap_port": 1,
+  "ldap_secure": true,
+  "ldap_user_include_groups": "",
+  "ldap_username": "[ldap username]",
+  "ldap_username_field": "sAMAccountName"
 }
 ```
 
@@ -53,8 +66,21 @@
 * `provision_attachments_permission` (boolean): Auto-provisioned users get Sharing permission?
 * `provision_dav_permission` (boolean): Auto-provisioned users get WebDAV permission?
 * `provision_ftp_permission` (boolean): Auto-provisioned users get FTP permission?
+* `provision_group_action` (string): Should we sync groups from this strategy?
 * `provision_sftp_permission` (boolean): Auto-provisioned users get SFTP permission?
 * `provision_time_zone` (string): Default time zone for auto provisioned users.
+* `provision_user_action` (string): Should we sync users from this strategy?
+* `ldap_base_dn` (string): Base DN for looking up users in LDAP server
+* `ldap_domain` (string): Domain name that will be appended to LDAP usernames
+* `enabled` (boolean): Is strategy enabled?
+* `ldap_host` (string): LDAP host
+* `ldap_host_2` (string): LDAP backup host
+* `ldap_host_3` (string): LDAP backup host
+* `ldap_port` (int64): LDAP port
+* `ldap_secure` (boolean): Use secure LDAP?
+* `ldap_user_include_groups` (string): Comma or newline separated list of group names (with optional wildcards) - if provided, only users in these groups will be added or synced.
+* `ldap_username` (string): Username for signing in to LDAP server.
+* `ldap_username_field` (string): LDAP username field
 
 
 ---

data/docs/style.md

@@ -65,7 +65,8 @@ Files::Style.delete(path)
 ## Update Style
 
 ```
-style = Files::Style.find(1)
+style = Files::Style.list_for(path).first
+
 style.update(
   file: "file"
 )
@@ -82,7 +83,8 @@ style.update(
 ## Delete Style
 
 ```
-style = Files::Style.find(1)
+style = Files::Style.list_for(path).first
+
 style.delete
 ```
 

data/docs/user.md

@@ -371,7 +371,8 @@ Files::User.delete(id)
 ## Unlock user who has been locked out due to failed logins
 
 ```
-user = Files::User.find(1)
+user = Files::User.list_for(path).first
+
 user.unlock
 ```
 
@@ -385,7 +386,8 @@ user.unlock
 ## Resend user welcome email
 
 ```
-user = Files::User.find(1)
+user = Files::User.list_for(path).first
+
 user.resend_welcome_email
 ```
 
@@ -399,7 +401,8 @@ user.resend_welcome_email
 ## Trigger 2FA Reset process for user who has lost access to their existing 2FA methods
 
 ```
-user = Files::User.find(1)
+user = Files::User.list_for(path).first
+
 user.user_2fa_reset
 ```
 
@@ -413,7 +416,8 @@ user.user_2fa_reset
 ## Update User
 
 ```
-user = Files::User.find(1)
+user = Files::User.list_for(path).first
+
 user.update(
   avatar_delete: true,
   email: "john.doe@files.com",
@@ -498,7 +502,8 @@ user.update(
 ## Delete User
 
 ```
-user = Files::User.find(1)
+user = Files::User.list_for(path).first
+
 user.delete
 ```
 

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
@@ -191,8 +191,9 @@ module Files
     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: id must be one of String, Integer, Hash") if params.dig(:id) and [String, Integer, Hash].none? { |klass| params.dig(:id).is_a?(klass) }
       raise InvalidParameterError.new("Bad parameter: value must be an String") if params.dig(:value) and !params.dig(:value).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: attachment_file must be one of String, Integer, Hash") if params.dig(:attachment_file) and [String, Integer, Hash].none? { |klass| params.dig(:attachment_file).is_a?(klass) }
       raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
 
       response, options = Api.send_request("/behaviors/#{params[:id]}", :patch, params, options)

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 ||= {}
@@ -176,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)
@@ -194,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
@@ -210,8 +210,8 @@ 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 - Public description
@@ -234,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 ||= {}

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 = {})

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

@@ -45,10 +45,10 @@ module Files
     #
     # Parameters:
     #   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?
     #   ref - string -
-    #   restart - integer - File byte offset to restart from.
+    #   restart - int64 - File byte offset to restart from.
     #   with_rename - boolean - Allow file rename instead of overwrite?
     def begin_upload(params = {})
       params ||= {}
@@ -100,10 +100,10 @@ module Files
     #
     # Parameters:
     #   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?
     #   ref - string -
-    #   restart - integer - File byte offset to restart from.
+    #   restart - int64 - File byte offset to restart from.
     #   with_rename - boolean - Allow file rename instead of overwrite?
     def self.begin_upload(path, params = {}, options = {})
       params ||= {}

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

@@ -83,8 +83,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.
     def self.list_for(path, params = {}, options = {})

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

@@ -69,8 +69,8 @@ module Files
     end
 
     # Parameters:
-    #   user_id - integer - User ID.  Provide a value of `0` to operate the current session's user.
-    #   file_comment_id (required) - integer - ID of file comment to attach reaction to.
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    #   file_comment_id (required) - int64 - ID of file comment to attach reaction to.
     #   emoji (required) - string - Emoji to react with.
     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)

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

@@ -312,8 +312,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 - Action to take.  Can be `count`, `count_nrs` (non recursive), `size`, `permissions`, or blank.
     #   path (required) - string - Path to operate on.
     #   cursor - string - Send cursor 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 header.

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

@@ -106,8 +106,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.
     #   ids - string - Comma-separated list of group ids to include in results.
     def self.list(params = {}, options = {})
@@ -124,7 +124,7 @@ module Files
     end
 
     # Parameters:
-    #   id (required) - integer - Group ID.
+    #   id (required) - int64 - Group ID.
     def self.find(id, params = {}, options = {})
       params ||= {}
       params[:id] = id