class UltracartClient::OrderPaymentCreditCard

Attributes

card_auth_ticket[RW]

Card authorization ticket

card_authorization_amount[RW]

Card authorization amount

card_authorization_dts[RW]

Card authorization date/time

card_authorization_reference_number[RW]

Card authorization reference number

card_expiration_month[RW]

Card expiration month (1-12)

card_expiration_year[RW]

Card expiration year (Four digit year)

card_number[RW]

Card number (masked to last 4)

card_number_token[RW]

Card number token from hosted fields used to update the cart number

card_number_truncated[RW]

True if the card has been truncated

card_type[RW]

Card type

card_verification_number_token[RW]

Card verification number token from hosted fields, only for import/insert of new orders, completely ignored for updates, and always null/empty for queries

Public Class Methods

attribute_map() click to toggle source

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

# File lib/ultracart_api/models/order_payment_credit_card.rb, line 73
def self.attribute_map
  {
    :'card_auth_ticket' => :'card_auth_ticket',
    :'card_authorization_amount' => :'card_authorization_amount',
    :'card_authorization_dts' => :'card_authorization_dts',
    :'card_authorization_reference_number' => :'card_authorization_reference_number',
    :'card_expiration_month' => :'card_expiration_month',
    :'card_expiration_year' => :'card_expiration_year',
    :'card_number' => :'card_number',
    :'card_number_token' => :'card_number_token',
    :'card_number_truncated' => :'card_number_truncated',
    :'card_type' => :'card_type',
    :'card_verification_number_token' => :'card_verification_number_token'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/ultracart_api/models/order_payment_credit_card.rb, line 108
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?(:'card_auth_ticket')
    self.card_auth_ticket = attributes[:'card_auth_ticket']
  end

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

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/ultracart_api/models/order_payment_credit_card.rb, line 90
def self.swagger_types
  {
    :'card_auth_ticket' => :'String',
    :'card_authorization_amount' => :'Float',
    :'card_authorization_dts' => :'String',
    :'card_authorization_reference_number' => :'String',
    :'card_expiration_month' => :'Integer',
    :'card_expiration_year' => :'Integer',
    :'card_number' => :'String',
    :'card_number_token' => :'String',
    :'card_number_truncated' => :'BOOLEAN',
    :'card_type' => :'String',
    :'card_verification_number_token' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/ultracart_api/models/order_payment_credit_card.rb, line 186
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      card_auth_ticket == o.card_auth_ticket &&
      card_authorization_amount == o.card_authorization_amount &&
      card_authorization_dts == o.card_authorization_dts &&
      card_authorization_reference_number == o.card_authorization_reference_number &&
      card_expiration_month == o.card_expiration_month &&
      card_expiration_year == o.card_expiration_year &&
      card_number == o.card_number &&
      card_number_token == o.card_number_token &&
      card_number_truncated == o.card_number_truncated &&
      card_type == o.card_type &&
      card_verification_number_token == o.card_verification_number_token
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/ultracart_api/models/order_payment_credit_card.rb, line 238
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 = UltracartClient.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/ultracart_api/models/order_payment_credit_card.rb, line 304
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/ultracart_api/models/order_payment_credit_card.rb, line 217
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
card_type=(card_type) click to toggle source

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

# File lib/ultracart_api/models/order_payment_credit_card.rb, line 176
def card_type=(card_type)
  validator = EnumAttributeValidator.new('String', ['AMEX', 'Diners Club', 'Discover', 'JCB', 'MasterCard', 'VISA'])
  unless validator.valid?(card_type)
    fail ArgumentError, 'invalid value for "card_type", must be one of #{validator.allowable_values}.'
  end
  @card_type = card_type
end
eql?(o) click to toggle source

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

# File lib/ultracart_api/models/order_payment_credit_card.rb, line 204
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/ultracart_api/models/order_payment_credit_card.rb, line 210
def hash
  [card_auth_ticket, card_authorization_amount, card_authorization_dts, card_authorization_reference_number, card_expiration_month, card_expiration_year, card_number, card_number_token, card_number_truncated, card_type, card_verification_number_token].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/ultracart_api/models/order_payment_credit_card.rb, line 161
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/ultracart_api/models/order_payment_credit_card.rb, line 284
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/ultracart_api/models/order_payment_credit_card.rb, line 290
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/ultracart_api/models/order_payment_credit_card.rb, line 278
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/ultracart_api/models/order_payment_credit_card.rb, line 168
def valid?
  card_type_validator = EnumAttributeValidator.new('String', ['AMEX', 'Diners Club', 'Discover', 'JCB', 'MasterCard', 'VISA'])
  return false unless card_type_validator.valid?(@card_type)
  true
end