class Wire4Client::TransactionOutgoing

Objeto que contiene la información de una transferencias SPEI de salida

Attributes

amount[RW]

Monto de la transferencia

beneficiary_account[RW]

Cuenta del beneficiario, podría ser un número celular, TDD o Cuenta CLABE interbancaria

beneficiary_bank_key[RW]

La clave del banco beneficiario, proprocionada por BANXICO, este campo solo es obligatario cuando la cuenta beneficiaria es un número celular (*).

concept[RW]

Concepto de la transferencia

currency_code[RW]

Código de moneda en la que opera la cuenta

email[RW]

Lista de email del beneficiario,es opcional

order_id[RW]

Referencia de la transferencia asignada por el cliente

reference[RW]

Referencia numérica de la transferencia

Public Class Methods

attribute_map() click to toggle source

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

# File lib/wire4_client/models/transaction_outgoing.rb, line 43
def self.attribute_map
  {
    :'amount' => :'amount',
    :'beneficiary_account' => :'beneficiary_account',
    :'beneficiary_bank_key' => :'beneficiary_bank_key',
    :'concept' => :'concept',
    :'currency_code' => :'currency_code',
    :'email' => :'email',
    :'order_id' => :'order_id',
    :'reference' => :'reference'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/wire4_client/models/transaction_outgoing.rb, line 72
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.beneficiary_account = attributes[:'beneficiary_account']
  end

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

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

  if attributes.has_key?(:'reference')
    self.reference = attributes[:'reference']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/wire4_client/models/transaction_outgoing.rb, line 57
def self.swagger_types
  {
    :'amount' => :'Float',
    :'beneficiary_account' => :'String',
    :'beneficiary_bank_key' => :'String',
    :'concept' => :'String',
    :'currency_code' => :'String',
    :'email' => :'Array<String>',
    :'order_id' => :'String',
    :'reference' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/wire4_client/models/transaction_outgoing.rb, line 261
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      beneficiary_account == o.beneficiary_account &&
      beneficiary_bank_key == o.beneficiary_bank_key &&
      concept == o.concept &&
      currency_code == o.currency_code &&
      email == o.email &&
      order_id == o.order_id &&
      reference == o.reference
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/wire4_client/models/transaction_outgoing.rb, line 310
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/wire4_client/models/transaction_outgoing.rb, line 376
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
amount=(amount) click to toggle source

Custom attribute writer method with validation @param [Object] amount Value to be assigned

# File lib/wire4_client/models/transaction_outgoing.rb, line 193
def amount=(amount)
  if amount.nil?
    fail ArgumentError, 'amount cannot be nil'
  end

  if amount < 0.01
    fail ArgumentError, 'invalid value for "amount", must be greater than or equal to 0.01.'
  end

  @amount = amount
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/wire4_client/models/transaction_outgoing.rb, line 289
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
concept=(concept) click to toggle source

Custom attribute writer method with validation @param [Object] concept Value to be assigned

# File lib/wire4_client/models/transaction_outgoing.rb, line 207
def concept=(concept)
  if concept.nil?
    fail ArgumentError, 'concept cannot be nil'
  end

  if concept.to_s.length > 250
    fail ArgumentError, 'invalid value for "concept", the character length must be smaller than or equal to 250.'
  end

  if concept.to_s.length < 1
    fail ArgumentError, 'invalid value for "concept", the character length must be great than or equal to 1.'
  end

  @concept = concept
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/wire4_client/models/transaction_outgoing.rb, line 276
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/wire4_client/models/transaction_outgoing.rb, line 282
def hash
  [amount, beneficiary_account, beneficiary_bank_key, concept, currency_code, email, order_id, reference].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/wire4_client/models/transaction_outgoing.rb, line 115
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 @concept.nil?
    invalid_properties.push('invalid value for "concept", concept cannot be nil.')
  end

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

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

  if @currency_code.nil?
    invalid_properties.push('invalid value for "currency_code", currency_code cannot be nil.')
  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 @reference.nil?
    invalid_properties.push('invalid value for "reference", reference cannot be nil.')
  end

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

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

  invalid_properties
end
order_id=(order_id) click to toggle source

Custom attribute writer method with validation @param [Object] order_id Value to be assigned

# File lib/wire4_client/models/transaction_outgoing.rb, line 225
def order_id=(order_id)
  if order_id.nil?
    fail ArgumentError, 'order_id cannot be nil'
  end

  if order_id.to_s.length > 36
    fail ArgumentError, 'invalid value for "order_id", the character length must be smaller than or equal to 36.'
  end

  if order_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "order_id", the character length must be great than or equal to 1.'
  end

  @order_id = order_id
end
reference=(reference) click to toggle source

Custom attribute writer method with validation @param [Object] reference Value to be assigned

# File lib/wire4_client/models/transaction_outgoing.rb, line 243
def reference=(reference)
  if reference.nil?
    fail ArgumentError, 'reference cannot be nil'
  end

  if reference > 9999999
    fail ArgumentError, 'invalid value for "reference", must be smaller than or equal to 9999999.'
  end

  if reference < 0
    fail ArgumentError, 'invalid value for "reference", must be greater than or equal to 0.'
  end

  @reference = reference
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/wire4_client/models/transaction_outgoing.rb, line 356
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/wire4_client/models/transaction_outgoing.rb, line 362
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/wire4_client/models/transaction_outgoing.rb, line 350
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/wire4_client/models/transaction_outgoing.rb, line 174
def valid?
  return false if @amount.nil?
  return false if @amount < 0.01
  return false if @beneficiary_account.nil?
  return false if @concept.nil?
  return false if @concept.to_s.length > 250
  return false if @concept.to_s.length < 1
  return false if @currency_code.nil?
  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 @reference.nil?
  return false if @reference > 9999999
  return false if @reference < 0
  true
end