Class: Files::EmailPreference

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of EmailPreference.



7
8
9
10
 
# File 'lib/files.com/models/email_preference.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/email_preference.rb', line 5

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



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

def options
  @options
end

Class Method Details

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

Parameters:

token (required) - string - Email preferences token.

Raises:



84
85
86
87
88
89
90
91
92
 
# File 'lib/files.com/models/email_preference.rb', line 84

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

  response, options = Api.send_request("/email_preferences/#{params[:token]}", :get, params, options)
  EmailPreference.new(response.data, options)
end

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

Parameters:

token (required) - string - Email preferences token.
user[receive_admin_alerts] - boolean
user[notify_on_all_site_warnings] - boolean
user[notify_on_all_sso_failures] - boolean
user[notify_on_all_user_security_events] - boolean
user[notify_on_all_pending_work_failures] - boolean
user[notify_on_all_siem_http_destination_failures] - boolean
user[notify_on_all_sync_failures] - boolean
user[notify_on_all_automation_failures] - boolean
user[notify_on_all_expectation_failures] - boolean
user[unsubscribe_marketing] - boolean
user[unsubscribe_transactional] - boolean
user[unsubscribe] - boolean
user[notifications][id] (required) - array(int64)
user[notifications][group] - array(boolean)
user[notifications][send_interval] - array(string)
user[notifications][unsubscribe] - array(boolean)
user[bundle_notifications][id] (required) - array(int64)
user[bundle_notifications][unsubscribe] - array(boolean)

Raises:



114
115
116
117
118
119
120
121
122
 
# File 'lib/files.com/models/email_preference.rb', line 114

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

  response, options = Api.send_request("/email_preferences/#{params[:token]}", :patch, params, options)
  EmailPreference.new(response.data, options)
end

Instance Method Details

#bundle_notifications ⇒ Object

array(object) - A list of bundle notifications



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

def bundle_notifications
  @attributes[:bundle_notifications]
end

#email ⇒ Object

email - Email address



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

def email
  @attributes[:email]
end

#notifications ⇒ Object

array(object) - A list of notifications



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

def notifications
  @attributes[:notifications]
end

#notify_on_all_automation_failures ⇒ Object

boolean - Receive automation failures?



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

def notify_on_all_automation_failures
  @attributes[:notify_on_all_automation_failures]
end

#notify_on_all_expectation_failures ⇒ Object

boolean - Receive expectation failures and misses?



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

def notify_on_all_expectation_failures
  @attributes[:notify_on_all_expectation_failures]
end

#notify_on_all_pending_work_failures ⇒ Object

boolean - Receive pending work failures?



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

def notify_on_all_pending_work_failures
  @attributes[:notify_on_all_pending_work_failures]
end

#notify_on_all_siem_http_destination_failures ⇒ Object

boolean - Receive siem failures?



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

def notify_on_all_siem_http_destination_failures
  @attributes[:notify_on_all_siem_http_destination_failures]
end

#notify_on_all_site_warnings ⇒ Object

boolean - Receive site warnings?



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

def notify_on_all_site_warnings
  @attributes[:notify_on_all_site_warnings]
end

#notify_on_all_sso_failures ⇒ Object

boolean - Receive sso/scim/ldap configuration/sync failures?



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

def notify_on_all_sso_failures
  @attributes[:notify_on_all_sso_failures]
end

#notify_on_all_sync_failures ⇒ Object

boolean - Receive sync failures?



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

def notify_on_all_sync_failures
  @attributes[:notify_on_all_sync_failures]
end

#notify_on_all_user_security_events ⇒ Object

boolean - Receive user security events?



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

def notify_on_all_user_security_events
  @attributes[:notify_on_all_user_security_events]
end

#receive_admin_alerts ⇒ Object

boolean - Deprecated. Use granular admin email preferences instead.



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

def receive_admin_alerts
  @attributes[:receive_admin_alerts]
end

#receive_marketing_mail ⇒ Object

boolean - Receive marketing mail?



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

def receive_marketing_mail
  @attributes[:receive_marketing_mail]
end

#receive_transactional_mail ⇒ Object

boolean - Receive transactional (service-related) mail?



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

def receive_transactional_mail
  @attributes[:receive_transactional_mail]
end