Class: UltracartClient::Conversation

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Conversation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::Conversation` 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::Conversation`. 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?(:'base_language_iso_code')
    self.base_language_iso_code = attributes[:'base_language_iso_code']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#base_language_iso_code ⇒ Object

The base language iso code for the StoreFront that everything is translated into



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

def base_language_iso_code
  @base_language_iso_code
end

#closed ⇒ Object

Returns the value of attribute closed.



21
22
23
 
# File 'lib/ultracart_api/models/conversation.rb', line 21

def closed
  @closed
end

#conversation_arn ⇒ Object

Returns the value of attribute conversation_arn.



23
24
25
 
# File 'lib/ultracart_api/models/conversation.rb', line 23

def conversation_arn
  @conversation_arn
end

#conversation_uuid ⇒ Object

Returns the value of attribute conversation_uuid.



25
26
27
 
# File 'lib/ultracart_api/models/conversation.rb', line 25

def conversation_uuid
  @conversation_uuid
end

#customer_first_message_unresponded_to_dts ⇒ Object

Date/time of the first customer message that is unresponded to.



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

def customer_first_message_unresponded_to_dts
  @customer_first_message_unresponded_to_dts
end

#last_conversation_message_body ⇒ Object

Returns the value of attribute last_conversation_message_body.



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

def last_conversation_message_body
  @last_conversation_message_body
end

#last_conversation_participant_arn ⇒ Object

Returns the value of attribute last_conversation_participant_arn.



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

def last_conversation_participant_arn
  @last_conversation_participant_arn
end

#last_conversation_participant_name ⇒ Object

Returns the value of attribute last_conversation_participant_name.



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

def last_conversation_participant_name
  @last_conversation_participant_name
end

#last_interactive_message_dts ⇒ Object

Last interactive message date/time



37
38
39
 
# File 'lib/ultracart_api/models/conversation.rb', line 37

def last_interactive_message_dts
  @last_interactive_message_dts
end

#last_message_dts ⇒ Object

Last message date/time



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

def last_message_dts
  @last_message_dts
end

#medium ⇒ Object

The communication medium of the customer.



43
44
45
 
# File 'lib/ultracart_api/models/conversation.rb', line 43

def medium
  @medium
end

#merchant_id ⇒ Object

Returns the value of attribute merchant_id.



45
46
47
 
# File 'lib/ultracart_api/models/conversation.rb', line 45

def merchant_id
  @merchant_id
end

#message_count ⇒ Object

Returns the value of attribute message_count.



47
48
49
 
# File 'lib/ultracart_api/models/conversation.rb', line 47

def message_count
  @message_count
end

#messages ⇒ Object

Returns the value of attribute messages.



49
50
51
 
# File 'lib/ultracart_api/models/conversation.rb', line 49

def messages
  @messages
end

#participants ⇒ Object

Returns the value of attribute participants.



51
52
53
 
# File 'lib/ultracart_api/models/conversation.rb', line 51

def participants
  @participants
end

#sentiment ⇒ Object

Returns the value of attribute sentiment.



53
54
55
 
# File 'lib/ultracart_api/models/conversation.rb', line 53

def sentiment
  @sentiment
end

#start_dts ⇒ Object

Start of the conversation date/time



56
57
58
 
# File 'lib/ultracart_api/models/conversation.rb', line 56

def start_dts
  @start_dts
end

#unread_messages ⇒ Object

Returns the value of attribute unread_messages.



58
59
60
 
# File 'lib/ultracart_api/models/conversation.rb', line 58

def unread_messages
  @unread_messages
end

#virtual_agent ⇒ Object

True if a virtual agent answered the conversation



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

def virtual_agent
  @virtual_agent
end

#virtual_agent_cost ⇒ Object

The cost of this conversation performed by the virtual agent



64
65
66
 
# File 'lib/ultracart_api/models/conversation.rb', line 64

def virtual_agent_cost
  @virtual_agent_cost
end

#visible ⇒ Object

Returns the value of attribute visible.



66
67
68
 
# File 'lib/ultracart_api/models/conversation.rb', line 66

def visible
  @visible
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



118
119
120
 
# File 'lib/ultracart_api/models/conversation.rb', line 118

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/ultracart_api/models/conversation.rb', line 91

def self.attribute_map
  {
    :'base_language_iso_code' => :'base_language_iso_code',
    :'closed' => :'closed',
    :'conversation_arn' => :'conversation_arn',
    :'conversation_uuid' => :'conversation_uuid',
    :'customer_first_message_unresponded_to_dts' => :'customer_first_message_unresponded_to_dts',
    :'last_conversation_message_body' => :'last_conversation_message_body',
    :'last_conversation_participant_arn' => :'last_conversation_participant_arn',
    :'last_conversation_participant_name' => :'last_conversation_participant_name',
    :'last_interactive_message_dts' => :'last_interactive_message_dts',
    :'last_message_dts' => :'last_message_dts',
    :'medium' => :'medium',
    :'merchant_id' => :'merchant_id',
    :'message_count' => :'message_count',
    :'messages' => :'messages',
    :'participants' => :'participants',
    :'sentiment' => :'sentiment',
    :'start_dts' => :'start_dts',
    :'unread_messages' => :'unread_messages',
    :'virtual_agent' => :'virtual_agent',
    :'virtual_agent_cost' => :'virtual_agent_cost',
    :'visible' => :'visible'
  }
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



327
328
329
 
# File 'lib/ultracart_api/models/conversation.rb', line 327

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



150
151
152
153
 
# File 'lib/ultracart_api/models/conversation.rb', line 150

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'base_language_iso_code' => :'String',
    :'closed' => :'Boolean',
    :'conversation_arn' => :'String',
    :'conversation_uuid' => :'String',
    :'customer_first_message_unresponded_to_dts' => :'String',
    :'last_conversation_message_body' => :'String',
    :'last_conversation_participant_arn' => :'String',
    :'last_conversation_participant_name' => :'String',
    :'last_interactive_message_dts' => :'String',
    :'last_message_dts' => :'String',
    :'medium' => :'String',
    :'merchant_id' => :'String',
    :'message_count' => :'Integer',
    :'messages' => :'Array<ConversationMessage>',
    :'participants' => :'Array<ConversationParticipant>',
    :'sentiment' => :'ConversationSentiment',
    :'start_dts' => :'String',
    :'unread_messages' => :'Boolean',
    :'virtual_agent' => :'Boolean',
    :'virtual_agent_cost' => :'Float',
    :'visible' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      base_language_iso_code == o.base_language_iso_code &&
      closed == o.closed &&
      conversation_arn == o.conversation_arn &&
      conversation_uuid == o.conversation_uuid &&
      customer_first_message_unresponded_to_dts == o.customer_first_message_unresponded_to_dts &&
      last_conversation_message_body == o.last_conversation_message_body &&
      last_conversation_participant_arn == o.last_conversation_participant_arn &&
      last_conversation_participant_name == o.last_conversation_participant_name &&
      last_interactive_message_dts == o.last_interactive_message_dts &&
      last_message_dts == o.last_message_dts &&
      medium == o.medium &&
      merchant_id == o.merchant_id &&
      message_count == o.message_count &&
      messages == o.messages &&
      participants == o.participants &&
      sentiment == o.sentiment &&
      start_dts == o.start_dts &&
      unread_messages == o.unread_messages &&
      virtual_agent == o.virtual_agent &&
      virtual_agent_cost == o.virtual_agent_cost &&
      visible == o.visible
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



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/ultracart_api/models/conversation.rb', line 358

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



429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/ultracart_api/models/conversation.rb', line 429

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



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/ultracart_api/models/conversation.rb', line 334

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


314
315
316
 
# File 'lib/ultracart_api/models/conversation.rb', line 314

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



320
321
322
 
# File 'lib/ultracart_api/models/conversation.rb', line 320

def hash
  [base_language_iso_code, closed, conversation_arn, conversation_uuid, customer_first_message_unresponded_to_dts, last_conversation_message_body, last_conversation_participant_arn, last_conversation_participant_name, last_interactive_message_dts, last_message_dts, medium, merchant_id, message_count, messages, participants, sentiment, start_dts, unread_messages, virtual_agent, virtual_agent_cost, visible].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



261
262
263
264
 
# File 'lib/ultracart_api/models/conversation.rb', line 261

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



405
406
407
 
# File 'lib/ultracart_api/models/conversation.rb', line 405

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



411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/ultracart_api/models/conversation.rb', line 411

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



399
400
401
 
# File 'lib/ultracart_api/models/conversation.rb', line 399

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



268
269
270
271
272
 
# File 'lib/ultracart_api/models/conversation.rb', line 268

def valid?
  medium_validator = EnumAttributeValidator.new('String', ["sms", "websocket"])
  return false unless medium_validator.valid?(@medium)
  true
end