Class: PureCloud::PostTextResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostTextResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#amazon_lex ⇒ Object

Raw data response from AWS (if called)



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

def amazon_lex
  @amazon_lex
end

#bot_correlation_id ⇒ Object

The optional ID specified in the request



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

def bot_correlation_id
  @bot_correlation_id
end

#bot_state ⇒ Object

The state of the bot after completion of the request



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/post_text_response.rb', line 22

def bot_state
  @bot_state
end

#genesys_dialog_engine ⇒ Object

Raw data response from Genesys’ Dialogengine (if called)



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

def genesys_dialog_engine
  @genesys_dialog_engine
end

#google_dialog_flow ⇒ Object

Raw data response from Google Dialogflow (if called)



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

def google_dialog_flow
  @google_dialog_flow
end

#intent_name ⇒ Object

The name of the intent the bot is either processing or has processed, this will be blank if no intent could be detected.



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

def intent_name
  @intent_name
end

#reply_messages ⇒ Object

The list of messages to respond with, if any



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

def reply_messages
  @reply_messages
end

#slots ⇒ Object

Data parameters detected and filled by the bot.



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

def slots
  @slots
end

Class Method Details

.attribute_map ⇒ Object

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

def self.attribute_map
  {
    
    :'bot_state' => :'botState',
    
    :'reply_messages' => :'replyMessages',
    
    :'intent_name' => :'intentName',
    
    :'slots' => :'slots',
    
    :'bot_correlation_id' => :'botCorrelationId',
    
    :'amazon_lex' => :'amazonLex',
    
    :'google_dialog_flow' => :'googleDialogFlow',
    
    :'genesys_dialog_engine' => :'genesysDialogEngine'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/purecloudplatformclientv2/models/post_text_response.rb', line 69

def self.swagger_types
  {
    
    :'bot_state' => :'String',
    
    :'reply_messages' => :'Array<PostTextMessage>',
    
    :'intent_name' => :'String',
    
    :'slots' => :'Hash<String, String>',
    
    :'bot_correlation_id' => :'String',
    
    :'amazon_lex' => :'Hash<String, Object>',
    
    :'google_dialog_flow' => :'Hash<String, Object>',
    
    :'genesys_dialog_engine' => :'Hash<String, Object>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/purecloudplatformclientv2/models/post_text_response.rb', line 293

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      bot_state == o.bot_state &&
      reply_messages == o.reply_messages &&
      intent_name == o.intent_name &&
      slots == o.slots &&
      bot_correlation_id == o.bot_correlation_id &&
      amazon_lex == o.amazon_lex &&
      google_dialog_flow == o.google_dialog_flow &&
      genesys_dialog_engine == o.genesys_dialog_engine
end

#_deserialize(type, value) ⇒ Object 



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/purecloudplatformclientv2/models/post_text_response.rb', line 338

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



398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/purecloudplatformclientv2/models/post_text_response.rb', line 398

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



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/purecloudplatformclientv2/models/post_text_response.rb', line 319

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


308
309
310
 
# File 'lib/purecloudplatformclientv2/models/post_text_response.rb', line 308

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



314
315
316
 
# File 'lib/purecloudplatformclientv2/models/post_text_response.rb', line 314

def hash
  [bot_state, reply_messages, intent_name, slots, bot_correlation_id, amazon_lex, google_dialog_flow, genesys_dialog_engine].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



186
187
188
189
190
191
 
# File 'lib/purecloudplatformclientv2/models/post_text_response.rb', line 186

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))



381
382
383
 
# File 'lib/purecloudplatformclientv2/models/post_text_response.rb', line 381

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



386
387
388
389
390
391
392
393
394
 
# File 'lib/purecloudplatformclientv2/models/post_text_response.rb', line 386

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 



376
377
378
 
# File 'lib/purecloudplatformclientv2/models/post_text_response.rb', line 376

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



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

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

  
  
  allowed_values = ["Complete", "Failed", "MoreData"]
  if @bot_state && !allowed_values.include?(@bot_state)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end