Class: UltracartClient::PaymentsConfigurationCreditCard

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentsConfigurationCreditCard

Initializes the object

Parameters:

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

    Model attributes in the form of hash



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card.rb', line 81

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?(:'accept_credit_card')
    self.accept_credit_card = attributes[:'accept_credit_card']
  end

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

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

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

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

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

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

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

  if attributes.has_key?(:'supported_cards')
    if (value = attributes[:'supported_cards']).is_a?(Array)
      self.supported_cards = value
    end
  end

  if attributes.has_key?(:'test_methods')
    if (value = attributes[:'test_methods']).is_a?(Array)
      self.test_methods = value
    end
  end
end

Instance Attribute Details

#accept_credit_card ⇒ Object

Master flag indicating whether this merchant accepts credit card payments



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

def accept_credit_card
  @accept_credit_card
end

#billed_by ⇒ Object

Description that appears on customer statements



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

def billed_by
  @billed_by
end

#charge_during_checkout ⇒ Object

If false, order will be accepted and placed into Accounts Receivable without charging card first



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

def charge_during_checkout
  @charge_during_checkout
end

#collect_cvv2 ⇒ Object

UltraCart will require customer to enter cvv if this is true



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

def collect_cvv2
  @collect_cvv2
end

#configured_gateway_details ⇒ Object

Human readable description of the credit card gateway currently configured



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

def configured_gateway_details
  @configured_gateway_details
end

#failed_attempts ⇒ Object

The number of failed attempts before the order is placed into Accounts Receivable for manual intervention



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

def failed_attempts
  @failed_attempts
end

#hide_connect_single_gateway ⇒ Object

This internal flag aids the UI in determining which buttons to show.



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

def hide_connect_single_gateway
  @hide_connect_single_gateway
end

#send_customer_billing_update_on_decline ⇒ Object

UltraCart will send customers emails to update their credit card if the card is declined



39
40
41
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card.rb', line 39

def send_customer_billing_update_on_decline
  @send_customer_billing_update_on_decline
end

#supported_cards ⇒ Object

A list of credit cards the merchant wishes to accept.



42
43
44
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card.rb', line 42

def supported_cards
  @supported_cards
end

#test_methods ⇒ Object

An array of test methods for placing test orders. The cards defined here may be real or fake, but any order placed with them will be marked as Test orders



45
46
47
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card.rb', line 45

def test_methods
  @test_methods
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card.rb', line 48

def self.attribute_map
  {
    :'accept_credit_card' => :'accept_credit_card',
    :'billed_by' => :'billed_by',
    :'charge_during_checkout' => :'charge_during_checkout',
    :'collect_cvv2' => :'collect_cvv2',
    :'configured_gateway_details' => :'configured_gateway_details',
    :'failed_attempts' => :'failed_attempts',
    :'hide_connect_single_gateway' => :'hide_connect_single_gateway',
    :'send_customer_billing_update_on_decline' => :'send_customer_billing_update_on_decline',
    :'supported_cards' => :'supported_cards',
    :'test_methods' => :'test_methods'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card.rb', line 64

def self.swagger_types
  {
    :'accept_credit_card' => :'BOOLEAN',
    :'billed_by' => :'String',
    :'charge_during_checkout' => :'BOOLEAN',
    :'collect_cvv2' => :'BOOLEAN',
    :'configured_gateway_details' => :'String',
    :'failed_attempts' => :'Integer',
    :'hide_connect_single_gateway' => :'BOOLEAN',
    :'send_customer_billing_update_on_decline' => :'BOOLEAN',
    :'supported_cards' => :'Array<PaymentsConfigurationCreditCardType>',
    :'test_methods' => :'Array<PaymentsConfigurationTestMethod>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card.rb', line 147

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      accept_credit_card == o.accept_credit_card &&
      billed_by == o.billed_by &&
      charge_during_checkout == o.charge_during_checkout &&
      collect_cvv2 == o.collect_cvv2 &&
      configured_gateway_details == o.configured_gateway_details &&
      failed_attempts == o.failed_attempts &&
      hide_connect_single_gateway == o.hide_connect_single_gateway &&
      send_customer_billing_update_on_decline == o.send_customer_billing_update_on_decline &&
      supported_cards == o.supported_cards &&
      test_methods == o.test_methods
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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card.rb', line 198

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



264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card.rb', line 264

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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card.rb', line 177

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


164
165
166
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card.rb', line 164

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



170
171
172
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card.rb', line 170

def hash
  [accept_credit_card, billed_by, charge_during_checkout, collect_cvv2, configured_gateway_details, failed_attempts, hide_connect_single_gateway, send_customer_billing_update_on_decline, supported_cards, test_methods].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



134
135
136
137
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card.rb', line 134

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



244
245
246
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card.rb', line 244

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



250
251
252
253
254
255
256
257
258
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card.rb', line 250

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



238
239
240
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card.rb', line 238

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



141
142
143
 
# File 'lib/ultracart_api/models/payments_configuration_credit_card.rb', line 141

def valid?
  true
end