Class: MParticle::CommerceEvent

Inherits:
Object
  • Object
show all
Defined in:
lib/mparticle/models/commerce_event.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CommerceEvent

Initializes the object

Parameters:

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

    Model attributes in the form of hash



84
85
86
87
88
89
90
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
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
 
# File 'lib/mparticle/models/commerce_event.rb', line 84

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#currency_code ⇒ Object

Returns the value of attribute currency_code.



30
31
32
 
# File 'lib/mparticle/models/commerce_event.rb', line 30

def currency_code
  @currency_code
end

#custom_attributes ⇒ Object

Returns the value of attribute custom_attributes.



16
17
18
 
# File 'lib/mparticle/models/commerce_event.rb', line 16

def custom_attributes
  @custom_attributes
end

#custom_flags ⇒ Object

Returns the value of attribute custom_flags.



36
37
38
 
# File 'lib/mparticle/models/commerce_event.rb', line 36

def custom_flags
  @custom_flags
end

#device_current_state ⇒ Object

Returns the value of attribute device_current_state.



20
21
22
 
# File 'lib/mparticle/models/commerce_event.rb', line 20

def device_current_state
  @device_current_state
end

#event_id ⇒ Object

Returns the value of attribute event_id.



8
9
10
 
# File 'lib/mparticle/models/commerce_event.rb', line 8

def event_id
  @event_id
end

#is_non_interactive ⇒ Object

Returns the value of attribute is_non_interactive.



34
35
36
 
# File 'lib/mparticle/models/commerce_event.rb', line 34

def is_non_interactive
  @is_non_interactive
end

#location ⇒ Object

Returns the value of attribute location.



18
19
20
 
# File 'lib/mparticle/models/commerce_event.rb', line 18

def location
  @location
end

#product_action ⇒ Object

Returns the value of attribute product_action.



22
23
24
 
# File 'lib/mparticle/models/commerce_event.rb', line 22

def product_action
  @product_action
end

#product_impressions ⇒ Object

Returns the value of attribute product_impressions.



26
27
28
 
# File 'lib/mparticle/models/commerce_event.rb', line 26

def product_impressions
  @product_impressions
end

#promotion_action ⇒ Object

Returns the value of attribute promotion_action.



24
25
26
 
# File 'lib/mparticle/models/commerce_event.rb', line 24

def promotion_action
  @promotion_action
end

#screen_name ⇒ Object

Returns the value of attribute screen_name.



32
33
34
 
# File 'lib/mparticle/models/commerce_event.rb', line 32

def screen_name
  @screen_name
end

#session_id ⇒ Object

Returns the value of attribute session_id.



12
13
14
 
# File 'lib/mparticle/models/commerce_event.rb', line 12

def session_id
  @session_id
end

#session_uuid ⇒ Object

Returns the value of attribute session_uuid.



14
15
16
 
# File 'lib/mparticle/models/commerce_event.rb', line 14

def session_uuid
  @session_uuid
end

#shopping_cart ⇒ Object

Returns the value of attribute shopping_cart.



28
29
30
 
# File 'lib/mparticle/models/commerce_event.rb', line 28

def shopping_cart
  @shopping_cart
end

#source_message_id ⇒ Object

Returns the value of attribute source_message_id.



10
11
12
 
# File 'lib/mparticle/models/commerce_event.rb', line 10

def source_message_id
  @source_message_id
end

#timestamp_unixtime_ms ⇒ Object

Returns the value of attribute timestamp_unixtime_ms.



6
7
8
 
# File 'lib/mparticle/models/commerce_event.rb', line 6

def timestamp_unixtime_ms
  @timestamp_unixtime_ms
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/mparticle/models/commerce_event.rb', line 39

def self.attribute_map
  {
    :'timestamp_unixtime_ms' => :'timestamp_unixtime_ms',
    :'event_id' => :'event_id',
    :'source_message_id' => :'source_message_id',
    :'session_id' => :'session_id',
    :'session_uuid' => :'session_uuid',
    :'custom_attributes' => :'custom_attributes',
    :'location' => :'location',
    :'device_current_state' => :'device_current_state',
    :'product_action' => :'product_action',
    :'promotion_action' => :'promotion_action',
    :'product_impressions' => :'product_impressions',
    :'shopping_cart' => :'shopping_cart',
    :'currency_code' => :'currency_code',
    :'screen_name' => :'screen_name',
    :'is_non_interactive' => :'is_non_interactive',
    :'custom_flags' => :'custom_flags',
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/mparticle/models/commerce_event.rb', line 61

def self.swagger_types
  {
    :'timestamp_unixtime_ms' => :'Integer',
    :'event_id' => :'Integer',
    :'source_message_id' => :'String',
    :'session_id' => :'Integer',
    :'session_uuid' => :'String',
    :'custom_attributes' => :'Hash<String, String>',
    :'location' => :'GeoLocation',
    :'device_current_state' => :'DeviceCurrentState',
    :'product_action' => :'ProductAction',
    :'promotion_action' => :'PromotionAction',
    :'product_impressions' => :'Array<ProductImpression>',
    :'shopping_cart' => :'ShoppingCart',
    :'currency_code' => :'String',
    :'screen_name' => :'String',
    :'is_non_interactive' => :'BOOLEAN',
    :'custom_flags' => :'Hash<String, String>',
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/mparticle/models/commerce_event.rb', line 175

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      timestamp_unixtime_ms == o.timestamp_unixtime_ms &&
      event_id == o.event_id &&
      source_message_id == o.source_message_id &&
      session_id == o.session_id &&
      session_uuid == o.session_uuid &&
      custom_attributes == o.custom_attributes &&
      location == o.location &&
      device_current_state == o.device_current_state &&
      product_action == o.product_action &&
      promotion_action == o.promotion_action &&
      product_impressions == o.product_impressions &&
      shopping_cart == o.shopping_cart &&
      currency_code == o.currency_code &&
      screen_name == o.screen_name &&
      is_non_interactive == o.is_non_interactive &&
      custom_flags == o.custom_flags
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



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
 
# File 'lib/mparticle/models/commerce_event.rb', line 232

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 = MParticle.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



298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/mparticle/models/commerce_event.rb', line 298

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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/mparticle/models/commerce_event.rb', line 211

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


198
199
200
 
# File 'lib/mparticle/models/commerce_event.rb', line 198

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



204
205
206
 
# File 'lib/mparticle/models/commerce_event.rb', line 204

def hash
  [timestamp_unixtime_ms, event_id, source_message_id, session_id, session_uuid, custom_attributes, location, device_current_state, product_action, promotion_action, product_impressions, shopping_cart, currency_code, screen_name, is_non_interactive, custom_flags].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



162
163
164
165
 
# File 'lib/mparticle/models/commerce_event.rb', line 162

def list_invalid_properties
  invalid_properties = Array.new
  return 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



278
279
280
 
# File 'lib/mparticle/models/commerce_event.rb', line 278

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



284
285
286
287
288
289
290
291
292
 
# File 'lib/mparticle/models/commerce_event.rb', line 284

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



272
273
274
 
# File 'lib/mparticle/models/commerce_event.rb', line 272

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



169
170
171
 
# File 'lib/mparticle/models/commerce_event.rb', line 169

def valid?
  return true
end