files.com 1.0.90

data/docs/sso_strategy.md

@@ -0,0 +1,114 @@
+# SsoStrategy
+
+## Example SsoStrategy Object
+
+```
+{
+  "protocol": [
+
+  ],
+  "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": "",
+  "saml_provider_metadata_url": "",
+  "saml_provider_slo_target_url": "",
+  "saml_provider_sso_target_url": "",
+  "scim_authentication_method": "",
+  "scim_username": "",
+  "subdomain": "my-site",
+  "provision_users": true,
+  "provision_groups": true,
+  "deprovision_users": true,
+  "deprovision_groups": true,
+  "provision_group_default": "Employees",
+  "provision_group_exclusion": "Employees",
+  "provision_group_inclusion": "Employees",
+  "provision_group_required": "",
+  "provision_attachments_permission": true,
+  "provision_dav_permission": true,
+  "provision_ftp_permission": true,
+  "provision_sftp_permission": true,
+  "provision_time_zone": "Eastern Time (US & Canada)",
+  "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_username": "[ldap username]",
+  "ldap_username_field": "sAMAccountName"
+}
+```
+
+* `protocol` (array): 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
+* `saml_provider_metadata_url` (string): Metadata URL for the SAML identity provider
+* `saml_provider_slo_target_url` (string): Identity provider SLO endpoint
+* `saml_provider_sso_target_url` (string): Identity provider SSO endpoint if saml_provider_metadata_url is not available.
+* `scim_authentication_method` (string): SCIM authentication type.
+* `scim_username` (string): SCIM username.
+* `subdomain` (string): Subdomain
+* `provision_users` (boolean): Auto-provision users?
+* `provision_groups` (boolean): Auto-provision group membership based on group memberships on the SSO side?
+* `deprovision_users` (boolean): Auto-deprovision users?
+* `deprovision_groups` (boolean): Auto-deprovision group membership based on group memberships on the SSO side?
+* `provision_group_default` (string): Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
+* `provision_group_exclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
+* `provision_group_inclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
+* `provision_group_required` (string): Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
+* `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_sftp_permission` (boolean): Auto-provisioned users get SFTP permission?
+* `provision_time_zone` (string): Default time zone for auto provisioned users.
+* `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_username` (string): Username for signing in to LDAP server.
+* `ldap_username_field` (string): LDAP username field
+
+
+---
+
+## List Sso Strategies
+
+```
+Files::SsoStrategy.list(
+  page: 1, 
+  per_page: 1
+)
+```
+
+### Parameters
+
+* `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.
+
+
+---
+
+## Show Sso Strategy
+
+```
+Files::SsoStrategy.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Sso Strategy ID.

data/docs/status.md

@@ -0,0 +1,21 @@
+# Status
+
+## Example Status Object
+
+```
+{
+  "code": 200,
+  "message": "",
+  "status": "",
+  "data": "",
+  "errors": [
+
+  ]
+}
+```
+
+* `code` (int64): Status http code
+* `message` (string): Error message
+* `status` (string): Status message
+* `data`: Additional data
+* `errors` (array): A list of api errors

data/docs/style.md

@@ -0,0 +1,93 @@
+# Style
+
+## Example Style Object
+
+```
+{
+  "id": 1,
+  "path": "",
+  "logo": "",
+  "thumbnail": ""
+}
+```
+
+* `id` (int64): Style ID
+* `path` (string): Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `logo`: Logo
+* `thumbnail`: Logo thumbnail
+* `file` (file): Logo for custom branding.
+
+
+---
+
+## Show Style
+
+```
+Files::Style.find(path)
+```
+
+### Parameters
+
+* `path` (string): Required - Style path.
+
+
+---
+
+## Update Style
+
+```
+Files::Style.update(path, 
+  file: "file"
+)
+```
+
+### Parameters
+
+* `path` (string): Required - Style path.
+* `file` (file): Required - Logo for custom branding.
+
+
+---
+
+## Delete Style
+
+```
+Files::Style.delete(path)
+```
+
+### Parameters
+
+* `path` (string): Required - Style path.
+
+
+---
+
+## Update Style
+
+```
+style = Files::Style.list_for(path).first
+
+style.update(
+  file: "file"
+)
+```
+
+### Parameters
+
+* `path` (string): Required - Style path.
+* `file` (file): Required - Logo for custom branding.
+
+
+---
+
+## Delete Style
+
+```
+style = Files::Style.list_for(path).first
+
+style.delete
+```
+
+### Parameters
+
+* `path` (string): Required - Style path.

data/docs/usage_daily_snapshot.md

@@ -0,0 +1,45 @@
+# UsageDailySnapshot
+
+## Example UsageDailySnapshot Object
+
+```
+{
+  "id": 1,
+  "date": "2020-11-21",
+  "current_storage": "65536",
+  "usage_by_top_level_dir": [
+
+  ]
+}
+```
+
+* `id` (int64): ID of the usage record
+* `date` (date): The date of this usage record
+* `current_storage` (int64): The quantity of storage held for this site
+* `usage_by_top_level_dir` (array): Usage broken down by each top-level folder
+
+
+---
+
+## List Usage Daily Snapshots
+
+```
+Files::UsageDailySnapshot.list(
+  page: 1, 
+  per_page: 1
+)
+```
+
+### Parameters
+
+* `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.
+* `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-Next header.
+* `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 `site_id`, `date` or `usage_snapshot_id`.
+* `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.
+* `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `date` and `usage_snapshot_id`.
+* `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.
+* `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.
+* `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `date` and `usage_snapshot_id`.
+* `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.

data/docs/usage_snapshot.md

@@ -0,0 +1,53 @@
+# UsageSnapshot
+
+## Example UsageSnapshot Object
+
+```
+{
+  "id": 1,
+  "start_at": "2000-01-01T01:00:00Z",
+  "end_at": "2000-01-01T01:00:00Z",
+  "created_at": "2000-01-01T01:00:00Z",
+  "current_storage": "",
+  "high_water_storage": "",
+  "total_downloads": 1,
+  "total_uploads": 1,
+  "updated_at": "2000-01-01T01:00:00Z",
+  "usage_by_top_level_dir": "",
+  "root_storage": "",
+  "deleted_files_counted_in_minimum": "",
+  "deleted_files_storage": ""
+}
+```
+
+* `id` (int64): Site usage ID
+* `start_at` (date-time): Site usage report start date/time
+* `end_at` (date-time): Site usage report end date/time
+* `created_at` (date-time): Site usage report created at date/time
+* `current_storage` (double): Current site usage as of report
+* `high_water_storage` (double): Site usage report highest usage in time period
+* `total_downloads` (int64): Number of downloads in report time period
+* `total_uploads` (int64): Number of uploads in time period
+* `updated_at` (date-time): The last time this site usage report was updated
+* `usage_by_top_level_dir` (object): A map of root folders to their total usage
+* `root_storage` (double): Usage for root folder
+* `deleted_files_counted_in_minimum` (double): Usage for files that are deleted but uploaded within last 30 days
+* `deleted_files_storage` (double): Usage for files that are deleted but retained as backups
+
+
+---
+
+## List Usage Snapshots
+
+```
+Files::UsageSnapshot.list(
+  page: 1, 
+  per_page: 1
+)
+```
+
+### Parameters
+
+* `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.

data/docs/user.md

@@ -0,0 +1,535 @@
+# User
+
+## Example User Object
+
+```
+{
+  "id": 1,
+  "username": "user",
+  "admin_group_ids": [
+
+  ],
+  "allowed_ips": "127.0.0.1",
+  "attachments_permission": true,
+  "api_keys_count": 1,
+  "authenticate_until": "2000-01-01T01:00:00Z",
+  "authentication_method": "password",
+  "avatar_url": "",
+  "billing_permission": true,
+  "bypass_site_allowed_ips": true,
+  "bypass_inactive_disable": true,
+  "created_at": "2000-01-01T01:00:00Z",
+  "dav_permission": true,
+  "disabled": true,
+  "email": "john.doe@files.com",
+  "ftp_permission": true,
+  "group_ids": "",
+  "header_text": "User-specific message.",
+  "language": "en",
+  "last_login_at": "2000-01-01T01:00:00Z",
+  "last_protocol_cipher": "",
+  "lockout_expires": "2000-01-01T01:00:00Z",
+  "name": "John Doe",
+  "notes": "Internal notes on this user.",
+  "notification_daily_send_time": 18,
+  "office_integration_enabled": true,
+  "password_set_at": "2000-01-01T01:00:00Z",
+  "password_validity_days": 1,
+  "public_keys_count": 1,
+  "receive_admin_alerts": true,
+  "require_2fa": true,
+  "require_password_change": true,
+  "restapi_permission": true,
+  "self_managed": true,
+  "sftp_permission": true,
+  "site_admin": true,
+  "skip_welcome_screen": true,
+  "ssl_required": "always_require",
+  "sso_strategy_id": 1,
+  "subscribe_to_newsletter": true,
+  "externally_managed": true,
+  "time_zone": "Pacific Time (US & Canada)",
+  "type_of_2fa": "",
+  "user_root": ""
+}
+```
+
+* `id` (int64): User ID
+* `username` (string): User's username
+* `admin_group_ids` (array): List of group IDs of which this user is an administrator
+* `allowed_ips` (string): A list of allowed IPs if applicable.  Newline delimited
+* `attachments_permission` (boolean): Can the user create Bundles (aka Share Links)?  This field will be aliased or renamed in the future to `bundles_permission`.
+* `api_keys_count` (int64): Number of api keys associated with this user
+* `authenticate_until` (date-time): Scheduled Date/Time at which user will be deactivated
+* `authentication_method` (string): How is this user authenticated?
+* `avatar_url` (string): URL holding the user's avatar
+* `billing_permission` (boolean): Allow this user to perform operations on the account, payments, and invoices?
+* `bypass_site_allowed_ips` (boolean): Allow this user to skip site-wide IP blacklists?
+* `bypass_inactive_disable` (boolean): Exempt this user from being disabled based on inactivity?
+* `created_at` (date-time): When this user was created
+* `dav_permission` (boolean): Can the user connect with WebDAV?
+* `disabled` (boolean): Is user disabled? Disabled users cannot log in, and do not count for billing purposes.  Users can be automatically disabled after an inactivity period via a Site setting.
+* `email` (email): User email address
+* `ftp_permission` (boolean): Can the user access with FTP/FTPS?
+* `group_ids` (string): Comma-separated list of group IDs of which this user is a member
+* `header_text` (string): Text to display to the user in the header of the UI
+* `language` (string): Preferred language
+* `last_login_at` (date-time): User's last login time
+* `last_protocol_cipher` (string): The last protocol and cipher used
+* `lockout_expires` (date-time): Time in the future that the user will no longer be locked out if applicable
+* `name` (string): User's full name
+* `notes` (string): Any internal notes on the user
+* `notification_daily_send_time` (int64): Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
+* `office_integration_enabled` (boolean): Enable integration with Office for the web?
+* `password_set_at` (date-time): Last time the user's password was set
+* `password_validity_days` (int64): Number of days to allow user to use the same password
+* `public_keys_count` (int64): Number of public keys associated with this user
+* `receive_admin_alerts` (boolean): Should the user receive admin alerts such a certificate expiration notifications and overages?
+* `require_2fa` (boolean): Is 2fa required to sign in?
+* `require_password_change` (boolean): Is a password change required upon next user login?
+* `restapi_permission` (boolean): Can this user access the REST API?
+* `self_managed` (boolean): Does this user manage it's own credentials or is it a shared/bot user?
+* `sftp_permission` (boolean): Can the user access with SFTP?
+* `site_admin` (boolean): Is the user an administrator for this site?
+* `skip_welcome_screen` (boolean): Skip Welcome page in the UI?
+* `ssl_required` (string): SSL required setting
+* `sso_strategy_id` (int64): SSO (Single Sign On) strategy ID for the user, if applicable.
+* `subscribe_to_newsletter` (boolean): Is the user subscribed to the newsletter?
+* `externally_managed` (boolean): Is this user managed by a SsoStrategy?
+* `time_zone` (string): User time zone
+* `type_of_2fa` (string): Type(s) of 2FA methods in use.  Will be either `sms`, `totp`, `u2f`, `yubi`, or multiple values sorted alphabetically and joined by an underscore.
+* `user_root` (string): Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set.)  Note that this is not used for API, Desktop, or Web interface.
+* `avatar_file` (file): An image file for your user avatar.
+* `avatar_delete` (boolean): If true, the avatar will be deleted.
+* `change_password` (string): Used for changing a password on an existing user.
+* `change_password_confirmation` (string): Optional, but if provided, we will ensure that it matches the value sent in `change_password`.
+* `grant_permission` (string): Permission to grant on the user root.  Can be blank or `full`, `read`, `write`, `list`, or `history`.
+* `group_id` (int64): Group ID to associate this user with.
+* `password` (string): User password.
+* `password_confirmation` (string): Optional, but if provided, we will ensure that it matches the value sent in `password`.
+* `announcements_read` (boolean): Signifies that the user has read all the announcements in the UI.
+
+
+---
+
+## List Users
+
+```
+Files::User.list(
+  page: 1, 
+  per_page: 1
+)
+```
+
+### Parameters
+
+* `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.
+* `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-Next header.
+* `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 `active`, `master_admin`, `site_id`, `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `notes`, `site_admin`, `receive_admin_alerts`, `allowed_ips`, `password_validity_days`, `ssl_required` or `not_site_admin`.
+* `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `username`, `email`, `notes`, `site_admin`, `allowed_ips`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`.
+* `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `username`, `email`, `notes`, `site_admin`, `allowed_ips`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`.
+* `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `username`, `email`, `notes`, `site_admin`, `allowed_ips`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`.
+* `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `username`, `email`, `notes`, `site_admin`, `allowed_ips`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`.
+* `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `username`, `email`, `notes`, `site_admin`, `allowed_ips`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`.
+* `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `username`, `email`, `notes`, `site_admin`, `allowed_ips`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`.
+* `ids` (string): comma-separated list of User IDs
+* `q[username]` (string): List users matching username.
+* `q[email]` (string): List users matching email.
+* `q[notes]` (string): List users matching notes field.
+* `q[admin]` (string): If `true`, list only admin users.
+* `q[allowed_ips]` (string): If set, list only users with overridden allowed IP setting.
+* `q[password_validity_days]` (string): If set, list only users with overridden password validity days setting.
+* `q[ssl_required]` (string): If set, list only users with overridden SSL required setting.
+* `search` (string): Searches for partial matches of name, username, or email.
+
+
+---
+
+## Show User
+
+```
+Files::User.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - User ID.
+
+
+---
+
+## Create User
+
+```
+Files::User.create(
+  avatar_delete: true, 
+  email: "john.doe@files.com", 
+  group_id: 1, 
+  announcements_read: true, 
+  allowed_ips: "127.0.0.1", 
+  attachments_permission: true, 
+  authenticate_until: "2000-01-01T01:00:00Z", 
+  authentication_method: "password", 
+  billing_permission: true, 
+  bypass_inactive_disable: true, 
+  bypass_site_allowed_ips: true, 
+  dav_permission: true, 
+  disabled: true, 
+  ftp_permission: true, 
+  header_text: "User-specific message.", 
+  language: "en", 
+  notification_daily_send_time: 18, 
+  name: "John Doe", 
+  notes: "Internal notes on this user.", 
+  office_integration_enabled: true, 
+  password_validity_days: 1, 
+  receive_admin_alerts: true, 
+  require_password_change: true, 
+  restapi_permission: true, 
+  self_managed: true, 
+  sftp_permission: true, 
+  site_admin: true, 
+  skip_welcome_screen: true, 
+  ssl_required: "always_require", 
+  sso_strategy_id: 1, 
+  subscribe_to_newsletter: true, 
+  time_zone: "Pacific Time (US & Canada)", 
+  username: "user"
+)
+```
+
+### Parameters
+
+* `avatar_file` (file): An image file for your user avatar.
+* `avatar_delete` (boolean): If true, the avatar will be deleted.
+* `change_password` (string): Used for changing a password on an existing user.
+* `change_password_confirmation` (string): Optional, but if provided, we will ensure that it matches the value sent in `change_password`.
+* `email` (string): User's email.
+* `grant_permission` (string): Permission to grant on the user root.  Can be blank or `full`, `read`, `write`, `list`, or `history`.
+* `group_id` (int64): Group ID to associate this user with.
+* `group_ids` (string): A list of group ids to associate this user with.  Comma delimited.
+* `password` (string): User password.
+* `password_confirmation` (string): Optional, but if provided, we will ensure that it matches the value sent in `password`.
+* `announcements_read` (boolean): Signifies that the user has read all the announcements in the UI.
+* `allowed_ips` (string): A list of allowed IPs if applicable.  Newline delimited
+* `attachments_permission` (boolean): Can the user create Bundles (aka Share Links)?  This field will be aliased or renamed in the future to `bundles_permission`.
+* `authenticate_until` (string): Scheduled Date/Time at which user will be deactivated
+* `authentication_method` (string): How is this user authenticated?
+* `billing_permission` (boolean): Allow this user to perform operations on the account, payments, and invoices?
+* `bypass_inactive_disable` (boolean): Exempt this user from being disabled based on inactivity?
+* `bypass_site_allowed_ips` (boolean): Allow this user to skip site-wide IP blacklists?
+* `dav_permission` (boolean): Can the user connect with WebDAV?
+* `disabled` (boolean): Is user disabled? Disabled users cannot log in, and do not count for billing purposes.  Users can be automatically disabled after an inactivity period via a Site setting.
+* `ftp_permission` (boolean): Can the user access with FTP/FTPS?
+* `header_text` (string): Text to display to the user in the header of the UI
+* `language` (string): Preferred language
+* `notification_daily_send_time` (int64): Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
+* `name` (string): User's full name
+* `notes` (string): Any internal notes on the user
+* `office_integration_enabled` (boolean): Enable integration with Office for the web?
+* `password_validity_days` (int64): Number of days to allow user to use the same password
+* `receive_admin_alerts` (boolean): Should the user receive admin alerts such a certificate expiration notifications and overages?
+* `require_password_change` (boolean): Is a password change required upon next user login?
+* `restapi_permission` (boolean): Can this user access the REST API?
+* `self_managed` (boolean): Does this user manage it's own credentials or is it a shared/bot user?
+* `sftp_permission` (boolean): Can the user access with SFTP?
+* `site_admin` (boolean): Is the user an administrator for this site?
+* `skip_welcome_screen` (boolean): Skip Welcome page in the UI?
+* `ssl_required` (string): SSL required setting
+* `sso_strategy_id` (int64): SSO (Single Sign On) strategy ID for the user, if applicable.
+* `subscribe_to_newsletter` (boolean): Is the user subscribed to the newsletter?
+* `time_zone` (string): User time zone
+* `user_root` (string): Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set.)  Note that this is not used for API, Desktop, or Web interface.
+* `username` (string): User's username
+
+
+---
+
+## Unlock user who has been locked out due to failed logins
+
+```
+Files::User.unlock(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - User ID.
+
+
+---
+
+## Resend user welcome email
+
+```
+Files::User.resend_welcome_email(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - User ID.
+
+
+---
+
+## Trigger 2FA Reset process for user who has lost access to their existing 2FA methods
+
+```
+Files::User.user_2fa_reset(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - User ID.
+
+
+---
+
+## Update User
+
+```
+Files::User.update(id, 
+  avatar_delete: true, 
+  email: "john.doe@files.com", 
+  group_id: 1, 
+  announcements_read: true, 
+  allowed_ips: "127.0.0.1", 
+  attachments_permission: true, 
+  authenticate_until: "2000-01-01T01:00:00Z", 
+  authentication_method: "password", 
+  billing_permission: true, 
+  bypass_inactive_disable: true, 
+  bypass_site_allowed_ips: true, 
+  dav_permission: true, 
+  disabled: true, 
+  ftp_permission: true, 
+  header_text: "User-specific message.", 
+  language: "en", 
+  notification_daily_send_time: 18, 
+  name: "John Doe", 
+  notes: "Internal notes on this user.", 
+  office_integration_enabled: true, 
+  password_validity_days: 1, 
+  receive_admin_alerts: true, 
+  require_password_change: true, 
+  restapi_permission: true, 
+  self_managed: true, 
+  sftp_permission: true, 
+  site_admin: true, 
+  skip_welcome_screen: true, 
+  ssl_required: "always_require", 
+  sso_strategy_id: 1, 
+  subscribe_to_newsletter: true, 
+  time_zone: "Pacific Time (US & Canada)", 
+  username: "user"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - User ID.
+* `avatar_file` (file): An image file for your user avatar.
+* `avatar_delete` (boolean): If true, the avatar will be deleted.
+* `change_password` (string): Used for changing a password on an existing user.
+* `change_password_confirmation` (string): Optional, but if provided, we will ensure that it matches the value sent in `change_password`.
+* `email` (string): User's email.
+* `grant_permission` (string): Permission to grant on the user root.  Can be blank or `full`, `read`, `write`, `list`, or `history`.
+* `group_id` (int64): Group ID to associate this user with.
+* `group_ids` (string): A list of group ids to associate this user with.  Comma delimited.
+* `password` (string): User password.
+* `password_confirmation` (string): Optional, but if provided, we will ensure that it matches the value sent in `password`.
+* `announcements_read` (boolean): Signifies that the user has read all the announcements in the UI.
+* `allowed_ips` (string): A list of allowed IPs if applicable.  Newline delimited
+* `attachments_permission` (boolean): Can the user create Bundles (aka Share Links)?  This field will be aliased or renamed in the future to `bundles_permission`.
+* `authenticate_until` (string): Scheduled Date/Time at which user will be deactivated
+* `authentication_method` (string): How is this user authenticated?
+* `billing_permission` (boolean): Allow this user to perform operations on the account, payments, and invoices?
+* `bypass_inactive_disable` (boolean): Exempt this user from being disabled based on inactivity?
+* `bypass_site_allowed_ips` (boolean): Allow this user to skip site-wide IP blacklists?
+* `dav_permission` (boolean): Can the user connect with WebDAV?
+* `disabled` (boolean): Is user disabled? Disabled users cannot log in, and do not count for billing purposes.  Users can be automatically disabled after an inactivity period via a Site setting.
+* `ftp_permission` (boolean): Can the user access with FTP/FTPS?
+* `header_text` (string): Text to display to the user in the header of the UI
+* `language` (string): Preferred language
+* `notification_daily_send_time` (int64): Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
+* `name` (string): User's full name
+* `notes` (string): Any internal notes on the user
+* `office_integration_enabled` (boolean): Enable integration with Office for the web?
+* `password_validity_days` (int64): Number of days to allow user to use the same password
+* `receive_admin_alerts` (boolean): Should the user receive admin alerts such a certificate expiration notifications and overages?
+* `require_password_change` (boolean): Is a password change required upon next user login?
+* `restapi_permission` (boolean): Can this user access the REST API?
+* `self_managed` (boolean): Does this user manage it's own credentials or is it a shared/bot user?
+* `sftp_permission` (boolean): Can the user access with SFTP?
+* `site_admin` (boolean): Is the user an administrator for this site?
+* `skip_welcome_screen` (boolean): Skip Welcome page in the UI?
+* `ssl_required` (string): SSL required setting
+* `sso_strategy_id` (int64): SSO (Single Sign On) strategy ID for the user, if applicable.
+* `subscribe_to_newsletter` (boolean): Is the user subscribed to the newsletter?
+* `time_zone` (string): User time zone
+* `user_root` (string): Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set.)  Note that this is not used for API, Desktop, or Web interface.
+* `username` (string): User's username
+
+
+---
+
+## Delete User
+
+```
+Files::User.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - User ID.
+
+
+---
+
+## Unlock user who has been locked out due to failed logins
+
+```
+user = Files::User.list_for(path).first
+
+user.unlock
+```
+
+### Parameters
+
+* `id` (int64): Required - User ID.
+
+
+---
+
+## Resend user welcome email
+
+```
+user = Files::User.list_for(path).first
+
+user.resend_welcome_email
+```
+
+### Parameters
+
+* `id` (int64): Required - User ID.
+
+
+---
+
+## Trigger 2FA Reset process for user who has lost access to their existing 2FA methods
+
+```
+user = Files::User.list_for(path).first
+
+user.user_2fa_reset
+```
+
+### Parameters
+
+* `id` (int64): Required - User ID.
+
+
+---
+
+## Update User
+
+```
+user = Files::User.list_for(path).first
+
+user.update(
+  avatar_delete: true,
+  email: "john.doe@files.com",
+  group_id: 1,
+  announcements_read: true,
+  allowed_ips: "127.0.0.1",
+  attachments_permission: true,
+  authenticate_until: "2000-01-01T01:00:00Z",
+  authentication_method: "password",
+  billing_permission: true,
+  bypass_inactive_disable: true,
+  bypass_site_allowed_ips: true,
+  dav_permission: true,
+  disabled: true,
+  ftp_permission: true,
+  header_text: "User-specific message.",
+  language: "en",
+  notification_daily_send_time: 18,
+  name: "John Doe",
+  notes: "Internal notes on this user.",
+  office_integration_enabled: true,
+  password_validity_days: 1,
+  receive_admin_alerts: true,
+  require_password_change: true,
+  restapi_permission: true,
+  self_managed: true,
+  sftp_permission: true,
+  site_admin: true,
+  skip_welcome_screen: true,
+  ssl_required: "always_require",
+  sso_strategy_id: 1,
+  subscribe_to_newsletter: true,
+  time_zone: "Pacific Time (US & Canada)",
+  username: "user"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - User ID.
+* `avatar_file` (file): An image file for your user avatar.
+* `avatar_delete` (boolean): If true, the avatar will be deleted.
+* `change_password` (string): Used for changing a password on an existing user.
+* `change_password_confirmation` (string): Optional, but if provided, we will ensure that it matches the value sent in `change_password`.
+* `email` (string): User's email.
+* `grant_permission` (string): Permission to grant on the user root.  Can be blank or `full`, `read`, `write`, `list`, or `history`.
+* `group_id` (int64): Group ID to associate this user with.
+* `group_ids` (string): A list of group ids to associate this user with.  Comma delimited.
+* `password` (string): User password.
+* `password_confirmation` (string): Optional, but if provided, we will ensure that it matches the value sent in `password`.
+* `announcements_read` (boolean): Signifies that the user has read all the announcements in the UI.
+* `allowed_ips` (string): A list of allowed IPs if applicable.  Newline delimited
+* `attachments_permission` (boolean): Can the user create Bundles (aka Share Links)?  This field will be aliased or renamed in the future to `bundles_permission`.
+* `authenticate_until` (string): Scheduled Date/Time at which user will be deactivated
+* `authentication_method` (string): How is this user authenticated?
+* `billing_permission` (boolean): Allow this user to perform operations on the account, payments, and invoices?
+* `bypass_inactive_disable` (boolean): Exempt this user from being disabled based on inactivity?
+* `bypass_site_allowed_ips` (boolean): Allow this user to skip site-wide IP blacklists?
+* `dav_permission` (boolean): Can the user connect with WebDAV?
+* `disabled` (boolean): Is user disabled? Disabled users cannot log in, and do not count for billing purposes.  Users can be automatically disabled after an inactivity period via a Site setting.
+* `ftp_permission` (boolean): Can the user access with FTP/FTPS?
+* `header_text` (string): Text to display to the user in the header of the UI
+* `language` (string): Preferred language
+* `notification_daily_send_time` (int64): Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
+* `name` (string): User's full name
+* `notes` (string): Any internal notes on the user
+* `office_integration_enabled` (boolean): Enable integration with Office for the web?
+* `password_validity_days` (int64): Number of days to allow user to use the same password
+* `receive_admin_alerts` (boolean): Should the user receive admin alerts such a certificate expiration notifications and overages?
+* `require_password_change` (boolean): Is a password change required upon next user login?
+* `restapi_permission` (boolean): Can this user access the REST API?
+* `self_managed` (boolean): Does this user manage it's own credentials or is it a shared/bot user?
+* `sftp_permission` (boolean): Can the user access with SFTP?
+* `site_admin` (boolean): Is the user an administrator for this site?
+* `skip_welcome_screen` (boolean): Skip Welcome page in the UI?
+* `ssl_required` (string): SSL required setting
+* `sso_strategy_id` (int64): SSO (Single Sign On) strategy ID for the user, if applicable.
+* `subscribe_to_newsletter` (boolean): Is the user subscribed to the newsletter?
+* `time_zone` (string): User time zone
+* `user_root` (string): Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set.)  Note that this is not used for API, Desktop, or Web interface.
+* `username` (string): User's username
+
+
+---
+
+## Delete User
+
+```
+user = Files::User.list_for(path).first
+
+user.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - User ID.