Class: Verizon::Notification

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/verizon/models/notification.rb

Overview

Notification Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(notification_type = SKIP, callback = SKIP, email_notification = SKIP, notification_group_name = SKIP, notification_frequency_factor = SKIP, notification_frequency_interval = SKIP, external_email_recipients = SKIP, sms_notification = SKIP, sms_numbers = SKIP, reminder = SKIP, severity = SKIP) ⇒ Notification

Returns a new instance of Notification.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/verizon/models/notification.rb', line 96

def initialize(notification_type = SKIP, callback = SKIP,
               email_notification = SKIP, notification_group_name = SKIP,
               notification_frequency_factor = SKIP,
               notification_frequency_interval = SKIP,
               external_email_recipients = SKIP, sms_notification = SKIP,
               sms_numbers = SKIP, reminder = SKIP, severity = SKIP)
  @notification_type = notification_type unless notification_type == SKIP
  @callback = callback unless callback == SKIP
  @email_notification = email_notification unless email_notification == SKIP
  @notification_group_name = notification_group_name unless notification_group_name == SKIP
  unless notification_frequency_factor == SKIP
    @notification_frequency_factor =
      notification_frequency_factor
  end
  unless notification_frequency_interval == SKIP
    @notification_frequency_interval =
      notification_frequency_interval
  end
  unless external_email_recipients == SKIP
    @external_email_recipients =
      external_email_recipients
  end
  @sms_notification = sms_notification unless sms_notification == SKIP
  @sms_numbers = sms_numbers unless sms_numbers == SKIP
  @reminder = reminder unless reminder == SKIP
  @severity = severity unless severity == SKIP
end

Instance Attribute Details

#callback ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


18
19
20
 
# File 'lib/verizon/models/notification.rb', line 18

def callback
  @callback
end

#email_notification ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


22
23
24
 
# File 'lib/verizon/models/notification.rb', line 22

def email_notification
  @email_notification
end

#external_email_recipients ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


38
39
40
 
# File 'lib/verizon/models/notification.rb', line 38

def external_email_recipients
  @external_email_recipients
end

#notification_frequency_factor ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


30
31
32
 
# File 'lib/verizon/models/notification.rb', line 30

def notification_frequency_factor
  @notification_frequency_factor
end

#notification_frequency_interval ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


34
35
36
 
# File 'lib/verizon/models/notification.rb', line 34

def notification_frequency_interval
  @notification_frequency_interval
end

#notification_group_name ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


26
27
28
 
# File 'lib/verizon/models/notification.rb', line 26

def notification_group_name
  @notification_group_name
end

#notification_type ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


14
15
16
 
# File 'lib/verizon/models/notification.rb', line 14

def notification_type
  @notification_type
end

#reminder ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


50
51
52
 
# File 'lib/verizon/models/notification.rb', line 50

def reminder
  @reminder
end

#severity ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


54
55
56
 
# File 'lib/verizon/models/notification.rb', line 54

def severity
  @severity
end

#sms_notification ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


42
43
44
 
# File 'lib/verizon/models/notification.rb', line 42

def sms_notification
  @sms_notification
end

#sms_numbers ⇒ Array[SmsNumbers]

TODO: Write general description for this method

Returns:



46
47
48
 
# File 'lib/verizon/models/notification.rb', line 46

def sms_numbers
  @sms_numbers
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/verizon/models/notification.rb', line 125

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  notification_type =
    hash.key?('notificationType') ? hash['notificationType'] : SKIP
  callback = hash.key?('callback') ? hash['callback'] : SKIP
  email_notification =
    hash.key?('emailNotification') ? hash['emailNotification'] : SKIP
  notification_group_name =
    hash.key?('notificationGroupName') ? hash['notificationGroupName'] : SKIP
  notification_frequency_factor =
    hash.key?('notificationFrequencyFactor') ? hash['notificationFrequencyFactor'] : SKIP
  notification_frequency_interval =
    hash.key?('notificationFrequencyInterval') ? hash['notificationFrequencyInterval'] : SKIP
  external_email_recipients =
    hash.key?('externalEmailRecipients') ? hash['externalEmailRecipients'] : SKIP
  sms_notification =
    hash.key?('smsNotification') ? hash['smsNotification'] : SKIP
  # Parameter is an array, so we need to iterate through it
  sms_numbers = nil
  unless hash['smsNumbers'].nil?
    sms_numbers = []
    hash['smsNumbers'].each do |structure|
      sms_numbers << (SmsNumbers.from_hash(structure) if structure)
    end
  end

  sms_numbers = SKIP unless hash.key?('smsNumbers')
  reminder = hash.key?('reminder') ? hash['reminder'] : SKIP
  severity = hash.key?('severity') ? hash['severity'] : SKIP

  # Create object from extracted values.
  Notification.new(notification_type,
                   callback,
                   email_notification,
                   notification_group_name,
                   notification_frequency_factor,
                   notification_frequency_interval,
                   external_email_recipients,
                   sms_notification,
                   sms_numbers,
                   reminder,
                   severity)
end

.names ⇒ Object

A mapping from model property names to API property names.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/verizon/models/notification.rb', line 57

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['notification_type'] = 'notificationType'
  @_hash['callback'] = 'callback'
  @_hash['email_notification'] = 'emailNotification'
  @_hash['notification_group_name'] = 'notificationGroupName'
  @_hash['notification_frequency_factor'] = 'notificationFrequencyFactor'
  @_hash['notification_frequency_interval'] =
    'notificationFrequencyInterval'
  @_hash['external_email_recipients'] = 'externalEmailRecipients'
  @_hash['sms_notification'] = 'smsNotification'
  @_hash['sms_numbers'] = 'smsNumbers'
  @_hash['reminder'] = 'reminder'
  @_hash['severity'] = 'severity'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



92
93
94
 
# File 'lib/verizon/models/notification.rb', line 92

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/verizon/models/notification.rb', line 75

def self.optionals
  %w[
    notification_type
    callback
    email_notification
    notification_group_name
    notification_frequency_factor
    notification_frequency_interval
    external_email_recipients
    sms_notification
    sms_numbers
    reminder
    severity
  ]
end