Class: BancoBrasilPayments::RootTypeForBatchTransfersCancelPaymentsListObject

Inherits:
Object
  • Object
show all
Defined in:
lib/bb_payments/models/root_type_for_batch_transfers_cancel_payments_list_object.rb

Overview

Objeto interno do objeto BatchTransfersCancelResponseObject

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RootTypeForBatchTransfersCancelPaymentsListObject

Initializes the object

Parameters:

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

    Model attributes in the form of hash



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/bb_payments/models/root_type_for_batch_transfers_cancel_payments_list_object.rb', line 57

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

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

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

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

Instance Attribute Details

#cancel_indicator ⇒ Object

Indica se o pagamento foi cancelado ou não



21
22
23
 
# File 'lib/bb_payments/models/root_type_for_batch_transfers_cancel_payments_list_object.rb', line 21

def cancel_indicator
  @cancel_indicator
end

#payment_id ⇒ Object

Identificação do pagamento. Representa o número do protocolo por meio do qual o beneficiário pode verificar a situação do crédito, se necessário.



18
19
20
 
# File 'lib/bb_payments/models/root_type_for_batch_transfers_cancel_payments_list_object.rb', line 18

def payment_id
  @payment_id
end

#payment_status ⇒ Object

Descrição da situação do pagamento: Domínios: - Consistente (pagamento recebido pelo banco, cumprem as regras de preenchimento dos campos mas ainda irá para validação e processamento) - Inconsistente (pagamento não aceito pelo banco por dados de entrada inconsistentes - não cumpre as regras de preenchimento dos campos) - Pago (pagamento efetuado ao favorecido) - Pendente (pagamento validado - pendência de autorização do pagamento por parte do pagador) - Aguardando saldo (débito não efetivado e em verificação de saldo até o horário limite da teimosinha). - Agendado (pagamento autorizado, porém aguardando a data de efetivação do pagamento ou horário de processamento) - Rejeitado (dados do pagamento não passaram na validações físicas e/ou lógicas, precisam ser corrigidos e reenviados. Ex: agência e conta não existem, conta não pertence ao CPF informado) - Cancelado (pagamento cancelado pelo pagador antes da data de efetivação do crédito) - Bloqueado (Débito na conta do pagador não efetivado por ocorrência no convênio, inconsistência de data/float ou falta de saldo) - Devolvido (pagamento efetuado e posteriormente devolvido pelo favorecido ou instituição recebedora. O valor é devolvido para a conta corrente onde ocorreu o débito da requisição)" - Debitado (pagamento debitado na conta do pagador e pendente de crédito ao favorecido)



24
25
26
 
# File 'lib/bb_payments/models/root_type_for_batch_transfers_cancel_payments_list_object.rb', line 24

def payment_status
  @payment_status
end

#processing_message ⇒ Object

Descrição do estado da requisição de cancelamento da transferência



27
28
29
 
# File 'lib/bb_payments/models/root_type_for_batch_transfers_cancel_payments_list_object.rb', line 27

def processing_message
  @processing_message
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
 
# File 'lib/bb_payments/models/root_type_for_batch_transfers_cancel_payments_list_object.rb', line 30

def self.attribute_map
  {
    :'payment_id' => :'paymentId',
    :'cancel_indicator' => :'cancelIndicator',
    :'payment_status' => :'paymentStatus',
    :'processing_message' => :'processingMessage'
  }
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



126
127
128
 
# File 'lib/bb_payments/models/root_type_for_batch_transfers_cancel_payments_list_object.rb', line 126

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



50
51
52
53
 
# File 'lib/bb_payments/models/root_type_for_batch_transfers_cancel_payments_list_object.rb', line 50

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
 
# File 'lib/bb_payments/models/root_type_for_batch_transfers_cancel_payments_list_object.rb', line 40

def self.openapi_types
  {
    :'payment_id' => :'Object',
    :'cancel_indicator' => :'Object',
    :'payment_status' => :'Object',
    :'processing_message' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



102
103
104
105
106
107
108
109
 
# File 'lib/bb_payments/models/root_type_for_batch_transfers_cancel_payments_list_object.rb', line 102

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      payment_id == o.payment_id &&
      cancel_indicator == o.cancel_indicator &&
      payment_status == o.payment_status &&
      processing_message == o.processing_message
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



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
 
# File 'lib/bb_payments/models/root_type_for_batch_transfers_cancel_payments_list_object.rb', line 156

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
    BancoBrasilPayments.const_get(type).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



225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/bb_payments/models/root_type_for_batch_transfers_cancel_payments_list_object.rb', line 225

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



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/bb_payments/models/root_type_for_batch_transfers_cancel_payments_list_object.rb', line 133

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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[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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


113
114
115
 
# File 'lib/bb_payments/models/root_type_for_batch_transfers_cancel_payments_list_object.rb', line 113

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



119
120
121
 
# File 'lib/bb_payments/models/root_type_for_batch_transfers_cancel_payments_list_object.rb', line 119

def hash
  [payment_id, cancel_indicator, payment_status, processing_message].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



89
90
91
92
 
# File 'lib/bb_payments/models/root_type_for_batch_transfers_cancel_payments_list_object.rb', line 89

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



201
202
203
 
# File 'lib/bb_payments/models/root_type_for_batch_transfers_cancel_payments_list_object.rb', line 201

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



207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/bb_payments/models/root_type_for_batch_transfers_cancel_payments_list_object.rb', line 207

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



195
196
197
 
# File 'lib/bb_payments/models/root_type_for_batch_transfers_cancel_payments_list_object.rb', line 195

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



96
97
98
 
# File 'lib/bb_payments/models/root_type_for_batch_transfers_cancel_payments_list_object.rb', line 96

def valid?
  true
end