Class: TalonOne::CustomerSessionV2

Inherits:
Object
  • Object
show all
Defined in:
lib/talon_one/models/customer_session_v2.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CustomerSessionV2

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/talon_one/models/customer_session_v2.rb', line 135

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

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

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

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

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

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

  if attributes.key?(:'state')
    self.state = attributes[:'state']
  else
    self.state = 'open'
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#additional_cost_total ⇒ Object

The total sum of additional costs before any discounts applied



61
62
63
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 61

def additional_cost_total
  @additional_cost_total
end

#additional_costs ⇒ Object

Any costs associated with the session that can not be explicitly attributed to cart items. Examples include shipping costs and service fees.



43
44
45
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 43

def additional_costs
  @additional_costs
end

#application_id ⇒ Object

The ID of the application that owns this entity.



25
26
27
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 25

def application_id
  @application_id
end

#attributes ⇒ Object

A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings.



49
50
51
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 49

def attributes
  @attributes
end

#cart_item_total ⇒ Object

The total sum of cart-items before any discounts applied



58
59
60
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 58

def cart_item_total
  @cart_item_total
end

#cart_items ⇒ Object

All items the customer will be purchasing in this session



40
41
42
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 40

def cart_items
  @cart_items
end

#coupon_codes ⇒ Object

Any coupon codes entered.



31
32
33
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 31

def coupon_codes
  @coupon_codes
end

#created ⇒ Object

The exact moment this entity was created.



22
23
24
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 22

def created
  @created
end

#first_session ⇒ Object

Indicates whether this is the first session for the customer’s profile. Will always be true for anonymous sessions.



52
53
54
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 52

def first_session
  @first_session
end

#identifiers ⇒ Object

Identifiers for the customer, this can be used for limits on values such as device ID.



46
47
48
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 46

def identifiers
  @identifiers
end

#integration_id ⇒ Object

The ID used for this entity in the application system.



19
20
21
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 19

def integration_id
  @integration_id
end

#profile_id ⇒ Object

ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID.



28
29
30
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 28

def profile_id
  @profile_id
end

#referral_code ⇒ Object

Any referral code entered.



34
35
36
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 34

def referral_code
  @referral_code
end

#state ⇒ Object

Indicates the current state of the session. All sessions must start in the "open" state, after which valid transitions are… 1. open -> closed 2. open -> cancelled 3. closed -> cancelled



37
38
39
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 37

def state
  @state
end

#total ⇒ Object

The total sum of cart-items, as well as additional costs, before any discounts applied



55
56
57
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 55

def total
  @total
end

Class Method Details

.attribute_map ⇒ Object

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 86

def self.attribute_map
  {
    :'integration_id' => :'integrationId',
    :'created' => :'created',
    :'application_id' => :'applicationId',
    :'profile_id' => :'profileId',
    :'coupon_codes' => :'couponCodes',
    :'referral_code' => :'referralCode',
    :'state' => :'state',
    :'cart_items' => :'cartItems',
    :'additional_costs' => :'additionalCosts',
    :'identifiers' => :'identifiers',
    :'attributes' => :'attributes',
    :'first_session' => :'firstSession',
    :'total' => :'total',
    :'cart_item_total' => :'cartItemTotal',
    :'additional_cost_total' => :'additionalCostTotal'
  }
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



336
337
338
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 336

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



128
129
130
131
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 128

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

.openapi_types ⇒ Object

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 107

def self.openapi_types
  {
    :'integration_id' => :'String',
    :'created' => :'DateTime',
    :'application_id' => :'Integer',
    :'profile_id' => :'String',
    :'coupon_codes' => :'Array<String>',
    :'referral_code' => :'String',
    :'state' => :'String',
    :'cart_items' => :'Array<CartItem>',
    :'additional_costs' => :'Hash<String, AdditionalCost>',
    :'identifiers' => :'Array<String>',
    :'attributes' => :'Object',
    :'first_session' => :'Boolean',
    :'total' => :'Float',
    :'cart_item_total' => :'Float',
    :'additional_cost_total' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 301

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      integration_id == o.integration_id &&
      created == o.created &&
      application_id == o.application_id &&
      profile_id == o.profile_id &&
      coupon_codes == o.coupon_codes &&
      referral_code == o.referral_code &&
      state == o.state &&
      cart_items == o.cart_items &&
      additional_costs == o.additional_costs &&
      identifiers == o.identifiers &&
      attributes == o.attributes &&
      first_session == o.first_session &&
      total == o.total &&
      cart_item_total == o.cart_item_total &&
      additional_cost_total == o.additional_cost_total
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



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
396
397
398
399
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 364

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
    TalonOne.const_get(type).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



433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 433

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



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 343

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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


323
324
325
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 323

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



329
330
331
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 329

def hash
  [integration_id, created, application_id, profile_id, coupon_codes, referral_code, state, cart_items, additional_costs, identifiers, attributes, first_session, total, cart_item_total, additional_cost_total].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
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
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 221

def list_invalid_properties
  invalid_properties = Array.new
  if @integration_id.nil?
    invalid_properties.push('invalid value for "integration_id", integration_id cannot be nil.')
  end

  if @created.nil?
    invalid_properties.push('invalid value for "created", created cannot be nil.')
  end

  if @application_id.nil?
    invalid_properties.push('invalid value for "application_id", application_id cannot be nil.')
  end

  if @profile_id.nil?
    invalid_properties.push('invalid value for "profile_id", profile_id cannot be nil.')
  end

  if @state.nil?
    invalid_properties.push('invalid value for "state", state cannot be nil.')
  end

  if @cart_items.nil?
    invalid_properties.push('invalid value for "cart_items", cart_items cannot be nil.')
  end

  if @attributes.nil?
    invalid_properties.push('invalid value for "attributes", attributes cannot be nil.')
  end

  if @first_session.nil?
    invalid_properties.push('invalid value for "first_session", first_session cannot be nil.')
  end

  if @total.nil?
    invalid_properties.push('invalid value for "total", total cannot be nil.')
  end

  if @cart_item_total.nil?
    invalid_properties.push('invalid value for "cart_item_total", cart_item_total cannot be nil.')
  end

  if @additional_cost_total.nil?
    invalid_properties.push('invalid value for "additional_cost_total", additional_cost_total cannot be nil.')
  end

  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



409
410
411
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 409

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



415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 415

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



403
404
405
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 403

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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 272

def valid?
  return false if @integration_id.nil?
  return false if @created.nil?
  return false if @application_id.nil?
  return false if @profile_id.nil?
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ["open", "closed", "cancelled"])
  return false unless state_validator.valid?(@state)
  return false if @cart_items.nil?
  return false if @attributes.nil?
  return false if @first_session.nil?
  return false if @total.nil?
  return false if @cart_item_total.nil?
  return false if @additional_cost_total.nil?
  true
end