Class: PureCloud::GreetingNotification

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/models/greeting_notification.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GreetingNotification

Initializes the object

Parameters:

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

    Model attributes in the form of hash



79
80
81
82
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
138
139
140
141
142
143
144
145
146
147
148
149
# File 'lib/purecloudclient_v2a/models/greeting_notification.rb', line 79

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?(:'name')
    
    
    self.name = attributes[:'name']
    
  
  end

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

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

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

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

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

  
end

Instance Attribute Details

#audio_ttsObject

Returns the value of attribute audio_tts.



33
34
35
# File 'lib/purecloudclient_v2a/models/greeting_notification.rb', line 33

def audio_tts
  @audio_tts
end

#greeting_audio_fileObject

Returns the value of attribute greeting_audio_file.



31
32
33
# File 'lib/purecloudclient_v2a/models/greeting_notification.rb', line 31

def greeting_audio_file
  @greeting_audio_file
end

#idObject

Returns the value of attribute id.



21
22
23
# File 'lib/purecloudclient_v2a/models/greeting_notification.rb', line 21

def id
  @id
end

#nameObject

Returns the value of attribute name.



23
24
25
# File 'lib/purecloudclient_v2a/models/greeting_notification.rb', line 23

def name
  @name
end

#ownerObject

Returns the value of attribute owner.



29
30
31
# File 'lib/purecloudclient_v2a/models/greeting_notification.rb', line 29

def owner
  @owner
end

#owner_typeObject

Returns the value of attribute owner_type.



27
28
29
# File 'lib/purecloudclient_v2a/models/greeting_notification.rb', line 27

def owner_type
  @owner_type
end

#typeObject

Returns the value of attribute type.



25
26
27
# File 'lib/purecloudclient_v2a/models/greeting_notification.rb', line 25

def type
  @type
end

Class Method Details

.attribute_mapObject

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



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/purecloudclient_v2a/models/greeting_notification.rb', line 36

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'type' => :'type',
    
    :'owner_type' => :'ownerType',
    
    :'owner' => :'owner',
    
    :'greeting_audio_file' => :'greetingAudioFile',
    
    :'audio_tts' => :'audioTTS'
    
  }
end

.swagger_typesObject

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# File 'lib/purecloudclient_v2a/models/greeting_notification.rb', line 57

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'type' => :'String',
    
    :'owner_type' => :'String',
    
    :'owner' => :'DocumentDataV2NotificationWorkspace',
    
    :'greeting_audio_file' => :'GreetingNotificationGreetingAudioFile',
    
    :'audio_tts' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



232
233
234
235
236
237
238
239
240
241
242
# File 'lib/purecloudclient_v2a/models/greeting_notification.rb', line 232

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      type == o.type &&
      owner_type == o.owner_type &&
      owner == o.owner &&
      greeting_audio_file == o.greeting_audio_file &&
      audio_tts == o.audio_tts
end

#_deserialize(type, value) ⇒ Object



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
# File 'lib/purecloudclient_v2a/models/greeting_notification.rb', line 276

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



336
337
338
339
340
341
342
343
344
345
346
347
348
# File 'lib/purecloudclient_v2a/models/greeting_notification.rb', line 336

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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
# File 'lib/purecloudclient_v2a/models/greeting_notification.rb', line 257

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


246
247
248
# File 'lib/purecloudclient_v2a/models/greeting_notification.rb', line 246

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



252
253
254
# File 'lib/purecloudclient_v2a/models/greeting_notification.rb', line 252

def hash
  [id, name, type, owner_type, owner, greeting_audio_file, audio_tts].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properies with the reasons



153
154
155
156
157
158
# File 'lib/purecloudclient_v2a/models/greeting_notification.rb', line 153

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



319
320
321
# File 'lib/purecloudclient_v2a/models/greeting_notification.rb', line 319

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



324
325
326
327
328
329
330
331
332
# File 'lib/purecloudclient_v2a/models/greeting_notification.rb', line 324

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



314
315
316
# File 'lib/purecloudclient_v2a/models/greeting_notification.rb', line 314

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



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/purecloudclient_v2a/models/greeting_notification.rb', line 162

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end