Class: Wire4Client::TransactionOutgoingSpid

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

Overview

Objeto que contiene la información de una transferencia SPID® de salida.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransactionOutgoingSpid

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/wire4_client/models/transaction_outgoing_spid.rb', line 82

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

Es el monto de la transferencia. Se valida que sean máximo 20 dígitos y 2 decimales. Ejemplo 1000.00



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

def amount
  @amount
end

#beneficiary_account ⇒ Object

Cuenta del beneficiario, podría ser un número celular (10dígitos), tarjeta de débito (TDD) o Cuenta CLABE interbancaria (18 dígitos).



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

def 
  @beneficiary_account
end

#cancel_return_url ⇒ Object

Es la dirección URL a la que se redirigirá en caso de que el usario cancele el registro.



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

def cancel_return_url
  @cancel_return_url
end

#classification_id ⇒ Object

Es el identificador de la clasificación de la transferencia SPID.



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

def classification_id
  @classification_id
end

#currency_code ⇒ Object

Código de moneda en la que opera la cuenta.



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

def currency_code
  @currency_code
end

#email ⇒ Object

Lista de correo electrónico (email) del beneficiario. Este campo es opcional.



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

def email
  @email
end

#numeric_reference_spid ⇒ Object

Es la referencia numérica de la transferencia.



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

def numeric_reference_spid
  @numeric_reference_spid
end

#order_id ⇒ Object

Es la referencia de la transferencia asignada por el cliente. Ejemplo: dae9c6ae-8c7a-42e8-99f4-ebe90566efae



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

def order_id
  @order_id
end

#payment_concept_spid ⇒ Object

Es el concepto de la transferencia.



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

def payment_concept_spid
  @payment_concept_spid
end

#return_url ⇒ Object

Es la dirección URL a la que se redirigirá en caso de éxito.



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

def return_url
  @return_url
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/wire4_client/models/transaction_outgoing_spid.rb', line 49

def self.attribute_map
  {
    :'amount' => :'amount',
    :'beneficiary_account' => :'beneficiary_account',
    :'cancel_return_url' => :'cancel_return_url',
    :'classification_id' => :'classification_id',
    :'currency_code' => :'currency_code',
    :'email' => :'email',
    :'numeric_reference_spid' => :'numeric_reference_spid',
    :'order_id' => :'order_id',
    :'payment_concept_spid' => :'payment_concept_spid',
    :'return_url' => :'return_url'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/wire4_client/models/transaction_outgoing_spid.rb', line 65

def self.swagger_types
  {
    :'amount' => :'Float',
    :'beneficiary_account' => :'String',
    :'cancel_return_url' => :'String',
    :'classification_id' => :'String',
    :'currency_code' => :'String',
    :'email' => :'Array<String>',
    :'numeric_reference_spid' => :'Integer',
    :'order_id' => :'String',
    :'payment_concept_spid' => :'String',
    :'return_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/wire4_client/models/transaction_outgoing_spid.rb', line 294

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
       == o. &&
      cancel_return_url == o.cancel_return_url &&
      classification_id == o.classification_id &&
      currency_code == o.currency_code &&
      email == o.email &&
      numeric_reference_spid == o.numeric_reference_spid &&
      order_id == o.order_id &&
      payment_concept_spid == o.payment_concept_spid &&
      return_url == o.return_url
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



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/wire4_client/models/transaction_outgoing_spid.rb', line 345

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



411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/wire4_client/models/transaction_outgoing_spid.rb', line 411

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



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/wire4_client/models/transaction_outgoing_spid.rb', line 324

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


311
312
313
 
# File 'lib/wire4_client/models/transaction_outgoing_spid.rb', line 311

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



317
318
319
 
# File 'lib/wire4_client/models/transaction_outgoing_spid.rb', line 317

def hash
  [amount, , cancel_return_url, classification_id, currency_code, email, numeric_reference_spid, order_id, payment_concept_spid, return_url].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



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

def list_invalid_properties
  invalid_properties = Array.new
  if @amount.nil?
    invalid_properties.push('invalid value for "amount", amount cannot be nil.')
  end

  if @amount < 0.01
    invalid_properties.push('invalid value for "amount", must be greater than or equal to 0.01.')
  end

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

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

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

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

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

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

  if @numeric_reference_spid < 0
    invalid_properties.push('invalid value for "numeric_reference_spid", must be greater than or equal to 0.')
  end

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

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

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

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

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

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

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



391
392
393
 
# File 'lib/wire4_client/models/transaction_outgoing_spid.rb', line 391

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



397
398
399
400
401
402
403
404
405
 
# File 'lib/wire4_client/models/transaction_outgoing_spid.rb', line 397

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



385
386
387
 
# File 'lib/wire4_client/models/transaction_outgoing_spid.rb', line 385

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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/wire4_client/models/transaction_outgoing_spid.rb', line 204

def valid?
  return false if @amount.nil?
  return false if @amount < 0.01
  return false if @beneficiary_account.nil?
  return false if @cancel_return_url.nil?
  return false if @classification_id.nil?
  return false if @currency_code.nil?
  return false if @numeric_reference_spid.nil?
  return false if @numeric_reference_spid > 9999999
  return false if @numeric_reference_spid < 0
  return false if @order_id.nil?
  return false if @order_id.to_s.length > 36
  return false if @order_id.to_s.length < 1
  return false if @payment_concept_spid.nil?
  return false if @payment_concept_spid.to_s.length > 250
  return false if @payment_concept_spid.to_s.length < 1
  return false if @return_url.nil?
  true
end