Class: PureCloud::VoicemailMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/voicemail_message.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VoicemailMessage

Returns a new instance of VoicemailMessage.



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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/purecloud/models/voicemail_message.rb', line 125

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

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

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'conversation']
    self.conversation = attributes[:'conversation']
  end
  
  if attributes[:'read']
    self.read = attributes[:'read']
  end
  
  if attributes[:'audioRecordingDurationSeconds']
    self.audio_recording_duration_seconds = attributes[:'audioRecordingDurationSeconds']
  end
  
  if attributes[:'audioRecordingSizeBytes']
    self.audio_recording_size_bytes = attributes[:'audioRecordingSizeBytes']
  end
  
  if attributes[:'createdDate']
    self.created_date = attributes[:'createdDate']
  end
  
  if attributes[:'modifiedDate']
    self.modified_date = attributes[:'modifiedDate']
  end
  
  if attributes[:'callerAddress']
    self.caller_address = attributes[:'callerAddress']
  end
  
  if attributes[:'callerName']
    self.caller_name = attributes[:'callerName']
  end
  
  if attributes[:'callerUser']
    self.caller_user = attributes[:'callerUser']
  end
  
  if attributes[:'deleted']
    self.deleted = attributes[:'deleted']
  end
  
  if attributes[:'note']
    self.note = attributes[:'note']
  end
  
  if attributes[:'user']
    self.user = attributes[:'user']
  end
  
  if attributes[:'group']
    self.group = attributes[:'group']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#audio_recording_duration_seconds ⇒ Object

The voicemail message’s audio recording duration in seconds



31
32
33
 
# File 'lib/purecloud/models/voicemail_message.rb', line 31

def audio_recording_duration_seconds
  @audio_recording_duration_seconds
end

#audio_recording_size_bytes ⇒ Object

The voicemail message’s audio recording size in bytes



34
35
36
 
# File 'lib/purecloud/models/voicemail_message.rb', line 34

def audio_recording_size_bytes
  @audio_recording_size_bytes
end

#caller_address ⇒ Object

The caller address



43
44
45
 
# File 'lib/purecloud/models/voicemail_message.rb', line 43

def caller_address
  @caller_address
end

#caller_name ⇒ Object

Optionally the name of the caller that left the voicemail message if the caller was a known user



46
47
48
 
# File 'lib/purecloud/models/voicemail_message.rb', line 46

def caller_name
  @caller_name
end

#caller_user ⇒ Object

Optionally the user that left the voicemail message if the caller was a known user



49
50
51
 
# File 'lib/purecloud/models/voicemail_message.rb', line 49

def caller_user
  @caller_user
end

#conversation ⇒ Object

The conversation that the voicemail message is associated with



25
26
27
 
# File 'lib/purecloud/models/voicemail_message.rb', line 25

def conversation
  @conversation
end

#created_date ⇒ Object

The date the voicemail message was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



37
38
39
 
# File 'lib/purecloud/models/voicemail_message.rb', line 37

def created_date
  @created_date
end

#deleted ⇒ Object

Whether the voicemail message has been marked as deleted



52
53
54
 
# File 'lib/purecloud/models/voicemail_message.rb', line 52

def deleted
  @deleted
end

#group ⇒ Object

The group that the voicemail message belongs to or null which means the voicemail message belongs to a user



61
62
63
 
# File 'lib/purecloud/models/voicemail_message.rb', line 61

def group
  @group
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloud/models/voicemail_message.rb', line 22

def id
  @id
end

#modified_date ⇒ Object

The date the voicemail message was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



40
41
42
 
# File 'lib/purecloud/models/voicemail_message.rb', line 40

def modified_date
  @modified_date
end

#note ⇒ Object

An optional note



55
56
57
 
# File 'lib/purecloud/models/voicemail_message.rb', line 55

def note
  @note
end

#read ⇒ Object

Whether the voicemail message is marked as read



28
29
30
 
# File 'lib/purecloud/models/voicemail_message.rb', line 28

def read
  @read
end

#self_uri ⇒ Object

The URI for this object



64
65
66
 
# File 'lib/purecloud/models/voicemail_message.rb', line 64

def self_uri
  @self_uri
end

#user ⇒ Object

The user that the voicemail message belongs to or null which means the voicemail message belongs to a group



58
59
60
 
# File 'lib/purecloud/models/voicemail_message.rb', line 58

def user
  @user
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/purecloud/models/voicemail_message.rb', line 67

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'conversation' => :'conversation',
    
    :'read' => :'read',
    
    :'audio_recording_duration_seconds' => :'audioRecordingDurationSeconds',
    
    :'audio_recording_size_bytes' => :'audioRecordingSizeBytes',
    
    :'created_date' => :'createdDate',
    
    :'modified_date' => :'modifiedDate',
    
    :'caller_address' => :'callerAddress',
    
    :'caller_name' => :'callerName',
    
    :'caller_user' => :'callerUser',
    
    :'deleted' => :'deleted',
    
    :'note' => :'note',
    
    :'user' => :'user',
    
    :'group' => :'group',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/purecloud/models/voicemail_message.rb', line 104

def self.swagger_types
  {
    :'id' => :'String',
    :'conversation' => :'Conversation',
    :'read' => :'BOOLEAN',
    :'audio_recording_duration_seconds' => :'Integer',
    :'audio_recording_size_bytes' => :'Integer',
    :'created_date' => :'DateTime',
    :'modified_date' => :'DateTime',
    :'caller_address' => :'String',
    :'caller_name' => :'String',
    :'caller_user' => :'User',
    :'deleted' => :'BOOLEAN',
    :'note' => :'String',
    :'user' => :'User',
    :'group' => :'Group',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/purecloud/models/voicemail_message.rb', line 195

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      conversation == o.conversation &&
      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 &&
      caller_user == o.caller_user &&
      deleted == o.deleted &&
      note == o.note &&
      user == o.user &&
      group == o.group &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/purecloud/models/voicemail_message.rb', line 245

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



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/purecloud/models/voicemail_message.rb', line 305

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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/purecloud/models/voicemail_message.rb', line 226

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

Returns:

  • (Boolean)

See Also:

  • `==` method


216
217
218
 
# File 'lib/purecloud/models/voicemail_message.rb', line 216

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



221
222
223
 
# File 'lib/purecloud/models/voicemail_message.rb', line 221

def hash
  [id, conversation, read, audio_recording_duration_seconds, audio_recording_size_bytes, created_date, modified_date, caller_address, caller_name, caller_user, deleted, note, user, group, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



288
289
290
 
# File 'lib/purecloud/models/voicemail_message.rb', line 288

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



293
294
295
296
297
298
299
300
301
 
# File 'lib/purecloud/models/voicemail_message.rb', line 293

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_s ⇒ Object 



283
284
285
 
# File 'lib/purecloud/models/voicemail_message.rb', line 283

def to_s
  to_hash.to_s
end