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.



9
10
11
12
 
# File 'lib/files.com/models/site.rb', line 9

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

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



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

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



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

def options
  @options
end

Class Method Details

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



927
928
929
930
 
# File 'lib/files.com/models/site.rb', line 927

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 



932
933
934
935
 
# File 'lib/files.com/models/site.rb', line 932

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).
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?
bundle_send_shared_receipts - boolean - Do Bundle creators receive receipts of invitations?
calculate_file_checksums_crc32 - boolean - Calculate CRC32 checksums for files?
calculate_file_checksums_md5 - boolean - Calculate MD5 checksums for files?
calculate_file_checksums_sha1 - boolean - Calculate SHA1 checksums for files?
calculate_file_checksums_sha256 - boolean - Calculate SHA256 checksums for files?
legacy_checksums_mode - boolean - Use legacy checksums mode?
migrate_remote_server_sync_to_sync - boolean - If true, we will migrate all remote server syncs to the new Sync model.
as2_message_retention_days - int64 - Number of days to retain AS2 messages (incoming and outgoing).
session_expiry_minutes - int64 - Session expiry in minutes
ssl_required - boolean - Is SSL required?  Disabling this is insecure.
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
allow_user_level_2fa_override - boolean - Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
allow_user_level_allowed_ip_override - boolean - Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
allow_user_level_ssl_override - boolean - Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
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?
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 - boolean - 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?
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
snapshot_sharing_enabled - boolean - Allow snapshot share links 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?
sftp_finalize_partial_uploads - boolean - Finalize partial SFTP uploads from interrupted connections? Default: true.
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?
show_user_notifications_log_in_link - boolean - Show log in link in user notifications?
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.
revoke_bundle_access_on_disable_or_delete - boolean - Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
bundle_watermark_value - object - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
group_admins_can_add_users - boolean - Allow group admins to create users in their groups
group_admins_can_delete_users - boolean - Allow group admins to delete users in their groups
group_admins_can_enable_disable_users - boolean - Allow group admins to enable or disable users in their groups
group_admins_can_modify_users - boolean - Allow group admins to modify users in their groups
group_admins_can_reset_passwords - boolean - Allow group admins to reset passwords for users in their groups
group_admins_can_set_user_password - boolean - Allow group admins to 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 for authenticated pages
site_footer - string - Custom site footer text for authenticated pages
site_public_header - string - Custom site header text for public pages
site_public_footer - string - Custom site footer text for public pages
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?
email_footer_custom_text - string - Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
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.

Raises:



1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'lib/files.com/models/site.rb', line 1113

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: as2_message_retention_days must be an Integer") if params[:as2_message_retention_days] and !params[:as2_message_retention_days].is_a?(Integer)
  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)
  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: 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: site_public_header must be an String") if params[:site_public_header] and !params[:site_public_header].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: site_public_footer must be an String") if params[:site_public_footer] and !params[:site_public_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: email_footer_custom_text must be an String") if params[:email_footer_custom_text] and !params[:email_footer_custom_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)

  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



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

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



25
26
27
 
# File 'lib/files.com/models/site.rb', line 25

def additional_text_file_types
  @attributes[:additional_text_file_types]
end

#admin_user_id ⇒ Object

int64 - User ID for the main site administrator



65
66
67
 
# File 'lib/files.com/models/site.rb', line 65

def admin_user_id
  @attributes[:admin_user_id]
end

#admins_bypass_locked_subfolders ⇒ Object

boolean - Allow admins to bypass the locked subfolders setting.



70
71
72
 
# File 'lib/files.com/models/site.rb', line 70

def admins_bypass_locked_subfolders
  @attributes[:admins_bypass_locked_subfolders]
end

#allow_bundle_names ⇒ Object

boolean - Are manual Bundle names allowed?



75
76
77
 
# File 'lib/files.com/models/site.rb', line 75

def allow_bundle_names
  @attributes[:allow_bundle_names]
end

#allow_user_level_2fa_override ⇒ Object

boolean - Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?



80
81
82
 
# File 'lib/files.com/models/site.rb', line 80

def allow_user_level_2fa_override
  @attributes[:allow_user_level_2fa_override]
end

#allow_user_level_allowed_ip_override ⇒ Object

boolean - Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?



85
86
87
 
# File 'lib/files.com/models/site.rb', line 85

def allow_user_level_allowed_ip_override
  @attributes[:allow_user_level_allowed_ip_override]
end

#allow_user_level_ssl_override ⇒ Object

boolean - Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?



90
91
92
 
# File 'lib/files.com/models/site.rb', line 90

def allow_user_level_ssl_override
  @attributes[:allow_user_level_ssl_override]
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?



60
61
62
 
# File 'lib/files.com/models/site.rb', line 60

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?



50
51
52
 
# File 'lib/files.com/models/site.rb', line 50

def allowed_2fa_method_email
  @attributes[:allowed_2fa_method_email]
end

#allowed_2fa_method_sms ⇒ Object

boolean - Is SMS two factor authentication allowed?



30
31
32
 
# File 'lib/files.com/models/site.rb', line 30

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?



55
56
57
 
# File 'lib/files.com/models/site.rb', line 55

def allowed_2fa_method_static
  @attributes[:allowed_2fa_method_static]
end

#allowed_2fa_method_totp ⇒ Object

boolean - Is TOTP two factor authentication allowed?



35
36
37
 
# File 'lib/files.com/models/site.rb', line 35

def allowed_2fa_method_totp
  @attributes[:allowed_2fa_method_totp]
end

#allowed_2fa_method_webauthn ⇒ Object

boolean - Is WebAuthn two factor authentication allowed?



40
41
42
 
# File 'lib/files.com/models/site.rb', line 40

def allowed_2fa_method_webauthn
  @attributes[:allowed_2fa_method_webauthn]
end

#allowed_2fa_method_yubi ⇒ Object

boolean - Is yubikey two factor authentication allowed?



45
46
47
 
# File 'lib/files.com/models/site.rb', line 45

def allowed_2fa_method_yubi
  @attributes[:allowed_2fa_method_yubi]
end

#allowed_countries ⇒ Object

string - Comma separated list of allowed Country codes



95
96
97
 
# File 'lib/files.com/models/site.rb', line 95

def allowed_countries
  @attributes[:allowed_countries]
end

#allowed_ips ⇒ Object

string - List of allowed IP addresses



100
101
102
 
# File 'lib/files.com/models/site.rb', line 100

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.



105
106
107
 
# File 'lib/files.com/models/site.rb', line 105

def always_mkdir_parents
  @attributes[:always_mkdir_parents]
end

#as2_message_retention_days ⇒ Object

int64 - Number of days to retain AS2 messages (incoming and outgoing).



110
111
112
 
# File 'lib/files.com/models/site.rb', line 110

def as2_message_retention_days
  @attributes[:as2_message_retention_days]
end

#ask_about_overwrites ⇒ Object

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



115
116
117
 
# File 'lib/files.com/models/site.rb', line 115

def ask_about_overwrites
  @attributes[:ask_about_overwrites]
end

#bundle_activity_notifications ⇒ Object

string - Do Bundle owners receive activity notifications?



120
121
122
 
# File 'lib/files.com/models/site.rb', line 120

def bundle_activity_notifications
  @attributes[:bundle_activity_notifications]
end

#bundle_expiration ⇒ Object

int64 - Site-wide Bundle expiration in days



125
126
127
 
# File 'lib/files.com/models/site.rb', line 125

def bundle_expiration
  @attributes[:bundle_expiration]
end

#bundle_not_found_message ⇒ Object

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



130
131
132
 
# File 'lib/files.com/models/site.rb', line 130

def bundle_not_found_message
  @attributes[:bundle_not_found_message]
end

#bundle_password_required ⇒ Object

boolean - Do Bundles require password protection?



135
136
137
 
# File 'lib/files.com/models/site.rb', line 135

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



140
141
142
 
# File 'lib/files.com/models/site.rb', line 140

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?



145
146
147
 
# File 'lib/files.com/models/site.rb', line 145

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?



150
151
152
 
# File 'lib/files.com/models/site.rb', line 150

def bundle_registration_notifications
  @attributes[:bundle_registration_notifications]
end

#bundle_require_note ⇒ Object

boolean - Do Bundles require internal notes?



165
166
167
 
# File 'lib/files.com/models/site.rb', line 165

def bundle_require_note
  @attributes[:bundle_require_note]
end

#bundle_require_registration ⇒ Object

boolean - Do Bundles require registration?



155
156
157
 
# File 'lib/files.com/models/site.rb', line 155

def bundle_require_registration
  @attributes[:bundle_require_registration]
end

#bundle_require_share_recipient ⇒ Object

boolean - Do Bundles require recipients for sharing?



160
161
162
 
# File 'lib/files.com/models/site.rb', line 160

def bundle_require_share_recipient
  @attributes[:bundle_require_share_recipient]
end

#bundle_send_shared_receipts ⇒ Object

boolean - Do Bundle creators receive receipts of invitations?



170
171
172
 
# File 'lib/files.com/models/site.rb', line 170

def bundle_send_shared_receipts
  @attributes[:bundle_send_shared_receipts]
end

#bundle_upload_receipt_notifications ⇒ Object

string - Do Bundle uploaders receive upload confirmation notifications?



175
176
177
 
# File 'lib/files.com/models/site.rb', line 175

def bundle_upload_receipt_notifications
  @attributes[:bundle_upload_receipt_notifications]
end

#bundle_watermark_attachment ⇒ Object

Image - Preview watermark image applied to all bundle items.



180
181
182
 
# File 'lib/files.com/models/site.rb', line 180

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



185
186
187
 
# File 'lib/files.com/models/site.rb', line 185

def bundle_watermark_value
  @attributes[:bundle_watermark_value]
end

#calculate_file_checksums_crc32 ⇒ Object

boolean - Calculate CRC32 checksums for files?



190
191
192
 
# File 'lib/files.com/models/site.rb', line 190

def calculate_file_checksums_crc32
  @attributes[:calculate_file_checksums_crc32]
end

#calculate_file_checksums_md5 ⇒ Object

boolean - Calculate MD5 checksums for files?



195
196
197
 
# File 'lib/files.com/models/site.rb', line 195

def calculate_file_checksums_md5
  @attributes[:calculate_file_checksums_md5]
end

#calculate_file_checksums_sha1 ⇒ Object

boolean - Calculate SHA1 checksums for files?



200
201
202
 
# File 'lib/files.com/models/site.rb', line 200

def calculate_file_checksums_sha1
  @attributes[:calculate_file_checksums_sha1]
end

#calculate_file_checksums_sha256 ⇒ Object

boolean - Calculate SHA256 checksums for files?



205
206
207
 
# File 'lib/files.com/models/site.rb', line 205

def calculate_file_checksums_sha256
  @attributes[:calculate_file_checksums_sha256]
end

#color2_left ⇒ Object

string - Page link and button color



215
216
217
 
# File 'lib/files.com/models/site.rb', line 215

def color2_left
  @attributes[:color2_left]
end

#color2_link ⇒ Object

string - Top bar link color



220
221
222
 
# File 'lib/files.com/models/site.rb', line 220

def color2_link
  @attributes[:color2_link]
end

#color2_text ⇒ Object

string - Page link and button color



225
226
227
 
# File 'lib/files.com/models/site.rb', line 225

def color2_text
  @attributes[:color2_text]
end

#color2_top ⇒ Object

string - Top bar background color



230
231
232
 
# File 'lib/files.com/models/site.rb', line 230

def color2_top
  @attributes[:color2_top]
end

#color2_top_text ⇒ Object

string - Top bar text color



235
236
237
 
# File 'lib/files.com/models/site.rb', line 235

def color2_top_text
  @attributes[:color2_top_text]
end

#contact_name ⇒ Object

string - Site main contact name



240
241
242
 
# File 'lib/files.com/models/site.rb', line 240

def contact_name
  @attributes[:contact_name]
end

#created_at ⇒ Object

date-time - Time this site was created



245
246
247
 
# File 'lib/files.com/models/site.rb', line 245

def created_at
  @attributes[:created_at]
end

#currency ⇒ Object

string - Preferred currency



250
251
252
 
# File 'lib/files.com/models/site.rb', line 250

def currency
  @attributes[:currency]
end

#custom_namespace ⇒ Object

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



255
256
257
 
# File 'lib/files.com/models/site.rb', line 255

def custom_namespace
  @attributes[:custom_namespace]
end

#dav_enabled ⇒ Object

boolean - Is WebDAV enabled?



260
261
262
 
# File 'lib/files.com/models/site.rb', line 260

def dav_enabled
  @attributes[:dav_enabled]
end

#dav_user_root_enabled ⇒ Object

boolean - Use user FTP roots also for WebDAV?



265
266
267
 
# File 'lib/files.com/models/site.rb', line 265

def dav_user_root_enabled
  @attributes[:dav_user_root_enabled]
end

#days_to_retain_backups ⇒ Object

int64 - Number of days to keep deleted files



270
271
272
 
# File 'lib/files.com/models/site.rb', line 270

def days_to_retain_backups
  @attributes[:days_to_retain_backups]
end

#default_time_zone ⇒ Object

string - Site default time zone



280
281
282
 
# File 'lib/files.com/models/site.rb', line 280

def default_time_zone
  @attributes[:default_time_zone]
end

#desktop_app ⇒ Object

boolean - Is the desktop app enabled?



285
286
287
 
# File 'lib/files.com/models/site.rb', line 285

def desktop_app
  @attributes[:desktop_app]
end

#desktop_app_session_ip_pinning ⇒ Object

boolean - Is desktop app session IP pinning enabled?



290
291
292
 
# File 'lib/files.com/models/site.rb', line 290

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)



295
296
297
 
# File 'lib/files.com/models/site.rb', line 295

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.



330
331
332
 
# File 'lib/files.com/models/site.rb', line 330

def disable_files_certificate_generation
  @attributes[:disable_files_certificate_generation]
end

#disable_notifications ⇒ Object

boolean - Are notifications disabled?



335
336
337
 
# File 'lib/files.com/models/site.rb', line 335

def disable_notifications
  @attributes[:disable_notifications]
end

#disable_password_reset ⇒ Object

boolean - Is password reset disabled?



340
341
342
 
# File 'lib/files.com/models/site.rb', line 340

def disable_password_reset
  @attributes[:disable_password_reset]
end

#disallowed_countries ⇒ Object

string - Comma separated list of disallowed Country codes



325
326
327
 
# File 'lib/files.com/models/site.rb', line 325

def disallowed_countries
  @attributes[:disallowed_countries]
end

#document_edits_in_bundle_allowed ⇒ Object

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



275
276
277
 
# File 'lib/files.com/models/site.rb', line 275

def document_edits_in_bundle_allowed
  @attributes[:document_edits_in_bundle_allowed]
end

#domain ⇒ Object

string - Custom domain



345
346
347
 
# File 'lib/files.com/models/site.rb', line 345

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?



350
351
352
 
# File 'lib/files.com/models/site.rb', line 350

def domain_hsts_header
  @attributes[:domain_hsts_header]
end

#domain_letsencrypt_chain ⇒ Object

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



355
356
357
 
# File 'lib/files.com/models/site.rb', line 355

def domain_letsencrypt_chain
  @attributes[:domain_letsencrypt_chain]
end

#email ⇒ Object

email - Main email for this site



360
361
362
 
# File 'lib/files.com/models/site.rb', line 360

def email
  @attributes[:email]
end

#email_footer_custom_text ⇒ Object

string - Custom footer text for system-generated emails. Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).



898
899
900
 
# File 'lib/files.com/models/site.rb', line 898

def email_footer_custom_text
  @attributes[:email_footer_custom_text]
end

#folder_permissions_groups_only ⇒ Object

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



385
386
387
 
# File 'lib/files.com/models/site.rb', line 385

def folder_permissions_groups_only
  @attributes[:folder_permissions_groups_only]
end

#ftp_enabled ⇒ Object

boolean - Is FTP enabled?



365
366
367
 
# File 'lib/files.com/models/site.rb', line 365

def ftp_enabled
  @attributes[:ftp_enabled]
end

#group_admins_can_add_users ⇒ Object

boolean - Allow group admins to create users in their groups



390
391
392
 
# File 'lib/files.com/models/site.rb', line 390

def group_admins_can_add_users
  @attributes[:group_admins_can_add_users]
end

#group_admins_can_delete_users ⇒ Object

boolean - Allow group admins to delete users in their groups



395
396
397
 
# File 'lib/files.com/models/site.rb', line 395

def group_admins_can_delete_users
  @attributes[:group_admins_can_delete_users]
end

#group_admins_can_enable_disable_users ⇒ Object

boolean - Allow group admins to enable or disable users in their groups



400
401
402
 
# File 'lib/files.com/models/site.rb', line 400

def group_admins_can_enable_disable_users
  @attributes[:group_admins_can_enable_disable_users]
end

#group_admins_can_modify_users ⇒ Object

boolean - Allow group admins to modify users in their groups



405
406
407
 
# File 'lib/files.com/models/site.rb', line 405

def group_admins_can_modify_users
  @attributes[:group_admins_can_modify_users]
end

#group_admins_can_reset_passwords ⇒ Object

boolean - Allow group admins to reset passwords for users in their groups



410
411
412
 
# File 'lib/files.com/models/site.rb', line 410

def group_admins_can_reset_passwords
  @attributes[:group_admins_can_reset_passwords]
end

#group_admins_can_set_user_password ⇒ Object

boolean - Allow group admins to set password authentication method



415
416
417
 
# File 'lib/files.com/models/site.rb', line 415

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?



420
421
422
 
# File 'lib/files.com/models/site.rb', line 420

def hipaa
  @attributes[:hipaa]
end

#icon128 ⇒ Object

Image - Branded icon 128x128



425
426
427
 
# File 'lib/files.com/models/site.rb', line 425

def icon128
  @attributes[:icon128]
end

#icon16 ⇒ Object

Image - Branded icon 16x16



430
431
432
 
# File 'lib/files.com/models/site.rb', line 430

def icon16
  @attributes[:icon16]
end

#icon32 ⇒ Object

Image - Branded icon 32x32



435
436
437
 
# File 'lib/files.com/models/site.rb', line 435

def icon32
  @attributes[:icon32]
end

#icon48 ⇒ Object

Image - Branded icon 48x48



440
441
442
 
# File 'lib/files.com/models/site.rb', line 440

def icon48
  @attributes[:icon48]
end

#id ⇒ Object

int64 - Site Id



15
16
17
 
# File 'lib/files.com/models/site.rb', line 15

def id
  @attributes[:id]
end

#immutable_files_set_at ⇒ Object

date-time - Can files be modified?



445
446
447
 
# File 'lib/files.com/models/site.rb', line 445

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?



450
451
452
 
# File 'lib/files.com/models/site.rb', line 450

def include_password_in_welcome_email
  @attributes[:include_password_in_welcome_email]
end

#language ⇒ Object

string - Site default language



455
456
457
 
# File 'lib/files.com/models/site.rb', line 455

def language
  @attributes[:language]
end

#ldap_base_dn ⇒ Object

string - Base DN for looking up users in LDAP server



460
461
462
 
# File 'lib/files.com/models/site.rb', line 460

def ldap_base_dn
  @attributes[:ldap_base_dn]
end

#ldap_domain ⇒ Object

string - Domain name that will be appended to usernames



465
466
467
 
# File 'lib/files.com/models/site.rb', line 465

def ldap_domain
  @attributes[:ldap_domain]
end

#ldap_enabled ⇒ Object

boolean - Main LDAP setting: is LDAP enabled?



470
471
472
 
# File 'lib/files.com/models/site.rb', line 470

def ldap_enabled
  @attributes[:ldap_enabled]
end

#ldap_group_action ⇒ Object

string - Should we sync groups from LDAP server?



475
476
477
 
# File 'lib/files.com/models/site.rb', line 475

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.



480
481
482
 
# File 'lib/files.com/models/site.rb', line 480

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.



485
486
487
 
# File 'lib/files.com/models/site.rb', line 485

def ldap_group_inclusion
  @attributes[:ldap_group_inclusion]
end

#ldap_host ⇒ Object

string - LDAP host



490
491
492
 
# File 'lib/files.com/models/site.rb', line 490

def ldap_host
  @attributes[:ldap_host]
end

#ldap_host_2 ⇒ Object

string - LDAP backup host



495
496
497
 
# File 'lib/files.com/models/site.rb', line 495

def ldap_host_2
  @attributes[:ldap_host_2]
end

#ldap_host_3 ⇒ Object

string - LDAP backup host



500
501
502
 
# File 'lib/files.com/models/site.rb', line 500

def ldap_host_3
  @attributes[:ldap_host_3]
end

#ldap_port ⇒ Object

int64 - LDAP port



505
506
507
 
# File 'lib/files.com/models/site.rb', line 505

def ldap_port
  @attributes[:ldap_port]
end

#ldap_secure ⇒ Object

boolean - Use secure LDAP?



510
511
512
 
# File 'lib/files.com/models/site.rb', line 510

def ldap_secure
  @attributes[:ldap_secure]
end

#ldap_type ⇒ Object

string - LDAP type



515
516
517
 
# File 'lib/files.com/models/site.rb', line 515

def ldap_type
  @attributes[:ldap_type]
end

#ldap_user_action ⇒ Object

string - Should we sync users from LDAP server?



520
521
522
 
# File 'lib/files.com/models/site.rb', line 520

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.



525
526
527
 
# File 'lib/files.com/models/site.rb', line 525

def ldap_user_include_groups
  @attributes[:ldap_user_include_groups]
end

#ldap_username ⇒ Object

string - Username for signing in to LDAP server.



530
531
532
 
# File 'lib/files.com/models/site.rb', line 530

def ldap_username
  @attributes[:ldap_username]
end

#ldap_username_field ⇒ Object

string - LDAP username field



535
536
537
 
# File 'lib/files.com/models/site.rb', line 535

def ldap_username_field
  @attributes[:ldap_username_field]
end

#legacy_checksums_mode ⇒ Object

boolean - Use legacy checksums mode?



300
301
302
 
# File 'lib/files.com/models/site.rb', line 300

def legacy_checksums_mode
  @attributes[:legacy_checksums_mode]
end

#login_help_text ⇒ Object

string - Login help text



540
541
542
 
# File 'lib/files.com/models/site.rb', line 540

def 
  @attributes[:login_help_text]
end

#login_page_background_image ⇒ Object

Image - Branded login page background



550
551
552
 
# File 'lib/files.com/models/site.rb', line 550

def 
  @attributes[:login_page_background_image]
end

#logo ⇒ Object

Image - Branded logo



545
546
547
 
# File 'lib/files.com/models/site.rb', line 545

def 
  @attributes[:logo]
end

#managed_site_settings ⇒ Object

object - List of site settings managed by the parent site



560
561
562
 
# File 'lib/files.com/models/site.rb', line 560

def managed_site_settings
  @attributes[:managed_site_settings]
end

#max_prior_passwords ⇒ Object

int64 - Number of prior passwords to disallow



555
556
557
 
# File 'lib/files.com/models/site.rb', line 555

def max_prior_passwords
  @attributes[:max_prior_passwords]
end

#migrate_remote_server_sync_to_sync ⇒ Object

boolean - If true, we will migrate all remote server syncs to the new Sync model.



305
306
307
 
# File 'lib/files.com/models/site.rb', line 305

def migrate_remote_server_sync_to_sync
  @attributes[:migrate_remote_server_sync_to_sync]
end

#mobile_app ⇒ Object

boolean - Is the mobile app enabled?



310
311
312
 
# File 'lib/files.com/models/site.rb', line 310

def mobile_app
  @attributes[:mobile_app]
end

#mobile_app_session_ip_pinning ⇒ Object

boolean - Is mobile app session IP pinning enabled?



315
316
317
 
# File 'lib/files.com/models/site.rb', line 315

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)



320
321
322
 
# File 'lib/files.com/models/site.rb', line 320

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.



565
566
567
 
# File 'lib/files.com/models/site.rb', line 565

def motd_text
  @attributes[:motd_text]
end

#motd_use_for_ftp ⇒ Object

boolean - Show message to users connecting via FTP



570
571
572
 
# File 'lib/files.com/models/site.rb', line 570

def motd_use_for_ftp
  @attributes[:motd_use_for_ftp]
end

#motd_use_for_sftp ⇒ Object

boolean - Show message to users connecting via SFTP



575
576
577
 
# File 'lib/files.com/models/site.rb', line 575

def motd_use_for_sftp
  @attributes[:motd_use_for_sftp]
end

#name ⇒ Object

string - Site name



20
21
22
 
# File 'lib/files.com/models/site.rb', line 20

def name
  @attributes[:name]
end

#next_billing_amount ⇒ Object

decimal - Next billing amount



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

def next_billing_amount
  value = @attributes[:next_billing_amount]
  return value if value.nil? || value.is_a?(BigDecimal)

  BigDecimal(value.to_s)
end

#next_billing_date ⇒ Object

string - Next billing date



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

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.



375
376
377
 
# File 'lib/files.com/models/site.rb', line 375

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.



380
381
382
 
# File 'lib/files.com/models/site.rb', line 380

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.



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

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.



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

def office_integration_type
  @attributes[:office_integration_type]
end

#oncehub_link ⇒ Object

string - Link to scheduling a meeting with our Sales team



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

def oncehub_link
  @attributes[:oncehub_link]
end

#opt_out_global ⇒ Object

boolean - Use servers in the USA only?



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

def opt_out_global
  @attributes[:opt_out_global]
end

#overdue ⇒ Object

boolean - Is this site’s billing overdue?



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

def overdue
  @attributes[:overdue]
end

#password_min_length ⇒ Object

int64 - Shortest password length for users



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

def password_min_length
  @attributes[:password_min_length]
end

#password_require_letter ⇒ Object

boolean - Require a letter in passwords?



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

def password_require_letter
  @attributes[:password_require_letter]
end

#password_require_mixed ⇒ Object

boolean - Require lower and upper case letters in passwords?



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

def password_require_mixed
  @attributes[:password_require_mixed]
end

#password_require_number ⇒ Object

boolean - Require a number in passwords?



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

def password_require_number
  @attributes[:password_require_number]
end

#password_require_special ⇒ Object

boolean - Require special characters in password?



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

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/)



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

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?



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

def password_requirements_apply_to_bundles
  @attributes[:password_requirements_apply_to_bundles]
end

#password_validity_days ⇒ Object

int64 - Number of days password is valid



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

def password_validity_days
  @attributes[:password_validity_days]
end

#phone ⇒ Object

string - Site phone number



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

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.



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

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.



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

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.



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

def protocol_access_groups_only
  @attributes[:protocol_access_groups_only]
end

#reply_to_email ⇒ Object

email - Reply-to email for this site



370
371
372
 
# File 'lib/files.com/models/site.rb', line 370

def reply_to_email
  @attributes[:reply_to_email]
end

#require_2fa ⇒ Object

boolean - Require two-factor authentication for all users?



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

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.



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

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)?



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

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.



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

def require_logout_from_bundles_and_inboxes
  @attributes[:require_logout_from_bundles_and_inboxes]
end

#revoke_bundle_access_on_disable_or_delete ⇒ Object

boolean - Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.



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

def revoke_bundle_access_on_disable_or_delete
  @attributes[:revoke_bundle_access_on_disable_or_delete]
end

#session ⇒ Object

Session - Current session



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

def session
  @attributes[:session]
end

#session_expiry_minutes ⇒ Object

int64 - Session expiry in minutes



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

def session_expiry_minutes
  @attributes[:session_expiry_minutes]
end

#sftp_enabled ⇒ Object

boolean - Is SFTP enabled?



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

def sftp_enabled
  @attributes[:sftp_enabled]
end

#sftp_finalize_partial_uploads ⇒ Object

boolean - Finalize partial SFTP uploads from interrupted connections? Default: true.



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

def sftp_finalize_partial_uploads
  @attributes[:sftp_finalize_partial_uploads]
end

#sftp_host_key_type ⇒ Object

string - Sftp Host Key Type



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

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.



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

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.



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

def sftp_insecure_diffie_hellman
  @attributes[:sftp_insecure_diffie_hellman]
end

#sftp_user_root_enabled ⇒ Object

boolean - Use user FTP roots also for SFTP?



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

def sftp_user_root_enabled
  @attributes[:sftp_user_root_enabled]
end

#sharing_enabled ⇒ Object

boolean - Allow bundle creation



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

def sharing_enabled
  @attributes[:sharing_enabled]
end

#show_request_access_link ⇒ Object

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



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

def show_request_access_link
  @attributes[:show_request_access_link]
end

#show_user_notifications_log_in_link ⇒ Object

boolean - Show log in link in user notifications?



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

def 
  @attributes[:show_user_notifications_log_in_link]
end

#site_footer ⇒ Object

string - Custom site footer text for authenticated pages



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

def site_footer
  @attributes[:site_footer]
end

#site_header ⇒ Object

string - Custom site header text for authenticated pages



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

def site_header
  @attributes[:site_header]
end

#site_public_footer ⇒ Object

string - Custom site footer text for public pages



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

def site_public_footer
  @attributes[:site_public_footer]
end

#site_public_header ⇒ Object

string - Custom site header text for public pages



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

def site_public_header
  @attributes[:site_public_header]
end

#smtp_address ⇒ Object

string - SMTP server hostname or IP



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

def smtp_address
  @attributes[:smtp_address]
end

#smtp_authentication ⇒ Object

string - SMTP server authentication type



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

def smtp_authentication
  @attributes[:smtp_authentication]
end

#smtp_from ⇒ Object

string - From address to use when mailing through custom SMTP



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

def smtp_from
  @attributes[:smtp_from]
end

#smtp_port ⇒ Object

int64 - SMTP server port



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

def smtp_port
  @attributes[:smtp_port]
end

#smtp_username ⇒ Object

string - SMTP server username



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

def smtp_username
  @attributes[:smtp_username]
end

#snapshot_sharing_enabled ⇒ Object

boolean - Allow snapshot share links creation



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

def snapshot_sharing_enabled
  @attributes[:snapshot_sharing_enabled]
end

#ssl_required ⇒ Object

boolean - Is SSL required? Disabling this is insecure.



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

def ssl_required
  @attributes[:ssl_required]
end

#subdomain ⇒ Object

string - Site subdomain



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

def subdomain
  @attributes[:subdomain]
end

#switch_to_plan_date ⇒ Object

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



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

def switch_to_plan_date
  @attributes[:switch_to_plan_date]
end

#trial_days_left ⇒ Object

int64 - Number of days left in trial



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

def trial_days_left
  @attributes[:trial_days_left]
end

#trial_until ⇒ Object

date-time - When does this Site trial expire?



833
834
835
 
# File 'lib/files.com/models/site.rb', line 833

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?



210
211
212
 
# File 'lib/files.com/models/site.rb', line 210

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?



838
839
840
 
# File 'lib/files.com/models/site.rb', line 838

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?



843
844
845
 
# File 'lib/files.com/models/site.rb', line 843

def use_provided_modified_at
  @attributes[:use_provided_modified_at]
end

#user ⇒ Object

User - User of current session



848
849
850
 
# File 'lib/files.com/models/site.rb', line 848

def user
  @attributes[:user]
end

#user_lockout ⇒ Object

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



853
854
855
 
# File 'lib/files.com/models/site.rb', line 853

def user_lockout
  @attributes[:user_lockout]
end

#user_lockout_lock_period ⇒ Object

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



858
859
860
 
# File 'lib/files.com/models/site.rb', line 858

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



863
864
865
 
# File 'lib/files.com/models/site.rb', line 863

def user_lockout_tries
  @attributes[:user_lockout_tries]
end

#user_lockout_within ⇒ Object

int64 - Number of hours for user lockout window



868
869
870
 
# File 'lib/files.com/models/site.rb', line 868

def user_lockout_within
  @attributes[:user_lockout_within]
end

#user_requests_enabled ⇒ Object

boolean - Enable User Requests feature



873
874
875
 
# File 'lib/files.com/models/site.rb', line 873

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?



878
879
880
 
# File 'lib/files.com/models/site.rb', line 878

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?



883
884
885
 
# File 'lib/files.com/models/site.rb', line 883

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?



888
889
890
 
# File 'lib/files.com/models/site.rb', line 888

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



893
894
895
 
# File 'lib/files.com/models/site.rb', line 893

def welcome_custom_text
  @attributes[:welcome_custom_text]
end

#welcome_email_cc ⇒ Object

email - Include this email in welcome emails if enabled



903
904
905
 
# File 'lib/files.com/models/site.rb', line 903

def welcome_email_cc
  @attributes[:welcome_email_cc]
end

#welcome_email_enabled ⇒ Object

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



913
914
915
 
# File 'lib/files.com/models/site.rb', line 913

def welcome_email_enabled
  @attributes[:welcome_email_enabled]
end

#welcome_email_subject ⇒ Object

string - Include this email subject in welcome emails if enabled



908
909
910
 
# File 'lib/files.com/models/site.rb', line 908

def welcome_email_subject
  @attributes[:welcome_email_subject]
end

#welcome_screen ⇒ Object

string - Does the welcome screen appear?



918
919
920
 
# File 'lib/files.com/models/site.rb', line 918

def welcome_screen
  @attributes[:welcome_screen]
end

#windows_mode_ftp ⇒ Object

boolean - Does FTP user Windows emulation mode?



923
924
925
 
# File 'lib/files.com/models/site.rb', line 923

def windows_mode_ftp
  @attributes[:windows_mode_ftp]
end