class TalonOne::CustomerProfile

Attributes

account_id[RW]

The ID of the Talon.One account that owns this profile.

attributes[RW]

Arbitrary properties associated with this item

audience_memberships[RW]

A list of audiences the customer belongs to

closed_sessions[RW]

The total amount of closed sessions by a customer. A closed session is a successful purchase.

created[RW]

The exact moment this entity was created.

integration_id[RW]

The integration ID for this entity sent to and used in the Talon.One system.

last_activity[RW]

Timestamp of the most recent event received from this customer

loyalty_memberships[RW]

A list of loyalty programs joined by the customer

total_sales[RW]

Sum of all purchases made by this customer

Public Class Methods

attribute_map() click to toggle source

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

# File lib/talon_one/models/customer_profile.rb, line 46
def self.attribute_map
  {
    :'integration_id' => :'integrationId',
    :'created' => :'created',
    :'attributes' => :'attributes',
    :'account_id' => :'accountId',
    :'closed_sessions' => :'closedSessions',
    :'total_sales' => :'totalSales',
    :'loyalty_memberships' => :'loyaltyMemberships',
    :'audience_memberships' => :'audienceMemberships',
    :'last_activity' => :'lastActivity'
  }
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/customer_profile.rb, line 216
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/customer_profile.rb, line 83
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::CustomerProfile` 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::CustomerProfile`. 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?(:'attributes')
    self.attributes = attributes[:'attributes']
  end

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

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

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

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

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

  if attributes.key?(:'last_activity')
    self.last_activity = attributes[:'last_activity']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/talon_one/models/customer_profile.rb, line 61
def self.openapi_types
  {
    :'integration_id' => :'String',
    :'created' => :'DateTime',
    :'attributes' => :'Object',
    :'account_id' => :'Integer',
    :'closed_sessions' => :'Integer',
    :'total_sales' => :'Float',
    :'loyalty_memberships' => :'Array<LoyaltyMembership>',
    :'audience_memberships' => :'Array<AudienceMembership>',
    :'last_activity' => :'DateTime'
  }
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/customer_profile.rb, line 187
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      integration_id == o.integration_id &&
      created == o.created &&
      attributes == o.attributes &&
      account_id == o.account_id &&
      closed_sessions == o.closed_sessions &&
      total_sales == o.total_sales &&
      loyalty_memberships == o.loyalty_memberships &&
      audience_memberships == o.audience_memberships &&
      last_activity == o.last_activity
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/customer_profile.rb, line 244
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/customer_profile.rb, line 313
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/customer_profile.rb, line 223
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/customer_profile.rb, line 203
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/customer_profile.rb, line 209
def hash
  [integration_id, created, attributes, account_id, closed_sessions, total_sales, loyalty_memberships, audience_memberships, last_activity].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/customer_profile.rb, line 139
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 @attributes.nil?
    invalid_properties.push('invalid value for "attributes", attributes cannot be nil.')
  end

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

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

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

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

  invalid_properties
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/customer_profile.rb, line 289
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/customer_profile.rb, line 295
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/customer_profile.rb, line 283
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/customer_profile.rb, line 174
def valid?
  return false if @integration_id.nil?
  return false if @created.nil?
  return false if @attributes.nil?
  return false if @account_id.nil?
  return false if @closed_sessions.nil?
  return false if @total_sales.nil?
  return false if @last_activity.nil?
  true
end