Class: TalonOne::NewCustomerSessionV2
- Inherits:
-
Object
- Object
- TalonOne::NewCustomerSessionV2
- Defined in:
- lib/talon_one/models/new_customer_session_v2.rb
Overview
The representation of the customer session.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#additional_costs ⇒ Object
Use this property to set a value for the additional costs of this session, such as a shipping cost.
-
#attributes ⇒ Object
Use this property to set a value for the attributes of your choice.
-
#cart_items ⇒ Object
The items to add to this sessions.
-
#coupon_codes ⇒ Object
Any coupon codes entered.
-
#evaluable_campaign_ids ⇒ Object
When using the ‘dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine.
-
#identifiers ⇒ Object
Session custom identifiers that you can set limits on or use inside your rules.
-
#loyalty_cards ⇒ Object
Any loyalty cards used.
-
#profile_id ⇒ Object
ID of the customer profile set by your integration layer.
-
#referral_code ⇒ Object
Any referral code entered.
-
#state ⇒ Object
Indicates the current state of the session.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ NewCustomerSessionV2
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ NewCustomerSessionV2
Initializes the object
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 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 110 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::NewCustomerSessionV2` 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::NewCustomerSessionV2`. 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?(:'profile_id') self.profile_id = attributes[:'profile_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 end |
Instance Attribute Details
#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).
40 41 42 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 40 def additional_costs @additional_costs 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.
46 47 48 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 46 def attributes @attributes end |
#cart_items ⇒ Object
The items to add to this sessions. - If cart item flattening is disabled: **Do not exceed 1000 items** (regardless of their ‘quantity`) per request. - If cart item flattening is enabled: **Do not exceed 1000 items** and ensure the sum of all cart item’s ‘quantity` **does not exceed 10.000** per request.
37 38 39 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 37 def cart_items @cart_items end |
#coupon_codes ⇒ Object
Any coupon codes entered. Important: 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.
25 26 27 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 25 def coupon_codes @coupon_codes 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.
22 23 24 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 22 def evaluable_campaign_ids @evaluable_campaign_ids 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).
43 44 45 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 43 def identifiers @identifiers end |
#loyalty_cards ⇒ Object
Any loyalty cards used.
31 32 33 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 31 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`.
19 20 21 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 19 def profile_id @profile_id end |
#referral_code ⇒ Object
Any referral code entered. Important: 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.
28 29 30 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 28 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-session).
34 35 36 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 34 def state @state end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 71 def self.attribute_map { :'profile_id' => :'profileId', :'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' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
250 251 252 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 250 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
103 104 105 106 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 103 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 87 def self.openapi_types { :'profile_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' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
220 221 222 223 224 225 226 227 228 229 230 231 232 233 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 220 def ==(o) return true if self.equal?(o) self.class == o.class && profile_id == o.profile_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 end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 278 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
347 348 349 350 351 352 353 354 355 356 357 358 359 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 347 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
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 257 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
237 238 239 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 237 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
243 244 245 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 243 def hash [profile_id, evaluable_campaign_ids, coupon_codes, referral_code, loyalty_cards, state, cart_items, additional_costs, identifiers, attributes].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
180 181 182 183 184 185 186 187 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 180 def list_invalid_properties invalid_properties = Array.new 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 invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
323 324 325 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 323 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
329 330 331 332 333 334 335 336 337 338 339 340 341 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 329 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
317 318 319 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 317 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
191 192 193 194 195 196 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 191 def valid? return false if !@referral_code.nil? && @referral_code.to_s.length > 100 state_validator = EnumAttributeValidator.new('String', ["open", "closed", "partially_returned", "cancelled"]) return false unless state_validator.valid?(@state) true end |