Class: UltracartClient::ConversationSummary

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConversationSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#closed ⇒ Object

Returns the value of attribute closed.



17
18
19
 
# File 'lib/ultracart_api/models/conversation_summary.rb', line 17

def closed
  @closed
end

#conversation_arn ⇒ Object

Returns the value of attribute conversation_arn.



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

def conversation_arn
  @conversation_arn
end

#conversation_uuid ⇒ Object

Returns the value of attribute conversation_uuid.



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

def conversation_uuid
  @conversation_uuid
end

#customer_first_message_unresponded_to_dts ⇒ Object

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



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

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.



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

def last_conversation_message_body
  @last_conversation_message_body
end

#last_conversation_participant_arn ⇒ Object

Returns the value of attribute last_conversation_participant_arn.



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

def last_conversation_participant_arn
  @last_conversation_participant_arn
end

#last_conversation_participant_name ⇒ Object

Returns the value of attribute last_conversation_participant_name.



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

def last_conversation_participant_name
  @last_conversation_participant_name
end

#last_interactive_message_dts ⇒ Object

Last interactive message date/time



33
34
35
 
# File 'lib/ultracart_api/models/conversation_summary.rb', line 33

def last_interactive_message_dts
  @last_interactive_message_dts
end

#last_message_dts ⇒ Object

Last message date/time



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

def last_message_dts
  @last_message_dts
end

#medium ⇒ Object

The communication medium of the customer.



39
40
41
 
# File 'lib/ultracart_api/models/conversation_summary.rb', line 39

def medium
  @medium
end

#merchant_id ⇒ Object

Returns the value of attribute merchant_id.



41
42
43
 
# File 'lib/ultracart_api/models/conversation_summary.rb', line 41

def merchant_id
  @merchant_id
end

#message_count ⇒ Object

Returns the value of attribute message_count.



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

def message_count
  @message_count
end

#participants ⇒ Object

Returns the value of attribute participants.



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

def participants
  @participants
end

#sentiment ⇒ Object

Returns the value of attribute sentiment.



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

def sentiment
  @sentiment
end

#start_dts ⇒ Object

Start of the conversation date/time



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

def start_dts
  @start_dts
end

#unread_messages ⇒ Object

Returns the value of attribute unread_messages.



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

def unread_messages
  @unread_messages
end

#visible ⇒ Object

Returns the value of attribute visible.



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

def visible
  @visible
end

Class Method Details

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/ultracart_api/models/conversation_summary.rb', line 79

def self.attribute_map
  {
    :'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',
    :'participants' => :'participants',
    :'sentiment' => :'sentiment',
    :'start_dts' => :'start_dts',
    :'unread_messages' => :'unread_messages',
    :'visible' => :'visible'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/ultracart_api/models/conversation_summary.rb', line 102

def self.swagger_types
  {
    :'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',
    :'participants' => :'Array<ConversationParticipant>',
    :'sentiment' => :'ConversationSentiment',
    :'start_dts' => :'String',
    :'unread_messages' => :'BOOLEAN',
    :'visible' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/ultracart_api/models/conversation_summary.rb', line 230

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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 &&
      participants == o.participants &&
      sentiment == o.sentiment &&
      start_dts == o.start_dts &&
      unread_messages == o.unread_messages &&
      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



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

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 =~ /\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
    temp_model = UltracartClient.const_get(type).new
    temp_model.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



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/ultracart_api/models/conversation_summary.rb', line 354

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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/ultracart_api/models/conversation_summary.rb', line 267

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


254
255
256
 
# File 'lib/ultracart_api/models/conversation_summary.rb', line 254

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



260
261
262
 
# File 'lib/ultracart_api/models/conversation_summary.rb', line 260

def hash
  [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, participants, sentiment, start_dts, unread_messages, 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



205
206
207
208
 
# File 'lib/ultracart_api/models/conversation_summary.rb', line 205

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



334
335
336
 
# File 'lib/ultracart_api/models/conversation_summary.rb', line 334

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



340
341
342
343
344
345
346
347
348
 
# File 'lib/ultracart_api/models/conversation_summary.rb', line 340

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



328
329
330
 
# File 'lib/ultracart_api/models/conversation_summary.rb', line 328

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



212
213
214
215
216
 
# File 'lib/ultracart_api/models/conversation_summary.rb', line 212

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