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



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
218
219
220
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
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 160

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

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

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

  if attributes.key?(:'evaluable_campaign_ids')
    if (value = attributes[:'evaluable_campaign_ids']).is_a?(Array)
      self.evaluable_campaign_ids = value
    end
  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?(:'loyalty_cards')
    if (value = attributes[:'loyalty_cards']).is_a?(Array)
      self.loyalty_cards = value
    end
  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

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

Instance Attribute Details

#additional_cost_total ⇒ Object

The total value of additional costs, before any discounts are applied.



73
74
75
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 73

def additional_cost_total
  @additional_cost_total
end

#additional_costs ⇒ Object

Use this property to set a value for the additional costs of this session, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](docs.talon.one/docs/product/account/dev-tools/managing-additional-costs).



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

def additional_costs
  @additional_costs
end

#application_id ⇒ Object

The ID of the application that owns this entity.



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

def application_id
  @application_id
end

#attributes ⇒ Object

Use this property to set a value for the attributes of your choice. Attributes represent any information to attach to your session, like the shipping city. You can use [built-in attributes](docs.talon.one/docs/dev/concepts/attributes#built-in-attributes) or [custom ones](docs.talon.one/docs/dev/concepts/attributes#custom-attributes). Custom attributes must be created in the Campaign Manager before you set them with this property.



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

def attributes
  @attributes
end

#cart_item_total ⇒ Object

The total value of cart items, before any discounts are applied.



70
71
72
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 70

def cart_item_total
  @cart_item_total
end

#cart_items ⇒ Object

The items to add to this session. **Do not exceed 1000 items** and ensure the sum of all cart item’s ‘quantity` **does not exceed 10.000** per request.



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

def cart_items
  @cart_items
end

#coupon_codes ⇒ Object

Any coupon codes entered. **Important - for requests only**: - If you [create a coupon budget](docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. - In requests where ‘dry=false`, providing an empty array discards any previous coupons. To avoid this, provide `"couponCodes": null` or omit the parameter entirely.



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

def coupon_codes
  @coupon_codes
end

#created ⇒ Object

The time this entity was created. The time this entity was created.



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

def created
  @created
end

#evaluable_campaign_ids ⇒ Object

When using the ‘dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them.



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

def evaluable_campaign_ids
  @evaluable_campaign_ids
end

#first_session ⇒ Object

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



64
65
66
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 64

def first_session
  @first_session
end

#id ⇒ Object

Internal ID of this entity.



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

def id
  @id
end

#identifiers ⇒ Object

Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](docs.talon.one/docs/dev/tutorials/using-identifiers). Important: Ensure the session contains an identifier by the time you close it if: - You [create a unique identifier budget](docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign. - Your campaign has [coupons](docs.talon.one/docs/product/campaigns/coupons/coupon-page-overview).



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

def identifiers
  @identifiers
end

#integration_id ⇒ Object

The integration ID set by your integration layer.



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

def integration_id
  @integration_id
end

#loyalty_cards ⇒ Object

Identifier of a loyalty card.



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

def loyalty_cards
  @loyalty_cards
end

#profile_id ⇒ Object

ID of the customer profile set by your integration layer. Note: If the customer does not yet have a known ‘profileId`, we recommend you use a guest `profileId`.



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

def profile_id
  @profile_id
end

#referral_code ⇒ Object

Any referral code entered. **Important - for requests only**: - If you [create a referral budget](docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. - In requests where ‘dry=false`, providing an empty value discards the previous referral code. To avoid this, provide `"referralCode": null` or omit the parameter entirely.



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

def referral_code
  @referral_code
end

#state ⇒ Object

Indicates the current state of the session. Sessions can be created as ‘open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. Either: - `closed` → `cancelled` (only via [Update customer session](docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or - `closed` → `partially_returned` (only via [Return cart items](docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems)) - `closed` → `open` (only via [Reopen customer session](docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled` For more information, see [Customer session states](docs.talon.one/docs/dev/concepts/entities/customer-sessions).



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

def state
  @state
end

#store_integration_id ⇒ Object

The integration ID of the store. You choose this ID when you create a store.



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

def store_integration_id
  @store_integration_id
end

#total ⇒ Object

The total value of cart items and additional costs in the session, before any discounts are applied.



67
68
69
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 67

def total
  @total
end

#updated ⇒ Object

Timestamp of the most recent event received on this session.



76
77
78
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 76

def updated
  @updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'created' => :'created',
    :'integration_id' => :'integrationId',
    :'application_id' => :'applicationId',
    :'profile_id' => :'profileId',
    :'store_integration_id' => :'storeIntegrationId',
    :'evaluable_campaign_ids' => :'evaluableCampaignIds',
    :'coupon_codes' => :'couponCodes',
    :'referral_code' => :'referralCode',
    :'loyalty_cards' => :'loyaltyCards',
    :'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',
    :'updated' => :'updated'
  }
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



458
459
460
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 458

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



153
154
155
156
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 153

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

.openapi_types ⇒ Object

Attribute type mapping.



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 127

def self.openapi_types
  {
    :'id' => :'Integer',
    :'created' => :'DateTime',
    :'integration_id' => :'String',
    :'application_id' => :'Integer',
    :'profile_id' => :'String',
    :'store_integration_id' => :'String',
    :'evaluable_campaign_ids' => :'Array<Integer>',
    :'coupon_codes' => :'Array<String>',
    :'referral_code' => :'String',
    :'loyalty_cards' => :'Array<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',
    :'updated' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 418

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created == o.created &&
      integration_id == o.integration_id &&
      application_id == o.application_id &&
      profile_id == o.profile_id &&
      store_integration_id == o.store_integration_id &&
      evaluable_campaign_ids == o.evaluable_campaign_ids &&
      coupon_codes == o.coupon_codes &&
      referral_code == o.referral_code &&
      loyalty_cards == o.loyalty_cards &&
      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 &&
      updated == o.updated
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



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 486

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



555
556
557
558
559
560
561
562
563
564
565
566
567
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 555

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



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 465

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


445
446
447
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 445

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



451
452
453
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 451

def hash
  [id, created, integration_id, application_id, profile_id, store_integration_id, evaluable_campaign_ids, coupon_codes, referral_code, loyalty_cards, state, cart_items, additional_costs, identifiers, attributes, first_session, total, cart_item_total, additional_cost_total, updated].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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 270

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

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

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

  if @integration_id.to_s.length > 1000
    invalid_properties.push('invalid value for "integration_id", the character length must be smaller than or equal to 1000.')
  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 !@store_integration_id.nil? && @store_integration_id.to_s.length > 1000
    invalid_properties.push('invalid value for "store_integration_id", the character length must be smaller than or equal to 1000.')
  end

  if !@store_integration_id.nil? && @store_integration_id.to_s.length < 1
    invalid_properties.push('invalid value for "store_integration_id", the character length must be great than or equal to 1.')
  end

  if !@referral_code.nil? && @referral_code.to_s.length > 100
    invalid_properties.push('invalid value for "referral_code", the character length must be smaller than or equal to 100.')
  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

  if @updated.nil?
    invalid_properties.push('invalid value for "updated", updated 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



531
532
533
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 531

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



537
538
539
540
541
542
543
544
545
546
547
548
549
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 537

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



525
526
527
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 525

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



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/talon_one/models/customer_session_v2.rb', line 345

def valid?
  return false if @id.nil?
  return false if @created.nil?
  return false if @integration_id.nil?
  return false if @integration_id.to_s.length > 1000
  return false if @application_id.nil?
  return false if @profile_id.nil?
  return false if !@store_integration_id.nil? && @store_integration_id.to_s.length > 1000
  return false if !@store_integration_id.nil? && @store_integration_id.to_s.length < 1
  return false if !@referral_code.nil? && @referral_code.to_s.length > 100
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ["open", "closed", "partially_returned", "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?
  return false if @updated.nil?
  true
end