class DocuSign_eSign::CreditCardInformation

This object contains information about a credit card that is associated with an account.

Attributes

address[RW]

A complex element containing the credit card billing address information.

card_last_digits[RW]
card_number[RW]

The number on the credit card.

card_type[RW]

The credit card type. Valid values are: visa, mastercard, or amex.

cv_number[RW]
expiration_month[RW]

The month that the credit card expires (1-12).

expiration_year[RW]

The year 4 digit year in which the credit card expires.

name_on_card[RW]

The exact name printed on the credit card.

tokenized_card[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/docusign_esign/models/credit_card_information.rb, line 45
def self.attribute_map
  {
    :'address' => :'address',
    :'card_last_digits' => :'cardLastDigits',
    :'card_number' => :'cardNumber',
    :'card_type' => :'cardType',
    :'cv_number' => :'cvNumber',
    :'expiration_month' => :'expirationMonth',
    :'expiration_year' => :'expirationYear',
    :'name_on_card' => :'nameOnCard',
    :'tokenized_card' => :'tokenizedCard'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/docusign_esign/models/credit_card_information.rb, line 76
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?(:'address')
    self.address = attributes[:'address']
  end

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

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

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

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

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

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

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

  if attributes.has_key?(:'tokenizedCard')
    self.tokenized_card = attributes[:'tokenizedCard']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/docusign_esign/models/credit_card_information.rb, line 60
def self.swagger_types
  {
    :'address' => :'AddressInformation',
    :'card_last_digits' => :'String',
    :'card_number' => :'String',
    :'card_type' => :'String',
    :'cv_number' => :'String',
    :'expiration_month' => :'String',
    :'expiration_year' => :'String',
    :'name_on_card' => :'String',
    :'tokenized_card' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/docusign_esign/models/credit_card_information.rb, line 134
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address == o.address &&
      card_last_digits == o.card_last_digits &&
      card_number == o.card_number &&
      card_type == o.card_type &&
      cv_number == o.cv_number &&
      expiration_month == o.expiration_month &&
      expiration_year == o.expiration_year &&
      name_on_card == o.name_on_card &&
      tokenized_card == o.tokenized_card
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/docusign_esign/models/credit_card_information.rb, line 184
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 = DocuSign_eSign.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/docusign_esign/models/credit_card_information.rb, line 250
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/docusign_esign/models/credit_card_information.rb, line 163
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 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/docusign_esign/models/credit_card_information.rb, line 150
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/docusign_esign/models/credit_card_information.rb, line 156
def hash
  [address, card_last_digits, card_number, card_type, cv_number, expiration_month, expiration_year, name_on_card, tokenized_card].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/docusign_esign/models/credit_card_information.rb, line 121
def list_invalid_properties
  invalid_properties = Array.new
  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/docusign_esign/models/credit_card_information.rb, line 230
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/docusign_esign/models/credit_card_information.rb, line 236
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/docusign_esign/models/credit_card_information.rb, line 224
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/docusign_esign/models/credit_card_information.rb, line 128
def valid?
  true
end