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



104
105
106
107
108
109
110
111
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
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 104

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_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.



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

def author_conversation_participant_arn
  @author_conversation_participant_arn
end

#author_conversation_participant_name ⇒ Object

Returns the value of attribute author_conversation_participant_name.



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

def author_conversation_participant_name
  @author_conversation_participant_name
end

#body ⇒ Object

Returns the value of attribute body.



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

def body
  @body
end

#client_message_id ⇒ Object

Returns the value of attribute client_message_id.



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

def client_message_id
  @client_message_id
end

#conversation_message_uuid ⇒ Object

Returns the value of attribute conversation_message_uuid.



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

def conversation_message_uuid
  @conversation_message_uuid
end

#media_urls ⇒ Object

Returns the value of attribute media_urls.



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

def media_urls
  @media_urls
end

#merchant_id ⇒ Object

Returns the value of attribute merchant_id.



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

def merchant_id
  @merchant_id
end

#message_dts ⇒ Object

Message date/time



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

def message_dts
  @message_dts
end

#message_epoch ⇒ Object

Message epoch milliseconds



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

def message_epoch
  @message_epoch
end

#transport_statuses ⇒ Object

Returns the value of attribute transport_statuses.



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

def transport_statuses
  @transport_statuses
end

#type ⇒ Object

Message type



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

def type
  @type
end

#upload_keys ⇒ Object

Returns the value of attribute upload_keys.



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

def upload_keys
  @upload_keys
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 67

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',
    :'media_urls' => :'media_urls',
    :'merchant_id' => :'merchant_id',
    :'message_dts' => :'message_dts',
    :'message_epoch' => :'message_epoch',
    :'transport_statuses' => :'transport_statuses',
    :'type' => :'type',
    :'upload_keys' => :'upload_keys'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 85

def self.swagger_types
  {
    :'author_conversation_participant_arn' => :'String',
    :'author_conversation_participant_name' => :'String',
    :'body' => :'String',
    :'client_message_id' => :'String',
    :'conversation_message_uuid' => :'String',
    :'media_urls' => :'Array<String>',
    :'merchant_id' => :'String',
    :'message_dts' => :'String',
    :'message_epoch' => :'Integer',
    :'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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 192

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 &&
      media_urls == o.media_urls &&
      merchant_id == o.merchant_id &&
      message_dts == o.message_dts &&
      message_epoch == o.message_epoch &&
      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



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

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



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 311

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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 224

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


211
212
213
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 211

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



217
218
219
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 217

def hash
  [author_conversation_participant_arn, author_conversation_participant_name, body, client_message_id, conversation_message_uuid, media_urls, merchant_id, message_dts, message_epoch, 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



167
168
169
170
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 167

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



291
292
293
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 291

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



297
298
299
300
301
302
303
304
305
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 297

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



285
286
287
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 285

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



174
175
176
177
178
 
# File 'lib/ultracart_api/models/conversation_message.rb', line 174

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