Class: Wire4Client::MessageCEP

Inherits:
Object
  • Object
show all
Defined in:
lib/wire4_client/models/message_cep.rb

Overview

Es el objeto del Comprobante Electrónico de Pago (CEP) de la transferencia, que es emitido por Banxico. Se muestra sólo cuando esté disponible, en otro caso se podrá usar la <a href="#operation/obtainTransactionCepUsingPOST">Consulta de CEP</a> que ésta misma API ofrece.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MessageCEP

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/wire4_client/models/message_cep.rb', line 137

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?(:'account_beneficiary')
    self. = attributes[:'account_beneficiary']
  end

  if attributes.has_key?(:'account_sender')
    self. = attributes[:'account_sender']
  end

  if attributes.has_key?(:'amount')
    self.amount = attributes[:'amount']
  end

  if attributes.has_key?(:'available')
    self.available = attributes[:'available']
  end

  if attributes.has_key?(:'bank_beneficiary')
    self.bank_beneficiary = attributes[:'bank_beneficiary']
  end

  if attributes.has_key?(:'bank_sender')
    self.bank_sender = attributes[:'bank_sender']
  end

  if attributes.has_key?(:'beneficiary_name')
    self.beneficiary_name = attributes[:'beneficiary_name']
  end

  if attributes.has_key?(:'beneficiary_rfc')
    self.beneficiary_rfc = attributes[:'beneficiary_rfc']
  end

  if attributes.has_key?(:'cadena_original')
    self.cadena_original = attributes[:'cadena_original']
  end

  if attributes.has_key?(:'capture_date')
    self.capture_date = attributes[:'capture_date']
  end

  if attributes.has_key?(:'certificate_serial_number')
    self.certificate_serial_number = attributes[:'certificate_serial_number']
  end

  if attributes.has_key?(:'clave_rastreo')
    self.clave_rastreo = attributes[:'clave_rastreo']
  end

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

  if attributes.has_key?(:'iva')
    self.iva = attributes[:'iva']
  end

  if attributes.has_key?(:'operation_date')
    self.operation_date = attributes[:'operation_date']
  end

  if attributes.has_key?(:'operation_date_cep')
    self.operation_date_cep = attributes[:'operation_date_cep']
  end

  if attributes.has_key?(:'reference')
    self.reference = attributes[:'reference']
  end

  if attributes.has_key?(:'sender_name')
    self.sender_name = attributes[:'sender_name']
  end

  if attributes.has_key?(:'sender_rfc')
    self.sender_rfc = attributes[:'sender_rfc']
  end

  if attributes.has_key?(:'signature')
    self.signature = attributes[:'signature']
  end

  if attributes.has_key?(:'url_zip')
    self.url_zip = attributes[:'url_zip']
  end
end

Instance Attribute Details

#account_beneficiary ⇒ Object

Es la cuenta del beneficiario.



19
20
21
 
# File 'lib/wire4_client/models/message_cep.rb', line 19

def 
  @account_beneficiary
end

#account_sender ⇒ Object

Es la cuenta que envía la operación.



22
23
24
 
# File 'lib/wire4_client/models/message_cep.rb', line 22

def 
  @account_sender
end

#amount ⇒ Object

Es el monto de la operación.



25
26
27
 
# File 'lib/wire4_client/models/message_cep.rb', line 25

def amount
  @amount
end

#available ⇒ Object

Indica sí el CEP está disponible.



28
29
30
 
# File 'lib/wire4_client/models/message_cep.rb', line 28

def available
  @available
end

#bank_beneficiary ⇒ Object

Es la clave del banco beneficiario.



31
32
33
 
# File 'lib/wire4_client/models/message_cep.rb', line 31

def bank_beneficiary
  @bank_beneficiary
end

#bank_sender ⇒ Object

Es la clave del banco que envía la operación.



34
35
36
 
# File 'lib/wire4_client/models/message_cep.rb', line 34

def bank_sender
  @bank_sender
end

#beneficiary_name ⇒ Object

Es el nombre del beneficiario.



37
38
39
 
# File 'lib/wire4_client/models/message_cep.rb', line 37

def beneficiary_name
  @beneficiary_name
end

#beneficiary_rfc ⇒ Object

Es el Registro Federal de Contribuyentes (RFC) del beneficiario.



40
41
42
 
# File 'lib/wire4_client/models/message_cep.rb', line 40

def beneficiary_rfc
  @beneficiary_rfc
end

#cadena_original ⇒ Object

Es la cadena original emitida por el Servicio de Administración Tributaria (SAT).



43
44
45
 
# File 'lib/wire4_client/models/message_cep.rb', line 43

def cadena_original
  @cadena_original
end

#capture_date ⇒ Object

Es la fecha de captura.



46
47
48
 
# File 'lib/wire4_client/models/message_cep.rb', line 46

def capture_date
  @capture_date
end

#certificate_serial_number ⇒ Object

Es el número de serie emitido por el SAT



49
50
51
 
# File 'lib/wire4_client/models/message_cep.rb', line 49

def certificate_serial_number
  @certificate_serial_number
end

#clave_rastreo ⇒ Object

Es la clave de rastreo de la operación.



52
53
54
 
# File 'lib/wire4_client/models/message_cep.rb', line 52

def clave_rastreo
  @clave_rastreo
end

#description ⇒ Object

Es la descripción de la operación.



55
56
57
 
# File 'lib/wire4_client/models/message_cep.rb', line 55

def description
  @description
end

#iva ⇒ Object

Es el Impuesto al Valor Agregado (IVA) de la operación.



58
59
60
 
# File 'lib/wire4_client/models/message_cep.rb', line 58

def iva
  @iva
end

#operation_date ⇒ Object

Es la fecha en la que se realizó la operación.



61
62
63
 
# File 'lib/wire4_client/models/message_cep.rb', line 61

def operation_date
  @operation_date
end

#operation_date_cep ⇒ Object

Es la fecha en la que se genera el CEP.



64
65
66
 
# File 'lib/wire4_client/models/message_cep.rb', line 64

def operation_date_cep
  @operation_date_cep
end

#reference ⇒ Object

Es la Referencia de la operación



67
68
69
 
# File 'lib/wire4_client/models/message_cep.rb', line 67

def reference
  @reference
end

#sender_name ⇒ Object

Es el nombre de quién envía la operación.



70
71
72
 
# File 'lib/wire4_client/models/message_cep.rb', line 70

def sender_name
  @sender_name
end

#sender_rfc ⇒ Object

Es el Registro Federal de Contrinuyentes (RFC) de quién envía la operación.



73
74
75
 
# File 'lib/wire4_client/models/message_cep.rb', line 73

def sender_rfc
  @sender_rfc
end

#signature ⇒ Object

Firma del CEP



76
77
78
 
# File 'lib/wire4_client/models/message_cep.rb', line 76

def signature
  @signature
end

#url_zip ⇒ Object

Dirección URL de descarga del archivo ZIP que contiene el PDF y XML del CEP proporcionado por BANXICO



79
80
81
 
# File 'lib/wire4_client/models/message_cep.rb', line 79

def url_zip
  @url_zip
end

Class Method Details

.attribute_map ⇒ Object

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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/wire4_client/models/message_cep.rb', line 82

def self.attribute_map
  {
    :'account_beneficiary' => :'account_beneficiary',
    :'account_sender' => :'account_sender',
    :'amount' => :'amount',
    :'available' => :'available',
    :'bank_beneficiary' => :'bank_beneficiary',
    :'bank_sender' => :'bank_sender',
    :'beneficiary_name' => :'beneficiary_name',
    :'beneficiary_rfc' => :'beneficiary_rfc',
    :'cadena_original' => :'cadena_original',
    :'capture_date' => :'capture_date',
    :'certificate_serial_number' => :'certificate_serial_number',
    :'clave_rastreo' => :'clave_rastreo',
    :'description' => :'description',
    :'iva' => :'iva',
    :'operation_date' => :'operation_date',
    :'operation_date_cep' => :'operation_date_cep',
    :'reference' => :'reference',
    :'sender_name' => :'sender_name',
    :'sender_rfc' => :'sender_rfc',
    :'signature' => :'signature',
    :'url_zip' => :'url_zip'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/wire4_client/models/message_cep.rb', line 109

def self.swagger_types
  {
    :'account_beneficiary' => :'String',
    :'account_sender' => :'String',
    :'amount' => :'Float',
    :'available' => :'BOOLEAN',
    :'bank_beneficiary' => :'String',
    :'bank_sender' => :'String',
    :'beneficiary_name' => :'String',
    :'beneficiary_rfc' => :'String',
    :'cadena_original' => :'String',
    :'capture_date' => :'DateTime',
    :'certificate_serial_number' => :'String',
    :'clave_rastreo' => :'String',
    :'description' => :'String',
    :'iva' => :'Float',
    :'operation_date' => :'DateTime',
    :'operation_date_cep' => :'DateTime',
    :'reference' => :'String',
    :'sender_name' => :'String',
    :'sender_rfc' => :'String',
    :'signature' => :'String',
    :'url_zip' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/wire4_client/models/message_cep.rb', line 243

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
       == o. &&
      amount == o.amount &&
      available == o.available &&
      bank_beneficiary == o.bank_beneficiary &&
      bank_sender == o.bank_sender &&
      beneficiary_name == o.beneficiary_name &&
      beneficiary_rfc == o.beneficiary_rfc &&
      cadena_original == o.cadena_original &&
      capture_date == o.capture_date &&
      certificate_serial_number == o.certificate_serial_number &&
      clave_rastreo == o.clave_rastreo &&
      description == o.description &&
      iva == o.iva &&
      operation_date == o.operation_date &&
      operation_date_cep == o.operation_date_cep &&
      reference == o.reference &&
      sender_name == o.sender_name &&
      sender_rfc == o.sender_rfc &&
      signature == o.signature &&
      url_zip == o.url_zip
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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/wire4_client/models/message_cep.rb', line 305

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



371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/wire4_client/models/message_cep.rb', line 371

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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/wire4_client/models/message_cep.rb', line 284

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


271
272
273
 
# File 'lib/wire4_client/models/message_cep.rb', line 271

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



277
278
279
 
# File 'lib/wire4_client/models/message_cep.rb', line 277

def hash
  [, , amount, available, bank_beneficiary, bank_sender, beneficiary_name, beneficiary_rfc, cadena_original, capture_date, certificate_serial_number, clave_rastreo, description, iva, operation_date, operation_date_cep, reference, sender_name, sender_rfc, signature, url_zip].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



230
231
232
233
 
# File 'lib/wire4_client/models/message_cep.rb', line 230

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



351
352
353
 
# File 'lib/wire4_client/models/message_cep.rb', line 351

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



357
358
359
360
361
362
363
364
365
 
# File 'lib/wire4_client/models/message_cep.rb', line 357

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



345
346
347
 
# File 'lib/wire4_client/models/message_cep.rb', line 345

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



237
238
239
 
# File 'lib/wire4_client/models/message_cep.rb', line 237

def valid?
  true
end