Class: TalonOne::NewCustomerSessionV2
- Inherits:
-
Object
- Object
- TalonOne::NewCustomerSessionV2
- Defined in:
- lib/talon_one/models/new_customer_session_v2.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#additional_costs ⇒ Object
Any costs associated with the session that can not be explicitly attributed to cart items.
-
#attributes ⇒ Object
A key-value map of the sessions attributes.
-
#cart_items ⇒ Object
All items the customer will be purchasing in this session.
-
#coupon_codes ⇒ Object
Any coupon codes entered.
-
#identifiers ⇒ Object
Identifiers for the customer, this can be used for limits on values such as device ID.
-
#profile_id ⇒ Object
ID of the customers profile as used within this Talon.One account.
-
#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
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 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 100 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?(:'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 end |
Instance Attribute Details
#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.
34 35 36 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 34 def additional_costs @additional_costs end |
#attributes ⇒ Object
A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings.
40 41 42 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 40 def attributes @attributes end |
#cart_items ⇒ Object
All items the customer will be purchasing in this session
31 32 33 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 31 def cart_items @cart_items end |
#coupon_codes ⇒ Object
Any coupon codes entered.
22 23 24 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 22 def coupon_codes @coupon_codes end |
#identifiers ⇒ Object
Identifiers for the customer, this can be used for limits on values such as device ID.
37 38 39 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 37 def identifiers @identifiers 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.
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.
25 26 27 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 25 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
28 29 30 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 28 def state @state end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
65 66 67 68 69 70 71 72 73 74 75 76 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 65 def self.attribute_map { :'profile_id' => :'profileId', :'coupon_codes' => :'couponCodes', :'referral_code' => :'referralCode', :'state' => :'state', :'cart_items' => :'cartItems', :'additional_costs' => :'additionalCosts', :'identifiers' => :'identifiers', :'attributes' => :'attributes' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
211 212 213 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 211 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
93 94 95 96 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 93 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
79 80 81 82 83 84 85 86 87 88 89 90 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 79 def self.openapi_types { :'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' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 183 def ==(o) return true if self.equal?(o) self.class == o.class && 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 end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 269 270 271 272 273 274 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 239 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
308 309 310 311 312 313 314 315 316 317 318 319 320 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 308 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
218 219 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 218 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
198 199 200 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 198 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
204 205 206 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 204 def hash [profile_id, coupon_codes, referral_code, state, cart_items, additional_costs, identifiers, attributes].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
158 159 160 161 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 158 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
284 285 286 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 284 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
290 291 292 293 294 295 296 297 298 299 300 301 302 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 290 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
278 279 280 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 278 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
165 166 167 168 169 |
# File 'lib/talon_one/models/new_customer_session_v2.rb', line 165 def valid? state_validator = EnumAttributeValidator.new('String', ["open", "closed", "cancelled"]) return false unless state_validator.valid?(@state) true end |