class UltracartClient::PaymentsConfigurationCreditCardType

Attributes

accounting_code[RW]

Optional field used for Quickbooks integrations to match this credit card with the corresponding payment type in Quickbooks

card_type_icon[RW]

Internally used icon information for this card type

credit_card[RW]

Credit card type

deposit_to_account[RW]

The name of the account to deposit funds

enabled[RW]

If true, this card type will be accepted during checkout

processing_fee[RW]

Optional additional fee applied to order for this card

processing_percentage[RW]

Optional additional fee applied to order for this card

restrictions[RW]
surcharge_accounting_code[RW]

Optional field. If integrated with Quickbooks, this code will be used when informing Quickbooks about any surcharges applied to orders

transaction_fee[RW]

An optional additional fee to charge the customer for using this card.

transaction_percentage[RW]

An optional transaction percentage to charge the customer for using this card

Public Class Methods

attribute_map() click to toggle source

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

# File lib/ultracart_api/models/payments_configuration_credit_card_type.rb, line 72
def self.attribute_map
  {
    :'accounting_code' => :'accounting_code',
    :'card_type_icon' => :'card_type_icon',
    :'credit_card' => :'credit_card',
    :'deposit_to_account' => :'deposit_to_account',
    :'enabled' => :'enabled',
    :'processing_fee' => :'processing_fee',
    :'processing_percentage' => :'processing_percentage',
    :'restrictions' => :'restrictions',
    :'surcharge_accounting_code' => :'surcharge_accounting_code',
    :'transaction_fee' => :'transaction_fee',
    :'transaction_percentage' => :'transaction_percentage'
  }
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/payments_configuration_credit_card_type.rb, line 107
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?(:'accounting_code')
    self.accounting_code = attributes[:'accounting_code']
  end

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

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/ultracart_api/models/payments_configuration_credit_card_type.rb, line 89
def self.swagger_types
  {
    :'accounting_code' => :'String',
    :'card_type_icon' => :'String',
    :'credit_card' => :'String',
    :'deposit_to_account' => :'String',
    :'enabled' => :'BOOLEAN',
    :'processing_fee' => :'Float',
    :'processing_percentage' => :'Float',
    :'restrictions' => :'PaymentsConfigurationRestrictions',
    :'surcharge_accounting_code' => :'String',
    :'transaction_fee' => :'Float',
    :'transaction_percentage' => :'Float'
  }
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/payments_configuration_credit_card_type.rb, line 185
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      accounting_code == o.accounting_code &&
      card_type_icon == o.card_type_icon &&
      credit_card == o.credit_card &&
      deposit_to_account == o.deposit_to_account &&
      enabled == o.enabled &&
      processing_fee == o.processing_fee &&
      processing_percentage == o.processing_percentage &&
      restrictions == o.restrictions &&
      surcharge_accounting_code == o.surcharge_accounting_code &&
      transaction_fee == o.transaction_fee &&
      transaction_percentage == o.transaction_percentage
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/payments_configuration_credit_card_type.rb, line 237
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/payments_configuration_credit_card_type.rb, line 303
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/payments_configuration_credit_card_type.rb, line 216
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
credit_card=(credit_card) click to toggle source

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

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

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

# File lib/ultracart_api/models/payments_configuration_credit_card_type.rb, line 203
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/payments_configuration_credit_card_type.rb, line 209
def hash
  [accounting_code, card_type_icon, credit_card, deposit_to_account, enabled, processing_fee, processing_percentage, restrictions, surcharge_accounting_code, transaction_fee, transaction_percentage].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/payments_configuration_credit_card_type.rb, line 160
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/payments_configuration_credit_card_type.rb, line 283
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/payments_configuration_credit_card_type.rb, line 289
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/payments_configuration_credit_card_type.rb, line 277
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/payments_configuration_credit_card_type.rb, line 167
def valid?
  credit_card_validator = EnumAttributeValidator.new('String', ['AMEX', 'Diners Club', 'Discover', 'MasterCard', 'JCB', 'VISA'])
  return false unless credit_card_validator.valid?(@credit_card)
  true
end