Class: PureCloud::VoicemailMessageNotification

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/voicemail_message_notification.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VoicemailMessageNotification

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash



83
84
85
86
87
88
89
90
91
92
93
94
95
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 83

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'read')
    self.read = attributes[:'read']
  end

  if attributes.has_key?(:'audioRecordingDurationSeconds')
    self.audio_recording_duration_seconds = attributes[:'audioRecordingDurationSeconds']
  end

  if attributes.has_key?(:'audioRecordingSizeBytes')
    self.audio_recording_size_bytes = attributes[:'audioRecordingSizeBytes']
  end

  if attributes.has_key?(:'createdDate')
    self.created_date = attributes[:'createdDate']
  end

  if attributes.has_key?(:'modifiedDate')
    self.modified_date = attributes[:'modifiedDate']
  end

  if attributes.has_key?(:'callerAddress')
    self.caller_address = attributes[:'callerAddress']
  end

  if attributes.has_key?(:'callerName')
    self.caller_name = attributes[:'callerName']
  end

  if attributes.has_key?(:'action')
    self.action = attributes[:'action']
  end

  if attributes.has_key?(:'note')
    self.note = attributes[:'note']
  end

  if attributes.has_key?(:'deleted')
    self.deleted = attributes[:'deleted']
  end

  if attributes.has_key?(:'modifiedByUserId')
    self.modified_by_user_id = attributes[:'modifiedByUserId']
  end

end

Instance Attribute Details

#actionObject

Returns the value of attribute action.



37
38
39
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 37

def action
  @action
end

#audio_recording_duration_secondsObject

Returns the value of attribute audio_recording_duration_seconds.



25
26
27
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 25

def audio_recording_duration_seconds
  @audio_recording_duration_seconds
end

#audio_recording_size_bytesObject

Returns the value of attribute audio_recording_size_bytes.



27
28
29
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 27

def audio_recording_size_bytes
  @audio_recording_size_bytes
end

#caller_addressObject

Returns the value of attribute caller_address.



33
34
35
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 33

def caller_address
  @caller_address
end

#caller_nameObject

Returns the value of attribute caller_name.



35
36
37
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 35

def caller_name
  @caller_name
end

#created_dateObject

Returns the value of attribute created_date.



29
30
31
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 29

def created_date
  @created_date
end

#deletedObject

Returns the value of attribute deleted.



41
42
43
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 41

def deleted
  @deleted
end

#idObject

Returns the value of attribute id.



21
22
23
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 21

def id
  @id
end

#modified_by_user_idObject

Returns the value of attribute modified_by_user_id.



43
44
45
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 43

def modified_by_user_id
  @modified_by_user_id
end

#modified_dateObject

Returns the value of attribute modified_date.



31
32
33
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 31

def modified_date
  @modified_date
end

#noteObject

Returns the value of attribute note.



39
40
41
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 39

def note
  @note
end

#readObject

Returns the value of attribute read.



23
24
25
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 23

def read
  @read
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 46

def self.attribute_map
  {
    :'id' => :'id',
    :'read' => :'read',
    :'audio_recording_duration_seconds' => :'audioRecordingDurationSeconds',
    :'audio_recording_size_bytes' => :'audioRecordingSizeBytes',
    :'created_date' => :'createdDate',
    :'modified_date' => :'modifiedDate',
    :'caller_address' => :'callerAddress',
    :'caller_name' => :'callerName',
    :'action' => :'action',
    :'note' => :'note',
    :'deleted' => :'deleted',
    :'modified_by_user_id' => :'modifiedByUserId'
  }
end

.swagger_typesObject

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 64

def self.swagger_types
  {
    :'id' => :'String',
    :'read' => :'BOOLEAN',
    :'audio_recording_duration_seconds' => :'Integer',
    :'audio_recording_size_bytes' => :'Integer',
    :'created_date' => :'DateTime',
    :'modified_date' => :'DateTime',
    :'caller_address' => :'String',
    :'caller_name' => :'String',
    :'action' => :'String',
    :'note' => :'String',
    :'deleted' => :'BOOLEAN',
    :'modified_by_user_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 153

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      read == o.read &&
      audio_recording_duration_seconds == o.audio_recording_duration_seconds &&
      audio_recording_size_bytes == o.audio_recording_size_bytes &&
      created_date == o.created_date &&
      modified_date == o.modified_date &&
      caller_address == o.caller_address &&
      caller_name == o.caller_name &&
      action == o.action &&
      note == o.note &&
      deleted == o.deleted &&
      modified_by_user_id == o.modified_by_user_id
end

#_deserialize(type, value) ⇒ Object



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 202

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



262
263
264
265
266
267
268
269
270
271
272
273
274
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 262

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

build the object from hash



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 183

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


172
173
174
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 172

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



178
179
180
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 178

def hash
  [id, read, audio_recording_duration_seconds, audio_recording_size_bytes, created_date, modified_date, caller_address, caller_name, action, note, deleted, modified_by_user_id].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



141
142
143
144
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 141

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



245
246
247
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 245

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



250
251
252
253
254
255
256
257
258
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 250

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_sObject



240
241
242
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 240

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



148
149
# File 'lib/purecloudplatformclientv2/models/voicemail_message_notification.rb', line 148

def valid?
end