Class: Files::Site

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Site.



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

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

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



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

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



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

def options
  @options
end

Class Method Details

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



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

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

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



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

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

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

Parameters:

name - string - Site name
subdomain - string - Site subdomain
domain - string - Custom domain
domain_hsts_header - boolean - Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
domain_letsencrypt_chain - string - Letsencrypt chain to use when registering SSL Certificate for domain.
email - string - Main email for this site
reply_to_email - string - Reply-to email for this site
allow_bundle_names - boolean - Are manual Bundle names allowed?
bundle_expiration - int64 - Site-wide Bundle expiration in days
overage_notify - boolean - Notify site email of overages?
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.
welcome_email_cc - string - Include this email in welcome emails if enabled
welcome_custom_text - string - Custom text send in user welcome email
language - string - Site default language
windows_mode_ftp - boolean - Does FTP user Windows emulation mode?
default_time_zone - string - Site default time zone
desktop_app - boolean - Is the desktop app enabled?
desktop_app_session_ip_pinning - boolean - Is desktop app session IP pinning enabled?
desktop_app_session_lifetime - int64 - Desktop app session lifetime (in hours)
mobile_app - boolean - Is the mobile app enabled?
mobile_app_session_ip_pinning - boolean - Is mobile app session IP pinning enabled?
mobile_app_session_lifetime - int64 - Mobile app session lifetime (in hours)
folder_permissions_groups_only - boolean - If true, permissions for this site must be bound to a group (not a user). Otherwise, permissions must be bound to a user.
welcome_screen - string - Does the welcome screen appear?
office_integration_available - boolean - Allow users to use Office for the web?
session_expiry - double - Session expiry in hours
ssl_required - boolean - Is SSL required?  Disabling this is insecure.
tls_disabled - boolean - Are Insecure TLS and SFTP Ciphers allowed?  Enabling this is insecure.
sftp_insecure_ciphers - boolean - Are Insecure Ciphers allowed for SFTP?  Note:  Settting TLS Disabled -> True will always allow insecure ciphers for SFTP as well.  Enabling this is insecure.
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 seperated list of allowed Country codes
allowed_ips - string - List of allowed IP addresses
disallowed_countries - string - Comma seperated 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/)
sftp_user_root_enabled - boolean - Use user FTP roots also for SFTP?
disable_password_reset - boolean - Is password reset disabled?
immutable_files - boolean - Are files protected from modification?
session_pinned_by_ip - boolean - Are sessions locked to the same IP? (i.e. do users need to log in again if they change IPs?)
bundle_password_required - boolean - Do Bundles require password protection?
bundle_require_share_recipient - boolean - Do Bundles require recipients for sharing?
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?
opt_out_global - boolean - Use servers in the USA only?
use_provided_modified_at - boolean - Allow uploaders to set `provided_modified_at` for uploaded files?
custom_namespace - boolean - Is this site using a custom namespace for users?
disable_users_from_inactivity_period_days - int64 - If greater than zero, users will unable to login if they do not show activity within this number of days.
non_sso_groups_allowed - boolean - If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
non_sso_users_allowed - boolean - If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
sharing_enabled - boolean - Allow bundle creation
user_requests_enabled - boolean - Enable User Requests feature
ftp_enabled - boolean - Is FTP enabled?
sftp_enabled - boolean - Is SFTP enabled?
allowed_2fa_method_sms - boolean - Is SMS two factor authentication allowed?
allowed_2fa_method_u2f - boolean - Is U2F 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?
require_2fa - boolean - Require two-factor authentication for all users?
require_2fa_user_type - string - What type of user is required to use two-factor authentication (when require_2fa is set to `true` for this site)?
color2_top - string - Top bar background color
color2_left - string - Page link and button color
color2_link - string - Top bar link color
color2_text - string - Page link and button color
color2_top_text - string - Top bar text color
site_header - string - Custom site header text
site_footer - string - Custom site footer text
login_help_text - string - Login help text
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
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
disable_2fa_with_delay - boolean - If set to true, we will begin the process of disabling 2FA on this site.
ldap_password_change - string - New LDAP password.
ldap_password_change_confirmation - string - Confirm new LDAP password.
smtp_password - string - Password for SMTP server.

Raises:



775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/files.com/models/site.rb', line 775

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

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

Instance Method Details

#admin_user_id ⇒ Object

int64 - User ID for the main site administrator



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

def admin_user_id
  @attributes[:admin_user_id]
end

#allow_bundle_names ⇒ Object

boolean - Are manual Bundle names allowed?



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

def allow_bundle_names
  @attributes[:allow_bundle_names]
end

#allowed_2fa_method_sms ⇒ Object

boolean - Is SMS two factor authentication allowed?



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

def allowed_2fa_method_sms
  @attributes[:allowed_2fa_method_sms]
end

#allowed_2fa_method_totp ⇒ Object

boolean - Is TOTP two factor authentication allowed?



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

def allowed_2fa_method_totp
  @attributes[:allowed_2fa_method_totp]
end

#allowed_2fa_method_u2f ⇒ Object

boolean - Is U2F two factor authentication allowed?



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

def allowed_2fa_method_u2f
  @attributes[:allowed_2fa_method_u2f]
end

#allowed_2fa_method_webauthn ⇒ Object

boolean - Is WebAuthn two factor authentication allowed?



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

def allowed_2fa_method_webauthn
  @attributes[:allowed_2fa_method_webauthn]
end

#allowed_2fa_method_yubi ⇒ Object

boolean - Is yubikey two factor authentication allowed?



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

def allowed_2fa_method_yubi
  @attributes[:allowed_2fa_method_yubi]
end

#allowed_countries ⇒ Object

string - Comma seperated list of allowed Country codes



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

def allowed_countries
  @attributes[:allowed_countries]
end

#allowed_ips ⇒ Object

string - List of allowed IP addresses



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

def allowed_ips
  @attributes[:allowed_ips]
end

#ask_about_overwrites ⇒ Object

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



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

def ask_about_overwrites
  @attributes[:ask_about_overwrites]
end

#bundle_expiration ⇒ Object

int64 - Site-wide Bundle expiration in days



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

def bundle_expiration
  @attributes[:bundle_expiration]
end

#bundle_password_required ⇒ Object

boolean - Do Bundles require password protection?



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

def bundle_password_required
  @attributes[:bundle_password_required]
end

#bundle_require_share_recipient ⇒ Object

boolean - Do Bundles require recipients for sharing?



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

def bundle_require_share_recipient
  @attributes[:bundle_require_share_recipient]
end

#bundle_watermark_attachment ⇒ Object

Preview watermark image applied to all bundle items.



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

def bundle_watermark_attachment
  @attributes[:bundle_watermark_attachment]
end

#bundle_watermark_value ⇒ Object

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



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

def bundle_watermark_value
  @attributes[:bundle_watermark_value]
end

#color2_left ⇒ Object

string - Page link and button color



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

def color2_left
  @attributes[:color2_left]
end

#color2_link ⇒ Object

string - Top bar link color



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

def color2_link
  @attributes[:color2_link]
end

#color2_text ⇒ Object

string - Page link and button color



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

def color2_text
  @attributes[:color2_text]
end

#color2_top ⇒ Object

string - Top bar background color



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

def color2_top
  @attributes[:color2_top]
end

#color2_top_text ⇒ Object

string - Top bar text color



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

def color2_top_text
  @attributes[:color2_top_text]
end

#contact_name ⇒ Object

string - Site main contact name



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

def contact_name
  @attributes[:contact_name]
end

#created_at ⇒ Object

date-time - Time this site was created



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

def created_at
  @attributes[:created_at]
end

#currency ⇒ Object

string - Preferred currency



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

def currency
  @attributes[:currency]
end

#custom_namespace ⇒ Object

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



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

def custom_namespace
  @attributes[:custom_namespace]
end

#days_to_retain_backups ⇒ Object

int64 - Number of days to keep deleted files



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

def days_to_retain_backups
  @attributes[:days_to_retain_backups]
end

#default_time_zone ⇒ Object

string - Site default time zone



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

def default_time_zone
  @attributes[:default_time_zone]
end

#desktop_app ⇒ Object

boolean - Is the desktop app enabled?



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

def desktop_app
  @attributes[:desktop_app]
end

#desktop_app_session_ip_pinning ⇒ Object

boolean - Is desktop app session IP pinning enabled?



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

def desktop_app_session_ip_pinning
  @attributes[:desktop_app_session_ip_pinning]
end

#desktop_app_session_lifetime ⇒ Object

int64 - Desktop app session lifetime (in hours)



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

def desktop_app_session_lifetime
  @attributes[:desktop_app_session_lifetime]
end

#disable_notifications ⇒ Object

boolean - Are notifications disabled?



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

def disable_notifications
  @attributes[:disable_notifications]
end

#disable_password_reset ⇒ Object

boolean - Is password reset disabled?



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

def disable_password_reset
  @attributes[:disable_password_reset]
end

#disable_users_from_inactivity_period_days ⇒ Object

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



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

def disable_users_from_inactivity_period_days
  @attributes[:disable_users_from_inactivity_period_days]
end

#disallowed_countries ⇒ Object

string - Comma seperated list of disallowed Country codes



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

def disallowed_countries
  @attributes[:disallowed_countries]
end

#domain ⇒ Object

string - Custom domain



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

def domain
  @attributes[:domain]
end

#domain_hsts_header ⇒ Object

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



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

def domain_hsts_header
  @attributes[:domain_hsts_header]
end

#domain_letsencrypt_chain ⇒ Object

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



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

def domain_letsencrypt_chain
  @attributes[:domain_letsencrypt_chain]
end

#email ⇒ Object

email - Main email for this site



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

def email
  @attributes[:email]
end

#folder_permissions_groups_only ⇒ Object

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



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

def folder_permissions_groups_only
  @attributes[:folder_permissions_groups_only]
end

#ftp_enabled ⇒ Object

boolean - Is FTP enabled?



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

def ftp_enabled
  @attributes[:ftp_enabled]
end

#hipaa ⇒ Object

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



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

def hipaa
  @attributes[:hipaa]
end

#icon128 ⇒ Object

Branded icon 128x128



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

def icon128
  @attributes[:icon128]
end

#icon16 ⇒ Object

Branded icon 16x16



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

def icon16
  @attributes[:icon16]
end

#icon32 ⇒ Object

Branded icon 32x32



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

def icon32
  @attributes[:icon32]
end

#icon48 ⇒ Object

Branded icon 48x48



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

def icon48
  @attributes[:icon48]
end

#immutable_files_set_at ⇒ Object

date-time - Can files be modified?



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

def immutable_files_set_at
  @attributes[:immutable_files_set_at]
end

#include_password_in_welcome_email ⇒ Object

boolean - Include password in emails to new users?



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

def include_password_in_welcome_email
  @attributes[:include_password_in_welcome_email]
end

#language ⇒ Object

string - Site default language



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

def language
  @attributes[:language]
end

#ldap_base_dn ⇒ Object

string - Base DN for looking up users in LDAP server



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

def ldap_base_dn
  @attributes[:ldap_base_dn]
end

#ldap_domain ⇒ Object

string - Domain name that will be appended to usernames



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

def ldap_domain
  @attributes[:ldap_domain]
end

#ldap_enabled ⇒ Object

boolean - Main LDAP setting: is LDAP enabled?



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

def ldap_enabled
  @attributes[:ldap_enabled]
end

#ldap_group_action ⇒ Object

string - Should we sync groups from LDAP server?



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

def ldap_group_action
  @attributes[:ldap_group_action]
end

#ldap_group_exclusion ⇒ Object

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



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

def ldap_group_exclusion
  @attributes[:ldap_group_exclusion]
end

#ldap_group_inclusion ⇒ Object

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



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

def ldap_group_inclusion
  @attributes[:ldap_group_inclusion]
end

#ldap_host ⇒ Object

string - LDAP host



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

def ldap_host
  @attributes[:ldap_host]
end

#ldap_host_2 ⇒ Object

string - LDAP backup host



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

def ldap_host_2
  @attributes[:ldap_host_2]
end

#ldap_host_3 ⇒ Object

string - LDAP backup host



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

def ldap_host_3
  @attributes[:ldap_host_3]
end

#ldap_port ⇒ Object

int64 - LDAP port



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

def ldap_port
  @attributes[:ldap_port]
end

#ldap_secure ⇒ Object

boolean - Use secure LDAP?



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

def ldap_secure
  @attributes[:ldap_secure]
end

#ldap_type ⇒ Object

string - LDAP type



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

def ldap_type
  @attributes[:ldap_type]
end

#ldap_user_action ⇒ Object

string - Should we sync users from LDAP server?



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

def ldap_user_action
  @attributes[:ldap_user_action]
end

#ldap_user_include_groups ⇒ Object

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



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

def ldap_user_include_groups
  @attributes[:ldap_user_include_groups]
end

#ldap_username ⇒ Object

string - Username for signing in to LDAP server.



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

def ldap_username
  @attributes[:ldap_username]
end

#ldap_username_field ⇒ Object

string - LDAP username field



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

def ldap_username_field
  @attributes[:ldap_username_field]
end

#login_help_text ⇒ Object

string - Login help text



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

def 
  @attributes[:login_help_text]
end

#logo ⇒ Object

Branded logo



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

def 
  @attributes[:logo]
end

#max_prior_passwords ⇒ Object

int64 - Number of prior passwords to disallow



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

def max_prior_passwords
  @attributes[:max_prior_passwords]
end

#mobile_app ⇒ Object

boolean - Is the mobile app enabled?



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

def mobile_app
  @attributes[:mobile_app]
end

#mobile_app_session_ip_pinning ⇒ Object

boolean - Is mobile app session IP pinning enabled?



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

def mobile_app_session_ip_pinning
  @attributes[:mobile_app_session_ip_pinning]
end

#mobile_app_session_lifetime ⇒ Object

int64 - Mobile app session lifetime (in hours)



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

def mobile_app_session_lifetime
  @attributes[:mobile_app_session_lifetime]
end

#name ⇒ Object

string - Site name



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

def name
  @attributes[:name]
end

#next_billing_amount ⇒ Object

double - Next billing amount



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

def next_billing_amount
  @attributes[:next_billing_amount]
end

#next_billing_date ⇒ Object

string - Next billing date



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

def next_billing_date
  @attributes[:next_billing_date]
end

#non_sso_groups_allowed ⇒ Object

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



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

def non_sso_groups_allowed
  @attributes[:non_sso_groups_allowed]
end

#non_sso_users_allowed ⇒ Object

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



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

def non_sso_users_allowed
  @attributes[:non_sso_users_allowed]
end

#office_integration_available ⇒ Object

boolean - Allow users to use Office for the web?



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

def office_integration_available
  @attributes[:office_integration_available]
end

#oncehub_link ⇒ Object

string - Link to scheduling a meeting with our Sales team



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

def oncehub_link
  @attributes[:oncehub_link]
end

#opt_out_global ⇒ Object

boolean - Use servers in the USA only?



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

def opt_out_global
  @attributes[:opt_out_global]
end

#overage_notified_at ⇒ Object

date-time - Last time the site was notified about an overage



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

def overage_notified_at
  @attributes[:overage_notified_at]
end

#overage_notify ⇒ Object

boolean - Notify site email of overages?



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

def overage_notify
  @attributes[:overage_notify]
end

#overdue ⇒ Object

boolean - Is this site’s billing overdue?



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

def overdue
  @attributes[:overdue]
end

#password_min_length ⇒ Object

int64 - Shortest password length for users



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

def password_min_length
  @attributes[:password_min_length]
end

#password_require_letter ⇒ Object

boolean - Require a letter in passwords?



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

def password_require_letter
  @attributes[:password_require_letter]
end

#password_require_mixed ⇒ Object

boolean - Require lower and upper case letters in passwords?



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

def password_require_mixed
  @attributes[:password_require_mixed]
end

#password_require_number ⇒ Object

boolean - Require a number in passwords?



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

def password_require_number
  @attributes[:password_require_number]
end

#password_require_special ⇒ Object

boolean - Require special characters in password?



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

def password_require_special
  @attributes[:password_require_special]
end

#password_require_unbreached ⇒ Object

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



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

def password_require_unbreached
  @attributes[:password_require_unbreached]
end

#password_requirements_apply_to_bundles ⇒ Object

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



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

def password_requirements_apply_to_bundles
  @attributes[:password_requirements_apply_to_bundles]
end

#password_validity_days ⇒ Object

int64 - Number of days password is valid



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

def password_validity_days
  @attributes[:password_validity_days]
end

#phone ⇒ Object

string - Site phone number



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

def phone
  @attributes[:phone]
end

#reply_to_email ⇒ Object

email - Reply-to email for this site



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

def reply_to_email
  @attributes[:reply_to_email]
end

#require_2fa ⇒ Object

boolean - Require two-factor authentication for all users?



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

def require_2fa
  @attributes[:require_2fa]
end

#require_2fa_stop_time ⇒ Object

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



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

def require_2fa_stop_time
  @attributes[:require_2fa_stop_time]
end

#require_2fa_user_type ⇒ Object

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



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

def require_2fa_user_type
  @attributes[:require_2fa_user_type]
end

#session ⇒ Object

Current session



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

def session
  @attributes[:session]
end

#session_expiry ⇒ Object

double - Session expiry in hours



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

def session_expiry
  @attributes[:session_expiry]
end

#session_pinned_by_ip ⇒ Object

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



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

def session_pinned_by_ip
  @attributes[:session_pinned_by_ip]
end

#sftp_enabled ⇒ Object

boolean - Is SFTP enabled?



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

def sftp_enabled
  @attributes[:sftp_enabled]
end

#sftp_insecure_ciphers ⇒ Object

boolean - Are Insecure Ciphers allowed for SFTP? Note: Settting TLS Disabled -> True will always allow insecure ciphers for SFTP as well. Enabling this is insecure.



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

def sftp_insecure_ciphers
  @attributes[:sftp_insecure_ciphers]
end

#sftp_user_root_enabled ⇒ Object

boolean - Use user FTP roots also for SFTP?



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

def sftp_user_root_enabled
  @attributes[:sftp_user_root_enabled]
end

#sharing_enabled ⇒ Object

boolean - Allow bundle creation



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

def sharing_enabled
  @attributes[:sharing_enabled]
end

#show_request_access_link ⇒ Object

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



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

def show_request_access_link
  @attributes[:show_request_access_link]
end

#site_footer ⇒ Object

string - Custom site footer text



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

def site_footer
  @attributes[:site_footer]
end

#site_header ⇒ Object

string - Custom site header text



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

def site_header
  @attributes[:site_header]
end

#smtp_address ⇒ Object

string - SMTP server hostname or IP



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

def smtp_address
  @attributes[:smtp_address]
end

#smtp_authentication ⇒ Object

string - SMTP server authentication type



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

def smtp_authentication
  @attributes[:smtp_authentication]
end

#smtp_from ⇒ Object

string - From address to use when mailing through custom SMTP



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

def smtp_from
  @attributes[:smtp_from]
end

#smtp_port ⇒ Object

int64 - SMTP server port



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

def smtp_port
  @attributes[:smtp_port]
end

#smtp_username ⇒ Object

string - SMTP server username



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

def smtp_username
  @attributes[:smtp_username]
end

#ssl_required ⇒ Object

boolean - Is SSL required? Disabling this is insecure.



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

def ssl_required
  @attributes[:ssl_required]
end

#subdomain ⇒ Object

string - Site subdomain



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

def subdomain
  @attributes[:subdomain]
end

#switch_to_plan_date ⇒ Object

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



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

def switch_to_plan_date
  @attributes[:switch_to_plan_date]
end

#tls_disabled ⇒ Object

boolean - Are Insecure TLS and SFTP Ciphers allowed? Enabling this is insecure.



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

def tls_disabled
  @attributes[:tls_disabled]
end

#trial_days_left ⇒ Object

int64 - Number of days left in trial



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

def trial_days_left
  @attributes[:trial_days_left]
end

#trial_until ⇒ Object

date-time - When does this Site trial expire?



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

def trial_until
  @attributes[:trial_until]
end

#updated_at ⇒ Object

date-time - Last time this Site was updated



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

def updated_at
  @attributes[:updated_at]
end

#use_provided_modified_at ⇒ Object

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



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

def use_provided_modified_at
  @attributes[:use_provided_modified_at]
end

#user ⇒ Object

User of current session



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

def user
  @attributes[:user]
end

#user_lockout ⇒ Object

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



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

def user_lockout
  @attributes[:user_lockout]
end

#user_lockout_lock_period ⇒ Object

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



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

def user_lockout_lock_period
  @attributes[:user_lockout_lock_period]
end

#user_lockout_tries ⇒ Object

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



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

def user_lockout_tries
  @attributes[:user_lockout_tries]
end

#user_lockout_within ⇒ Object

int64 - Number of hours for user lockout window



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

def user_lockout_within
  @attributes[:user_lockout_within]
end

#user_requests_enabled ⇒ Object

boolean - Enable User Requests feature



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

def user_requests_enabled
  @attributes[:user_requests_enabled]
end

#welcome_custom_text ⇒ Object

string - Custom text send in user welcome email



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

def welcome_custom_text
  @attributes[:welcome_custom_text]
end

#welcome_email_cc ⇒ Object

email - Include this email in welcome emails if enabled



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

def welcome_email_cc
  @attributes[:welcome_email_cc]
end

#welcome_email_enabled ⇒ Object

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



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

def welcome_email_enabled
  @attributes[:welcome_email_enabled]
end

#welcome_screen ⇒ Object

string - Does the welcome screen appear?



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

def welcome_screen
  @attributes[:welcome_screen]
end

#windows_mode_ftp ⇒ Object

boolean - Does FTP user Windows emulation mode?



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

def windows_mode_ftp
  @attributes[:windows_mode_ftp]
end