class TalonOne::NewCustomerSessionV2

Attributes

additional_costs[RW]

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

attributes[RW]

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

cart_items[RW]

All items the customer will be purchasing in this session

coupon_codes[RW]

Any coupon codes entered.

identifiers[RW]

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

profile_id[RW]

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.

referral_code[RW]

Any referral code entered.

state[RW]

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

Public Class Methods

attribute_map() click to toggle source

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

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/talon_one/models/new_customer_session_v2.rb, line 226
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/talon_one/models/new_customer_session_v2.rb, line 93
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/talon_one/models/new_customer_session_v2.rb, line 198
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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/talon_one/models/new_customer_session_v2.rb, line 254
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/talon_one/models/new_customer_session_v2.rb, line 323
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/talon_one/models/new_customer_session_v2.rb, line 233
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/talon_one/models/new_customer_session_v2.rb, line 213
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/talon_one/models/new_customer_session_v2.rb, line 219
def hash
  [profile_id, coupon_codes, referral_code, state, cart_items, additional_costs, identifiers, attributes].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/talon_one/models/new_customer_session_v2.rb, line 158
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
referral_code=(referral_code) click to toggle source

Custom attribute writer method with validation @param [Object] referral_code Value to be assigned

# File lib/talon_one/models/new_customer_session_v2.rb, line 178
def referral_code=(referral_code)
  if !referral_code.nil? && referral_code.to_s.length > 100
    fail ArgumentError, 'invalid value for "referral_code", the character length must be smaller than or equal to 100.'
  end

  @referral_code = referral_code
end
state=(state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned

# File lib/talon_one/models/new_customer_session_v2.rb, line 188
def state=(state)
  validator = EnumAttributeValidator.new('String', ["open", "closed", "cancelled"])
  unless validator.valid?(state)
    fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
  end
  @state = state
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/talon_one/models/new_customer_session_v2.rb, line 299
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/talon_one/models/new_customer_session_v2.rb, line 305
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/talon_one/models/new_customer_session_v2.rb, line 293
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/talon_one/models/new_customer_session_v2.rb, line 169
def valid?
  return false if !@referral_code.nil? && @referral_code.to_s.length > 100
  state_validator = EnumAttributeValidator.new('String', ["open", "closed", "cancelled"])
  return false unless state_validator.valid?(@state)
  true
end