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



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
157
 
# 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

Instance Attribute Details

#card_auth_ticket ⇒ Object

Card authorization ticket



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

def card_auth_ticket
  @card_auth_ticket
end

#card_authorization_amount ⇒ Object

Card authorization amount



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

def card_authorization_amount
  @card_authorization_amount
end

#card_authorization_dts ⇒ Object

Card authorization date/time



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

def card_authorization_dts
  @card_authorization_dts
end

#card_authorization_reference_number ⇒ Object

Card authorization reference number



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

def card_authorization_reference_number
  @card_authorization_reference_number
end

#card_expiration_month ⇒ Object

Card expiration month (1-12)



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

def card_expiration_month
  @card_expiration_month
end

#card_expiration_year ⇒ Object

Card expiration year (Four digit year)



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

def card_expiration_year
  @card_expiration_year
end

#card_number ⇒ Object

Card number (masked to last 4)



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

def card_number
  @card_number
end

#card_number_token ⇒ Object

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



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

def card_number_token
  @card_number_token
end

#card_number_truncated ⇒ Object

True if the card has been truncated



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

def card_number_truncated
  @card_number_truncated
end

#card_type ⇒ Object

Card type



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

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



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

def card_verification_number_token
  @card_verification_number_token
end

Class Method Details

.attribute_map ⇒ Object

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



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

.swagger_types ⇒ Object

Attribute type mapping.



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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
274
 
# 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) ⇒ 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



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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


204
205
206
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 204

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



210
211
212
 
# 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 ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



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

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



284
285
286
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 284

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



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

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



278
279
280
 
# File 'lib/ultracart_api/models/order_payment_credit_card.rb', line 278

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



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