class SquareConnect::Card

Represents the payment details of a card to be used for payments. These details are determined by the `card_nonce` generated by `SqPaymentForm`.

Attributes

billing_address[RW]

The billing address for this card.

card_brand[RW]

The card's brand (such as `VISA`). See [CardBrand](type-cardbrand) for possible values

cardholder_name[RW]

The name of the cardholder.

exp_month[RW]

The expiration month of the associated card as an integer between 1 and 12.

exp_year[RW]

The four-digit year of the card's expiration date.

fingerprint[RW]

A unique, Square-assigned ID that identifies the card across multiple locations and applications for a single Square account.

id[RW]

Unique ID for this card. Generated by Square.

last_4[RW]

The last 4 digits of the card number.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/square_connect/models/card.rb, line 41
def self.attribute_map
  {
    :'id' => :'id',
    :'card_brand' => :'card_brand',
    :'last_4' => :'last_4',
    :'exp_month' => :'exp_month',
    :'exp_year' => :'exp_year',
    :'cardholder_name' => :'cardholder_name',
    :'billing_address' => :'billing_address',
    :'fingerprint' => :'fingerprint'
  }
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/card.rb, line 70
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?(:'card_brand')
    self.card_brand = attributes[:'card_brand']
  end

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/square_connect/models/card.rb, line 55
def self.swagger_types
  {
    :'id' => :'String',
    :'card_brand' => :'String',
    :'last_4' => :'String',
    :'exp_month' => :'Integer',
    :'exp_year' => :'Integer',
    :'cardholder_name' => :'String',
    :'billing_address' => :'Address',
    :'fingerprint' => :'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/card.rb, line 125
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      card_brand == o.card_brand &&
      last_4 == o.last_4 &&
      exp_month == o.exp_month &&
      exp_year == o.exp_year &&
      cardholder_name == o.cardholder_name &&
      billing_address == o.billing_address &&
      fingerprint == o.fingerprint
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/card.rb, line 174
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/card.rb, line 240
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/card.rb, line 153
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/card.rb, line 140
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/card.rb, line 146
def hash
  [id, card_brand, last_4, exp_month, exp_year, cardholder_name, billing_address, fingerprint].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/card.rb, line 112
def list_invalid_properties
  invalid_properties = Array.new
  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/card.rb, line 220
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/card.rb, line 226
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/card.rb, line 214
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/card.rb, line 119
def valid?
  return true
end