Class: UltracartClient::PaymentsConfigurationCreditCardType

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/payments_configuration_credit_card_type.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentsConfigurationCreditCardType

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# 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. = 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

Instance Attribute Details

#accounting_code ⇒ Object

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



18
19
20
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card_type.rb', line 18

def accounting_code
  @accounting_code
end

#card_type_icon ⇒ Object

Internally used icon information for this card type



21
22
23
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card_type.rb', line 21

def card_type_icon
  @card_type_icon
end

#credit_card ⇒ Object

Credit card type



24
25
26
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card_type.rb', line 24

def credit_card
  @credit_card
end

#deposit_to_account ⇒ Object

The name of the account to deposit funds



27
28
29
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card_type.rb', line 27

def 
  @deposit_to_account
end

#enabled ⇒ Object

If true, this card type will be accepted during checkout



30
31
32
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card_type.rb', line 30

def enabled
  @enabled
end

#processing_fee ⇒ Object

Optional additional fee applied to order for this card



33
34
35
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card_type.rb', line 33

def processing_fee
  @processing_fee
end

#processing_percentage ⇒ Object

Optional additional fee applied to order for this card



36
37
38
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card_type.rb', line 36

def processing_percentage
  @processing_percentage
end

#restrictions ⇒ Object

Returns the value of attribute restrictions.



38
39
40
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card_type.rb', line 38

def restrictions
  @restrictions
end

#surcharge_accounting_code ⇒ Object

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



41
42
43
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card_type.rb', line 41

def surcharge_accounting_code
  @surcharge_accounting_code
end

#transaction_fee ⇒ Object

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



44
45
46
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card_type.rb', line 44

def transaction_fee
  @transaction_fee
end

#transaction_percentage ⇒ Object

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



47
48
49
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card_type.rb', line 47

def transaction_percentage
  @transaction_percentage
end

Class Method Details

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# 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

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# 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 &&
       == o. &&
      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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# 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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# 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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


203
204
205
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card_type.rb', line 203

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



209
210
211
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card_type.rb', line 209

def hash
  [accounting_code, card_type_icon, credit_card, , enabled, processing_fee, processing_percentage, restrictions, surcharge_accounting_code, transaction_fee, transaction_percentage].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



160
161
162
163
 
# 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 ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



283
284
285
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card_type.rb', line 283

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



289
290
291
292
293
294
295
296
297
 
# 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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



277
278
279
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card_type.rb', line 277

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



167
168
169
170
171
 
# 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