Class: Conekta::PaymentMethodCardRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/conekta/models/payment_method_card_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentMethodCardRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
131
132
133
134
135
136
137
 
# File 'lib/conekta/models/payment_method_card_request.rb', line 85

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Conekta::PaymentMethodCardRequest` 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 `Conekta::PaymentMethodCardRequest`. 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?(:'type')
    self.type = attributes[:'type']
  else
    self.type = nil
  end

  if attributes.key?(:'cvc')
    self.cvc = attributes[:'cvc']
  else
    self.cvc = nil
  end

  if attributes.key?(:'exp_month')
    self.exp_month = attributes[:'exp_month']
  else
    self.exp_month = nil
  end

  if attributes.key?(:'exp_year')
    self.exp_year = attributes[:'exp_year']
  else
    self.exp_year = nil
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = nil
  end

  if attributes.key?(:'number')
    self.number = attributes[:'number']
  else
    self.number = nil
  end

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

Instance Attribute Details

#customer_ip_address ⇒ Object

Optional field used to capture the customer’s IP address for fraud prevention and security monitoring purposes



37
38
39
 
# File 'lib/conekta/models/payment_method_card_request.rb', line 37

def customer_ip_address
  @customer_ip_address
end

#cvc ⇒ Object

Card security code



22
23
24
 
# File 'lib/conekta/models/payment_method_card_request.rb', line 22

def cvc
  @cvc
end

#exp_month ⇒ Object

Card expiration month



25
26
27
 
# File 'lib/conekta/models/payment_method_card_request.rb', line 25

def exp_month
  @exp_month
end

#exp_year ⇒ Object

Card expiration year



28
29
30
 
# File 'lib/conekta/models/payment_method_card_request.rb', line 28

def exp_year
  @exp_year
end

#name ⇒ Object

Cardholder name



31
32
33
 
# File 'lib/conekta/models/payment_method_card_request.rb', line 31

def name
  @name
end

#number ⇒ Object

Card number



34
35
36
 
# File 'lib/conekta/models/payment_method_card_request.rb', line 34

def number
  @number
end

#type ⇒ Object

Type of payment method



19
20
21
 
# File 'lib/conekta/models/payment_method_card_request.rb', line 19

def type
  @type
end

Class Method Details

._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



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/conekta/models/payment_method_card_request.rb', line 321

def self._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 = Conekta.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



53
54
55
 
# File 'lib/conekta/models/payment_method_card_request.rb', line 53

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/conekta/models/payment_method_card_request.rb', line 40

def self.attribute_map
  {
    :'type' => :'type',
    :'cvc' => :'cvc',
    :'exp_month' => :'exp_month',
    :'exp_year' => :'exp_year',
    :'name' => :'name',
    :'number' => :'number',
    :'customer_ip_address' => :'customer_ip_address'
  }
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



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/conekta/models/payment_method_card_request.rb', line 297

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



77
78
79
80
81
 
# File 'lib/conekta/models/payment_method_card_request.rb', line 77

def self.openapi_all_of
  [
  :'CustomerPaymentMethodRequest'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



71
72
73
74
 
# File 'lib/conekta/models/payment_method_card_request.rb', line 71

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

.openapi_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/conekta/models/payment_method_card_request.rb', line 58

def self.openapi_types
  {
    :'type' => :'String',
    :'cvc' => :'String',
    :'exp_month' => :'String',
    :'exp_year' => :'String',
    :'name' => :'String',
    :'number' => :'String',
    :'customer_ip_address' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/conekta/models/payment_method_card_request.rb', line 270

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      cvc == o.cvc &&
      exp_month == o.exp_month &&
      exp_year == o.exp_year &&
      name == o.name &&
      number == o.number &&
      customer_ip_address == o.customer_ip_address
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



392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/conekta/models/payment_method_card_request.rb', line 392

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


284
285
286
 
# File 'lib/conekta/models/payment_method_card_request.rb', line 284

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



290
291
292
 
# File 'lib/conekta/models/payment_method_card_request.rb', line 290

def hash
  [type, cvc, exp_month, exp_year, name, number, customer_ip_address].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



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
185
186
187
188
189
190
191
192
193
 
# File 'lib/conekta/models/payment_method_card_request.rb', line 141

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  if @cvc.nil?
    invalid_properties.push('invalid value for "cvc", cvc cannot be nil.')
  end

  if @cvc.to_s.length > 4
    invalid_properties.push('invalid value for "cvc", the character length must be smaller than or equal to 4.')
  end

  if @cvc.to_s.length < 3
    invalid_properties.push('invalid value for "cvc", the character length must be great than or equal to 3.')
  end

  if @exp_month.nil?
    invalid_properties.push('invalid value for "exp_month", exp_month cannot be nil.')
  end

  if @exp_month.to_s.length > 2
    invalid_properties.push('invalid value for "exp_month", the character length must be smaller than or equal to 2.')
  end

  if @exp_month.to_s.length < 2
    invalid_properties.push('invalid value for "exp_month", the character length must be great than or equal to 2.')
  end

  if @exp_year.nil?
    invalid_properties.push('invalid value for "exp_year", exp_year cannot be nil.')
  end

  if @exp_year.to_s.length > 4
    invalid_properties.push('invalid value for "exp_year", the character length must be smaller than or equal to 4.')
  end

  if @exp_year.to_s.length < 4
    invalid_properties.push('invalid value for "exp_year", the character length must be great than or equal to 4.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @number.nil?
    invalid_properties.push('invalid value for "number", number cannot be nil.')
  end

  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



368
369
370
 
# File 'lib/conekta/models/payment_method_card_request.rb', line 368

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



374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/conekta/models/payment_method_card_request.rb', line 374

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



362
363
364
 
# File 'lib/conekta/models/payment_method_card_request.rb', line 362

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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/conekta/models/payment_method_card_request.rb', line 197

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @type.nil?
  return false if @cvc.nil?
  return false if @cvc.to_s.length > 4
  return false if @cvc.to_s.length < 3
  return false if @exp_month.nil?
  return false if @exp_month.to_s.length > 2
  return false if @exp_month.to_s.length < 2
  return false if @exp_year.nil?
  return false if @exp_year.to_s.length > 4
  return false if @exp_year.to_s.length < 4
  return false if @name.nil?
  return false if @number.nil?
  true
end