Class: UltracartClient::OrderPaymentCreditCard

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderPaymentCreditCard

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 124

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::OrderPaymentCreditCard` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::OrderPaymentCreditCard`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'card_auth_ticket')
    self.card_auth_ticket = attributes[:'card_auth_ticket']
  end

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'card_verification_number_token')
    self.card_verification_number_token = attributes[:'card_verification_number_token']
  end

  if attributes.key?(:'dual_vaulted')
    self.dual_vaulted = attributes[:'dual_vaulted']
  end
end

Instance Attribute Details

#card_auth_ticket ⇒ Object

Card authorization ticket



19
20
21
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 19

def card_auth_ticket
  @card_auth_ticket
end

#card_authorization_amount ⇒ Object

Card authorization amount



22
23
24
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 22

def card_authorization_amount
  @card_authorization_amount
end

#card_authorization_dts ⇒ Object

Card authorization date/time



25
26
27
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 25

def card_authorization_dts
  @card_authorization_dts
end

#card_authorization_reference_number ⇒ Object

Card authorization reference number



28
29
30
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 28

def card_authorization_reference_number
  @card_authorization_reference_number
end

#card_expiration_month ⇒ Object

Card expiration month (1-12)



31
32
33
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 31

def card_expiration_month
  @card_expiration_month
end

#card_expiration_year ⇒ Object

Card expiration year (Four digit year)



34
35
36
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 34

def card_expiration_year
  @card_expiration_year
end

#card_number ⇒ Object

Card number (masked to last 4)



37
38
39
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 37

def card_number
  @card_number
end

#card_number_token ⇒ Object

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



40
41
42
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 40

def card_number_token
  @card_number_token
end

#card_number_truncated ⇒ Object

True if the card has been truncated



43
44
45
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 43

def card_number_truncated
  @card_number_truncated
end

#card_type ⇒ Object

Card type



46
47
48
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 46

def card_type
  @card_type
end

#card_verification_number_token ⇒ Object

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



49
50
51
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 49

def card_verification_number_token
  @card_verification_number_token
end

#dual_vaulted ⇒ Object

Returns the value of attribute dual_vaulted.



51
52
53
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 51

def dual_vaulted
  @dual_vaulted
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



94
95
96
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 94

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 76

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',
    :'dual_vaulted' => :'dual_vaulted'
  }
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



245
246
247
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 245

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



117
118
119
120
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 117

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 99

def self.openapi_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',
    :'dual_vaulted' => :'OrderPaymentCreditCardDualVaulted'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 213

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 &&
      dual_vaulted == o.dual_vaulted
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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 276

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 347

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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 252

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


232
233
234
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 232

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

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, dual_vaulted].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



188
189
190
191
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 188

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



323
324
325
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 323

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



329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 329

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



317
318
319
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 317

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



195
196
197
198
199
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 195

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