Class: PureCloud::PostTextRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostTextRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#amazon_lex_request ⇒ Object

Returns the value of attribute amazon_lex_request.



48
49
50
 
# File 'lib/purecloudplatformclientv2/models/post_text_request.rb', line 48

def amazon_lex_request
  @amazon_lex_request
end

#bot_alias ⇒ Object

Alias/Version of the bot



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

def bot_alias
  @bot_alias
end

#bot_channels ⇒ Object

The channels this bot is utilizing



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

def bot_channels
  @bot_channels
end

#bot_correlation_id ⇒ Object

Id for tracking the activity - this will be returned in the response



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

def bot_correlation_id
  @bot_correlation_id
end

#bot_id ⇒ Object

ID of the bot to send the text to.



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

def bot_id
  @bot_id
end

#bot_session_id ⇒ Object

GUID for this bot’s session



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

def bot_session_id
  @bot_session_id
end

#bot_session_timeout_minutes ⇒ Object

Override timeout for the bot session. This should be greater than 10 minutes.



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

def bot_session_timeout_minutes
  @bot_session_timeout_minutes
end

#google_dialogflow ⇒ Object

Returns the value of attribute google_dialogflow.



50
51
52
 
# File 'lib/purecloudplatformclientv2/models/post_text_request.rb', line 50

def google_dialogflow
  @google_dialogflow
end

#integration_id ⇒ Object

the integration service id for the bot’s credentials



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

def integration_id
  @integration_id
end

#language_code ⇒ Object

The launguage code the bot will run under



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

def language_code
  @language_code
end

#post_text_message ⇒ Object

Message to send to the bot



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

def post_text_message
  @post_text_message
end

Class Method Details

.attribute_map ⇒ Object

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

def self.attribute_map
  {
    
    :'bot_id' => :'botId',
    
    :'bot_alias' => :'botAlias',
    
    :'integration_id' => :'integrationId',
    
    :'bot_session_id' => :'botSessionId',
    
    :'post_text_message' => :'postTextMessage',
    
    :'language_code' => :'languageCode',
    
    :'bot_session_timeout_minutes' => :'botSessionTimeoutMinutes',
    
    :'bot_channels' => :'botChannels',
    
    :'bot_correlation_id' => :'botCorrelationId',
    
    :'amazon_lex_request' => :'amazonLexRequest',
    
    :'google_dialogflow' => :'googleDialogflow'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'bot_id' => :'String',
    
    :'bot_alias' => :'String',
    
    :'integration_id' => :'String',
    
    :'bot_session_id' => :'String',
    
    :'post_text_message' => :'PostTextMessage',
    
    :'language_code' => :'String',
    
    :'bot_session_timeout_minutes' => :'Integer',
    
    :'bot_channels' => :'Array<String>',
    
    :'bot_correlation_id' => :'String',
    
    :'amazon_lex_request' => :'AmazonLexRequest',
    
    :'google_dialogflow' => :'GoogleDialogflowCustomSettings'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/purecloudplatformclientv2/models/post_text_request.rb', line 359

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      bot_id == o.bot_id &&
      bot_alias == o.bot_alias &&
      integration_id == o.integration_id &&
      bot_session_id == o.bot_session_id &&
      post_text_message == o.post_text_message &&
      language_code == o.language_code &&
      bot_session_timeout_minutes == o.bot_session_timeout_minutes &&
      bot_channels == o.bot_channels &&
      bot_correlation_id == o.bot_correlation_id &&
      amazon_lex_request == o.amazon_lex_request &&
      google_dialogflow == o.google_dialogflow
end

#_deserialize(type, value) ⇒ Object 



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/purecloudplatformclientv2/models/post_text_request.rb', line 407

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



467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/purecloudplatformclientv2/models/post_text_request.rb', line 467

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



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/purecloudplatformclientv2/models/post_text_request.rb', line 388

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


377
378
379
 
# File 'lib/purecloudplatformclientv2/models/post_text_request.rb', line 377

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



383
384
385
 
# File 'lib/purecloudplatformclientv2/models/post_text_request.rb', line 383

def hash
  [bot_id, bot_alias, integration_id, bot_session_id, post_text_message, language_code, bot_session_timeout_minutes, bot_channels, bot_correlation_id, amazon_lex_request, google_dialogflow].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



224
225
226
227
228
229
 
# File 'lib/purecloudplatformclientv2/models/post_text_request.rb', line 224

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



450
451
452
 
# File 'lib/purecloudplatformclientv2/models/post_text_request.rb', line 450

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



455
456
457
458
459
460
461
462
463
 
# File 'lib/purecloudplatformclientv2/models/post_text_request.rb', line 455

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 



445
446
447
 
# File 'lib/purecloudplatformclientv2/models/post_text_request.rb', line 445

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



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
262
263
264
265
266
267
268
269
270
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
 
# File 'lib/purecloudplatformclientv2/models/post_text_request.rb', line 233

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

  
  
  
  
  
  
  
  
  
  if @integration_id.nil?
    return false
  end

  
  
  
  
  
  if @bot_session_id.nil?
    return false
  end

  
  
  
  
  
  if @post_text_message.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end