class SquareConnect::Customer

Represents one of a business's customers, which can have one or more cards on file associated with it.

Attributes

address[RW]

The customer's physical address.

birthday[RW]

The customer's birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: `0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998.

cards[RW]

The payment details of the customer's cards on file.

company_name[RW]

The name of the customer's company.

created_at[RW]

The time when the customer was created, in RFC 3339 format.

creation_source[RW]

A creation source represents the method used to create the customer profile. See [CustomerCreationSource](type-customercreationsource) for possible values

email_address[RW]

The customer's email address.

family_name[RW]

The customer's family (i.e., last) name.

given_name[RW]

The customer's given (i.e., first) name.

groups[RW]

The groups the customer belongs to.

id[RW]

The customer's unique ID.

nickname[RW]

The customer's nickname.

note[RW]

A note to associate with the customer.

phone_number[RW]

The customer's phone number.

preferences[RW]

The customer's preferences.

reference_id[RW]

A second ID you can set to associate the customer with an entity in another system.

updated_at[RW]

The time when the customer was last updated, in RFC 3339 format.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/square_connect/models/customer.rb, line 68
def self.attribute_map
  {
    :'id' => :'id',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'cards' => :'cards',
    :'given_name' => :'given_name',
    :'family_name' => :'family_name',
    :'nickname' => :'nickname',
    :'company_name' => :'company_name',
    :'email_address' => :'email_address',
    :'address' => :'address',
    :'phone_number' => :'phone_number',
    :'birthday' => :'birthday',
    :'reference_id' => :'reference_id',
    :'note' => :'note',
    :'preferences' => :'preferences',
    :'groups' => :'groups',
    :'creation_source' => :'creation_source'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/square_connect/models/customer.rb, line 115
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.has_key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  end

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

  if attributes.has_key?(:'given_name')
    self.given_name = attributes[:'given_name']
  end

  if attributes.has_key?(:'family_name')
    self.family_name = attributes[:'family_name']
  end

  if attributes.has_key?(:'nickname')
    self.nickname = attributes[:'nickname']
  end

  if attributes.has_key?(:'company_name')
    self.company_name = attributes[:'company_name']
  end

  if attributes.has_key?(:'email_address')
    self.email_address = attributes[:'email_address']
  end

  if attributes.has_key?(:'address')
    self.address = attributes[:'address']
  end

  if attributes.has_key?(:'phone_number')
    self.phone_number = attributes[:'phone_number']
  end

  if attributes.has_key?(:'birthday')
    self.birthday = attributes[:'birthday']
  end

  if attributes.has_key?(:'reference_id')
    self.reference_id = attributes[:'reference_id']
  end

  if attributes.has_key?(:'note')
    self.note = attributes[:'note']
  end

  if attributes.has_key?(:'preferences')
    self.preferences = attributes[:'preferences']
  end

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

  if attributes.has_key?(:'creation_source')
    self.creation_source = attributes[:'creation_source']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/square_connect/models/customer.rb, line 91
def self.swagger_types
  {
    :'id' => :'String',
    :'created_at' => :'String',
    :'updated_at' => :'String',
    :'cards' => :'Array<Card>',
    :'given_name' => :'String',
    :'family_name' => :'String',
    :'nickname' => :'String',
    :'company_name' => :'String',
    :'email_address' => :'String',
    :'address' => :'Address',
    :'phone_number' => :'String',
    :'birthday' => :'String',
    :'reference_id' => :'String',
    :'note' => :'String',
    :'preferences' => :'CustomerPreferences',
    :'groups' => :'Array<CustomerGroupInfo>',
    :'creation_source' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/square_connect/models/customer.rb, line 225
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      cards == o.cards &&
      given_name == o.given_name &&
      family_name == o.family_name &&
      nickname == o.nickname &&
      company_name == o.company_name &&
      email_address == o.email_address &&
      address == o.address &&
      phone_number == o.phone_number &&
      birthday == o.birthday &&
      reference_id == o.reference_id &&
      note == o.note &&
      preferences == o.preferences &&
      groups == o.groups &&
      creation_source == o.creation_source
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/square_connect/models/customer.rb, line 283
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
    temp_model = SquareConnect.const_get(type).new
    temp_model.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/square_connect/models/customer.rb, line 349
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/square_connect/models/customer.rb, line 262
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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/square_connect/models/customer.rb, line 249
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/square_connect/models/customer.rb, line 255
def hash
  [id, created_at, updated_at, cards, given_name, family_name, nickname, company_name, email_address, address, phone_number, birthday, reference_id, note, preferences, groups, creation_source].hash
end
list_invalid_properties() click to toggle source

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

# File lib/square_connect/models/customer.rb, line 197
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_at.nil?
    invalid_properties.push("invalid value for 'created_at', created_at cannot be nil.")
  end

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

  return 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/square_connect/models/customer.rb, line 329
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/square_connect/models/customer.rb, line 335
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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/square_connect/models/customer.rb, line 323
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/square_connect/models/customer.rb, line 216
def valid?
  return false if @id.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  return true
end