Class: UltracartClient::ConversationWebsocketMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/conversation_websocket_message.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConversationWebsocketMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 165

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::ConversationWebsocketMessage` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::ConversationWebsocketMessage`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'conversation_arn')
    self.conversation_arn = attributes[:'conversation_arn']
  end

  if attributes.key?(:'conversation_uuid')
    self.conversation_uuid = attributes[:'conversation_uuid']
  end

  if attributes.key?(:'event_add_coupon')
    self.event_add_coupon = attributes[:'event_add_coupon']
  end

  if attributes.key?(:'event_add_item')
    self.event_add_item = attributes[:'event_add_item']
  end

  if attributes.key?(:'event_conversation_closed')
    self.event_conversation_closed = attributes[:'event_conversation_closed']
  end

  if attributes.key?(:'event_engage_customer')
    self.event_engage_customer = attributes[:'event_engage_customer']
  end

  if attributes.key?(:'event_new_conversation')
    self.event_new_conversation = attributes[:'event_new_conversation']
  end

  if attributes.key?(:'event_new_message')
    self.event_new_message = attributes[:'event_new_message']
  end

  if attributes.key?(:'event_participant_join')
    self.event_participant_join = attributes[:'event_participant_join']
  end

  if attributes.key?(:'event_participant_join_participant')
    self.event_participant_join_participant = attributes[:'event_participant_join_participant']
  end

  if attributes.key?(:'event_participant_left')
    self.event_participant_left = attributes[:'event_participant_left']
  end

  if attributes.key?(:'event_participant_left_participant')
    self.event_participant_left_participant = attributes[:'event_participant_left_participant']
  end

  if attributes.key?(:'event_participant_update')
    self.event_participant_update = attributes[:'event_participant_update']
  end

  if attributes.key?(:'event_queue_new_member')
    self.event_queue_new_member = attributes[:'event_queue_new_member']
  end

  if attributes.key?(:'event_queue_position')
    self.event_queue_position = attributes[:'event_queue_position']
  end

  if attributes.key?(:'event_queue_status_update')
    self.event_queue_status_update = attributes[:'event_queue_status_update']
  end

  if attributes.key?(:'event_read_message')
    self.event_read_message = attributes[:'event_read_message']
  end

  if attributes.key?(:'event_rrweb')
    self.event_rrweb = attributes[:'event_rrweb']
  end

  if attributes.key?(:'event_type')
    self.event_type = attributes[:'event_type']
  end

  if attributes.key?(:'event_typing')
    self.event_typing = attributes[:'event_typing']
  end

  if attributes.key?(:'event_updated_message')
    self.event_updated_message = attributes[:'event_updated_message']
  end

  if attributes.key?(:'event_webchat_context')
    self.event_webchat_context = attributes[:'event_webchat_context']
  end

  if attributes.key?(:'message')
    self.message = attributes[:'message']
  end

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

Instance Attribute Details

#conversation_arn ⇒ Object

Conversation ARN



19
20
21
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 19

def conversation_arn
  @conversation_arn
end

#conversation_uuid ⇒ Object

Conversation UUID if the websocket message is tied to a specific conversation



22
23
24
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 22

def conversation_uuid
  @conversation_uuid
end

#event_add_coupon ⇒ Object

Returns the value of attribute event_add_coupon.



24
25
26
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 24

def event_add_coupon
  @event_add_coupon
end

#event_add_item ⇒ Object

Returns the value of attribute event_add_item.



26
27
28
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 26

def event_add_item
  @event_add_item
end

#event_conversation_closed ⇒ Object

Returns the value of attribute event_conversation_closed.



28
29
30
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 28

def event_conversation_closed
  @event_conversation_closed
end

#event_engage_customer ⇒ Object

Returns the value of attribute event_engage_customer.



30
31
32
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 30

def event_engage_customer
  @event_engage_customer
end

#event_new_conversation ⇒ Object

Returns the value of attribute event_new_conversation.



32
33
34
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 32

def event_new_conversation
  @event_new_conversation
end

#event_new_message ⇒ Object

Returns the value of attribute event_new_message.



34
35
36
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 34

def event_new_message
  @event_new_message
end

#event_participant_join ⇒ Object

Returns the value of attribute event_participant_join.



36
37
38
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 36

def event_participant_join
  @event_participant_join
end

#event_participant_join_participant ⇒ Object

Returns the value of attribute event_participant_join_participant.



38
39
40
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 38

def event_participant_join_participant
  @event_participant_join_participant
end

#event_participant_left ⇒ Object

Returns the value of attribute event_participant_left.



40
41
42
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 40

def event_participant_left
  @event_participant_left
end

#event_participant_left_participant ⇒ Object

Returns the value of attribute event_participant_left_participant.



42
43
44
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 42

def event_participant_left_participant
  @event_participant_left_participant
end

#event_participant_update ⇒ Object

Returns the value of attribute event_participant_update.



44
45
46
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 44

def event_participant_update
  @event_participant_update
end

#event_queue_new_member ⇒ Object

Returns the value of attribute event_queue_new_member.



46
47
48
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 46

def event_queue_new_member
  @event_queue_new_member
end

#event_queue_position ⇒ Object

Returns the value of attribute event_queue_position.



48
49
50
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 48

def event_queue_position
  @event_queue_position
end

#event_queue_status_update ⇒ Object

Returns the value of attribute event_queue_status_update.



50
51
52
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 50

def event_queue_status_update
  @event_queue_status_update
end

#event_read_message ⇒ Object

Returns the value of attribute event_read_message.



52
53
54
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 52

def event_read_message
  @event_read_message
end

#event_rrweb ⇒ Object

Returns the value of attribute event_rrweb.



54
55
56
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 54

def event_rrweb
  @event_rrweb
end

#event_type ⇒ Object

Type of event



57
58
59
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 57

def event_type
  @event_type
end

#event_typing ⇒ Object

Returns the value of attribute event_typing.



59
60
61
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 59

def event_typing
  @event_typing
end

#event_updated_message ⇒ Object

Returns the value of attribute event_updated_message.



61
62
63
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 61

def event_updated_message
  @event_updated_message
end

#event_webchat_context ⇒ Object

Returns the value of attribute event_webchat_context.



63
64
65
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 63

def event_webchat_context
  @event_webchat_context
end

#message ⇒ Object

Returns the value of attribute message.



65
66
67
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 65

def message
  @message
end

#type ⇒ Object

Type of message



68
69
70
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 68

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



123
124
125
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 123

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'conversation_arn' => :'conversation_arn',
    :'conversation_uuid' => :'conversation_uuid',
    :'event_add_coupon' => :'event_add_coupon',
    :'event_add_item' => :'event_add_item',
    :'event_conversation_closed' => :'event_conversation_closed',
    :'event_engage_customer' => :'event_engage_customer',
    :'event_new_conversation' => :'event_new_conversation',
    :'event_new_message' => :'event_new_message',
    :'event_participant_join' => :'event_participant_join',
    :'event_participant_join_participant' => :'event_participant_join_participant',
    :'event_participant_left' => :'event_participant_left',
    :'event_participant_left_participant' => :'event_participant_left_participant',
    :'event_participant_update' => :'event_participant_update',
    :'event_queue_new_member' => :'event_queue_new_member',
    :'event_queue_position' => :'event_queue_position',
    :'event_queue_status_update' => :'event_queue_status_update',
    :'event_read_message' => :'event_read_message',
    :'event_rrweb' => :'event_rrweb',
    :'event_type' => :'event_type',
    :'event_typing' => :'event_typing',
    :'event_updated_message' => :'event_updated_message',
    :'event_webchat_context' => :'event_webchat_context',
    :'message' => :'message',
    :'type' => :'type'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



358
359
360
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 358

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



158
159
160
161
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 158

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 128

def self.openapi_types
  {
    :'conversation_arn' => :'String',
    :'conversation_uuid' => :'String',
    :'event_add_coupon' => :'ConversationEventAddCoupon',
    :'event_add_item' => :'ConversationEventAddItem',
    :'event_conversation_closed' => :'ConversationSummary',
    :'event_engage_customer' => :'ConversationWebchatQueueStatusQueueEntry',
    :'event_new_conversation' => :'ConversationSummary',
    :'event_new_message' => :'ConversationSummary',
    :'event_participant_join' => :'ConversationSummary',
    :'event_participant_join_participant' => :'ConversationParticipant',
    :'event_participant_left' => :'ConversationSummary',
    :'event_participant_left_participant' => :'ConversationParticipant',
    :'event_participant_update' => :'ConversationSummary',
    :'event_queue_new_member' => :'ConversationWebchatQueueStatusQueueEntry',
    :'event_queue_position' => :'ConversationEventQueuePosition',
    :'event_queue_status_update' => :'ConversationWebchatQueueStatus',
    :'event_read_message' => :'ConversationEventReadMessage',
    :'event_rrweb' => :'ConversationEventRRWeb',
    :'event_type' => :'String',
    :'event_typing' => :'ConversationEventTyping',
    :'event_updated_message' => :'ConversationMessage',
    :'event_webchat_context' => :'ConversationEventWebchatContext',
    :'message' => :'ConversationMessage',
    :'type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 314

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      conversation_arn == o.conversation_arn &&
      conversation_uuid == o.conversation_uuid &&
      event_add_coupon == o.event_add_coupon &&
      event_add_item == o.event_add_item &&
      event_conversation_closed == o.event_conversation_closed &&
      event_engage_customer == o.event_engage_customer &&
      event_new_conversation == o.event_new_conversation &&
      event_new_message == o.event_new_message &&
      event_participant_join == o.event_participant_join &&
      event_participant_join_participant == o.event_participant_join_participant &&
      event_participant_left == o.event_participant_left &&
      event_participant_left_participant == o.event_participant_left_participant &&
      event_participant_update == o.event_participant_update &&
      event_queue_new_member == o.event_queue_new_member &&
      event_queue_position == o.event_queue_position &&
      event_queue_status_update == o.event_queue_status_update &&
      event_read_message == o.event_read_message &&
      event_rrweb == o.event_rrweb &&
      event_type == o.event_type &&
      event_typing == o.event_typing &&
      event_updated_message == o.event_updated_message &&
      event_webchat_context == o.event_webchat_context &&
      message == o.message &&
      type == o.type
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 389

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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 =~ /\A(true|t|yes|y|1)\z/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
    # models (e.g. Pet) or oneOf
    klass = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 460

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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 365

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


345
346
347
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 345

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



351
352
353
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 351

def hash
  [conversation_arn, conversation_uuid, event_add_coupon, event_add_item, event_conversation_closed, event_engage_customer, event_new_conversation, event_new_message, event_participant_join, event_participant_join_participant, event_participant_left, event_participant_left_participant, event_participant_update, event_queue_new_member, event_queue_position, event_queue_status_update, event_read_message, event_rrweb, event_type, event_typing, event_updated_message, event_webchat_context, message, type].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



277
278
279
280
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 277

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



436
437
438
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 436

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 442

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



430
431
432
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 430

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



284
285
286
287
288
289
290
 
# File 'lib/ultracart_api/models/conversation_websocket_message.rb', line 284

def valid?
  event_type_validator = EnumAttributeValidator.new('String', ["queue position", "webchat start conversation", "conversation closed", "new conversation", "new message", "updated message", "queue status update", "rrweb", "participant update", "participant join", "participant left", "read message", "typing", "add coupon", "add item", "webchat context", "engage customer", "queue new member"])
  return false unless event_type_validator.valid?(@event_type)
  type_validator = EnumAttributeValidator.new('String', ["message", "event", "ping", "check queue position"])
  return false unless type_validator.valid?(@type)
  true
end