Class: Files::Site

Inherits:
Object
  • Object
show all
Defined in:
lib/files.com/models/site.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}, options = {}) ⇒ Site

Returns a new instance of Site.



7
8
9
10
 
# File 'lib/files.com/models/site.rb', line 7

def initialize(attributes = {}, options = {})
  @attributes = attributes || {}
  @options = options || {}
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



5
6
7
 
# File 'lib/files.com/models/site.rb', line 5

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



5
6
7
 
# File 'lib/files.com/models/site.rb', line 5

def options
  @options
end

Class Method Details

.get(params = {}, options = {}) ⇒ Object 



822
823
824
825
 
# File 'lib/files.com/models/site.rb', line 822

def self.get(params = {}, options = {})
  response, options = Api.send_request("/site", :get, params, options)
  Site.new(response.data, options)
end

.get_usage(params = {}, options = {}) ⇒ Object 



827
828
829
830
 
# File 'lib/files.com/models/site.rb', line 827

def self.get_usage(params = {}, options = {})
  response, options = Api.send_request("/site/usage", :get, params, options)
  UsageSnapshot.new(response.data, options)
end

.update(params = {}, options = {}) ⇒ Object

Parameters:

name - string - Site name
subdomain - string - Site subdomain
domain - string - Custom domain
domain_hsts_header - boolean - Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
domain_letsencrypt_chain - string - Letsencrypt chain to use when registering SSL Certificate for domain.
email - string - Main email for this site
reply_to_email - string - Reply-to email for this site
allow_bundle_names - boolean - Are manual Bundle names allowed?
bundle_expiration - int64 - Site-wide Bundle expiration in days
welcome_email_enabled - boolean - Will the welcome email be sent to new users?
ask_about_overwrites - boolean - If false, rename conflicting files instead of asking for overwrite confirmation.  Only applies to web interface.
show_request_access_link - boolean - Show request access link for users without access?  Currently unused.
always_mkdir_parents - boolean - Create parent directories if they do not exist during uploads?  This is primarily used to work around broken upload clients that assume servers will perform this step.
welcome_email_cc - string - Include this email in welcome emails if enabled
welcome_email_subject - string - Include this email subject in welcome emails if enabled
welcome_custom_text - string - Custom text send in user welcome email
language - string - Site default language
windows_mode_ftp - boolean - Does FTP user Windows emulation mode?
default_time_zone - string - Site default time zone
desktop_app - boolean - Is the desktop app enabled?
desktop_app_session_ip_pinning - boolean - Is desktop app session IP pinning enabled?
desktop_app_session_lifetime - int64 - Desktop app session lifetime (in hours)
mobile_app - boolean - Is the mobile app enabled?
mobile_app_session_ip_pinning - boolean - Is mobile app session IP pinning enabled?
mobile_app_session_lifetime - int64 - Mobile 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?
office_integration_available - boolean - If true, allows users to use a document editing integration.
office_integration_type - string - Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
pin_all_remote_servers_to_site_region - boolean - If true, we will ensure that all internal communications with any remote server are made through the primary region of the site. This setting overrides individual remote server settings.
motd_text - string - A message to show users when they connect via FTP or SFTP.
motd_use_for_ftp - boolean - Show message to users connecting via FTP
motd_use_for_sftp - boolean - Show message to users connecting via SFTP
left_navigation_visibility - object - Visibility settings for account navigation
additional_text_file_types - array(string) - Additional extensions that are considered text files
bundle_require_note - boolean - Do Bundles require internal notes?
session_expiry - double - Session expiry in hours
ssl_required - boolean - Is SSL required?  Disabling this is insecure.
tls_disabled - boolean - DO NOT ENABLE. This setting allows TLSv1.0 and TLSv1.1 to be used on your site.  We intend to remove this capability entirely in early 2024.  If set, the `sftp_insecure_ciphers` flag will be automatically set to true.
sftp_insecure_ciphers - boolean - If true, we will allow weak and known insecure ciphers to be used for SFTP connections.  Enabling this setting severely weakens the security of your site and it is not recommend, except as a last resort for compatibility.
sftp_insecure_diffie_hellman - boolean - If true, we will allow weak Diffie Hellman parameters to be used within ciphers for SFTP that are otherwise on our secure list.  This has the effect of making the cipher weaker than our normal threshold for security, but is required to support certain legacy or broken SSH and MFT clients.  Enabling this weakens security, but not nearly as much as enabling the full `sftp_insecure_ciphers` option.
disable_files_certificate_generation - boolean - If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.
user_lockout - boolean - Will users be locked out after incorrect login attempts?
user_lockout_tries - int64 - Number of login tries within `user_lockout_within` hours before users are locked out
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_countries - string - Comma separated list of allowed Country codes
allowed_ips - string - List of allowed IP addresses
disallowed_countries - string - Comma separated list of disallowed Country codes
days_to_retain_backups - int64 - Number of days to keep deleted files
max_prior_passwords - int64 - Number of prior passwords to disallow
password_validity_days - int64 - Number of days password is valid
password_min_length - int64 - Shortest password length for users
password_require_letter - boolean - Require a letter in passwords?
password_require_mixed - boolean - Require lower and upper case letters in passwords?
password_require_special - boolean - Require special characters in password?
password_require_number - boolean - Require a number in passwords?
password_require_unbreached - boolean - Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
require_logout_from_bundles_and_inboxes - boolean - If true, we will hide the 'Remember Me' box on Inbox and Bundle registration pages, requiring that the user logout and log back in every time they visit the page.
dav_user_root_enabled - boolean - Use user FTP roots also for WebDAV?
sftp_user_root_enabled - boolean - Use user FTP roots also for SFTP?
disable_password_reset - boolean - Is password reset disabled?
immutable_files - boolean - Are files protected from modification?
session_pinned_by_ip - boolean - Are sessions locked to the same IP? (i.e. do users need to log in again if they change IPs?)
bundle_not_found_message - string - Custom error message to show when bundle is not found.
bundle_password_required - boolean - Do Bundles require password protection?
bundle_require_registration - boolean - Do Bundles require registration?
bundle_require_share_recipient - boolean - Do Bundles require recipients for sharing?
bundle_registration_notifications - string - Do Bundle owners receive registration notification?
bundle_activity_notifications - string - Do Bundle owners receive activity notifications?
bundle_upload_receipt_notifications - string - Do Bundle uploaders receive upload confirmation notifications?
document_edits_in_bundle_allowed - string - If true, allow public viewers of Bundles with full permissions to use document editing integrations.
password_requirements_apply_to_bundles - boolean - Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
prevent_root_permissions_for_non_site_admins - boolean - If true, we will prevent non-administrators from receiving any permissions directly on the root folder.  This is commonly used to prevent the accidental application of permissions.
opt_out_global - boolean - Use servers in the USA only?
use_provided_modified_at - boolean - Allow uploaders to set `provided_modified_at` for uploaded files?
custom_namespace - boolean - Is this site using a custom namespace for users?
disable_users_from_inactivity_period_days - int64 - If greater than zero, users will unable to login if they do not show activity within this number of days.
non_sso_groups_allowed - boolean - If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
non_sso_users_allowed - boolean - If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
sharing_enabled - boolean - Allow bundle creation
user_requests_enabled - boolean - Enable User Requests feature
user_requests_notify_admins - boolean - Send email to site admins when a user request is received?
dav_enabled - boolean - Is WebDAV enabled?
ftp_enabled - boolean - Is FTP enabled?
sftp_enabled - boolean - Is SFTP enabled?
users_can_create_api_keys - boolean - Allow users to create their own API keys?
users_can_create_ssh_keys - boolean - Allow users to create their own SSH keys?
sftp_host_key_type - string - Sftp Host Key Type
active_sftp_host_key_id - int64 - Id of the currently selected custom SFTP Host Key
protocol_access_groups_only - boolean - If true, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored.  Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
bundle_watermark_value - object - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
group_admins_can_set_user_password - boolean - Allow group admins set password authentication method
bundle_recipient_blacklist_free_email_domains - boolean - Disallow free email domains for Bundle/Inbox recipients?
bundle_recipient_blacklist_domains - array(string) - List of email domains to disallow when entering a Bundle/Inbox recipients
admins_bypass_locked_subfolders - boolean - Allow admins to bypass the locked subfolders setting.
allowed_2fa_method_sms - boolean - Is SMS two factor authentication allowed?
allowed_2fa_method_totp - boolean - Is TOTP two factor authentication allowed?
allowed_2fa_method_webauthn - boolean - Is WebAuthn two factor authentication allowed?
allowed_2fa_method_yubi - boolean - Is yubikey two factor authentication allowed?
allowed_2fa_method_email - boolean - Is OTP via email two factor authentication allowed?
allowed_2fa_method_static - boolean - Is OTP via static codes for two factor authentication allowed?
allowed_2fa_method_bypass_for_ftp_sftp_dav - boolean - Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
require_2fa - boolean - Require two-factor authentication for all users?
require_2fa_user_type - string - What type of user is required to use two-factor authentication (when require_2fa is set to `true` for this site)?
color2_top - string - Top bar background color
color2_left - string - Page link and button color
color2_link - string - Top bar link color
color2_text - string - Page link and button color
color2_top_text - string - Top bar text color
site_header - string - Custom site header text
site_footer - string - Custom site footer text
login_help_text - string - Login help text
use_dedicated_ips_for_smtp - boolean - If using custom SMTP, should we use dedicated IPs to deliver emails?
smtp_address - string - SMTP server hostname or IP
smtp_authentication - string - SMTP server authentication type
smtp_from - string - From address to use when mailing through custom SMTP
smtp_username - string - SMTP server username
smtp_port - int64 - SMTP server port
ldap_enabled - boolean - Main LDAP setting: is LDAP enabled?
ldap_type - string - LDAP type
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
ldap_domain - string - Domain name that will be appended to usernames
ldap_user_action - string - Should we sync users from LDAP server?
ldap_group_action - string - Should we sync groups from LDAP server?
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_group_exclusion - string - Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
ldap_group_inclusion - string - Comma or newline separated list of group names (with optional wildcards) to include when syncing.
ldap_base_dn - string - Base DN for looking up users in LDAP server
uploads_via_email_authentication - boolean - Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?
icon16_file - file
icon16_delete - boolean - If true, will delete the file stored in icon16
icon32_file - file
icon32_delete - boolean - If true, will delete the file stored in icon32
icon48_file - file
icon48_delete - boolean - If true, will delete the file stored in icon48
icon128_file - file
icon128_delete - boolean - If true, will delete the file stored in icon128
logo_file - file
logo_delete - boolean - If true, will delete the file stored in logo
bundle_watermark_attachment_file - file
bundle_watermark_attachment_delete - boolean - If true, will delete the file stored in bundle_watermark_attachment
login_page_background_image_file - file
login_page_background_image_delete - boolean - If true, will delete the file stored in login_page_background_image
disable_2fa_with_delay - boolean - If set to true, we will begin the process of disabling 2FA on this site.
ldap_password_change - string - New LDAP password.
ldap_password_change_confirmation - string - Confirm new LDAP password.
smtp_password - string - Password for SMTP server.
session_expiry_minutes - int64 - Session expiry in minutes

Raises:



989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
 
# File 'lib/files.com/models/site.rb', line 989

def self.update(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: subdomain must be an String") if params[:subdomain] and !params[:subdomain].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: domain must be an String") if params[:domain] and !params[:domain].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: domain_letsencrypt_chain must be an String") if params[:domain_letsencrypt_chain] and !params[:domain_letsencrypt_chain].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: email must be an String") if params[:email] and !params[:email].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: reply_to_email must be an String") if params[:reply_to_email] and !params[:reply_to_email].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: bundle_expiration must be an Integer") if params[:bundle_expiration] and !params[:bundle_expiration].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: welcome_email_cc must be an String") if params[:welcome_email_cc] and !params[:welcome_email_cc].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: welcome_email_subject must be an String") if params[:welcome_email_subject] and !params[:welcome_email_subject].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: welcome_custom_text must be an String") if params[:welcome_custom_text] and !params[:welcome_custom_text].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: language must be an String") if params[:language] and !params[:language].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: default_time_zone must be an String") if params[:default_time_zone] and !params[:default_time_zone].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: desktop_app_session_lifetime must be an Integer") if params[:desktop_app_session_lifetime] and !params[:desktop_app_session_lifetime].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: mobile_app_session_lifetime must be an Integer") if params[:mobile_app_session_lifetime] and !params[:mobile_app_session_lifetime].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: welcome_screen must be an String") if params[:welcome_screen] and !params[:welcome_screen].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: office_integration_type must be an String") if params[:office_integration_type] and !params[:office_integration_type].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: motd_text must be an String") if params[:motd_text] and !params[:motd_text].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: left_navigation_visibility must be an Hash") if params[:left_navigation_visibility] and !params[:left_navigation_visibility].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: additional_text_file_types must be an Array") if params[:additional_text_file_types] and !params[:additional_text_file_types].is_a?(Array)
  raise InvalidParameterError.new("Bad parameter: session_expiry must be an Float") if params[:session_expiry] and !params[:session_expiry].is_a?(Float)
  raise InvalidParameterError.new("Bad parameter: user_lockout_tries must be an Integer") if params[:user_lockout_tries] and !params[:user_lockout_tries].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: user_lockout_within must be an Integer") if params[:user_lockout_within] and !params[:user_lockout_within].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: user_lockout_lock_period must be an Integer") if params[:user_lockout_lock_period] and !params[:user_lockout_lock_period].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: allowed_countries must be an String") if params[:allowed_countries] and !params[:allowed_countries].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params[:allowed_ips] and !params[:allowed_ips].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: disallowed_countries must be an String") if params[:disallowed_countries] and !params[:disallowed_countries].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: days_to_retain_backups must be an Integer") if params[:days_to_retain_backups] and !params[:days_to_retain_backups].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: max_prior_passwords must be an Integer") if params[:max_prior_passwords] and !params[:max_prior_passwords].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: password_validity_days must be an Integer") if params[:password_validity_days] and !params[:password_validity_days].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: password_min_length must be an Integer") if params[:password_min_length] and !params[:password_min_length].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: bundle_not_found_message must be an String") if params[:bundle_not_found_message] and !params[:bundle_not_found_message].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: bundle_registration_notifications must be an String") if params[:bundle_registration_notifications] and !params[:bundle_registration_notifications].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: bundle_activity_notifications must be an String") if params[:bundle_activity_notifications] and !params[:bundle_activity_notifications].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: bundle_upload_receipt_notifications must be an String") if params[:bundle_upload_receipt_notifications] and !params[:bundle_upload_receipt_notifications].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: document_edits_in_bundle_allowed must be an String") if params[:document_edits_in_bundle_allowed] and !params[:document_edits_in_bundle_allowed].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: disable_users_from_inactivity_period_days must be an Integer") if params[:disable_users_from_inactivity_period_days] and !params[:disable_users_from_inactivity_period_days].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: sftp_host_key_type must be an String") if params[:sftp_host_key_type] and !params[:sftp_host_key_type].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: active_sftp_host_key_id must be an Integer") if params[:active_sftp_host_key_id] and !params[:active_sftp_host_key_id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: bundle_watermark_value must be an Hash") if params[:bundle_watermark_value] and !params[:bundle_watermark_value].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: bundle_recipient_blacklist_domains must be an Array") if params[:bundle_recipient_blacklist_domains] and !params[:bundle_recipient_blacklist_domains].is_a?(Array)
  raise InvalidParameterError.new("Bad parameter: require_2fa_user_type must be an String") if params[:require_2fa_user_type] and !params[:require_2fa_user_type].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: color2_top must be an String") if params[:color2_top] and !params[:color2_top].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: color2_left must be an String") if params[:color2_left] and !params[:color2_left].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: color2_link must be an String") if params[:color2_link] and !params[:color2_link].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: color2_text must be an String") if params[:color2_text] and !params[:color2_text].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: color2_top_text must be an String") if params[:color2_top_text] and !params[:color2_top_text].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: site_header must be an String") if params[:site_header] and !params[:site_header].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: site_footer must be an String") if params[:site_footer] and !params[:site_footer].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: login_help_text must be an String") if params[:login_help_text] and !params[:login_help_text].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: smtp_address must be an String") if params[:smtp_address] and !params[:smtp_address].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: smtp_authentication must be an String") if params[:smtp_authentication] and !params[:smtp_authentication].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: smtp_from must be an String") if params[:smtp_from] and !params[:smtp_from].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: smtp_username must be an String") if params[:smtp_username] and !params[:smtp_username].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: smtp_port must be an Integer") if params[:smtp_port] and !params[:smtp_port].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: ldap_type must be an String") if params[:ldap_type] and !params[:ldap_type].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ldap_host must be an String") if params[:ldap_host] and !params[:ldap_host].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ldap_host_2 must be an String") if params[:ldap_host_2] and !params[:ldap_host_2].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ldap_host_3 must be an String") if params[:ldap_host_3] and !params[:ldap_host_3].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ldap_port must be an Integer") if params[:ldap_port] and !params[:ldap_port].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: ldap_username must be an String") if params[:ldap_username] and !params[:ldap_username].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ldap_username_field must be an String") if params[:ldap_username_field] and !params[:ldap_username_field].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ldap_domain must be an String") if params[:ldap_domain] and !params[:ldap_domain].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ldap_user_action must be an String") if params[:ldap_user_action] and !params[:ldap_user_action].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ldap_group_action must be an String") if params[:ldap_group_action] and !params[:ldap_group_action].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ldap_user_include_groups must be an String") if params[:ldap_user_include_groups] and !params[:ldap_user_include_groups].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ldap_group_exclusion must be an String") if params[:ldap_group_exclusion] and !params[:ldap_group_exclusion].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ldap_group_inclusion must be an String") if params[:ldap_group_inclusion] and !params[:ldap_group_inclusion].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ldap_base_dn must be an String") if params[:ldap_base_dn] and !params[:ldap_base_dn].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ldap_password_change must be an String") if params[:ldap_password_change] and !params[:ldap_password_change].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ldap_password_change_confirmation must be an String") if params[:ldap_password_change_confirmation] and !params[:ldap_password_change_confirmation].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: smtp_password must be an String") if params[:smtp_password] and !params[:smtp_password].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: session_expiry_minutes must be an Integer") if params[:session_expiry_minutes] and !params[:session_expiry_minutes].is_a?(Integer)

  response, options = Api.send_request("/site", :patch, params, options)
  Site.new(response.data, options)
end

Instance Method Details

#active_sftp_host_key_id ⇒ Object

int64 - Id of the currently selected custom SFTP Host Key



623
624
625
 
# File 'lib/files.com/models/site.rb', line 623

def active_sftp_host_key_id
  @attributes[:active_sftp_host_key_id]
end

#additional_text_file_types ⇒ Object

array(string) - Additional extensions that are considered text files



23
24
25
 
# File 'lib/files.com/models/site.rb', line 23

def additional_text_file_types
  @attributes[:additional_text_file_types]
end

#admin_user_id ⇒ Object

int64 - User ID for the main site administrator



63
64
65
 
# File 'lib/files.com/models/site.rb', line 63

def admin_user_id
  @attributes[:admin_user_id]
end

#admins_bypass_locked_subfolders ⇒ Object

boolean - Allow admins to bypass the locked subfolders setting.



68
69
70
 
# File 'lib/files.com/models/site.rb', line 68

def admins_bypass_locked_subfolders
  @attributes[:admins_bypass_locked_subfolders]
end

#allow_bundle_names ⇒ Object

boolean - Are manual Bundle names allowed?



73
74
75
 
# File 'lib/files.com/models/site.rb', line 73

def allow_bundle_names
  @attributes[:allow_bundle_names]
end

#allowed_2fa_method_bypass_for_ftp_sftp_dav ⇒ Object

boolean - Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?



58
59
60
 
# File 'lib/files.com/models/site.rb', line 58

def allowed_2fa_method_bypass_for_ftp_sftp_dav
  @attributes[:allowed_2fa_method_bypass_for_ftp_sftp_dav]
end

#allowed_2fa_method_email ⇒ Object

boolean - Is OTP via email two factor authentication allowed?



48
49
50
 
# File 'lib/files.com/models/site.rb', line 48

def allowed_2fa_method_email
  @attributes[:allowed_2fa_method_email]
end

#allowed_2fa_method_sms ⇒ Object

boolean - Is SMS two factor authentication allowed?



28
29
30
 
# File 'lib/files.com/models/site.rb', line 28

def allowed_2fa_method_sms
  @attributes[:allowed_2fa_method_sms]
end

#allowed_2fa_method_static ⇒ Object

boolean - Is OTP via static codes for two factor authentication allowed?



53
54
55
 
# File 'lib/files.com/models/site.rb', line 53

def allowed_2fa_method_static
  @attributes[:allowed_2fa_method_static]
end

#allowed_2fa_method_totp ⇒ Object

boolean - Is TOTP two factor authentication allowed?



33
34
35
 
# File 'lib/files.com/models/site.rb', line 33

def allowed_2fa_method_totp
  @attributes[:allowed_2fa_method_totp]
end

#allowed_2fa_method_webauthn ⇒ Object

boolean - Is WebAuthn two factor authentication allowed?



38
39
40
 
# File 'lib/files.com/models/site.rb', line 38

def allowed_2fa_method_webauthn
  @attributes[:allowed_2fa_method_webauthn]
end

#allowed_2fa_method_yubi ⇒ Object

boolean - Is yubikey two factor authentication allowed?



43
44
45
 
# File 'lib/files.com/models/site.rb', line 43

def allowed_2fa_method_yubi
  @attributes[:allowed_2fa_method_yubi]
end

#allowed_countries ⇒ Object

string - Comma separated list of allowed Country codes



78
79
80
 
# File 'lib/files.com/models/site.rb', line 78

def allowed_countries
  @attributes[:allowed_countries]
end

#allowed_ips ⇒ Object

string - List of allowed IP addresses



83
84
85
 
# File 'lib/files.com/models/site.rb', line 83

def allowed_ips
  @attributes[:allowed_ips]
end

#always_mkdir_parents ⇒ Object

boolean - Create parent directories if they do not exist during uploads? This is primarily used to work around broken upload clients that assume servers will perform this step.



88
89
90
 
# File 'lib/files.com/models/site.rb', line 88

def always_mkdir_parents
  @attributes[:always_mkdir_parents]
end

#ask_about_overwrites ⇒ Object

boolean - If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.



93
94
95
 
# File 'lib/files.com/models/site.rb', line 93

def ask_about_overwrites
  @attributes[:ask_about_overwrites]
end

#bundle_activity_notifications ⇒ Object

string - Do Bundle owners receive activity notifications?



98
99
100
 
# File 'lib/files.com/models/site.rb', line 98

def bundle_activity_notifications
  @attributes[:bundle_activity_notifications]
end

#bundle_expiration ⇒ Object

int64 - Site-wide Bundle expiration in days



103
104
105
 
# File 'lib/files.com/models/site.rb', line 103

def bundle_expiration
  @attributes[:bundle_expiration]
end

#bundle_not_found_message ⇒ Object

string - Custom error message to show when bundle is not found.



108
109
110
 
# File 'lib/files.com/models/site.rb', line 108

def bundle_not_found_message
  @attributes[:bundle_not_found_message]
end

#bundle_password_required ⇒ Object

boolean - Do Bundles require password protection?



113
114
115
 
# File 'lib/files.com/models/site.rb', line 113

def bundle_password_required
  @attributes[:bundle_password_required]
end

#bundle_recipient_blacklist_domains ⇒ Object

array(string) - List of email domains to disallow when entering a Bundle/Inbox recipients



118
119
120
 
# File 'lib/files.com/models/site.rb', line 118

def bundle_recipient_blacklist_domains
  @attributes[:bundle_recipient_blacklist_domains]
end

#bundle_recipient_blacklist_free_email_domains ⇒ Object

boolean - Disallow free email domains for Bundle/Inbox recipients?



123
124
125
 
# File 'lib/files.com/models/site.rb', line 123

def bundle_recipient_blacklist_free_email_domains
  @attributes[:bundle_recipient_blacklist_free_email_domains]
end

#bundle_registration_notifications ⇒ Object

string - Do Bundle owners receive registration notification?



128
129
130
 
# File 'lib/files.com/models/site.rb', line 128

def bundle_registration_notifications
  @attributes[:bundle_registration_notifications]
end

#bundle_require_note ⇒ Object

boolean - Do Bundles require internal notes?



143
144
145
 
# File 'lib/files.com/models/site.rb', line 143

def bundle_require_note
  @attributes[:bundle_require_note]
end

#bundle_require_registration ⇒ Object

boolean - Do Bundles require registration?



133
134
135
 
# File 'lib/files.com/models/site.rb', line 133

def bundle_require_registration
  @attributes[:bundle_require_registration]
end

#bundle_require_share_recipient ⇒ Object

boolean - Do Bundles require recipients for sharing?



138
139
140
 
# File 'lib/files.com/models/site.rb', line 138

def bundle_require_share_recipient
  @attributes[:bundle_require_share_recipient]
end

#bundle_upload_receipt_notifications ⇒ Object

string - Do Bundle uploaders receive upload confirmation notifications?



148
149
150
 
# File 'lib/files.com/models/site.rb', line 148

def bundle_upload_receipt_notifications
  @attributes[:bundle_upload_receipt_notifications]
end

#bundle_watermark_attachment ⇒ Object

Image - Preview watermark image applied to all bundle items.



153
154
155
 
# File 'lib/files.com/models/site.rb', line 153

def bundle_watermark_attachment
  @attributes[:bundle_watermark_attachment]
end

#bundle_watermark_value ⇒ Object

object - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value



158
159
160
 
# File 'lib/files.com/models/site.rb', line 158

def bundle_watermark_value
  @attributes[:bundle_watermark_value]
end

#color2_left ⇒ Object

string - Page link and button color



168
169
170
 
# File 'lib/files.com/models/site.rb', line 168

def color2_left
  @attributes[:color2_left]
end

#color2_link ⇒ Object

string - Top bar link color



173
174
175
 
# File 'lib/files.com/models/site.rb', line 173

def color2_link
  @attributes[:color2_link]
end

#color2_text ⇒ Object

string - Page link and button color



178
179
180
 
# File 'lib/files.com/models/site.rb', line 178

def color2_text
  @attributes[:color2_text]
end

#color2_top ⇒ Object

string - Top bar background color



183
184
185
 
# File 'lib/files.com/models/site.rb', line 183

def color2_top
  @attributes[:color2_top]
end

#color2_top_text ⇒ Object

string - Top bar text color



188
189
190
 
# File 'lib/files.com/models/site.rb', line 188

def color2_top_text
  @attributes[:color2_top_text]
end

#contact_name ⇒ Object

string - Site main contact name



193
194
195
 
# File 'lib/files.com/models/site.rb', line 193

def contact_name
  @attributes[:contact_name]
end

#created_at ⇒ Object

date-time - Time this site was created



198
199
200
 
# File 'lib/files.com/models/site.rb', line 198

def created_at
  @attributes[:created_at]
end

#currency ⇒ Object

string - Preferred currency



203
204
205
 
# File 'lib/files.com/models/site.rb', line 203

def currency
  @attributes[:currency]
end

#custom_namespace ⇒ Object

boolean - Is this site using a custom namespace for users?



208
209
210
 
# File 'lib/files.com/models/site.rb', line 208

def custom_namespace
  @attributes[:custom_namespace]
end

#dav_enabled ⇒ Object

boolean - Is WebDAV enabled?



213
214
215
 
# File 'lib/files.com/models/site.rb', line 213

def dav_enabled
  @attributes[:dav_enabled]
end

#dav_user_root_enabled ⇒ Object

boolean - Use user FTP roots also for WebDAV?



218
219
220
 
# File 'lib/files.com/models/site.rb', line 218

def dav_user_root_enabled
  @attributes[:dav_user_root_enabled]
end

#days_to_retain_backups ⇒ Object

int64 - Number of days to keep deleted files



223
224
225
 
# File 'lib/files.com/models/site.rb', line 223

def days_to_retain_backups
  @attributes[:days_to_retain_backups]
end

#default_time_zone ⇒ Object

string - Site default time zone



233
234
235
 
# File 'lib/files.com/models/site.rb', line 233

def default_time_zone
  @attributes[:default_time_zone]
end

#desktop_app ⇒ Object

boolean - Is the desktop app enabled?



238
239
240
 
# File 'lib/files.com/models/site.rb', line 238

def desktop_app
  @attributes[:desktop_app]
end

#desktop_app_session_ip_pinning ⇒ Object

boolean - Is desktop app session IP pinning enabled?



243
244
245
 
# File 'lib/files.com/models/site.rb', line 243

def desktop_app_session_ip_pinning
  @attributes[:desktop_app_session_ip_pinning]
end

#desktop_app_session_lifetime ⇒ Object

int64 - Desktop app session lifetime (in hours)



248
249
250
 
# File 'lib/files.com/models/site.rb', line 248

def desktop_app_session_lifetime
  @attributes[:desktop_app_session_lifetime]
end

#disable_files_certificate_generation ⇒ Object

boolean - If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.



273
274
275
 
# File 'lib/files.com/models/site.rb', line 273

def disable_files_certificate_generation
  @attributes[:disable_files_certificate_generation]
end

#disable_notifications ⇒ Object

boolean - Are notifications disabled?



278
279
280
 
# File 'lib/files.com/models/site.rb', line 278

def disable_notifications
  @attributes[:disable_notifications]
end

#disable_password_reset ⇒ Object

boolean - Is password reset disabled?



283
284
285
 
# File 'lib/files.com/models/site.rb', line 283

def disable_password_reset
  @attributes[:disable_password_reset]
end

#disable_users_from_inactivity_period_days ⇒ Object

int64 - If greater than zero, users will unable to login if they do not show activity within this number of days.



813
814
815
 
# File 'lib/files.com/models/site.rb', line 813

def disable_users_from_inactivity_period_days
  @attributes[:disable_users_from_inactivity_period_days]
end

#disallowed_countries ⇒ Object

string - Comma separated list of disallowed Country codes



268
269
270
 
# File 'lib/files.com/models/site.rb', line 268

def disallowed_countries
  @attributes[:disallowed_countries]
end

#document_edits_in_bundle_allowed ⇒ Object

string - If true, allow public viewers of Bundles with full permissions to use document editing integrations.



228
229
230
 
# File 'lib/files.com/models/site.rb', line 228

def document_edits_in_bundle_allowed
  @attributes[:document_edits_in_bundle_allowed]
end

#domain ⇒ Object

string - Custom domain



288
289
290
 
# File 'lib/files.com/models/site.rb', line 288

def domain
  @attributes[:domain]
end

#domain_hsts_header ⇒ Object

boolean - Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?



293
294
295
 
# File 'lib/files.com/models/site.rb', line 293

def domain_hsts_header
  @attributes[:domain_hsts_header]
end

#domain_letsencrypt_chain ⇒ Object

string - Letsencrypt chain to use when registering SSL Certificate for domain.



298
299
300
 
# File 'lib/files.com/models/site.rb', line 298

def domain_letsencrypt_chain
  @attributes[:domain_letsencrypt_chain]
end

#email ⇒ Object

email - Main email for this site



303
304
305
 
# File 'lib/files.com/models/site.rb', line 303

def email
  @attributes[:email]
end

#folder_permissions_groups_only ⇒ Object

boolean - If true, permissions for this site must be bound to a group (not a user). Otherwise, permissions must be bound to a user.



328
329
330
 
# File 'lib/files.com/models/site.rb', line 328

def folder_permissions_groups_only
  @attributes[:folder_permissions_groups_only]
end

#ftp_enabled ⇒ Object

boolean - Is FTP enabled?



308
309
310
 
# File 'lib/files.com/models/site.rb', line 308

def ftp_enabled
  @attributes[:ftp_enabled]
end

#group_admins_can_set_user_password ⇒ Object

boolean - Allow group admins set password authentication method



818
819
820
 
# File 'lib/files.com/models/site.rb', line 818

def group_admins_can_set_user_password
  @attributes[:group_admins_can_set_user_password]
end

#hipaa ⇒ Object

boolean - Is there a signed HIPAA BAA between Files.com and this site?



333
334
335
 
# File 'lib/files.com/models/site.rb', line 333

def hipaa
  @attributes[:hipaa]
end

#icon128 ⇒ Object

Image - Branded icon 128x128



338
339
340
 
# File 'lib/files.com/models/site.rb', line 338

def icon128
  @attributes[:icon128]
end

#icon16 ⇒ Object

Image - Branded icon 16x16



343
344
345
 
# File 'lib/files.com/models/site.rb', line 343

def icon16
  @attributes[:icon16]
end

#icon32 ⇒ Object

Image - Branded icon 32x32



348
349
350
 
# File 'lib/files.com/models/site.rb', line 348

def icon32
  @attributes[:icon32]
end

#icon48 ⇒ Object

Image - Branded icon 48x48



353
354
355
 
# File 'lib/files.com/models/site.rb', line 353

def icon48
  @attributes[:icon48]
end

#id ⇒ Object

int64 - Site Id



13
14
15
 
# File 'lib/files.com/models/site.rb', line 13

def id
  @attributes[:id]
end

#immutable_files_set_at ⇒ Object

date-time - Can files be modified?



358
359
360
 
# File 'lib/files.com/models/site.rb', line 358

def immutable_files_set_at
  @attributes[:immutable_files_set_at]
end

#include_password_in_welcome_email ⇒ Object

boolean - Include password in emails to new users?



363
364
365
 
# File 'lib/files.com/models/site.rb', line 363

def include_password_in_welcome_email
  @attributes[:include_password_in_welcome_email]
end

#language ⇒ Object

string - Site default language



368
369
370
 
# File 'lib/files.com/models/site.rb', line 368

def language
  @attributes[:language]
end

#ldap_base_dn ⇒ Object

string - Base DN for looking up users in LDAP server



373
374
375
 
# File 'lib/files.com/models/site.rb', line 373

def ldap_base_dn
  @attributes[:ldap_base_dn]
end

#ldap_domain ⇒ Object

string - Domain name that will be appended to usernames



378
379
380
 
# File 'lib/files.com/models/site.rb', line 378

def ldap_domain
  @attributes[:ldap_domain]
end

#ldap_enabled ⇒ Object

boolean - Main LDAP setting: is LDAP enabled?



383
384
385
 
# File 'lib/files.com/models/site.rb', line 383

def ldap_enabled
  @attributes[:ldap_enabled]
end

#ldap_group_action ⇒ Object

string - Should we sync groups from LDAP server?



388
389
390
 
# File 'lib/files.com/models/site.rb', line 388

def ldap_group_action
  @attributes[:ldap_group_action]
end

#ldap_group_exclusion ⇒ Object

string - Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.



393
394
395
 
# File 'lib/files.com/models/site.rb', line 393

def ldap_group_exclusion
  @attributes[:ldap_group_exclusion]
end

#ldap_group_inclusion ⇒ Object

string - Comma or newline separated list of group names (with optional wildcards) to include when syncing.



398
399
400
 
# File 'lib/files.com/models/site.rb', line 398

def ldap_group_inclusion
  @attributes[:ldap_group_inclusion]
end

#ldap_host ⇒ Object

string - LDAP host



403
404
405
 
# File 'lib/files.com/models/site.rb', line 403

def ldap_host
  @attributes[:ldap_host]
end

#ldap_host_2 ⇒ Object

string - LDAP backup host



408
409
410
 
# File 'lib/files.com/models/site.rb', line 408

def ldap_host_2
  @attributes[:ldap_host_2]
end

#ldap_host_3 ⇒ Object

string - LDAP backup host



413
414
415
 
# File 'lib/files.com/models/site.rb', line 413

def ldap_host_3
  @attributes[:ldap_host_3]
end

#ldap_port ⇒ Object

int64 - LDAP port



418
419
420
 
# File 'lib/files.com/models/site.rb', line 418

def ldap_port
  @attributes[:ldap_port]
end

#ldap_secure ⇒ Object

boolean - Use secure LDAP?



423
424
425
 
# File 'lib/files.com/models/site.rb', line 423

def ldap_secure
  @attributes[:ldap_secure]
end

#ldap_type ⇒ Object

string - LDAP type



428
429
430
 
# File 'lib/files.com/models/site.rb', line 428

def ldap_type
  @attributes[:ldap_type]
end

#ldap_user_action ⇒ Object

string - Should we sync users from LDAP server?



433
434
435
 
# File 'lib/files.com/models/site.rb', line 433

def ldap_user_action
  @attributes[:ldap_user_action]
end

#ldap_user_include_groups ⇒ Object

string - Comma or newline separated list of group names (with optional wildcards) - if provided, only users in these groups will be added or synced.



438
439
440
 
# File 'lib/files.com/models/site.rb', line 438

def ldap_user_include_groups
  @attributes[:ldap_user_include_groups]
end

#ldap_username ⇒ Object

string - Username for signing in to LDAP server.



443
444
445
 
# File 'lib/files.com/models/site.rb', line 443

def ldap_username
  @attributes[:ldap_username]
end

#ldap_username_field ⇒ Object

string - LDAP username field



448
449
450
 
# File 'lib/files.com/models/site.rb', line 448

def ldap_username_field
  @attributes[:ldap_username_field]
end

#login_help_text ⇒ Object

string - Login help text



453
454
455
 
# File 'lib/files.com/models/site.rb', line 453

def 
  @attributes[:login_help_text]
end

#login_page_background_image ⇒ Object

Image - Branded login page background



463
464
465
 
# File 'lib/files.com/models/site.rb', line 463

def 
  @attributes[:login_page_background_image]
end

#logo ⇒ Object

Image - Branded logo



458
459
460
 
# File 'lib/files.com/models/site.rb', line 458

def 
  @attributes[:logo]
end

#max_prior_passwords ⇒ Object

int64 - Number of prior passwords to disallow



468
469
470
 
# File 'lib/files.com/models/site.rb', line 468

def max_prior_passwords
  @attributes[:max_prior_passwords]
end

#mobile_app ⇒ Object

boolean - Is the mobile app enabled?



253
254
255
 
# File 'lib/files.com/models/site.rb', line 253

def mobile_app
  @attributes[:mobile_app]
end

#mobile_app_session_ip_pinning ⇒ Object

boolean - Is mobile app session IP pinning enabled?



258
259
260
 
# File 'lib/files.com/models/site.rb', line 258

def mobile_app_session_ip_pinning
  @attributes[:mobile_app_session_ip_pinning]
end

#mobile_app_session_lifetime ⇒ Object

int64 - Mobile app session lifetime (in hours)



263
264
265
 
# File 'lib/files.com/models/site.rb', line 263

def mobile_app_session_lifetime
  @attributes[:mobile_app_session_lifetime]
end

#motd_text ⇒ Object

string - A message to show users when they connect via FTP or SFTP.



473
474
475
 
# File 'lib/files.com/models/site.rb', line 473

def motd_text
  @attributes[:motd_text]
end

#motd_use_for_ftp ⇒ Object

boolean - Show message to users connecting via FTP



478
479
480
 
# File 'lib/files.com/models/site.rb', line 478

def motd_use_for_ftp
  @attributes[:motd_use_for_ftp]
end

#motd_use_for_sftp ⇒ Object

boolean - Show message to users connecting via SFTP



483
484
485
 
# File 'lib/files.com/models/site.rb', line 483

def motd_use_for_sftp
  @attributes[:motd_use_for_sftp]
end

#name ⇒ Object

string - Site name



18
19
20
 
# File 'lib/files.com/models/site.rb', line 18

def name
  @attributes[:name]
end

#next_billing_amount ⇒ Object

double - Next billing amount



488
489
490
 
# File 'lib/files.com/models/site.rb', line 488

def next_billing_amount
  @attributes[:next_billing_amount]
end

#next_billing_date ⇒ Object

string - Next billing date



493
494
495
 
# File 'lib/files.com/models/site.rb', line 493

def next_billing_date
  @attributes[:next_billing_date]
end

#non_sso_groups_allowed ⇒ Object

boolean - If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.



318
319
320
 
# File 'lib/files.com/models/site.rb', line 318

def non_sso_groups_allowed
  @attributes[:non_sso_groups_allowed]
end

#non_sso_users_allowed ⇒ Object

boolean - If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.



323
324
325
 
# File 'lib/files.com/models/site.rb', line 323

def non_sso_users_allowed
  @attributes[:non_sso_users_allowed]
end

#office_integration_available ⇒ Object

boolean - If true, allows users to use a document editing integration.



498
499
500
 
# File 'lib/files.com/models/site.rb', line 498

def office_integration_available
  @attributes[:office_integration_available]
end

#office_integration_type ⇒ Object

string - Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.



503
504
505
 
# File 'lib/files.com/models/site.rb', line 503

def office_integration_type
  @attributes[:office_integration_type]
end

#oncehub_link ⇒ Object

string - Link to scheduling a meeting with our Sales team



508
509
510
 
# File 'lib/files.com/models/site.rb', line 508

def oncehub_link
  @attributes[:oncehub_link]
end

#opt_out_global ⇒ Object

boolean - Use servers in the USA only?



513
514
515
 
# File 'lib/files.com/models/site.rb', line 513

def opt_out_global
  @attributes[:opt_out_global]
end

#overdue ⇒ Object

boolean - Is this site’s billing overdue?



518
519
520
 
# File 'lib/files.com/models/site.rb', line 518

def overdue
  @attributes[:overdue]
end

#password_min_length ⇒ Object

int64 - Shortest password length for users



523
524
525
 
# File 'lib/files.com/models/site.rb', line 523

def password_min_length
  @attributes[:password_min_length]
end

#password_require_letter ⇒ Object

boolean - Require a letter in passwords?



528
529
530
 
# File 'lib/files.com/models/site.rb', line 528

def password_require_letter
  @attributes[:password_require_letter]
end

#password_require_mixed ⇒ Object

boolean - Require lower and upper case letters in passwords?



533
534
535
 
# File 'lib/files.com/models/site.rb', line 533

def password_require_mixed
  @attributes[:password_require_mixed]
end

#password_require_number ⇒ Object

boolean - Require a number in passwords?



538
539
540
 
# File 'lib/files.com/models/site.rb', line 538

def password_require_number
  @attributes[:password_require_number]
end

#password_require_special ⇒ Object

boolean - Require special characters in password?



543
544
545
 
# File 'lib/files.com/models/site.rb', line 543

def password_require_special
  @attributes[:password_require_special]
end

#password_require_unbreached ⇒ Object

boolean - Require passwords that have not been previously breached? (see haveibeenpwned.com/)



548
549
550
 
# File 'lib/files.com/models/site.rb', line 548

def password_require_unbreached
  @attributes[:password_require_unbreached]
end

#password_requirements_apply_to_bundles ⇒ Object

boolean - Require bundles’ passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users’ passwords?



553
554
555
 
# File 'lib/files.com/models/site.rb', line 553

def password_requirements_apply_to_bundles
  @attributes[:password_requirements_apply_to_bundles]
end

#password_validity_days ⇒ Object

int64 - Number of days password is valid



558
559
560
 
# File 'lib/files.com/models/site.rb', line 558

def password_validity_days
  @attributes[:password_validity_days]
end

#phone ⇒ Object

string - Site phone number



563
564
565
 
# File 'lib/files.com/models/site.rb', line 563

def phone
  @attributes[:phone]
end

#pin_all_remote_servers_to_site_region ⇒ Object

boolean - If true, we will ensure that all internal communications with any remote server are made through the primary region of the site. This setting overrides individual remote server settings.



568
569
570
 
# File 'lib/files.com/models/site.rb', line 568

def pin_all_remote_servers_to_site_region
  @attributes[:pin_all_remote_servers_to_site_region]
end

#prevent_root_permissions_for_non_site_admins ⇒ Object

boolean - If true, we will prevent non-administrators from receiving any permissions directly on the root folder. This is commonly used to prevent the accidental application of permissions.



573
574
575
 
# File 'lib/files.com/models/site.rb', line 573

def prevent_root_permissions_for_non_site_admins
  @attributes[:prevent_root_permissions_for_non_site_admins]
end

#protocol_access_groups_only ⇒ Object

boolean - If true, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored. Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.



578
579
580
 
# File 'lib/files.com/models/site.rb', line 578

def protocol_access_groups_only
  @attributes[:protocol_access_groups_only]
end

#reply_to_email ⇒ Object

email - Reply-to email for this site



313
314
315
 
# File 'lib/files.com/models/site.rb', line 313

def reply_to_email
  @attributes[:reply_to_email]
end

#require_2fa ⇒ Object

boolean - Require two-factor authentication for all users?



583
584
585
 
# File 'lib/files.com/models/site.rb', line 583

def require_2fa
  @attributes[:require_2fa]
end

#require_2fa_stop_time ⇒ Object

date-time - If set, requirement for two-factor authentication has been scheduled to end on this date-time.



588
589
590
 
# File 'lib/files.com/models/site.rb', line 588

def require_2fa_stop_time
  @attributes[:require_2fa_stop_time]
end

#require_2fa_user_type ⇒ Object

string - What type of user is required to use two-factor authentication (when require_2fa is set to ‘true` for this site)?



593
594
595
 
# File 'lib/files.com/models/site.rb', line 593

def require_2fa_user_type
  @attributes[:require_2fa_user_type]
end

#require_logout_from_bundles_and_inboxes ⇒ Object

boolean - If true, we will hide the ‘Remember Me’ box on Inbox and Bundle registration pages, requiring that the user logout and log back in every time they visit the page.



598
599
600
 
# File 'lib/files.com/models/site.rb', line 598

def require_logout_from_bundles_and_inboxes
  @attributes[:require_logout_from_bundles_and_inboxes]
end

#session ⇒ Object

Session - Current session



603
604
605
 
# File 'lib/files.com/models/site.rb', line 603

def session
  @attributes[:session]
end

#session_expiry ⇒ Object

double - Session expiry in hours



688
689
690
 
# File 'lib/files.com/models/site.rb', line 688

def session_expiry
  @attributes[:session_expiry]
end

#session_expiry_minutes ⇒ Object

int64 - Session expiry in minutes



693
694
695
 
# File 'lib/files.com/models/site.rb', line 693

def session_expiry_minutes
  @attributes[:session_expiry_minutes]
end

#session_pinned_by_ip ⇒ Object

boolean - Are sessions locked to the same IP? (i.e. do users need to log in again if they change IPs?)



608
609
610
 
# File 'lib/files.com/models/site.rb', line 608

def session_pinned_by_ip
  @attributes[:session_pinned_by_ip]
end

#sftp_enabled ⇒ Object

boolean - Is SFTP enabled?



613
614
615
 
# File 'lib/files.com/models/site.rb', line 613

def sftp_enabled
  @attributes[:sftp_enabled]
end

#sftp_host_key_type ⇒ Object

string - Sftp Host Key Type



618
619
620
 
# File 'lib/files.com/models/site.rb', line 618

def sftp_host_key_type
  @attributes[:sftp_host_key_type]
end

#sftp_insecure_ciphers ⇒ Object

boolean - If true, we will allow weak and known insecure ciphers to be used for SFTP connections. Enabling this setting severely weakens the security of your site and it is not recommend, except as a last resort for compatibility.



628
629
630
 
# File 'lib/files.com/models/site.rb', line 628

def sftp_insecure_ciphers
  @attributes[:sftp_insecure_ciphers]
end

#sftp_insecure_diffie_hellman ⇒ Object

boolean - If true, we will allow weak Diffie Hellman parameters to be used within ciphers for SFTP that are otherwise on our secure list. This has the effect of making the cipher weaker than our normal threshold for security, but is required to support certain legacy or broken SSH and MFT clients. Enabling this weakens security, but not nearly as much as enabling the full ‘sftp_insecure_ciphers` option.



633
634
635
 
# File 'lib/files.com/models/site.rb', line 633

def sftp_insecure_diffie_hellman
  @attributes[:sftp_insecure_diffie_hellman]
end

#sftp_user_root_enabled ⇒ Object

boolean - Use user FTP roots also for SFTP?



638
639
640
 
# File 'lib/files.com/models/site.rb', line 638

def sftp_user_root_enabled
  @attributes[:sftp_user_root_enabled]
end

#sharing_enabled ⇒ Object

boolean - Allow bundle creation



643
644
645
 
# File 'lib/files.com/models/site.rb', line 643

def sharing_enabled
  @attributes[:sharing_enabled]
end

#show_request_access_link ⇒ Object

boolean - Show request access link for users without access? Currently unused.



648
649
650
 
# File 'lib/files.com/models/site.rb', line 648

def show_request_access_link
  @attributes[:show_request_access_link]
end

#site_footer ⇒ Object

string - Custom site footer text



653
654
655
 
# File 'lib/files.com/models/site.rb', line 653

def site_footer
  @attributes[:site_footer]
end

#site_header ⇒ Object

string - Custom site header text



658
659
660
 
# File 'lib/files.com/models/site.rb', line 658

def site_header
  @attributes[:site_header]
end

#smtp_address ⇒ Object

string - SMTP server hostname or IP



663
664
665
 
# File 'lib/files.com/models/site.rb', line 663

def smtp_address
  @attributes[:smtp_address]
end

#smtp_authentication ⇒ Object

string - SMTP server authentication type



668
669
670
 
# File 'lib/files.com/models/site.rb', line 668

def smtp_authentication
  @attributes[:smtp_authentication]
end

#smtp_from ⇒ Object

string - From address to use when mailing through custom SMTP



673
674
675
 
# File 'lib/files.com/models/site.rb', line 673

def smtp_from
  @attributes[:smtp_from]
end

#smtp_port ⇒ Object

int64 - SMTP server port



678
679
680
 
# File 'lib/files.com/models/site.rb', line 678

def smtp_port
  @attributes[:smtp_port]
end

#smtp_username ⇒ Object

string - SMTP server username



683
684
685
 
# File 'lib/files.com/models/site.rb', line 683

def smtp_username
  @attributes[:smtp_username]
end

#ssl_required ⇒ Object

boolean - Is SSL required? Disabling this is insecure.



698
699
700
 
# File 'lib/files.com/models/site.rb', line 698

def ssl_required
  @attributes[:ssl_required]
end

#subdomain ⇒ Object

string - Site subdomain



703
704
705
 
# File 'lib/files.com/models/site.rb', line 703

def subdomain
  @attributes[:subdomain]
end

#switch_to_plan_date ⇒ Object

date-time - If switching plans, when does the new plan take effect?



708
709
710
 
# File 'lib/files.com/models/site.rb', line 708

def switch_to_plan_date
  @attributes[:switch_to_plan_date]
end

#tls_disabled ⇒ Object

boolean - DO NOT ENABLE. This setting allows TLSv1.0 and TLSv1.1 to be used on your site. We intend to remove this capability entirely in early 2024. If set, the ‘sftp_insecure_ciphers` flag will be automatically set to true.



713
714
715
 
# File 'lib/files.com/models/site.rb', line 713

def tls_disabled
  @attributes[:tls_disabled]
end

#trial_days_left ⇒ Object

int64 - Number of days left in trial



718
719
720
 
# File 'lib/files.com/models/site.rb', line 718

def trial_days_left
  @attributes[:trial_days_left]
end

#trial_until ⇒ Object

date-time - When does this Site trial expire?



723
724
725
 
# File 'lib/files.com/models/site.rb', line 723

def trial_until
  @attributes[:trial_until]
end

#uploads_via_email_authentication ⇒ Object

boolean - Do incoming emails in the Inboxes require checking for SPF/DKIM/DMARC?



163
164
165
 
# File 'lib/files.com/models/site.rb', line 163

def uploads_via_email_authentication
  @attributes[:uploads_via_email_authentication]
end

#use_dedicated_ips_for_smtp ⇒ Object

boolean - If using custom SMTP, should we use dedicated IPs to deliver emails?



728
729
730
 
# File 'lib/files.com/models/site.rb', line 728

def use_dedicated_ips_for_smtp
  @attributes[:use_dedicated_ips_for_smtp]
end

#use_provided_modified_at ⇒ Object

boolean - Allow uploaders to set ‘provided_modified_at` for uploaded files?



733
734
735
 
# File 'lib/files.com/models/site.rb', line 733

def use_provided_modified_at
  @attributes[:use_provided_modified_at]
end

#user ⇒ Object

User - User of current session



738
739
740
 
# File 'lib/files.com/models/site.rb', line 738

def user
  @attributes[:user]
end

#user_lockout ⇒ Object

boolean - Will users be locked out after incorrect login attempts?



743
744
745
 
# File 'lib/files.com/models/site.rb', line 743

def user_lockout
  @attributes[:user_lockout]
end

#user_lockout_lock_period ⇒ Object

int64 - How many hours to lock user out for failed password?



748
749
750
 
# File 'lib/files.com/models/site.rb', line 748

def user_lockout_lock_period
  @attributes[:user_lockout_lock_period]
end

#user_lockout_tries ⇒ Object

int64 - Number of login tries within ‘user_lockout_within` hours before users are locked out



753
754
755
 
# File 'lib/files.com/models/site.rb', line 753

def user_lockout_tries
  @attributes[:user_lockout_tries]
end

#user_lockout_within ⇒ Object

int64 - Number of hours for user lockout window



758
759
760
 
# File 'lib/files.com/models/site.rb', line 758

def user_lockout_within
  @attributes[:user_lockout_within]
end

#user_requests_enabled ⇒ Object

boolean - Enable User Requests feature



763
764
765
 
# File 'lib/files.com/models/site.rb', line 763

def user_requests_enabled
  @attributes[:user_requests_enabled]
end

#user_requests_notify_admins ⇒ Object

boolean - Send email to site admins when a user request is received?



768
769
770
 
# File 'lib/files.com/models/site.rb', line 768

def user_requests_notify_admins
  @attributes[:user_requests_notify_admins]
end

#users_can_create_api_keys ⇒ Object

boolean - Allow users to create their own API keys?



773
774
775
 
# File 'lib/files.com/models/site.rb', line 773

def users_can_create_api_keys
  @attributes[:users_can_create_api_keys]
end

#users_can_create_ssh_keys ⇒ Object

boolean - Allow users to create their own SSH keys?



778
779
780
 
# File 'lib/files.com/models/site.rb', line 778

def users_can_create_ssh_keys
  @attributes[:users_can_create_ssh_keys]
end

#welcome_custom_text ⇒ Object

string - Custom text send in user welcome email



783
784
785
 
# File 'lib/files.com/models/site.rb', line 783

def welcome_custom_text
  @attributes[:welcome_custom_text]
end

#welcome_email_cc ⇒ Object

email - Include this email in welcome emails if enabled



788
789
790
 
# File 'lib/files.com/models/site.rb', line 788

def welcome_email_cc
  @attributes[:welcome_email_cc]
end

#welcome_email_enabled ⇒ Object

boolean - Will the welcome email be sent to new users?



798
799
800
 
# File 'lib/files.com/models/site.rb', line 798

def welcome_email_enabled
  @attributes[:welcome_email_enabled]
end

#welcome_email_subject ⇒ Object

string - Include this email subject in welcome emails if enabled



793
794
795
 
# File 'lib/files.com/models/site.rb', line 793

def welcome_email_subject
  @attributes[:welcome_email_subject]
end

#welcome_screen ⇒ Object

string - Does the welcome screen appear?



803
804
805
 
# File 'lib/files.com/models/site.rb', line 803

def welcome_screen
  @attributes[:welcome_screen]
end

#windows_mode_ftp ⇒ Object

boolean - Does FTP user Windows emulation mode?



808
809
810
 
# File 'lib/files.com/models/site.rb', line 808

def windows_mode_ftp
  @attributes[:windows_mode_ftp]
end