Class: UltracartClient::ConversationMessage

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConversationMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#author_conversation_participant_arn ⇒ Object

Returns the value of attribute author_conversation_participant_arn.



18
19
20
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 18

def author_conversation_participant_arn
  @author_conversation_participant_arn
end

#author_conversation_participant_name ⇒ Object

Returns the value of attribute author_conversation_participant_name.



20
21
22
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 20

def author_conversation_participant_name
  @author_conversation_participant_name
end

#body ⇒ Object

Returns the value of attribute body.



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

def body
  @body
end

#client_message_id ⇒ Object

Returns the value of attribute client_message_id.



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

def client_message_id
  @client_message_id
end

#conversation_message_uuid ⇒ Object

Returns the value of attribute conversation_message_uuid.



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

def conversation_message_uuid
  @conversation_message_uuid
end

#delay_until_dts ⇒ Object

Delay message transmission until date/time



29
30
31
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 29

def delay_until_dts
  @delay_until_dts
end

#language_iso_code ⇒ Object

Returns the value of attribute language_iso_code.



31
32
33
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 31

def language_iso_code
  @language_iso_code
end

#media_urls ⇒ Object

Returns the value of attribute media_urls.



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

def media_urls
  @media_urls
end

#merchant_id ⇒ Object

Returns the value of attribute merchant_id.



35
36
37
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 35

def merchant_id
  @merchant_id
end

#message_dts ⇒ Object

Message date/time



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

def message_dts
  @message_dts
end

#message_epoch ⇒ Object

Message epoch milliseconds



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

def message_epoch
  @message_epoch
end

#message_type ⇒ Object

Returns the value of attribute message_type.



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

def message_type
  @message_type
end

#translations ⇒ Object

Returns the value of attribute translations.



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

def translations
  @translations
end

#transport_statuses ⇒ Object

Returns the value of attribute transport_statuses.



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

def transport_statuses
  @transport_statuses
end

#type ⇒ Object

Message type



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

def type
  @type
end

#upload_keys ⇒ Object

Returns the value of attribute upload_keys.



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

def upload_keys
  @upload_keys
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



99
100
101
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 99

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'author_conversation_participant_arn' => :'author_conversation_participant_arn',
    :'author_conversation_participant_name' => :'author_conversation_participant_name',
    :'body' => :'body',
    :'client_message_id' => :'client_message_id',
    :'conversation_message_uuid' => :'conversation_message_uuid',
    :'delay_until_dts' => :'delay_until_dts',
    :'language_iso_code' => :'language_iso_code',
    :'media_urls' => :'media_urls',
    :'merchant_id' => :'merchant_id',
    :'message_dts' => :'message_dts',
    :'message_epoch' => :'message_epoch',
    :'message_type' => :'message_type',
    :'translations' => :'translations',
    :'transport_statuses' => :'transport_statuses',
    :'type' => :'type',
    :'upload_keys' => :'upload_keys'
  }
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



282
283
284
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 282

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



126
127
128
129
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 126

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'author_conversation_participant_arn' => :'String',
    :'author_conversation_participant_name' => :'String',
    :'body' => :'String',
    :'client_message_id' => :'String',
    :'conversation_message_uuid' => :'String',
    :'delay_until_dts' => :'String',
    :'language_iso_code' => :'String',
    :'media_urls' => :'Array<String>',
    :'merchant_id' => :'String',
    :'message_dts' => :'String',
    :'message_epoch' => :'Integer',
    :'message_type' => :'String',
    :'translations' => :'Array<ConversationMessageTranslation>',
    :'transport_statuses' => :'Array<ConversationMessageTransportStatus>',
    :'type' => :'String',
    :'upload_keys' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 246

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      author_conversation_participant_arn == o.author_conversation_participant_arn &&
      author_conversation_participant_name == o.author_conversation_participant_name &&
      body == o.body &&
      client_message_id == o.client_message_id &&
      conversation_message_uuid == o.conversation_message_uuid &&
      delay_until_dts == o.delay_until_dts &&
      language_iso_code == o.language_iso_code &&
      media_urls == o.media_urls &&
      merchant_id == o.merchant_id &&
      message_dts == o.message_dts &&
      message_epoch == o.message_epoch &&
      message_type == o.message_type &&
      translations == o.translations &&
      transport_statuses == o.transport_statuses &&
      type == o.type &&
      upload_keys == o.upload_keys
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



313
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
342
343
344
345
346
347
348
349
350
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 313

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



384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 384

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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 289

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


269
270
271
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 269

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



275
276
277
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 275

def hash
  [author_conversation_participant_arn, author_conversation_participant_name, body, client_message_id, conversation_message_uuid, delay_until_dts, language_iso_code, media_urls, merchant_id, message_dts, message_epoch, message_type, translations, transport_statuses, type, upload_keys].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



221
222
223
224
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 221

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



360
361
362
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 360

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



366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 366

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



354
355
356
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 354

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



228
229
230
231
232
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 228

def valid?
  type_validator = EnumAttributeValidator.new('String', ["message", "notice", "engagement prompt"])
  return false unless type_validator.valid?(@type)
  true
end