Class: PureCloud::Greeting

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Greeting

Returns a new instance of Greeting.



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
150
151
152
153
154
155
156
157
# File 'lib/purecloud/models/greeting.rb', line 102

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[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'type']
    self.type = attributes[:'type']
  end
  
  if attributes[:'ownerType']
    self.owner_type = attributes[:'ownerType']
  end
  
  if attributes[:'owner']
    self.owner = attributes[:'owner']
  end
  
  if attributes[:'audioFile']
    self.audio_file = attributes[:'audioFile']
  end
  
  if attributes[:'audioTTS']
    self.audio_tts = attributes[:'audioTTS']
  end
  
  if attributes[:'createdDate']
    self.created_date = attributes[:'createdDate']
  end
  
  if attributes[:'createdBy']
    self.created_by = attributes[:'createdBy']
  end
  
  if attributes[:'modifiedDate']
    self.modified_date = attributes[:'modifiedDate']
  end
  
  if attributes[:'modifiedBy']
    self.modified_by = attributes[:'modifiedBy']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#audio_fileObject

Returns the value of attribute audio_file.



35
36
37
# File 'lib/purecloud/models/greeting.rb', line 35

def audio_file
  @audio_file
end

#audio_ttsObject

Returns the value of attribute audio_tts.



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

def audio_tts
  @audio_tts
end

#created_byObject

Returns the value of attribute created_by.



42
43
44
# File 'lib/purecloud/models/greeting.rb', line 42

def created_by
  @created_by
end

#created_dateObject

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def created_date
  @created_date
end

#idObject

The globally unique identifier for the object.



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

def id
  @id
end

#modified_byObject

Returns the value of attribute modified_by.



47
48
49
# File 'lib/purecloud/models/greeting.rb', line 47

def modified_by
  @modified_by
end

#modified_dateObject

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



45
46
47
# File 'lib/purecloud/models/greeting.rb', line 45

def modified_date
  @modified_date
end

#nameObject

Returns the value of attribute name.



24
25
26
# File 'lib/purecloud/models/greeting.rb', line 24

def name
  @name
end

#ownerObject

Greeting owner



33
34
35
# File 'lib/purecloud/models/greeting.rb', line 33

def owner
  @owner
end

#owner_typeObject

Greeting owner type



30
31
32
# File 'lib/purecloud/models/greeting.rb', line 30

def owner_type
  @owner_type
end

#self_uriObject

The URI for this object



50
51
52
# File 'lib/purecloud/models/greeting.rb', line 50

def self_uri
  @self_uri
end

#typeObject

Greeting type



27
28
29
# File 'lib/purecloud/models/greeting.rb', line 27

def type
  @type
end

Class Method Details

.attribute_mapObject

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/purecloud/models/greeting.rb', line 53

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'type' => :'type',
    
    :'owner_type' => :'ownerType',
    
    :'owner' => :'owner',
    
    :'audio_file' => :'audioFile',
    
    :'audio_tts' => :'audioTTS',
    
    :'created_date' => :'createdDate',
    
    :'created_by' => :'createdBy',
    
    :'modified_date' => :'modifiedDate',
    
    :'modified_by' => :'modifiedBy',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_typesObject

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# File 'lib/purecloud/models/greeting.rb', line 84

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'type' => :'String',
    :'owner_type' => :'String',
    :'owner' => :'DomainEntity',
    :'audio_file' => :'GreetingAudioFile',
    :'audio_tts' => :'String',
    :'created_date' => :'DateTime',
    :'created_by' => :'String',
    :'modified_date' => :'DateTime',
    :'modified_by' => :'String',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
# File 'lib/purecloud/models/greeting.rb', line 178

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 &&
      audio_file == o.audio_file &&
      audio_tts == o.audio_tts &&
      created_date == o.created_date &&
      created_by == o.created_by &&
      modified_date == o.modified_date &&
      modified_by == o.modified_by &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
# File 'lib/purecloud/models/greeting.rb', line 225

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



285
286
287
288
289
290
291
292
293
294
295
296
297
# File 'lib/purecloud/models/greeting.rb', line 285

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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'lib/purecloud/models/greeting.rb', line 206

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


196
197
198
# File 'lib/purecloud/models/greeting.rb', line 196

def eql?(o)
  self == o
end

#hashObject

Calculate hash code according to all attributes.



201
202
203
# File 'lib/purecloud/models/greeting.rb', line 201

def hash
  [id, name, type, owner_type, owner, audio_file, audio_tts, created_date, created_by, modified_date, modified_by, self_uri].hash
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



268
269
270
# File 'lib/purecloud/models/greeting.rb', line 268

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



273
274
275
276
277
278
279
280
281
# File 'lib/purecloud/models/greeting.rb', line 273

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



263
264
265
# File 'lib/purecloud/models/greeting.rb', line 263

def to_s
  to_hash.to_s
end