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

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

Parameters:

name (required) - string
email (required) - string
lead_cookie_code (required) - string
recaptcha_token (required) - string
reply_to_email - string
phone - string
contact_name - string
username - string
password - string
currency - string
language - string
utm_term - string
utm_source - string
utm_content - string
utm_medium - string
utm_campaign - string
utm_domain - string
gclid - string
plan_id - int64
brand - string

Raises:



1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
 
# File 'lib/files.com/models/site.rb', line 1934

def self.create(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: email must be an String") if params[:email] and !params[:email].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: lead_cookie_code must be an String") if params[:lead_cookie_code] and !params[:lead_cookie_code].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: recaptcha_token must be an String") if params[:recaptcha_token] and !params[:recaptcha_token].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: phone must be an String") if params[:phone] and !params[:phone].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: contact_name must be an String") if params[:contact_name] and !params[:contact_name].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: username must be an String") if params[:username] and !params[:username].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: password must be an String") if params[:password] and !params[:password].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: currency must be an String") if params[:currency] and !params[:currency].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: utm_term must be an String") if params[:utm_term] and !params[:utm_term].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: utm_source must be an String") if params[:utm_source] and !params[:utm_source].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: utm_content must be an String") if params[:utm_content] and !params[:utm_content].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: utm_medium must be an String") if params[:utm_medium] and !params[:utm_medium].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: utm_campaign must be an String") if params[:utm_campaign] and !params[:utm_campaign].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: utm_domain must be an String") if params[:utm_domain] and !params[:utm_domain].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: gclid must be an String") if params[:gclid] and !params[:gclid].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: plan_id must be an Integer") if params[:plan_id] and !params[:plan_id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: brand must be an String") if params[:brand] and !params[:brand].is_a?(String)
  raise MissingParameterError.new("Parameter missing: name") unless params[:name]
  raise MissingParameterError.new("Parameter missing: email") unless params[:email]
  raise MissingParameterError.new("Parameter missing: lead_cookie_code") unless params[:lead_cookie_code]
  raise MissingParameterError.new("Parameter missing: recaptcha_token") unless params[:recaptcha_token]

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

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

Parameters:

reason - string - Reason the site was cancelled.

Raises:



2246
2247
2248
2249
2250
2251
 
# File 'lib/files.com/models/site.rb', line 2246

def self.delete(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: reason must be an String") if params[:reason] and !params[:reason].is_a?(String)

  Api.send_request("/site", :delete, params, options)
  nil
end

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



2253
2254
2255
2256
 
# File 'lib/files.com/models/site.rb', line 2253

def self.destroy(params = {}, options = {})
  delete(params, options)
  nil
end

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



1857
1858
1859
1860
 
# File 'lib/files.com/models/site.rb', line 1857

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

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

Parameters:

return_to_url (required) - string - URL that paypal express forwards the user to.
plan_id - int64 - Plan ID to switch to.

Raises:



1894
1895
1896
1897
1898
1899
1900
1901
 
# File 'lib/files.com/models/site.rb', line 1894

def self.get_paypal_express(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: return_to_url must be an String") if params[:return_to_url] and !params[:return_to_url].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: plan_id must be an Integer") if params[:plan_id] and !params[:plan_id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: return_to_url") unless params[:return_to_url]

  response, options = Api.send_request("/site/paypal_express", :get, params, options)
  PaypalExpressUrl.new(response.data, options)
end

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

Parameters:

paypal_token (required) - string - Billing token for use with paypal.

Raises:



1883
1884
1885
1886
1887
1888
1889
 
# File 'lib/files.com/models/site.rb', line 1883

def self.get_paypal_express_info(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: paypal_token must be an String") if params[:paypal_token] and !params[:paypal_token].is_a?(String)
  raise MissingParameterError.new("Parameter missing: paypal_token") unless params[:paypal_token]

  response, options = Api.send_request("/site/paypal_express_info", :get, params, options)
  PaypalExpressInfo.new(response.data, options)
end

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

Parameters:

currency - string - Currency.

Raises:



1874
1875
1876
1877
1878
1879
 
# File 'lib/files.com/models/site.rb', line 1874

def self.get_plan(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: currency must be an String") if params[:currency] and !params[:currency].is_a?(String)

  response, options = Api.send_request("/site/plan", :get, params, options)
  Plan.new(response.data, options)
end

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



1867
1868
1869
1870
 
# File 'lib/files.com/models/site.rb', line 1867

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

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



1862
1863
1864
1865
 
# File 'lib/files.com/models/site.rb', line 1862

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

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

Parameters:

code (required) - string - Mover trial code to apply

Raises:



1905
1906
1907
1908
1909
1910
1911
 
# File 'lib/files.com/models/site.rb', line 1905

def self.mover_trial_code(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: code must be an String") if params[:code] and !params[:code].is_a?(String)
  raise MissingParameterError.new("Parameter missing: code") unless params[:code]

  response, options = Api.send_request("/site/mover_trial_code", :post, params, options)
  Site.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. No longer used as of 2026.
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
disable_all_ai_features - boolean - If true, all AI features are disabled for this site.
ai_feature_availability - object - Availability settings for AI features by user class
mcp_dcr_enabled - boolean - Is OAuth DCR (dynamic client registration) for MCP enabled?
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?
bundles_default_owned_by_primary_group - boolean - If true, new Share Links created by a user with a primary group will default to that group as owner.
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).
username_display - string - How usernames are displayed in the web UI. Can be `username_only`, `full_name_only`, `full_name_username`, `full_name_company`, or `full_name_username_company`.
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_bypass_user_lifecycle_rules - boolean - Allow group admins to exempt users in their groups from lifecycle rules
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_exempt_all_sso_users - boolean - If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
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.
redirect_old_subdomain - boolean - If true, and if changing the site subdomain, then create a redirect from the previous Files.com subdomain to the new Files.com subdomain.
smtp_password - string - Password for SMTP server.

Raises:



2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
 
# File 'lib/files.com/models/site.rb', line 2148

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: ai_feature_availability must be an Hash") if params[:ai_feature_availability] and !params[:ai_feature_availability].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: username_display must be an String") if params[:username_display] and !params[:username_display].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)
  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

.update_plan(id, params = {}, options = {}) ⇒ Object

Change the current billing plan for the site

Parameters:

billing_frequency - int64 - The billing frequency for the site.  Must be 1 (monthly) or 12 (annual).

Raises:



2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
 
# File 'lib/files.com/models/site.rb', line 2233

def self.update_plan(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: billing_frequency must be an Integer") if params[:billing_frequency] and !params[:billing_frequency].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

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

Instance Method Details

#active_sftp_host_key_id ⇒ Object

int64 - Id of the currently selected custom SFTP Host Key



1337
1338
1339
 
# File 'lib/files.com/models/site.rb', line 1337

def active_sftp_host_key_id
  @attributes[:active_sftp_host_key_id]
end

#active_sftp_host_key_id=(value) ⇒ Object 



1341
1342
1343
 
# File 'lib/files.com/models/site.rb', line 1341

def active_sftp_host_key_id=(value)
  @attributes[:active_sftp_host_key_id] = value
end

#additional_text_file_types ⇒ Object

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



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

def additional_text_file_types
  @attributes[:additional_text_file_types]
end

#additional_text_file_types=(value) ⇒ Object 



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

def additional_text_file_types=(value)
  @attributes[:additional_text_file_types] = value
end

#admin_user_id ⇒ Object

int64 - User ID for the main site administrator



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

def admin_user_id
  @attributes[:admin_user_id]
end

#admin_user_id=(value) ⇒ Object 



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

def admin_user_id=(value)
  @attributes[:admin_user_id] = value
end

#admins_bypass_locked_subfolders ⇒ Object

boolean - Allow admins to bypass the locked subfolders setting.



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

def admins_bypass_locked_subfolders
  @attributes[:admins_bypass_locked_subfolders]
end

#admins_bypass_locked_subfolders=(value) ⇒ Object 



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

def admins_bypass_locked_subfolders=(value)
  @attributes[:admins_bypass_locked_subfolders] = value
end

#ai_feature_availability ⇒ Object

object - Availability settings for AI features by user class



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

def ai_feature_availability
  @attributes[:ai_feature_availability]
end

#ai_feature_availability=(value) ⇒ Object 



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

def ai_feature_availability=(value)
  @attributes[:ai_feature_availability] = value
end

#allow_bundle_names ⇒ Object

boolean - Are manual Bundle names allowed?



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

def allow_bundle_names
  @attributes[:allow_bundle_names]
end

#allow_bundle_names=(value) ⇒ Object 



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

def allow_bundle_names=(value)
  @attributes[:allow_bundle_names] = value
end

#allow_user_level_2fa_override ⇒ Object

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



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

def allow_user_level_2fa_override
  @attributes[:allow_user_level_2fa_override]
end

#allow_user_level_2fa_override=(value) ⇒ Object 



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

def allow_user_level_2fa_override=(value)
  @attributes[:allow_user_level_2fa_override] = value
end

#allow_user_level_allowed_ip_override ⇒ Object

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



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

def allow_user_level_allowed_ip_override
  @attributes[:allow_user_level_allowed_ip_override]
end

#allow_user_level_allowed_ip_override=(value) ⇒ Object 



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

def allow_user_level_allowed_ip_override=(value)
  @attributes[:allow_user_level_allowed_ip_override] = value
end

#allow_user_level_ssl_override ⇒ Object

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



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

def allow_user_level_ssl_override
  @attributes[:allow_user_level_ssl_override]
end

#allow_user_level_ssl_override=(value) ⇒ Object 



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

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



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

def allowed_2fa_method_bypass_for_ftp_sftp_dav
  @attributes[:allowed_2fa_method_bypass_for_ftp_sftp_dav]
end

#allowed_2fa_method_bypass_for_ftp_sftp_dav=(value) ⇒ Object 



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

def allowed_2fa_method_bypass_for_ftp_sftp_dav=(value)
  @attributes[:allowed_2fa_method_bypass_for_ftp_sftp_dav] = value
end

#allowed_2fa_method_email ⇒ Object

boolean - Is OTP via email two factor authentication allowed?



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

def allowed_2fa_method_email
  @attributes[:allowed_2fa_method_email]
end

#allowed_2fa_method_email=(value) ⇒ Object 



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

def allowed_2fa_method_email=(value)
  @attributes[:allowed_2fa_method_email] = value
end

#allowed_2fa_method_sms ⇒ Object

boolean - Is SMS two factor authentication allowed?



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

def allowed_2fa_method_sms
  @attributes[:allowed_2fa_method_sms]
end

#allowed_2fa_method_sms=(value) ⇒ Object 



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

def allowed_2fa_method_sms=(value)
  @attributes[:allowed_2fa_method_sms] = value
end

#allowed_2fa_method_static ⇒ Object

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



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

def allowed_2fa_method_static
  @attributes[:allowed_2fa_method_static]
end

#allowed_2fa_method_static=(value) ⇒ Object 



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

def allowed_2fa_method_static=(value)
  @attributes[:allowed_2fa_method_static] = value
end

#allowed_2fa_method_totp ⇒ Object

boolean - Is TOTP two factor authentication allowed?



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

def allowed_2fa_method_totp
  @attributes[:allowed_2fa_method_totp]
end

#allowed_2fa_method_totp=(value) ⇒ Object 



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

def allowed_2fa_method_totp=(value)
  @attributes[:allowed_2fa_method_totp] = value
end

#allowed_2fa_method_webauthn ⇒ Object

boolean - Is WebAuthn two factor authentication allowed?



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

def allowed_2fa_method_webauthn
  @attributes[:allowed_2fa_method_webauthn]
end

#allowed_2fa_method_webauthn=(value) ⇒ Object 



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

def allowed_2fa_method_webauthn=(value)
  @attributes[:allowed_2fa_method_webauthn] = value
end

#allowed_2fa_method_yubi ⇒ Object

boolean - Is yubikey two factor authentication allowed?



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

def allowed_2fa_method_yubi
  @attributes[:allowed_2fa_method_yubi]
end

#allowed_2fa_method_yubi=(value) ⇒ Object 



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

def allowed_2fa_method_yubi=(value)
  @attributes[:allowed_2fa_method_yubi] = value
end

#allowed_countries ⇒ Object

string - Comma separated list of allowed Country codes



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

def allowed_countries
  @attributes[:allowed_countries]
end

#allowed_countries=(value) ⇒ Object 



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

def allowed_countries=(value)
  @attributes[:allowed_countries] = value
end

#allowed_ips ⇒ Object

string - List of allowed IP addresses



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

def allowed_ips
  @attributes[:allowed_ips]
end

#allowed_ips=(value) ⇒ Object 



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

def allowed_ips=(value)
  @attributes[:allowed_ips] = value
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.



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

def always_mkdir_parents
  @attributes[:always_mkdir_parents]
end

#always_mkdir_parents=(value) ⇒ Object 



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

def always_mkdir_parents=(value)
  @attributes[:always_mkdir_parents] = value
end

#as2_message_retention_days ⇒ Object

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



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

def as2_message_retention_days
  @attributes[:as2_message_retention_days]
end

#as2_message_retention_days=(value) ⇒ Object 



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

def as2_message_retention_days=(value)
  @attributes[:as2_message_retention_days] = value
end

#ask_about_overwrites ⇒ Object

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



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

def ask_about_overwrites
  @attributes[:ask_about_overwrites]
end

#ask_about_overwrites=(value) ⇒ Object 



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

def ask_about_overwrites=(value)
  @attributes[:ask_about_overwrites] = value
end

#brand ⇒ Object

string



1823
1824
1825
 
# File 'lib/files.com/models/site.rb', line 1823

def brand
  @attributes[:brand]
end

#brand=(value) ⇒ Object 



1827
1828
1829
 
# File 'lib/files.com/models/site.rb', line 1827

def brand=(value)
  @attributes[:brand] = value
end

#bundle_activity_notifications ⇒ Object

string - Do Bundle owners receive activity notifications?



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

def bundle_activity_notifications
  @attributes[:bundle_activity_notifications]
end

#bundle_activity_notifications=(value) ⇒ Object 



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

def bundle_activity_notifications=(value)
  @attributes[:bundle_activity_notifications] = value
end

#bundle_expiration ⇒ Object

int64 - Site-wide Bundle expiration in days



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

def bundle_expiration
  @attributes[:bundle_expiration]
end

#bundle_expiration=(value) ⇒ Object 



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

def bundle_expiration=(value)
  @attributes[:bundle_expiration] = value
end

#bundle_not_found_message ⇒ Object

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



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

def bundle_not_found_message
  @attributes[:bundle_not_found_message]
end

#bundle_not_found_message=(value) ⇒ Object 



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

def bundle_not_found_message=(value)
  @attributes[:bundle_not_found_message] = value
end

#bundle_password_required ⇒ Object

boolean - Do Bundles require password protection?



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

def bundle_password_required
  @attributes[:bundle_password_required]
end

#bundle_password_required=(value) ⇒ Object 



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

def bundle_password_required=(value)
  @attributes[:bundle_password_required] = value
end

#bundle_recipient_blacklist_domains ⇒ Object

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



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

def bundle_recipient_blacklist_domains
  @attributes[:bundle_recipient_blacklist_domains]
end

#bundle_recipient_blacklist_domains=(value) ⇒ Object 



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

def bundle_recipient_blacklist_domains=(value)
  @attributes[:bundle_recipient_blacklist_domains] = value
end

#bundle_recipient_blacklist_free_email_domains ⇒ Object

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



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

def bundle_recipient_blacklist_free_email_domains
  @attributes[:bundle_recipient_blacklist_free_email_domains]
end

#bundle_recipient_blacklist_free_email_domains=(value) ⇒ Object 



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

def bundle_recipient_blacklist_free_email_domains=(value)
  @attributes[:bundle_recipient_blacklist_free_email_domains] = value
end

#bundle_registration_notifications ⇒ Object

string - Do Bundle owners receive registration notification?



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

def bundle_registration_notifications
  @attributes[:bundle_registration_notifications]
end

#bundle_registration_notifications=(value) ⇒ Object 



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

def bundle_registration_notifications=(value)
  @attributes[:bundle_registration_notifications] = value
end

#bundle_require_note ⇒ Object

boolean - Do Bundles require internal notes?



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

def bundle_require_note
  @attributes[:bundle_require_note]
end

#bundle_require_note=(value) ⇒ Object 



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

def bundle_require_note=(value)
  @attributes[:bundle_require_note] = value
end

#bundle_require_registration ⇒ Object

boolean - Do Bundles require registration?



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

def bundle_require_registration
  @attributes[:bundle_require_registration]
end

#bundle_require_registration=(value) ⇒ Object 



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

def bundle_require_registration=(value)
  @attributes[:bundle_require_registration] = value
end

#bundle_require_share_recipient ⇒ Object

boolean - Do Bundles require recipients for sharing?



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

def bundle_require_share_recipient
  @attributes[:bundle_require_share_recipient]
end

#bundle_require_share_recipient=(value) ⇒ Object 



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

def bundle_require_share_recipient=(value)
  @attributes[:bundle_require_share_recipient] = value
end

#bundle_send_shared_receipts ⇒ Object

boolean - Do Bundle creators receive receipts of invitations?



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

def bundle_send_shared_receipts
  @attributes[:bundle_send_shared_receipts]
end

#bundle_send_shared_receipts=(value) ⇒ Object 



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

def bundle_send_shared_receipts=(value)
  @attributes[:bundle_send_shared_receipts] = value
end

#bundle_upload_receipt_notifications ⇒ Object

string - Do Bundle uploaders receive upload confirmation notifications?



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

def bundle_upload_receipt_notifications
  @attributes[:bundle_upload_receipt_notifications]
end

#bundle_upload_receipt_notifications=(value) ⇒ Object 



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

def bundle_upload_receipt_notifications=(value)
  @attributes[:bundle_upload_receipt_notifications] = value
end

#bundle_watermark_attachment ⇒ Object

Image - Preview watermark image applied to all bundle items.



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

def bundle_watermark_attachment
  @attributes[:bundle_watermark_attachment]
end

#bundle_watermark_attachment=(value) ⇒ Object 



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

def bundle_watermark_attachment=(value)
  @attributes[:bundle_watermark_attachment] = value
end

#bundle_watermark_value ⇒ Object

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



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

def bundle_watermark_value
  @attributes[:bundle_watermark_value]
end

#bundle_watermark_value=(value) ⇒ Object 



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

def bundle_watermark_value=(value)
  @attributes[:bundle_watermark_value] = value
end

#bundles_default_owned_by_primary_group ⇒ Object

boolean - If true, new Share Links created by a user with a primary group will default to that group as owner.



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

def bundles_default_owned_by_primary_group
  @attributes[:bundles_default_owned_by_primary_group]
end

#bundles_default_owned_by_primary_group=(value) ⇒ Object 



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

def bundles_default_owned_by_primary_group=(value)
  @attributes[:bundles_default_owned_by_primary_group] = value
end

#calculate_file_checksums_crc32 ⇒ Object

boolean - Calculate CRC32 checksums for files?



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

def calculate_file_checksums_crc32
  @attributes[:calculate_file_checksums_crc32]
end

#calculate_file_checksums_crc32=(value) ⇒ Object 



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

def calculate_file_checksums_crc32=(value)
  @attributes[:calculate_file_checksums_crc32] = value
end

#calculate_file_checksums_md5 ⇒ Object

boolean - Calculate MD5 checksums for files?



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

def calculate_file_checksums_md5
  @attributes[:calculate_file_checksums_md5]
end

#calculate_file_checksums_md5=(value) ⇒ Object 



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

def calculate_file_checksums_md5=(value)
  @attributes[:calculate_file_checksums_md5] = value
end

#calculate_file_checksums_sha1 ⇒ Object

boolean - Calculate SHA1 checksums for files?



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

def calculate_file_checksums_sha1
  @attributes[:calculate_file_checksums_sha1]
end

#calculate_file_checksums_sha1=(value) ⇒ Object 



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

def calculate_file_checksums_sha1=(value)
  @attributes[:calculate_file_checksums_sha1] = value
end

#calculate_file_checksums_sha256 ⇒ Object

boolean - Calculate SHA256 checksums for files?



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

def calculate_file_checksums_sha256
  @attributes[:calculate_file_checksums_sha256]
end

#calculate_file_checksums_sha256=(value) ⇒ Object 



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

def calculate_file_checksums_sha256=(value)
  @attributes[:calculate_file_checksums_sha256] = value
end

#color2_left ⇒ Object

string - Page link and button color



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

def color2_left
  @attributes[:color2_left]
end

#color2_left=(value) ⇒ Object 



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

def color2_left=(value)
  @attributes[:color2_left] = value
end

#color2_link ⇒ Object

string - Top bar link color



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

def color2_link
  @attributes[:color2_link]
end

#color2_link=(value) ⇒ Object 



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

def color2_link=(value)
  @attributes[:color2_link] = value
end

#color2_text ⇒ Object

string - Page link and button color



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

def color2_text
  @attributes[:color2_text]
end

#color2_text=(value) ⇒ Object 



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

def color2_text=(value)
  @attributes[:color2_text] = value
end

#color2_top ⇒ Object

string - Top bar background color



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

def color2_top
  @attributes[:color2_top]
end

#color2_top=(value) ⇒ Object 



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

def color2_top=(value)
  @attributes[:color2_top] = value
end

#color2_top_text ⇒ Object

string - Top bar text color



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

def color2_top_text
  @attributes[:color2_top_text]
end

#color2_top_text=(value) ⇒ Object 



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

def color2_top_text=(value)
  @attributes[:color2_top_text] = value
end

#contact_name ⇒ Object

string - Site main contact name



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

def contact_name
  @attributes[:contact_name]
end

#contact_name=(value) ⇒ Object 



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

def contact_name=(value)
  @attributes[:contact_name] = value
end

#created_at ⇒ Object

date-time - Time this site was created



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

def created_at
  @attributes[:created_at]
end

#currency ⇒ Object

string - Preferred currency



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

def currency
  @attributes[:currency]
end

#currency=(value) ⇒ Object 



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

def currency=(value)
  @attributes[:currency] = value
end

#custom_namespace ⇒ Object

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



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

def custom_namespace
  @attributes[:custom_namespace]
end

#custom_namespace=(value) ⇒ Object 



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

def custom_namespace=(value)
  @attributes[:custom_namespace] = value
end

#dav_enabled ⇒ Object

boolean - Is WebDAV enabled?



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

def dav_enabled
  @attributes[:dav_enabled]
end

#dav_enabled=(value) ⇒ Object 



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

def dav_enabled=(value)
  @attributes[:dav_enabled] = value
end

#dav_user_root_enabled ⇒ Object

boolean - Use user FTP roots also for WebDAV?



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

def dav_user_root_enabled
  @attributes[:dav_user_root_enabled]
end

#dav_user_root_enabled=(value) ⇒ Object 



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

def dav_user_root_enabled=(value)
  @attributes[:dav_user_root_enabled] = value
end

#days_to_retain_backups ⇒ Object

int64 - Number of days to keep deleted files



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

def days_to_retain_backups
  @attributes[:days_to_retain_backups]
end

#days_to_retain_backups=(value) ⇒ Object 



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

def days_to_retain_backups=(value)
  @attributes[:days_to_retain_backups] = value
end

#default_time_zone ⇒ Object

string - Site default time zone



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

def default_time_zone
  @attributes[:default_time_zone]
end

#default_time_zone=(value) ⇒ Object 



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

def default_time_zone=(value)
  @attributes[:default_time_zone] = value
end

#desktop_app ⇒ Object

boolean - Is the desktop app enabled?



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

def desktop_app
  @attributes[:desktop_app]
end

#desktop_app=(value) ⇒ Object 



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

def desktop_app=(value)
  @attributes[:desktop_app] = value
end

#desktop_app_session_ip_pinning ⇒ Object

boolean - Is desktop app session IP pinning enabled?



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

def desktop_app_session_ip_pinning
  @attributes[:desktop_app_session_ip_pinning]
end

#desktop_app_session_ip_pinning=(value) ⇒ Object 



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

def desktop_app_session_ip_pinning=(value)
  @attributes[:desktop_app_session_ip_pinning] = value
end

#desktop_app_session_lifetime ⇒ Object

int64 - Desktop app session lifetime (in hours)



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

def desktop_app_session_lifetime
  @attributes[:desktop_app_session_lifetime]
end

#desktop_app_session_lifetime=(value) ⇒ Object 



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

def desktop_app_session_lifetime=(value)
  @attributes[:desktop_app_session_lifetime] = value
end

#disable_all_ai_features ⇒ Object

boolean - If true, all AI features are disabled for this site.



605
606
607
 
# File 'lib/files.com/models/site.rb', line 605

def disable_all_ai_features
  @attributes[:disable_all_ai_features]
end

#disable_all_ai_features=(value) ⇒ Object 



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

def disable_all_ai_features=(value)
  @attributes[:disable_all_ai_features] = value
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.



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

def disable_files_certificate_generation
  @attributes[:disable_files_certificate_generation]
end

#disable_files_certificate_generation=(value) ⇒ Object 



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

def disable_files_certificate_generation=(value)
  @attributes[:disable_files_certificate_generation] = value
end

#disable_notifications ⇒ Object

boolean - Are notifications disabled?



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

def disable_notifications
  @attributes[:disable_notifications]
end

#disable_notifications=(value) ⇒ Object 



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

def disable_notifications=(value)
  @attributes[:disable_notifications] = value
end

#disable_password_reset ⇒ Object

boolean - Is password reset disabled?



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

def disable_password_reset
  @attributes[:disable_password_reset]
end

#disable_password_reset=(value) ⇒ Object 



636
637
638
 
# File 'lib/files.com/models/site.rb', line 636

def disable_password_reset=(value)
  @attributes[:disable_password_reset] = value
end

#disallowed_countries ⇒ Object

string - Comma separated list of disallowed Country codes



596
597
598
 
# File 'lib/files.com/models/site.rb', line 596

def disallowed_countries
  @attributes[:disallowed_countries]
end

#disallowed_countries=(value) ⇒ Object 



600
601
602
 
# File 'lib/files.com/models/site.rb', line 600

def disallowed_countries=(value)
  @attributes[:disallowed_countries] = value
end

#document_edits_in_bundle_allowed ⇒ Object

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



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

def document_edits_in_bundle_allowed
  @attributes[:document_edits_in_bundle_allowed]
end

#document_edits_in_bundle_allowed=(value) ⇒ Object 



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

def document_edits_in_bundle_allowed=(value)
  @attributes[:document_edits_in_bundle_allowed] = value
end

#domain ⇒ Object

string - Custom domain



641
642
643
 
# File 'lib/files.com/models/site.rb', line 641

def domain
  @attributes[:domain]
end

#domain=(value) ⇒ Object 



645
646
647
 
# File 'lib/files.com/models/site.rb', line 645

def domain=(value)
  @attributes[:domain] = value
end

#domain_hsts_header ⇒ Object

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



650
651
652
 
# File 'lib/files.com/models/site.rb', line 650

def domain_hsts_header
  @attributes[:domain_hsts_header]
end

#domain_hsts_header=(value) ⇒ Object 



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

def domain_hsts_header=(value)
  @attributes[:domain_hsts_header] = value
end

#domain_letsencrypt_chain ⇒ Object

string - Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.



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

def domain_letsencrypt_chain
  @attributes[:domain_letsencrypt_chain]
end

#domain_letsencrypt_chain=(value) ⇒ Object 



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

def domain_letsencrypt_chain=(value)
  @attributes[:domain_letsencrypt_chain] = value
end

#email ⇒ Object

email - Main email for this site



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

def email
  @attributes[:email]
end

#email=(value) ⇒ Object 



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

def email=(value)
  @attributes[:email] = value
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).



1661
1662
1663
 
# File 'lib/files.com/models/site.rb', line 1661

def email_footer_custom_text
  @attributes[:email_footer_custom_text]
end

#email_footer_custom_text=(value) ⇒ Object 



1665
1666
1667
 
# File 'lib/files.com/models/site.rb', line 1665

def email_footer_custom_text=(value)
  @attributes[:email_footer_custom_text] = value
end

#folder_permissions_groups_only ⇒ Object

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



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

def folder_permissions_groups_only
  @attributes[:folder_permissions_groups_only]
end

#folder_permissions_groups_only=(value) ⇒ Object 



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

def folder_permissions_groups_only=(value)
  @attributes[:folder_permissions_groups_only] = value
end

#ftp_enabled ⇒ Object

boolean - Is FTP enabled?



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

def ftp_enabled
  @attributes[:ftp_enabled]
end

#ftp_enabled=(value) ⇒ Object 



681
682
683
 
# File 'lib/files.com/models/site.rb', line 681

def ftp_enabled=(value)
  @attributes[:ftp_enabled] = value
end

#gclid ⇒ Object

string



1805
1806
1807
 
# File 'lib/files.com/models/site.rb', line 1805

def gclid
  @attributes[:gclid]
end

#gclid=(value) ⇒ Object 



1809
1810
1811
 
# File 'lib/files.com/models/site.rb', line 1809

def gclid=(value)
  @attributes[:gclid] = value
end

#group_admins_can_add_users ⇒ Object

boolean - Allow group admins to create users in their groups



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

def group_admins_can_add_users
  @attributes[:group_admins_can_add_users]
end

#group_admins_can_add_users=(value) ⇒ Object 



726
727
728
 
# File 'lib/files.com/models/site.rb', line 726

def group_admins_can_add_users=(value)
  @attributes[:group_admins_can_add_users] = value
end

#group_admins_can_bypass_user_lifecycle_rules ⇒ Object

boolean - Allow group admins to exempt users in their groups from lifecycle rules



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

def group_admins_can_bypass_user_lifecycle_rules
  @attributes[:group_admins_can_bypass_user_lifecycle_rules]
end

#group_admins_can_bypass_user_lifecycle_rules=(value) ⇒ Object 



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

def group_admins_can_bypass_user_lifecycle_rules=(value)
  @attributes[:group_admins_can_bypass_user_lifecycle_rules] = value
end

#group_admins_can_delete_users ⇒ Object

boolean - Allow group admins to delete users in their groups



731
732
733
 
# File 'lib/files.com/models/site.rb', line 731

def group_admins_can_delete_users
  @attributes[:group_admins_can_delete_users]
end

#group_admins_can_delete_users=(value) ⇒ Object 



735
736
737
 
# File 'lib/files.com/models/site.rb', line 735

def group_admins_can_delete_users=(value)
  @attributes[:group_admins_can_delete_users] = value
end

#group_admins_can_enable_disable_users ⇒ Object

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



740
741
742
 
# File 'lib/files.com/models/site.rb', line 740

def group_admins_can_enable_disable_users
  @attributes[:group_admins_can_enable_disable_users]
end

#group_admins_can_enable_disable_users=(value) ⇒ Object 



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

def group_admins_can_enable_disable_users=(value)
  @attributes[:group_admins_can_enable_disable_users] = value
end

#group_admins_can_modify_users ⇒ Object

boolean - Allow group admins to modify users in their groups



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

def group_admins_can_modify_users
  @attributes[:group_admins_can_modify_users]
end

#group_admins_can_modify_users=(value) ⇒ Object 



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

def group_admins_can_modify_users=(value)
  @attributes[:group_admins_can_modify_users] = value
end

#group_admins_can_reset_passwords ⇒ Object

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



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

def group_admins_can_reset_passwords
  @attributes[:group_admins_can_reset_passwords]
end

#group_admins_can_reset_passwords=(value) ⇒ Object 



771
772
773
 
# File 'lib/files.com/models/site.rb', line 771

def group_admins_can_reset_passwords=(value)
  @attributes[:group_admins_can_reset_passwords] = value
end

#group_admins_can_set_user_password ⇒ Object

boolean - Allow group admins to set password authentication method



776
777
778
 
# File 'lib/files.com/models/site.rb', line 776

def group_admins_can_set_user_password
  @attributes[:group_admins_can_set_user_password]
end

#group_admins_can_set_user_password=(value) ⇒ Object 



780
781
782
 
# File 'lib/files.com/models/site.rb', line 780

def group_admins_can_set_user_password=(value)
  @attributes[:group_admins_can_set_user_password] = value
end

#hipaa ⇒ Object

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



785
786
787
 
# File 'lib/files.com/models/site.rb', line 785

def hipaa
  @attributes[:hipaa]
end

#hipaa=(value) ⇒ Object 



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

def hipaa=(value)
  @attributes[:hipaa] = value
end

#icon128 ⇒ Object

Image - Branded icon 128x128



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

def icon128
  @attributes[:icon128]
end

#icon128=(value) ⇒ Object 



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

def icon128=(value)
  @attributes[:icon128] = value
end

#icon16 ⇒ Object

Image - Branded icon 16x16



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

def icon16
  @attributes[:icon16]
end

#icon16=(value) ⇒ Object 



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

def icon16=(value)
  @attributes[:icon16] = value
end

#icon32 ⇒ Object

Image - Branded icon 32x32



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

def icon32
  @attributes[:icon32]
end

#icon32=(value) ⇒ Object 



816
817
818
 
# File 'lib/files.com/models/site.rb', line 816

def icon32=(value)
  @attributes[:icon32] = value
end

#icon48 ⇒ Object

Image - Branded icon 48x48



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

def icon48
  @attributes[:icon48]
end

#icon48=(value) ⇒ Object 



825
826
827
 
# File 'lib/files.com/models/site.rb', line 825

def icon48=(value)
  @attributes[:icon48] = value
end

#id ⇒ Object

int64 - Site Id



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

def id
  @attributes[:id]
end

#id=(value) ⇒ Object 



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

def id=(value)
  @attributes[:id] = value
end

#immutable_files_set_at ⇒ Object

date-time - Can files be modified?



830
831
832
 
# File 'lib/files.com/models/site.rb', line 830

def immutable_files_set_at
  @attributes[:immutable_files_set_at]
end

#immutable_files_set_at=(value) ⇒ Object 



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

def immutable_files_set_at=(value)
  @attributes[:immutable_files_set_at] = value
end

#include_password_in_welcome_email ⇒ Object

boolean - Include password in emails to new users?



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

def include_password_in_welcome_email
  @attributes[:include_password_in_welcome_email]
end

#include_password_in_welcome_email=(value) ⇒ Object 



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

def include_password_in_welcome_email=(value)
  @attributes[:include_password_in_welcome_email] = value
end

#language ⇒ Object

string - Site default language



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

def language
  @attributes[:language]
end

#language=(value) ⇒ Object 



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

def language=(value)
  @attributes[:language] = value
end

#ldap_base_dn ⇒ Object

string - Base DN for looking up users in LDAP server



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

def ldap_base_dn
  @attributes[:ldap_base_dn]
end

#ldap_base_dn=(value) ⇒ Object 



861
862
863
 
# File 'lib/files.com/models/site.rb', line 861

def ldap_base_dn=(value)
  @attributes[:ldap_base_dn] = value
end

#ldap_domain ⇒ Object

string - Domain name that will be appended to usernames



866
867
868
 
# File 'lib/files.com/models/site.rb', line 866

def ldap_domain
  @attributes[:ldap_domain]
end

#ldap_domain=(value) ⇒ Object 



870
871
872
 
# File 'lib/files.com/models/site.rb', line 870

def ldap_domain=(value)
  @attributes[:ldap_domain] = value
end

#ldap_enabled ⇒ Object

boolean - Main LDAP setting: is LDAP enabled?



875
876
877
 
# File 'lib/files.com/models/site.rb', line 875

def ldap_enabled
  @attributes[:ldap_enabled]
end

#ldap_enabled=(value) ⇒ Object 



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

def ldap_enabled=(value)
  @attributes[:ldap_enabled] = value
end

#ldap_group_action ⇒ Object

string - Should we sync groups from LDAP server?



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

def ldap_group_action
  @attributes[:ldap_group_action]
end

#ldap_group_action=(value) ⇒ Object 



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

def ldap_group_action=(value)
  @attributes[:ldap_group_action] = value
end

#ldap_group_exclusion ⇒ Object

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



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

def ldap_group_exclusion
  @attributes[:ldap_group_exclusion]
end

#ldap_group_exclusion=(value) ⇒ Object 



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

def ldap_group_exclusion=(value)
  @attributes[:ldap_group_exclusion] = value
end

#ldap_group_inclusion ⇒ Object

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



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

def ldap_group_inclusion
  @attributes[:ldap_group_inclusion]
end

#ldap_group_inclusion=(value) ⇒ Object 



906
907
908
 
# File 'lib/files.com/models/site.rb', line 906

def ldap_group_inclusion=(value)
  @attributes[:ldap_group_inclusion] = value
end

#ldap_host ⇒ Object

string - LDAP host



911
912
913
 
# File 'lib/files.com/models/site.rb', line 911

def ldap_host
  @attributes[:ldap_host]
end

#ldap_host=(value) ⇒ Object 



915
916
917
 
# File 'lib/files.com/models/site.rb', line 915

def ldap_host=(value)
  @attributes[:ldap_host] = value
end

#ldap_host_2 ⇒ Object

string - LDAP backup host



920
921
922
 
# File 'lib/files.com/models/site.rb', line 920

def ldap_host_2
  @attributes[:ldap_host_2]
end

#ldap_host_2=(value) ⇒ Object 



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

def ldap_host_2=(value)
  @attributes[:ldap_host_2] = value
end

#ldap_host_3 ⇒ Object

string - LDAP backup host



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

def ldap_host_3
  @attributes[:ldap_host_3]
end

#ldap_host_3=(value) ⇒ Object 



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

def ldap_host_3=(value)
  @attributes[:ldap_host_3] = value
end

#ldap_port ⇒ Object

int64 - LDAP port



938
939
940
 
# File 'lib/files.com/models/site.rb', line 938

def ldap_port
  @attributes[:ldap_port]
end

#ldap_port=(value) ⇒ Object 



942
943
944
 
# File 'lib/files.com/models/site.rb', line 942

def ldap_port=(value)
  @attributes[:ldap_port] = value
end

#ldap_secure ⇒ Object

boolean - Use secure LDAP?



947
948
949
 
# File 'lib/files.com/models/site.rb', line 947

def ldap_secure
  @attributes[:ldap_secure]
end

#ldap_secure=(value) ⇒ Object 



951
952
953
 
# File 'lib/files.com/models/site.rb', line 951

def ldap_secure=(value)
  @attributes[:ldap_secure] = value
end

#ldap_type ⇒ Object

string - LDAP type



956
957
958
 
# File 'lib/files.com/models/site.rb', line 956

def ldap_type
  @attributes[:ldap_type]
end

#ldap_type=(value) ⇒ Object 



960
961
962
 
# File 'lib/files.com/models/site.rb', line 960

def ldap_type=(value)
  @attributes[:ldap_type] = value
end

#ldap_user_action ⇒ Object

string - Should we sync users from LDAP server?



965
966
967
 
# File 'lib/files.com/models/site.rb', line 965

def ldap_user_action
  @attributes[:ldap_user_action]
end

#ldap_user_action=(value) ⇒ Object 



969
970
971
 
# File 'lib/files.com/models/site.rb', line 969

def ldap_user_action=(value)
  @attributes[:ldap_user_action] = value
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.



974
975
976
 
# File 'lib/files.com/models/site.rb', line 974

def ldap_user_include_groups
  @attributes[:ldap_user_include_groups]
end

#ldap_user_include_groups=(value) ⇒ Object 



978
979
980
 
# File 'lib/files.com/models/site.rb', line 978

def ldap_user_include_groups=(value)
  @attributes[:ldap_user_include_groups] = value
end

#ldap_username ⇒ Object

string - Username for signing in to LDAP server.



983
984
985
 
# File 'lib/files.com/models/site.rb', line 983

def ldap_username
  @attributes[:ldap_username]
end

#ldap_username=(value) ⇒ Object 



987
988
989
 
# File 'lib/files.com/models/site.rb', line 987

def ldap_username=(value)
  @attributes[:ldap_username] = value
end

#ldap_username_field ⇒ Object

string - LDAP username field



992
993
994
 
# File 'lib/files.com/models/site.rb', line 992

def ldap_username_field
  @attributes[:ldap_username_field]
end

#ldap_username_field=(value) ⇒ Object 



996
997
998
 
# File 'lib/files.com/models/site.rb', line 996

def ldap_username_field=(value)
  @attributes[:ldap_username_field] = value
end

#lead_cookie_code ⇒ Object

string



1715
1716
1717
 
# File 'lib/files.com/models/site.rb', line 1715

def lead_cookie_code
  @attributes[:lead_cookie_code]
end

#lead_cookie_code=(value) ⇒ Object 



1719
1720
1721
 
# File 'lib/files.com/models/site.rb', line 1719

def lead_cookie_code=(value)
  @attributes[:lead_cookie_code] = value
end

#legacy_checksums_mode ⇒ Object

boolean - Use legacy checksums mode?



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

def legacy_checksums_mode
  @attributes[:legacy_checksums_mode]
end

#legacy_checksums_mode=(value) ⇒ Object 



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

def legacy_checksums_mode=(value)
  @attributes[:legacy_checksums_mode] = value
end

#login_help_text ⇒ Object

string - Login help text



1001
1002
1003
 
# File 'lib/files.com/models/site.rb', line 1001

def 
  @attributes[:login_help_text]
end

#login_help_text=(value) ⇒ Object 



1005
1006
1007
 
# File 'lib/files.com/models/site.rb', line 1005

def (value)
  @attributes[:login_help_text] = value
end

#login_page_background_image ⇒ Object

Image - Branded login page background



1019
1020
1021
 
# File 'lib/files.com/models/site.rb', line 1019

def 
  @attributes[:login_page_background_image]
end

#login_page_background_image=(value) ⇒ Object 



1023
1024
1025
 
# File 'lib/files.com/models/site.rb', line 1023

def (value)
  @attributes[:login_page_background_image] = value
end

#logo ⇒ Object

Image - Branded logo



1010
1011
1012
 
# File 'lib/files.com/models/site.rb', line 1010

def 
  @attributes[:logo]
end

#logo=(value) ⇒ Object 



1014
1015
1016
 
# File 'lib/files.com/models/site.rb', line 1014

def logo=(value)
  @attributes[:logo] = value
end

#managed_site_settings ⇒ Object

object - List of site settings managed by the parent site



1037
1038
1039
 
# File 'lib/files.com/models/site.rb', line 1037

def managed_site_settings
  @attributes[:managed_site_settings]
end

#managed_site_settings=(value) ⇒ Object 



1041
1042
1043
 
# File 'lib/files.com/models/site.rb', line 1041

def managed_site_settings=(value)
  @attributes[:managed_site_settings] = value
end

#max_prior_passwords ⇒ Object

int64 - Number of prior passwords to disallow



1028
1029
1030
 
# File 'lib/files.com/models/site.rb', line 1028

def max_prior_passwords
  @attributes[:max_prior_passwords]
end

#max_prior_passwords=(value) ⇒ Object 



1032
1033
1034
 
# File 'lib/files.com/models/site.rb', line 1032

def max_prior_passwords=(value)
  @attributes[:max_prior_passwords] = value
end

#mcp_dcr_enabled ⇒ Object

boolean - Is OAuth DCR (dynamic client registration) for MCP enabled?



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

def mcp_dcr_enabled
  @attributes[:mcp_dcr_enabled]
end

#mcp_dcr_enabled=(value) ⇒ Object 



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

def mcp_dcr_enabled=(value)
  @attributes[:mcp_dcr_enabled] = value
end

#migrate_remote_server_sync_to_sync ⇒ Object

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



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

def migrate_remote_server_sync_to_sync
  @attributes[:migrate_remote_server_sync_to_sync]
end

#migrate_remote_server_sync_to_sync=(value) ⇒ Object 



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

def migrate_remote_server_sync_to_sync=(value)
  @attributes[:migrate_remote_server_sync_to_sync] = value
end

#mobile_app ⇒ Object

boolean - Is the mobile app enabled?



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

def mobile_app
  @attributes[:mobile_app]
end

#mobile_app=(value) ⇒ Object 



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

def mobile_app=(value)
  @attributes[:mobile_app] = value
end

#mobile_app_session_ip_pinning ⇒ Object

boolean - Is mobile app session IP pinning enabled?



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

def mobile_app_session_ip_pinning
  @attributes[:mobile_app_session_ip_pinning]
end

#mobile_app_session_ip_pinning=(value) ⇒ Object 



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

def mobile_app_session_ip_pinning=(value)
  @attributes[:mobile_app_session_ip_pinning] = value
end

#mobile_app_session_lifetime ⇒ Object

int64 - Mobile app session lifetime (in hours)



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

def mobile_app_session_lifetime
  @attributes[:mobile_app_session_lifetime]
end

#mobile_app_session_lifetime=(value) ⇒ Object 



591
592
593
 
# File 'lib/files.com/models/site.rb', line 591

def mobile_app_session_lifetime=(value)
  @attributes[:mobile_app_session_lifetime] = value
end

#motd_text ⇒ Object

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



1046
1047
1048
 
# File 'lib/files.com/models/site.rb', line 1046

def motd_text
  @attributes[:motd_text]
end

#motd_text=(value) ⇒ Object 



1050
1051
1052
 
# File 'lib/files.com/models/site.rb', line 1050

def motd_text=(value)
  @attributes[:motd_text] = value
end

#motd_use_for_ftp ⇒ Object

boolean - Show message to users connecting via FTP



1055
1056
1057
 
# File 'lib/files.com/models/site.rb', line 1055

def motd_use_for_ftp
  @attributes[:motd_use_for_ftp]
end

#motd_use_for_ftp=(value) ⇒ Object 



1059
1060
1061
 
# File 'lib/files.com/models/site.rb', line 1059

def motd_use_for_ftp=(value)
  @attributes[:motd_use_for_ftp] = value
end

#motd_use_for_sftp ⇒ Object

boolean - Show message to users connecting via SFTP



1064
1065
1066
 
# File 'lib/files.com/models/site.rb', line 1064

def motd_use_for_sftp
  @attributes[:motd_use_for_sftp]
end

#motd_use_for_sftp=(value) ⇒ Object 



1068
1069
1070
 
# File 'lib/files.com/models/site.rb', line 1068

def motd_use_for_sftp=(value)
  @attributes[:motd_use_for_sftp] = value
end

#name ⇒ Object

string - Site name



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

def name
  @attributes[:name]
end

#name=(value) ⇒ Object 



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

def name=(value)
  @attributes[:name] = value
end

#next_billing_amount ⇒ Object

decimal - Next billing amount



1073
1074
1075
1076
1077
1078
 
# File 'lib/files.com/models/site.rb', line 1073

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_amount=(value) ⇒ Object 



1080
1081
1082
 
# File 'lib/files.com/models/site.rb', line 1080

def next_billing_amount=(value)
  @attributes[:next_billing_amount] = value
end

#next_billing_date ⇒ Object

string - Next billing date



1085
1086
1087
 
# File 'lib/files.com/models/site.rb', line 1085

def next_billing_date
  @attributes[:next_billing_date]
end

#next_billing_date=(value) ⇒ Object 



1089
1090
1091
 
# File 'lib/files.com/models/site.rb', line 1089

def next_billing_date=(value)
  @attributes[:next_billing_date] = value
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.



695
696
697
 
# File 'lib/files.com/models/site.rb', line 695

def non_sso_groups_allowed
  @attributes[:non_sso_groups_allowed]
end

#non_sso_groups_allowed=(value) ⇒ Object 



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

def non_sso_groups_allowed=(value)
  @attributes[:non_sso_groups_allowed] = value
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.



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

def non_sso_users_allowed
  @attributes[:non_sso_users_allowed]
end

#non_sso_users_allowed=(value) ⇒ Object 



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

def non_sso_users_allowed=(value)
  @attributes[:non_sso_users_allowed] = value
end

#office_integration_available ⇒ Object

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



1094
1095
1096
 
# File 'lib/files.com/models/site.rb', line 1094

def office_integration_available
  @attributes[:office_integration_available]
end

#office_integration_available=(value) ⇒ Object 



1098
1099
1100
 
# File 'lib/files.com/models/site.rb', line 1098

def office_integration_available=(value)
  @attributes[:office_integration_available] = value
end

#office_integration_type ⇒ Object

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



1103
1104
1105
 
# File 'lib/files.com/models/site.rb', line 1103

def office_integration_type
  @attributes[:office_integration_type]
end

#office_integration_type=(value) ⇒ Object 



1107
1108
1109
 
# File 'lib/files.com/models/site.rb', line 1107

def office_integration_type=(value)
  @attributes[:office_integration_type] = value
end

#oncehub_link ⇒ Object

string - Link to scheduling a meeting with our Sales team



1112
1113
1114
 
# File 'lib/files.com/models/site.rb', line 1112

def oncehub_link
  @attributes[:oncehub_link]
end

#oncehub_link=(value) ⇒ Object 



1116
1117
1118
 
# File 'lib/files.com/models/site.rb', line 1116

def oncehub_link=(value)
  @attributes[:oncehub_link] = value
end

#opt_out_global ⇒ Object

boolean - Use servers in the USA only?



1121
1122
1123
 
# File 'lib/files.com/models/site.rb', line 1121

def opt_out_global
  @attributes[:opt_out_global]
end

#opt_out_global=(value) ⇒ Object 



1125
1126
1127
 
# File 'lib/files.com/models/site.rb', line 1125

def opt_out_global=(value)
  @attributes[:opt_out_global] = value
end

#overdue ⇒ Object

boolean - Is this site's billing overdue?



1130
1131
1132
 
# File 'lib/files.com/models/site.rb', line 1130

def overdue
  @attributes[:overdue]
end

#overdue=(value) ⇒ Object 



1134
1135
1136
 
# File 'lib/files.com/models/site.rb', line 1134

def overdue=(value)
  @attributes[:overdue] = value
end

#password ⇒ Object

string



1742
1743
1744
 
# File 'lib/files.com/models/site.rb', line 1742

def password
  @attributes[:password]
end

#password=(value) ⇒ Object 



1746
1747
1748
 
# File 'lib/files.com/models/site.rb', line 1746

def password=(value)
  @attributes[:password] = value
end

#password_min_length ⇒ Object

int64 - Shortest password length for users



1139
1140
1141
 
# File 'lib/files.com/models/site.rb', line 1139

def password_min_length
  @attributes[:password_min_length]
end

#password_min_length=(value) ⇒ Object 



1143
1144
1145
 
# File 'lib/files.com/models/site.rb', line 1143

def password_min_length=(value)
  @attributes[:password_min_length] = value
end

#password_require_letter ⇒ Object

boolean - Require a letter in passwords?



1148
1149
1150
 
# File 'lib/files.com/models/site.rb', line 1148

def password_require_letter
  @attributes[:password_require_letter]
end

#password_require_letter=(value) ⇒ Object 



1152
1153
1154
 
# File 'lib/files.com/models/site.rb', line 1152

def password_require_letter=(value)
  @attributes[:password_require_letter] = value
end

#password_require_mixed ⇒ Object

boolean - Require lower and upper case letters in passwords?



1157
1158
1159
 
# File 'lib/files.com/models/site.rb', line 1157

def password_require_mixed
  @attributes[:password_require_mixed]
end

#password_require_mixed=(value) ⇒ Object 



1161
1162
1163
 
# File 'lib/files.com/models/site.rb', line 1161

def password_require_mixed=(value)
  @attributes[:password_require_mixed] = value
end

#password_require_number ⇒ Object

boolean - Require a number in passwords?



1166
1167
1168
 
# File 'lib/files.com/models/site.rb', line 1166

def password_require_number
  @attributes[:password_require_number]
end

#password_require_number=(value) ⇒ Object 



1170
1171
1172
 
# File 'lib/files.com/models/site.rb', line 1170

def password_require_number=(value)
  @attributes[:password_require_number] = value
end

#password_require_special ⇒ Object

boolean - Require special characters in password?



1175
1176
1177
 
# File 'lib/files.com/models/site.rb', line 1175

def password_require_special
  @attributes[:password_require_special]
end

#password_require_special=(value) ⇒ Object 



1179
1180
1181
 
# File 'lib/files.com/models/site.rb', line 1179

def password_require_special=(value)
  @attributes[:password_require_special] = value
end

#password_require_unbreached ⇒ Object

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



1184
1185
1186
 
# File 'lib/files.com/models/site.rb', line 1184

def password_require_unbreached
  @attributes[:password_require_unbreached]
end

#password_require_unbreached=(value) ⇒ Object 



1188
1189
1190
 
# File 'lib/files.com/models/site.rb', line 1188

def password_require_unbreached=(value)
  @attributes[:password_require_unbreached] = value
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?



1193
1194
1195
 
# File 'lib/files.com/models/site.rb', line 1193

def password_requirements_apply_to_bundles
  @attributes[:password_requirements_apply_to_bundles]
end

#password_requirements_apply_to_bundles=(value) ⇒ Object 



1197
1198
1199
 
# File 'lib/files.com/models/site.rb', line 1197

def password_requirements_apply_to_bundles=(value)
  @attributes[:password_requirements_apply_to_bundles] = value
end

#password_validity_days ⇒ Object

int64 - Number of days password is valid



1202
1203
1204
 
# File 'lib/files.com/models/site.rb', line 1202

def password_validity_days
  @attributes[:password_validity_days]
end

#password_validity_days=(value) ⇒ Object 



1206
1207
1208
 
# File 'lib/files.com/models/site.rb', line 1206

def password_validity_days=(value)
  @attributes[:password_validity_days] = value
end

#phone ⇒ Object

string - Site phone number



1211
1212
1213
 
# File 'lib/files.com/models/site.rb', line 1211

def phone
  @attributes[:phone]
end

#phone=(value) ⇒ Object 



1215
1216
1217
 
# File 'lib/files.com/models/site.rb', line 1215

def phone=(value)
  @attributes[:phone] = value
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.



1220
1221
1222
 
# File 'lib/files.com/models/site.rb', line 1220

def pin_all_remote_servers_to_site_region
  @attributes[:pin_all_remote_servers_to_site_region]
end

#pin_all_remote_servers_to_site_region=(value) ⇒ Object 



1224
1225
1226
 
# File 'lib/files.com/models/site.rb', line 1224

def pin_all_remote_servers_to_site_region=(value)
  @attributes[:pin_all_remote_servers_to_site_region] = value
end

#plan_id ⇒ Object

int64



1814
1815
1816
 
# File 'lib/files.com/models/site.rb', line 1814

def plan_id
  @attributes[:plan_id]
end

#plan_id=(value) ⇒ Object 



1818
1819
1820
 
# File 'lib/files.com/models/site.rb', line 1818

def plan_id=(value)
  @attributes[:plan_id] = value
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.



1229
1230
1231
 
# File 'lib/files.com/models/site.rb', line 1229

def prevent_root_permissions_for_non_site_admins
  @attributes[:prevent_root_permissions_for_non_site_admins]
end

#prevent_root_permissions_for_non_site_admins=(value) ⇒ Object 



1233
1234
1235
 
# File 'lib/files.com/models/site.rb', line 1233

def prevent_root_permissions_for_non_site_admins=(value)
  @attributes[:prevent_root_permissions_for_non_site_admins] = value
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.



1238
1239
1240
 
# File 'lib/files.com/models/site.rb', line 1238

def protocol_access_groups_only
  @attributes[:protocol_access_groups_only]
end

#protocol_access_groups_only=(value) ⇒ Object 



1242
1243
1244
 
# File 'lib/files.com/models/site.rb', line 1242

def protocol_access_groups_only=(value)
  @attributes[:protocol_access_groups_only] = value
end

#recaptcha_token ⇒ Object

string



1724
1725
1726
 
# File 'lib/files.com/models/site.rb', line 1724

def recaptcha_token
  @attributes[:recaptcha_token]
end

#recaptcha_token=(value) ⇒ Object 



1728
1729
1730
 
# File 'lib/files.com/models/site.rb', line 1728

def recaptcha_token=(value)
  @attributes[:recaptcha_token] = value
end

#reply_to_email ⇒ Object

email - Reply-to email for this site



686
687
688
 
# File 'lib/files.com/models/site.rb', line 686

def reply_to_email
  @attributes[:reply_to_email]
end

#reply_to_email=(value) ⇒ Object 



690
691
692
 
# File 'lib/files.com/models/site.rb', line 690

def reply_to_email=(value)
  @attributes[:reply_to_email] = value
end

#require_2fa ⇒ Object

boolean - Require two-factor authentication for all users?



1247
1248
1249
 
# File 'lib/files.com/models/site.rb', line 1247

def require_2fa
  @attributes[:require_2fa]
end

#require_2fa=(value) ⇒ Object 



1251
1252
1253
 
# File 'lib/files.com/models/site.rb', line 1251

def require_2fa=(value)
  @attributes[:require_2fa] = value
end

#require_2fa_exempt_all_sso_users ⇒ Object

boolean - If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.



1256
1257
1258
 
# File 'lib/files.com/models/site.rb', line 1256

def require_2fa_exempt_all_sso_users
  @attributes[:require_2fa_exempt_all_sso_users]
end

#require_2fa_exempt_all_sso_users=(value) ⇒ Object 



1260
1261
1262
 
# File 'lib/files.com/models/site.rb', line 1260

def require_2fa_exempt_all_sso_users=(value)
  @attributes[:require_2fa_exempt_all_sso_users] = value
end

#require_2fa_stop_time ⇒ Object

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



1265
1266
1267
 
# File 'lib/files.com/models/site.rb', line 1265

def require_2fa_stop_time
  @attributes[:require_2fa_stop_time]
end

#require_2fa_stop_time=(value) ⇒ Object 



1269
1270
1271
 
# File 'lib/files.com/models/site.rb', line 1269

def require_2fa_stop_time=(value)
  @attributes[:require_2fa_stop_time] = value
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)?



1283
1284
1285
 
# File 'lib/files.com/models/site.rb', line 1283

def require_2fa_user_type
  @attributes[:require_2fa_user_type]
end

#require_2fa_user_type=(value) ⇒ Object 



1287
1288
1289
 
# File 'lib/files.com/models/site.rb', line 1287

def require_2fa_user_type=(value)
  @attributes[:require_2fa_user_type] = value
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.



1292
1293
1294
 
# File 'lib/files.com/models/site.rb', line 1292

def require_logout_from_bundles_and_inboxes
  @attributes[:require_logout_from_bundles_and_inboxes]
end

#require_logout_from_bundles_and_inboxes=(value) ⇒ Object 



1296
1297
1298
 
# File 'lib/files.com/models/site.rb', line 1296

def require_logout_from_bundles_and_inboxes=(value)
  @attributes[:require_logout_from_bundles_and_inboxes] = value
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.



1274
1275
1276
 
# File 'lib/files.com/models/site.rb', line 1274

def revoke_bundle_access_on_disable_or_delete
  @attributes[:revoke_bundle_access_on_disable_or_delete]
end

#revoke_bundle_access_on_disable_or_delete=(value) ⇒ Object 



1278
1279
1280
 
# File 'lib/files.com/models/site.rb', line 1278

def revoke_bundle_access_on_disable_or_delete=(value)
  @attributes[:revoke_bundle_access_on_disable_or_delete] = value
end

#save ⇒ Object 



1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
 
# File 'lib/files.com/models/site.rb', line 1846

def save
  if @attributes[:id]
    raise NotImplementedError.new("The Site object doesn't support updates.")
  else
    new_obj = Site.create(@attributes, @options)
  end

  @attributes = new_obj.attributes
  true
end

#session ⇒ Object

Session - Current session



1301
1302
1303
 
# File 'lib/files.com/models/site.rb', line 1301

def session
  @attributes[:session]
end

#session=(value) ⇒ Object 



1305
1306
1307
 
# File 'lib/files.com/models/site.rb', line 1305

def session=(value)
  @attributes[:session] = value
end

#session_expiry_minutes ⇒ Object

int64 - Session expiry in minutes



1481
1482
1483
 
# File 'lib/files.com/models/site.rb', line 1481

def session_expiry_minutes
  @attributes[:session_expiry_minutes]
end

#session_expiry_minutes=(value) ⇒ Object 



1485
1486
1487
 
# File 'lib/files.com/models/site.rb', line 1485

def session_expiry_minutes=(value)
  @attributes[:session_expiry_minutes] = value
end

#sftp_enabled ⇒ Object

boolean - Is SFTP enabled?



1310
1311
1312
 
# File 'lib/files.com/models/site.rb', line 1310

def sftp_enabled
  @attributes[:sftp_enabled]
end

#sftp_enabled=(value) ⇒ Object 



1314
1315
1316
 
# File 'lib/files.com/models/site.rb', line 1314

def sftp_enabled=(value)
  @attributes[:sftp_enabled] = value
end

#sftp_finalize_partial_uploads ⇒ Object

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



1319
1320
1321
 
# File 'lib/files.com/models/site.rb', line 1319

def sftp_finalize_partial_uploads
  @attributes[:sftp_finalize_partial_uploads]
end

#sftp_finalize_partial_uploads=(value) ⇒ Object 



1323
1324
1325
 
# File 'lib/files.com/models/site.rb', line 1323

def sftp_finalize_partial_uploads=(value)
  @attributes[:sftp_finalize_partial_uploads] = value
end

#sftp_host_key_type ⇒ Object

string - Sftp Host Key Type



1328
1329
1330
 
# File 'lib/files.com/models/site.rb', line 1328

def sftp_host_key_type
  @attributes[:sftp_host_key_type]
end

#sftp_host_key_type=(value) ⇒ Object 



1332
1333
1334
 
# File 'lib/files.com/models/site.rb', line 1332

def sftp_host_key_type=(value)
  @attributes[:sftp_host_key_type] = value
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.



1346
1347
1348
 
# File 'lib/files.com/models/site.rb', line 1346

def sftp_insecure_ciphers
  @attributes[:sftp_insecure_ciphers]
end

#sftp_insecure_ciphers=(value) ⇒ Object 



1350
1351
1352
 
# File 'lib/files.com/models/site.rb', line 1350

def sftp_insecure_ciphers=(value)
  @attributes[:sftp_insecure_ciphers] = value
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.



1355
1356
1357
 
# File 'lib/files.com/models/site.rb', line 1355

def sftp_insecure_diffie_hellman
  @attributes[:sftp_insecure_diffie_hellman]
end

#sftp_insecure_diffie_hellman=(value) ⇒ Object 



1359
1360
1361
 
# File 'lib/files.com/models/site.rb', line 1359

def sftp_insecure_diffie_hellman=(value)
  @attributes[:sftp_insecure_diffie_hellman] = value
end

#sftp_user_root_enabled ⇒ Object

boolean - Use user FTP roots also for SFTP?



1364
1365
1366
 
# File 'lib/files.com/models/site.rb', line 1364

def sftp_user_root_enabled
  @attributes[:sftp_user_root_enabled]
end

#sftp_user_root_enabled=(value) ⇒ Object 



1368
1369
1370
 
# File 'lib/files.com/models/site.rb', line 1368

def sftp_user_root_enabled=(value)
  @attributes[:sftp_user_root_enabled] = value
end

#sharing_enabled ⇒ Object

boolean - Allow bundle creation



1373
1374
1375
 
# File 'lib/files.com/models/site.rb', line 1373

def sharing_enabled
  @attributes[:sharing_enabled]
end

#sharing_enabled=(value) ⇒ Object 



1377
1378
1379
 
# File 'lib/files.com/models/site.rb', line 1377

def sharing_enabled=(value)
  @attributes[:sharing_enabled] = value
end

#show_request_access_link ⇒ Object

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



1391
1392
1393
 
# File 'lib/files.com/models/site.rb', line 1391

def show_request_access_link
  @attributes[:show_request_access_link]
end

#show_request_access_link=(value) ⇒ Object 



1395
1396
1397
 
# File 'lib/files.com/models/site.rb', line 1395

def show_request_access_link=(value)
  @attributes[:show_request_access_link] = value
end

#show_user_notifications_log_in_link ⇒ Object

boolean - Show log in link in user notifications?



1382
1383
1384
 
# File 'lib/files.com/models/site.rb', line 1382

def 
  @attributes[:show_user_notifications_log_in_link]
end

#show_user_notifications_log_in_link=(value) ⇒ Object 



1386
1387
1388
 
# File 'lib/files.com/models/site.rb', line 1386

def (value)
  @attributes[:show_user_notifications_log_in_link] = value
end

#site_footer ⇒ Object

string - Custom site footer text for authenticated pages



1400
1401
1402
 
# File 'lib/files.com/models/site.rb', line 1400

def site_footer
  @attributes[:site_footer]
end

#site_footer=(value) ⇒ Object 



1404
1405
1406
 
# File 'lib/files.com/models/site.rb', line 1404

def site_footer=(value)
  @attributes[:site_footer] = value
end

#site_header ⇒ Object

string - Custom site header text for authenticated pages



1409
1410
1411
 
# File 'lib/files.com/models/site.rb', line 1409

def site_header
  @attributes[:site_header]
end

#site_header=(value) ⇒ Object 



1413
1414
1415
 
# File 'lib/files.com/models/site.rb', line 1413

def site_header=(value)
  @attributes[:site_header] = value
end

#site_public_footer ⇒ Object

string - Custom site footer text for public pages



1418
1419
1420
 
# File 'lib/files.com/models/site.rb', line 1418

def site_public_footer
  @attributes[:site_public_footer]
end

#site_public_footer=(value) ⇒ Object 



1422
1423
1424
 
# File 'lib/files.com/models/site.rb', line 1422

def site_public_footer=(value)
  @attributes[:site_public_footer] = value
end

#site_public_header ⇒ Object

string - Custom site header text for public pages



1427
1428
1429
 
# File 'lib/files.com/models/site.rb', line 1427

def site_public_header
  @attributes[:site_public_header]
end

#site_public_header=(value) ⇒ Object 



1431
1432
1433
 
# File 'lib/files.com/models/site.rb', line 1431

def site_public_header=(value)
  @attributes[:site_public_header] = value
end

#smtp_address ⇒ Object

string - SMTP server hostname or IP



1436
1437
1438
 
# File 'lib/files.com/models/site.rb', line 1436

def smtp_address
  @attributes[:smtp_address]
end

#smtp_address=(value) ⇒ Object 



1440
1441
1442
 
# File 'lib/files.com/models/site.rb', line 1440

def smtp_address=(value)
  @attributes[:smtp_address] = value
end

#smtp_authentication ⇒ Object

string - SMTP server authentication type



1445
1446
1447
 
# File 'lib/files.com/models/site.rb', line 1445

def smtp_authentication
  @attributes[:smtp_authentication]
end

#smtp_authentication=(value) ⇒ Object 



1449
1450
1451
 
# File 'lib/files.com/models/site.rb', line 1449

def smtp_authentication=(value)
  @attributes[:smtp_authentication] = value
end

#smtp_from ⇒ Object

string - From address to use when mailing through custom SMTP



1454
1455
1456
 
# File 'lib/files.com/models/site.rb', line 1454

def smtp_from
  @attributes[:smtp_from]
end

#smtp_from=(value) ⇒ Object 



1458
1459
1460
 
# File 'lib/files.com/models/site.rb', line 1458

def smtp_from=(value)
  @attributes[:smtp_from] = value
end

#smtp_port ⇒ Object

int64 - SMTP server port



1463
1464
1465
 
# File 'lib/files.com/models/site.rb', line 1463

def smtp_port
  @attributes[:smtp_port]
end

#smtp_port=(value) ⇒ Object 



1467
1468
1469
 
# File 'lib/files.com/models/site.rb', line 1467

def smtp_port=(value)
  @attributes[:smtp_port] = value
end

#smtp_username ⇒ Object

string - SMTP server username



1472
1473
1474
 
# File 'lib/files.com/models/site.rb', line 1472

def smtp_username
  @attributes[:smtp_username]
end

#smtp_username=(value) ⇒ Object 



1476
1477
1478
 
# File 'lib/files.com/models/site.rb', line 1476

def smtp_username=(value)
  @attributes[:smtp_username] = value
end

#snapshot_sharing_enabled ⇒ Object

boolean - Allow snapshot share links creation



1490
1491
1492
 
# File 'lib/files.com/models/site.rb', line 1490

def snapshot_sharing_enabled
  @attributes[:snapshot_sharing_enabled]
end

#snapshot_sharing_enabled=(value) ⇒ Object 



1494
1495
1496
 
# File 'lib/files.com/models/site.rb', line 1494

def snapshot_sharing_enabled=(value)
  @attributes[:snapshot_sharing_enabled] = value
end

#ssl_required ⇒ Object

boolean - Is SSL required? Disabling this is insecure.



1499
1500
1501
 
# File 'lib/files.com/models/site.rb', line 1499

def ssl_required
  @attributes[:ssl_required]
end

#ssl_required=(value) ⇒ Object 



1503
1504
1505
 
# File 'lib/files.com/models/site.rb', line 1503

def ssl_required=(value)
  @attributes[:ssl_required] = value
end

#subdomain ⇒ Object

string - Site subdomain



1508
1509
1510
 
# File 'lib/files.com/models/site.rb', line 1508

def subdomain
  @attributes[:subdomain]
end

#subdomain=(value) ⇒ Object 



1512
1513
1514
 
# File 'lib/files.com/models/site.rb', line 1512

def subdomain=(value)
  @attributes[:subdomain] = value
end

#switch_to_plan_date ⇒ Object

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



1517
1518
1519
 
# File 'lib/files.com/models/site.rb', line 1517

def switch_to_plan_date
  @attributes[:switch_to_plan_date]
end

#switch_to_plan_date=(value) ⇒ Object 



1521
1522
1523
 
# File 'lib/files.com/models/site.rb', line 1521

def switch_to_plan_date=(value)
  @attributes[:switch_to_plan_date] = value
end

#trial_days_left ⇒ Object

int64 - Number of days left in trial



1526
1527
1528
 
# File 'lib/files.com/models/site.rb', line 1526

def trial_days_left
  @attributes[:trial_days_left]
end

#trial_days_left=(value) ⇒ Object 



1530
1531
1532
 
# File 'lib/files.com/models/site.rb', line 1530

def trial_days_left=(value)
  @attributes[:trial_days_left] = value
end

#trial_until ⇒ Object

date-time - When does this Site trial expire?



1535
1536
1537
 
# File 'lib/files.com/models/site.rb', line 1535

def trial_until
  @attributes[:trial_until]
end

#trial_until=(value) ⇒ Object 



1539
1540
1541
 
# File 'lib/files.com/models/site.rb', line 1539

def trial_until=(value)
  @attributes[:trial_until] = value
end

#update_plan(params = {}) ⇒ Object

Change the current billing plan for the site

Parameters:

billing_frequency - int64 - The billing frequency for the site.  Must be 1 (monthly) or 12 (annual).

Raises:



1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
 
# File 'lib/files.com/models/site.rb', line 1835

def update_plan(params = {})
  params ||= {}
  params[:id] = @attributes[:id]
  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: billing_frequency must be an Integer") if params[:billing_frequency] and !params[:billing_frequency].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  Api.send_request("/site/plan", :patch, params, @options)
end

#uploads_via_email_authentication ⇒ Object

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



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

def uploads_via_email_authentication
  @attributes[:uploads_via_email_authentication]
end

#uploads_via_email_authentication=(value) ⇒ Object 



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

def uploads_via_email_authentication=(value)
  @attributes[:uploads_via_email_authentication] = value
end

#use_dedicated_ips_for_smtp ⇒ Object

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



1544
1545
1546
 
# File 'lib/files.com/models/site.rb', line 1544

def use_dedicated_ips_for_smtp
  @attributes[:use_dedicated_ips_for_smtp]
end

#use_dedicated_ips_for_smtp=(value) ⇒ Object 



1548
1549
1550
 
# File 'lib/files.com/models/site.rb', line 1548

def use_dedicated_ips_for_smtp=(value)
  @attributes[:use_dedicated_ips_for_smtp] = value
end

#use_provided_modified_at ⇒ Object

boolean - Allow uploaders to set provided_modified_at for uploaded files?



1553
1554
1555
 
# File 'lib/files.com/models/site.rb', line 1553

def use_provided_modified_at
  @attributes[:use_provided_modified_at]
end

#use_provided_modified_at=(value) ⇒ Object 



1557
1558
1559
 
# File 'lib/files.com/models/site.rb', line 1557

def use_provided_modified_at=(value)
  @attributes[:use_provided_modified_at] = value
end

#user ⇒ Object

User - User of current session



1562
1563
1564
 
# File 'lib/files.com/models/site.rb', line 1562

def user
  @attributes[:user]
end

#user=(value) ⇒ Object 



1566
1567
1568
 
# File 'lib/files.com/models/site.rb', line 1566

def user=(value)
  @attributes[:user] = value
end

#user_lockout ⇒ Object

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



1571
1572
1573
 
# File 'lib/files.com/models/site.rb', line 1571

def user_lockout
  @attributes[:user_lockout]
end

#user_lockout=(value) ⇒ Object 



1575
1576
1577
 
# File 'lib/files.com/models/site.rb', line 1575

def user_lockout=(value)
  @attributes[:user_lockout] = value
end

#user_lockout_lock_period ⇒ Object

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



1580
1581
1582
 
# File 'lib/files.com/models/site.rb', line 1580

def user_lockout_lock_period
  @attributes[:user_lockout_lock_period]
end

#user_lockout_lock_period=(value) ⇒ Object 



1584
1585
1586
 
# File 'lib/files.com/models/site.rb', line 1584

def user_lockout_lock_period=(value)
  @attributes[:user_lockout_lock_period] = value
end

#user_lockout_tries ⇒ Object

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



1589
1590
1591
 
# File 'lib/files.com/models/site.rb', line 1589

def user_lockout_tries
  @attributes[:user_lockout_tries]
end

#user_lockout_tries=(value) ⇒ Object 



1593
1594
1595
 
# File 'lib/files.com/models/site.rb', line 1593

def user_lockout_tries=(value)
  @attributes[:user_lockout_tries] = value
end

#user_lockout_within ⇒ Object

int64 - Number of hours for user lockout window



1598
1599
1600
 
# File 'lib/files.com/models/site.rb', line 1598

def user_lockout_within
  @attributes[:user_lockout_within]
end

#user_lockout_within=(value) ⇒ Object 



1602
1603
1604
 
# File 'lib/files.com/models/site.rb', line 1602

def user_lockout_within=(value)
  @attributes[:user_lockout_within] = value
end

#user_requests_enabled ⇒ Object

boolean - Enable User Requests feature



1607
1608
1609
 
# File 'lib/files.com/models/site.rb', line 1607

def user_requests_enabled
  @attributes[:user_requests_enabled]
end

#user_requests_enabled=(value) ⇒ Object 



1611
1612
1613
 
# File 'lib/files.com/models/site.rb', line 1611

def user_requests_enabled=(value)
  @attributes[:user_requests_enabled] = value
end

#user_requests_notify_admins ⇒ Object

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



1616
1617
1618
 
# File 'lib/files.com/models/site.rb', line 1616

def user_requests_notify_admins
  @attributes[:user_requests_notify_admins]
end

#user_requests_notify_admins=(value) ⇒ Object 



1620
1621
1622
 
# File 'lib/files.com/models/site.rb', line 1620

def user_requests_notify_admins=(value)
  @attributes[:user_requests_notify_admins] = value
end

#username ⇒ Object

string



1733
1734
1735
 
# File 'lib/files.com/models/site.rb', line 1733

def username
  @attributes[:username]
end

#username=(value) ⇒ Object 



1737
1738
1739
 
# File 'lib/files.com/models/site.rb', line 1737

def username=(value)
  @attributes[:username] = value
end

#username_display ⇒ Object

string - How usernames are displayed in the web UI. Can be username_only, full_name_only, full_name_username, full_name_company, or full_name_username_company.



1643
1644
1645
 
# File 'lib/files.com/models/site.rb', line 1643

def username_display
  @attributes[:username_display]
end

#username_display=(value) ⇒ Object 



1647
1648
1649
 
# File 'lib/files.com/models/site.rb', line 1647

def username_display=(value)
  @attributes[:username_display] = value
end

#users_can_create_api_keys ⇒ Object

boolean - Allow users to create their own API keys?



1625
1626
1627
 
# File 'lib/files.com/models/site.rb', line 1625

def users_can_create_api_keys
  @attributes[:users_can_create_api_keys]
end

#users_can_create_api_keys=(value) ⇒ Object 



1629
1630
1631
 
# File 'lib/files.com/models/site.rb', line 1629

def users_can_create_api_keys=(value)
  @attributes[:users_can_create_api_keys] = value
end

#users_can_create_ssh_keys ⇒ Object

boolean - Allow users to create their own SSH keys?



1634
1635
1636
 
# File 'lib/files.com/models/site.rb', line 1634

def users_can_create_ssh_keys
  @attributes[:users_can_create_ssh_keys]
end

#users_can_create_ssh_keys=(value) ⇒ Object 



1638
1639
1640
 
# File 'lib/files.com/models/site.rb', line 1638

def users_can_create_ssh_keys=(value)
  @attributes[:users_can_create_ssh_keys] = value
end

#utm_campaign ⇒ Object

string



1787
1788
1789
 
# File 'lib/files.com/models/site.rb', line 1787

def utm_campaign
  @attributes[:utm_campaign]
end

#utm_campaign=(value) ⇒ Object 



1791
1792
1793
 
# File 'lib/files.com/models/site.rb', line 1791

def utm_campaign=(value)
  @attributes[:utm_campaign] = value
end

#utm_content ⇒ Object

string



1769
1770
1771
 
# File 'lib/files.com/models/site.rb', line 1769

def utm_content
  @attributes[:utm_content]
end

#utm_content=(value) ⇒ Object 



1773
1774
1775
 
# File 'lib/files.com/models/site.rb', line 1773

def utm_content=(value)
  @attributes[:utm_content] = value
end

#utm_domain ⇒ Object

string



1796
1797
1798
 
# File 'lib/files.com/models/site.rb', line 1796

def utm_domain
  @attributes[:utm_domain]
end

#utm_domain=(value) ⇒ Object 



1800
1801
1802
 
# File 'lib/files.com/models/site.rb', line 1800

def utm_domain=(value)
  @attributes[:utm_domain] = value
end

#utm_medium ⇒ Object

string



1778
1779
1780
 
# File 'lib/files.com/models/site.rb', line 1778

def utm_medium
  @attributes[:utm_medium]
end

#utm_medium=(value) ⇒ Object 



1782
1783
1784
 
# File 'lib/files.com/models/site.rb', line 1782

def utm_medium=(value)
  @attributes[:utm_medium] = value
end

#utm_source ⇒ Object

string



1760
1761
1762
 
# File 'lib/files.com/models/site.rb', line 1760

def utm_source
  @attributes[:utm_source]
end

#utm_source=(value) ⇒ Object 



1764
1765
1766
 
# File 'lib/files.com/models/site.rb', line 1764

def utm_source=(value)
  @attributes[:utm_source] = value
end

#utm_term ⇒ Object

string



1751
1752
1753
 
# File 'lib/files.com/models/site.rb', line 1751

def utm_term
  @attributes[:utm_term]
end

#utm_term=(value) ⇒ Object 



1755
1756
1757
 
# File 'lib/files.com/models/site.rb', line 1755

def utm_term=(value)
  @attributes[:utm_term] = value
end

#welcome_custom_text ⇒ Object

string - Custom text send in user welcome email



1652
1653
1654
 
# File 'lib/files.com/models/site.rb', line 1652

def welcome_custom_text
  @attributes[:welcome_custom_text]
end

#welcome_custom_text=(value) ⇒ Object 



1656
1657
1658
 
# File 'lib/files.com/models/site.rb', line 1656

def welcome_custom_text=(value)
  @attributes[:welcome_custom_text] = value
end

#welcome_email_cc ⇒ Object

email - Include this email in welcome emails if enabled



1670
1671
1672
 
# File 'lib/files.com/models/site.rb', line 1670

def welcome_email_cc
  @attributes[:welcome_email_cc]
end

#welcome_email_cc=(value) ⇒ Object 



1674
1675
1676
 
# File 'lib/files.com/models/site.rb', line 1674

def welcome_email_cc=(value)
  @attributes[:welcome_email_cc] = value
end

#welcome_email_enabled ⇒ Object

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



1688
1689
1690
 
# File 'lib/files.com/models/site.rb', line 1688

def welcome_email_enabled
  @attributes[:welcome_email_enabled]
end

#welcome_email_enabled=(value) ⇒ Object 



1692
1693
1694
 
# File 'lib/files.com/models/site.rb', line 1692

def welcome_email_enabled=(value)
  @attributes[:welcome_email_enabled] = value
end

#welcome_email_subject ⇒ Object

string - Include this email subject in welcome emails if enabled



1679
1680
1681
 
# File 'lib/files.com/models/site.rb', line 1679

def welcome_email_subject
  @attributes[:welcome_email_subject]
end

#welcome_email_subject=(value) ⇒ Object 



1683
1684
1685
 
# File 'lib/files.com/models/site.rb', line 1683

def welcome_email_subject=(value)
  @attributes[:welcome_email_subject] = value
end

#welcome_screen ⇒ Object

string - Does the welcome screen appear?



1697
1698
1699
 
# File 'lib/files.com/models/site.rb', line 1697

def welcome_screen
  @attributes[:welcome_screen]
end

#welcome_screen=(value) ⇒ Object 



1701
1702
1703
 
# File 'lib/files.com/models/site.rb', line 1701

def welcome_screen=(value)
  @attributes[:welcome_screen] = value
end

#windows_mode_ftp ⇒ Object

boolean - Does FTP user Windows emulation mode?



1706
1707
1708
 
# File 'lib/files.com/models/site.rb', line 1706

def windows_mode_ftp
  @attributes[:windows_mode_ftp]
end

#windows_mode_ftp=(value) ⇒ Object 



1710
1711
1712
 
# File 'lib/files.com/models/site.rb', line 1710

def windows_mode_ftp=(value)
  @attributes[:windows_mode_ftp] = value
end