Class: PureCloud::Response

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

Overview

Contains information about a response.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Response

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
193
194
195
196
197
198
199
200
201
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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/purecloudplatformclientv2/models/response.rb', line 128

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

  
  if attributes.has_key?(:'libraries')
    
    if (value = attributes[:'libraries']).is_a?(Array)
      self.libraries = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'texts')
    
    if (value = attributes[:'texts']).is_a?(Array)
      self.texts = value
    end
    
    
  
  end

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

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

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

  
  if attributes.has_key?(:'substitutions')
    
    if (value = attributes[:'substitutions']).is_a?(Array)
      self.substitutions = value
    end
    
    
  
  end

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

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

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

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

  
end

Instance Attribute Details

#created_by ⇒ Object

User that created the response



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

def created_by
  @created_by
end

#date_created ⇒ Object

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



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/response.rb', line 40

def date_created
  @date_created
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#interaction_type ⇒ Object

The interaction type for this response.



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

def interaction_type
  @interaction_type
end

#libraries ⇒ Object

One or more libraries response is associated with.



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

def libraries
  @libraries
end

#messaging_template ⇒ Object

An optional messaging template definition for responseType.MessagingTemplate.



55
56
57
 
# File 'lib/purecloudplatformclientv2/models/response.rb', line 55

def messaging_template
  @messaging_template
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#response_type ⇒ Object

The response type represented by the response.



52
53
54
 
# File 'lib/purecloudplatformclientv2/models/response.rb', line 52

def response_type
  @response_type
end

#self_uri ⇒ Object

The URI for this object



58
59
60
 
# File 'lib/purecloudplatformclientv2/models/response.rb', line 58

def self_uri
  @self_uri
end

#substitutions ⇒ Object

Details about any text substitutions used in the texts for this response.



46
47
48
 
# File 'lib/purecloudplatformclientv2/models/response.rb', line 46

def substitutions
  @substitutions
end

#substitutions_schema ⇒ Object

Metadata about the text substitutions in json schema format.



49
50
51
 
# File 'lib/purecloudplatformclientv2/models/response.rb', line 49

def substitutions_schema
  @substitutions_schema
end

#texts ⇒ Object

One or more texts associated with the response.



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/response.rb', line 34

def texts
  @texts
end

#version ⇒ Object

Version number required for updates.



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/response.rb', line 28

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
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
 
# File 'lib/purecloudplatformclientv2/models/response.rb', line 61

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'version' => :'version',
    
    :'libraries' => :'libraries',
    
    :'texts' => :'texts',
    
    :'created_by' => :'createdBy',
    
    :'date_created' => :'dateCreated',
    
    :'interaction_type' => :'interactionType',
    
    :'substitutions' => :'substitutions',
    
    :'substitutions_schema' => :'substitutionsSchema',
    
    :'response_type' => :'responseType',
    
    :'messaging_template' => :'messagingTemplate',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/purecloudplatformclientv2/models/response.rb', line 94

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'version' => :'Integer',
    
    :'libraries' => :'Array<DomainEntityRef>',
    
    :'texts' => :'Array<ResponseText>',
    
    :'created_by' => :'User',
    
    :'date_created' => :'DateTime',
    
    :'interaction_type' => :'String',
    
    :'substitutions' => :'Array<ResponseSubstitution>',
    
    :'substitutions_schema' => :'JsonSchemaDocument',
    
    :'response_type' => :'String',
    
    :'messaging_template' => :'MessagingTemplate',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/purecloudplatformclientv2/models/response.rb', line 433

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      version == o.version &&
      libraries == o.libraries &&
      texts == o.texts &&
      created_by == o.created_by &&
      date_created == o.date_created &&
      interaction_type == o.interaction_type &&
      substitutions == o.substitutions &&
      substitutions_schema == o.substitutions_schema &&
      response_type == o.response_type &&
      messaging_template == o.messaging_template &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
 
# File 'lib/purecloudplatformclientv2/models/response.rb', line 483

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



543
544
545
546
547
548
549
550
551
552
553
554
555
 
# File 'lib/purecloudplatformclientv2/models/response.rb', line 543

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



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/purecloudplatformclientv2/models/response.rb', line 464

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


453
454
455
 
# File 'lib/purecloudplatformclientv2/models/response.rb', line 453

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



459
460
461
 
# File 'lib/purecloudplatformclientv2/models/response.rb', line 459

def hash
  [id, name, version, libraries, texts, created_by, date_created, interaction_type, substitutions, substitutions_schema, response_type, messaging_template, self_uri].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



262
263
264
265
266
267
 
# File 'lib/purecloudplatformclientv2/models/response.rb', line 262

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



526
527
528
 
# File 'lib/purecloudplatformclientv2/models/response.rb', line 526

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



531
532
533
534
535
536
537
538
539
 
# File 'lib/purecloudplatformclientv2/models/response.rb', line 531

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 



521
522
523
 
# File 'lib/purecloudplatformclientv2/models/response.rb', line 521

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



271
272
273
274
275
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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/purecloudplatformclientv2/models/response.rb', line 271

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if @libraries.nil?
    return false
  end

  
  
  
  
  
  if @texts.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["chat", "email", "twitter"]
  if @interaction_type && !allowed_values.include?(@interaction_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["MessagingTemplate", "CampaignSmsTemplate"]
  if @response_type && !allowed_values.include?(@response_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
end