Class: LinodeOpenapiClient::PostCreditCardRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/linode_openapi_client/models/post_credit_card_request.rb

Overview

An object representing the credit card information you have on file with Linode to make Payments against your Account.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostCreditCardRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/linode_openapi_client/models/post_credit_card_request.rb', line 64

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

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

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

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

Instance Attribute Details

#card_number ⇒ Object

Your credit card number. No spaces or hyphens (‘-`) allowed.



26
27
28
 
# File 'lib/linode_openapi_client/models/post_credit_card_request.rb', line 26

def card_number
  @card_number
end

#cvv ⇒ Object

CVV (Card Verification Value) of the credit card, typically found on the back of the card.



23
24
25
 
# File 'lib/linode_openapi_client/models/post_credit_card_request.rb', line 23

def cvv
  @cvv
end

#expiry_month ⇒ Object

A value from 1-12 representing the expiration month of your credit card. - 1 = January - 2 = February - 3 = March - Etc.



29
30
31
 
# File 'lib/linode_openapi_client/models/post_credit_card_request.rb', line 29

def expiry_month
  @expiry_month
end

#expiry_year ⇒ Object

A four-digit integer representing the expiration year of your credit card. The combination of ‘expiry_month` and `expiry_year` must result in a month/year combination of the current month or in the future. An expiration date set in the past is invalid.



20
21
22
 
# File 'lib/linode_openapi_client/models/post_credit_card_request.rb', line 20

def expiry_year
  @expiry_year
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



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
314
315
316
317
318
 
# File 'lib/linode_openapi_client/models/post_credit_card_request.rb', line 281

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 = LinodeOpenapiClient.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



42
43
44
 
# File 'lib/linode_openapi_client/models/post_credit_card_request.rb', line 42

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
 
# File 'lib/linode_openapi_client/models/post_credit_card_request.rb', line 32

def self.attribute_map
  {
    :'expiry_year' => :'expiry_year',
    :'cvv' => :'cvv',
    :'card_number' => :'card_number',
    :'expiry_month' => :'expiry_month'
  }
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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/linode_openapi_client/models/post_credit_card_request.rb', line 257

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_nullable ⇒ Object

List of attributes with nullable: true



57
58
59
60
 
# File 'lib/linode_openapi_client/models/post_credit_card_request.rb', line 57

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

.openapi_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
 
# File 'lib/linode_openapi_client/models/post_credit_card_request.rb', line 47

def self.openapi_types
  {
    :'expiry_year' => :'Integer',
    :'cvv' => :'String',
    :'card_number' => :'String',
    :'expiry_month' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



233
234
235
236
237
238
239
240
 
# File 'lib/linode_openapi_client/models/post_credit_card_request.rb', line 233

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      expiry_year == o.expiry_year &&
      cvv == o.cvv &&
      card_number == o.card_number &&
      expiry_month == o.expiry_month
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



352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/linode_openapi_client/models/post_credit_card_request.rb', line 352

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


244
245
246
 
# File 'lib/linode_openapi_client/models/post_credit_card_request.rb', line 244

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



250
251
252
 
# File 'lib/linode_openapi_client/models/post_credit_card_request.rb', line 250

def hash
  [expiry_year, cvv, card_number, expiry_month].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



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
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/linode_openapi_client/models/post_credit_card_request.rb', line 104

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

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

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

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

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

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

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

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

  if @expiry_month > 12
    invalid_properties.push('invalid value for "expiry_month", must be smaller than or equal to 12.')
  end

  if @expiry_month < 1
    invalid_properties.push('invalid value for "expiry_month", must be greater than or equal to 1.')
  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



328
329
330
 
# File 'lib/linode_openapi_client/models/post_credit_card_request.rb', line 328

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



334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/linode_openapi_client/models/post_credit_card_request.rb', line 334

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



322
323
324
 
# File 'lib/linode_openapi_client/models/post_credit_card_request.rb', line 322

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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/linode_openapi_client/models/post_credit_card_request.rb', line 152

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @expiry_year.nil?
  return false if @cvv.nil?
  return false if @cvv.to_s.length > 4
  return false if @cvv.to_s.length < 3
  return false if @card_number.nil?
  return false if @card_number.to_s.length > 24
  return false if @card_number.to_s.length < 14
  return false if @expiry_month.nil?
  return false if @expiry_month > 12
  return false if @expiry_month < 1
  true
end