Class: Conekta::Checkout

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

Overview

It is a sub-resource of the Order model that can be stipulated in order to configure its corresponding checkout

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Checkout

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/conekta/models/checkout.rb', line 104

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#allowed_payment_methods ⇒ Object

Those are the payment methods that will be available for the link



20
21
22
 
# File 'lib/conekta/models/checkout.rb', line 20

def allowed_payment_methods
  @allowed_payment_methods
end

#expires_at ⇒ Object

It is the time when the link will expire. It is expressed in seconds since the Unix epoch. The valid range is from 2 to 365 days (the valid range will be taken from the next day of the creation date at 00:01 hrs)



23
24
25
 
# File 'lib/conekta/models/checkout.rb', line 23

def expires_at
  @expires_at
end

#monthly_installments_enabled ⇒ Object

This flag allows you to specify if months without interest will be active.



26
27
28
 
# File 'lib/conekta/models/checkout.rb', line 26

def monthly_installments_enabled
  @monthly_installments_enabled
end

#monthly_installments_options ⇒ Object

This field allows you to specify the number of months without interest.



29
30
31
 
# File 'lib/conekta/models/checkout.rb', line 29

def monthly_installments_options
  @monthly_installments_options
end

#name ⇒ Object

Reason for charge



35
36
37
 
# File 'lib/conekta/models/checkout.rb', line 35

def name
  @name
end

#needs_shipping_contact ⇒ Object

This flag allows you to fill in the shipping information at checkout.



38
39
40
 
# File 'lib/conekta/models/checkout.rb', line 38

def needs_shipping_contact
  @needs_shipping_contact
end

#on_demand_enabled ⇒ Object

This flag allows you to specify if the link will be on demand.



41
42
43
 
# File 'lib/conekta/models/checkout.rb', line 41

def on_demand_enabled
  @on_demand_enabled
end

#order_template ⇒ Object

Returns the value of attribute order_template.



43
44
45
 
# File 'lib/conekta/models/checkout.rb', line 43

def order_template
  @order_template
end

#payments_limit_count ⇒ Object

It is the number of payments that can be made through the link.



46
47
48
 
# File 'lib/conekta/models/checkout.rb', line 46

def payments_limit_count
  @payments_limit_count
end

#recurrent ⇒ Object

false: single use. true: multiple payments



49
50
51
 
# File 'lib/conekta/models/checkout.rb', line 49

def recurrent
  @recurrent
end

#three_ds_mode ⇒ Object

Indicates the 3DS2 mode for the order, either smart or strict.



32
33
34
 
# File 'lib/conekta/models/checkout.rb', line 32

def three_ds_mode
  @three_ds_mode
end

#type ⇒ Object

It is the type of link that will be created. It must be a valid type.



52
53
54
 
# File 'lib/conekta/models/checkout.rb', line 52

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



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
319
320
321
322
 
# File 'lib/conekta/models/checkout.rb', line 285

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



73
74
75
 
# File 'lib/conekta/models/checkout.rb', line 73

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/conekta/models/checkout.rb', line 55

def self.attribute_map
  {
    :'allowed_payment_methods' => :'allowed_payment_methods',
    :'expires_at' => :'expires_at',
    :'monthly_installments_enabled' => :'monthly_installments_enabled',
    :'monthly_installments_options' => :'monthly_installments_options',
    :'three_ds_mode' => :'three_ds_mode',
    :'name' => :'name',
    :'needs_shipping_contact' => :'needs_shipping_contact',
    :'on_demand_enabled' => :'on_demand_enabled',
    :'order_template' => :'order_template',
    :'payments_limit_count' => :'payments_limit_count',
    :'recurrent' => :'recurrent',
    :'type' => :'type'
  }
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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/conekta/models/checkout.rb', line 261

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



96
97
98
99
100
 
# File 'lib/conekta/models/checkout.rb', line 96

def self.openapi_nullable
  Set.new([
    :'on_demand_enabled',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/conekta/models/checkout.rb', line 78

def self.openapi_types
  {
    :'allowed_payment_methods' => :'Array<String>',
    :'expires_at' => :'Integer',
    :'monthly_installments_enabled' => :'Boolean',
    :'monthly_installments_options' => :'Array<Integer>',
    :'three_ds_mode' => :'String',
    :'name' => :'String',
    :'needs_shipping_contact' => :'Boolean',
    :'on_demand_enabled' => :'Boolean',
    :'order_template' => :'CheckoutOrderTemplate',
    :'payments_limit_count' => :'Integer',
    :'recurrent' => :'Boolean',
    :'type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/conekta/models/checkout.rb', line 229

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allowed_payment_methods == o.allowed_payment_methods &&
      expires_at == o.expires_at &&
      monthly_installments_enabled == o.monthly_installments_enabled &&
      monthly_installments_options == o.monthly_installments_options &&
      three_ds_mode == o.three_ds_mode &&
      name == o.name &&
      needs_shipping_contact == o.needs_shipping_contact &&
      on_demand_enabled == o.on_demand_enabled &&
      order_template == o.order_template &&
      payments_limit_count == o.payments_limit_count &&
      recurrent == o.recurrent &&
      type == o.type
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



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/conekta/models/checkout.rb', line 356

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


248
249
250
 
# File 'lib/conekta/models/checkout.rb', line 248

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



254
255
256
 
# File 'lib/conekta/models/checkout.rb', line 254

def hash
  [allowed_payment_methods, expires_at, monthly_installments_enabled, monthly_installments_options, three_ds_mode, name, needs_shipping_contact, on_demand_enabled, order_template, payments_limit_count, recurrent, type].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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/conekta/models/checkout.rb', line 184

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

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

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

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

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

  if @type.nil?
    invalid_properties.push('invalid value for "type", type 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



332
333
334
 
# File 'lib/conekta/models/checkout.rb', line 332

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



338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/conekta/models/checkout.rb', line 338

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



326
327
328
 
# File 'lib/conekta/models/checkout.rb', line 326

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



216
217
218
219
220
221
222
223
224
225
 
# File 'lib/conekta/models/checkout.rb', line 216

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @allowed_payment_methods.nil?
  return false if @expires_at.nil?
  return false if @name.nil?
  return false if @order_template.nil?
  return false if @recurrent.nil?
  return false if @type.nil?
  true
end