Class: Conekta::ChargeResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChargeResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/conekta/models/charge_response.rb', line 123

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

Returns the value of attribute amount.



18
19
20
 
# File 'lib/conekta/models/charge_response.rb', line 18

def amount
  @amount
end

#channel ⇒ Object

Returns the value of attribute channel.



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

def channel
  @channel
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#currency ⇒ Object

Returns the value of attribute currency.



24
25
26
 
# File 'lib/conekta/models/charge_response.rb', line 24

def currency
  @currency
end

#customer_id ⇒ Object

Returns the value of attribute customer_id.



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

def customer_id
  @customer_id
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#device_fingerprint ⇒ Object

Returns the value of attribute device_fingerprint.



30
31
32
 
# File 'lib/conekta/models/charge_response.rb', line 30

def device_fingerprint
  @device_fingerprint
end

#failure_code ⇒ Object

Returns the value of attribute failure_code.



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

def failure_code
  @failure_code
end

#failure_message ⇒ Object

Returns the value of attribute failure_message.



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

def failure_message
  @failure_message
end

#id ⇒ Object

Charge ID



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

def id
  @id
end

#livemode ⇒ Object

Whether the charge was made in live mode or not



40
41
42
 
# File 'lib/conekta/models/charge_response.rb', line 40

def livemode
  @livemode
end

#object ⇒ Object

Returns the value of attribute object.



42
43
44
 
# File 'lib/conekta/models/charge_response.rb', line 42

def object
  @object
end

#order_id ⇒ Object

Order ID



45
46
47
 
# File 'lib/conekta/models/charge_response.rb', line 45

def order_id
  @order_id
end

Payment date



48
49
50
 
# File 'lib/conekta/models/charge_response.rb', line 48

def paid_at
  @paid_at
end

#payment_method ⇒ Object

Returns the value of attribute payment_method.



50
51
52
 
# File 'lib/conekta/models/charge_response.rb', line 50

def payment_method
  @payment_method
end

#reference_id ⇒ Object

Reference ID of the charge



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

def reference_id
  @reference_id
end

#refunds ⇒ Object

Returns the value of attribute refunds.



55
56
57
 
# File 'lib/conekta/models/charge_response.rb', line 55

def refunds
  @refunds
end

#status ⇒ Object

Returns the value of attribute status.



57
58
59
 
# File 'lib/conekta/models/charge_response.rb', line 57

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



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
323
324
325
 
# File 'lib/conekta/models/charge_response.rb', line 288

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



84
85
86
 
# File 'lib/conekta/models/charge_response.rb', line 84

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/conekta/models/charge_response.rb', line 60

def self.attribute_map
  {
    :'amount' => :'amount',
    :'channel' => :'channel',
    :'created_at' => :'created_at',
    :'currency' => :'currency',
    :'customer_id' => :'customer_id',
    :'description' => :'description',
    :'device_fingerprint' => :'device_fingerprint',
    :'failure_code' => :'failure_code',
    :'failure_message' => :'failure_message',
    :'id' => :'id',
    :'livemode' => :'livemode',
    :'object' => :'object',
    :'order_id' => :'order_id',
    :'paid_at' => :'paid_at',
    :'payment_method' => :'payment_method',
    :'reference_id' => :'reference_id',
    :'refunds' => :'refunds',
    :'status' => :'status'
  }
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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/conekta/models/charge_response.rb', line 264

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



113
114
115
116
117
118
119
 
# File 'lib/conekta/models/charge_response.rb', line 113

def self.openapi_nullable
  Set.new([
    :'paid_at',
    :'reference_id',
    :'refunds',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/conekta/models/charge_response.rb', line 89

def self.openapi_types
  {
    :'amount' => :'Integer',
    :'channel' => :'ChargeResponseChannel',
    :'created_at' => :'Integer',
    :'currency' => :'String',
    :'customer_id' => :'String',
    :'description' => :'String',
    :'device_fingerprint' => :'String',
    :'failure_code' => :'String',
    :'failure_message' => :'String',
    :'id' => :'String',
    :'livemode' => :'Boolean',
    :'object' => :'String',
    :'order_id' => :'String',
    :'paid_at' => :'Integer',
    :'payment_method' => :'ChargeResponsePaymentMethod',
    :'reference_id' => :'String',
    :'refunds' => :'ChargeResponseRefunds',
    :'status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/conekta/models/charge_response.rb', line 226

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      channel == o.channel &&
      created_at == o.created_at &&
      currency == o.currency &&
      customer_id == o.customer_id &&
      description == o.description &&
      device_fingerprint == o.device_fingerprint &&
      failure_code == o.failure_code &&
      failure_message == o.failure_message &&
      id == o.id &&
      livemode == o.livemode &&
      object == o.object &&
      order_id == o.order_id &&
      paid_at == o.paid_at &&
      payment_method == o.payment_method &&
      reference_id == o.reference_id &&
      refunds == o.refunds &&
      status == o.status
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



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/conekta/models/charge_response.rb', line 359

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


251
252
253
 
# File 'lib/conekta/models/charge_response.rb', line 251

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



257
258
259
 
# File 'lib/conekta/models/charge_response.rb', line 257

def hash
  [amount, channel, created_at, currency, customer_id, description, device_fingerprint, failure_code, failure_message, id, livemode, object, order_id, paid_at, payment_method, reference_id, refunds, status].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



211
212
213
214
215
 
# File 'lib/conekta/models/charge_response.rb', line 211

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



335
336
337
 
# File 'lib/conekta/models/charge_response.rb', line 335

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



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/conekta/models/charge_response.rb', line 341

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



329
330
331
 
# File 'lib/conekta/models/charge_response.rb', line 329

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



219
220
221
222
 
# File 'lib/conekta/models/charge_response.rb', line 219

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end