Class: BancoBrasilPayments::InlineResponse2003ListaBoleto

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InlineResponse2003ListaBoleto

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
208
209
210
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 126

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#codigo_barras ⇒ Object

"Código de barras do boleto consultado. Não é a linha digitável do boleto."



17
18
19
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 17

def codigo_barras
  @codigo_barras
end

#data_agendamento ⇒ Object

Data do pagamento informado na solicitação de pagamento (formato ddmmaaaa)



56
57
58
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 56

def data_agendamento
  @data_agendamento
end

#data_vencimento ⇒ Object

Data de vencimento do boleto informado na solicitação de pagamento (formato ddmmaaaa)



53
54
55
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 53

def data_vencimento
  @data_vencimento
end

#documento_avalista ⇒ Object

Nº CPF ou um Nº de CNPJ do Avalista do boleto informado na solicitação de pagamento.



47
48
49
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 47

def documento_avalista
  @documento_avalista
end

#documento_beneficiario ⇒ Object

Nº CPF ou um Nº de CNPJ do Beneficiário do Boleto informado na solicitação de pagamento.



29
30
31
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 29

def documento_beneficiario
  @documento_beneficiario
end

#documento_pagador ⇒ Object

Nº CPF ou um Nº de CNPJ do Pagador do boleto informado na solicitação de pagamento.



38
39
40
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 38

def documento_pagador
  @documento_pagador
end

#nome_avalista ⇒ Object

Nome do Avalista - dado retornado pelo Banco



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

def nome_avalista
  @nome_avalista
end

#nome_beneficiario ⇒ Object

Nome do Beneficiário - dado retornado pelo Banco



32
33
34
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 32

def nome_beneficiario
  @nome_beneficiario
end

#nome_pagador ⇒ Object

Nome do Pagador - dado retornado pelo Banco.



41
42
43
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 41

def nome_pagador
  @nome_pagador
end

#nosso_documento ⇒ Object

Exibe o Nosso Número quando informado na solicitação de pagamento. Não validado pelo Banco.



20
21
22
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 20

def nosso_documento
  @nosso_documento
end

#seu_documento ⇒ Object

Exibe o Seu Número quando informado na solicitação de pagamento. Não validado pelo Banco.



23
24
25
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 23

def seu_documento
  @seu_documento
end

#texto ⇒ Object

Campo livre informado pelo pagador quando do envio do lançamento consultado – sem tratamento pelo Banco.



68
69
70
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 68

def texto
  @texto
end

#tipo_pessoa_avalista ⇒ Object

Determina se é um Nº CPF ou um Nº de CNPJ no campo Número Inscrição Avalista do Boleto. DOMÍNIOS: 1 - CPF 2 – CNPJ



44
45
46
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 44

def tipo_pessoa_avalista
  @tipo_pessoa_avalista
end

#tipo_pessoa_beneficiario ⇒ Object

Determina se é um Nº CPF ou um Nº de CNPJ no campo Número Inscrição Beneficiário do Boleto DOMÍNIOS: 1 - CPF 2 – CNPJ



26
27
28
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 26

def tipo_pessoa_beneficiario
  @tipo_pessoa_beneficiario
end

#tipo_pessoa_pagador ⇒ Object

Determina se é um Nº CPF ou um Nº de CNPJ no campo Número Inscrição Pagador do Boleto. DOMÍNIOS: 1 - CPF 2 – CNPJ



35
36
37
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 35

def tipo_pessoa_pagador
  @tipo_pessoa_pagador
end

#valor_desconto ⇒ Object

Valor do desconto/abatimento informado na solicitação de pagamento (formato 0.00)



65
66
67
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 65

def valor_desconto
  @valor_desconto
end

#valor_mora_multa ⇒ Object

Valor do juros mora e multa informado na solicitação de pagamento (formato 0.00)



62
63
64
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 62

def valor_mora_multa
  @valor_mora_multa
end

#valor_nominal ⇒ Object

Valor do boleto registrado pelo Beneficiário do Boleto e informado na solicitação de pagamento (formato 0.00)



59
60
61
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 59

def valor_nominal
  @valor_nominal
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 71

def self.attribute_map
  {
    :'codigo_barras' => :'codigoBarras',
    :'nosso_documento' => :'nossoDocumento',
    :'seu_documento' => :'seuDocumento',
    :'tipo_pessoa_beneficiario' => :'tipoPessoaBeneficiario',
    :'documento_beneficiario' => :'documentoBeneficiario',
    :'nome_beneficiario' => :'nomeBeneficiario',
    :'tipo_pessoa_pagador' => :'tipoPessoaPagador',
    :'documento_pagador' => :'documentoPagador',
    :'nome_pagador' => :'nomePagador',
    :'tipo_pessoa_avalista' => :'tipoPessoaAvalista',
    :'documento_avalista' => :'documentoAvalista',
    :'nome_avalista' => :'nomeAvalista',
    :'data_vencimento' => :'dataVencimento',
    :'data_agendamento' => :'dataAgendamento',
    :'valor_nominal' => :'valorNominal',
    :'valor_mora_multa' => :'valorMoraMulta',
    :'valor_desconto' => :'valorDesconto',
    :'texto' => :'texto'
  }
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



265
266
267
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 265

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 95

def self.openapi_types
  {
    :'codigo_barras' => :'Object',
    :'nosso_documento' => :'Object',
    :'seu_documento' => :'Object',
    :'tipo_pessoa_beneficiario' => :'Object',
    :'documento_beneficiario' => :'Object',
    :'nome_beneficiario' => :'Object',
    :'tipo_pessoa_pagador' => :'Object',
    :'documento_pagador' => :'Object',
    :'nome_pagador' => :'Object',
    :'tipo_pessoa_avalista' => :'Object',
    :'documento_avalista' => :'Object',
    :'nome_avalista' => :'Object',
    :'data_vencimento' => :'Object',
    :'data_agendamento' => :'Object',
    :'valor_nominal' => :'Object',
    :'valor_mora_multa' => :'Object',
    :'valor_desconto' => :'Object',
    :'texto' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      codigo_barras == o.codigo_barras &&
      nosso_documento == o.nosso_documento &&
      seu_documento == o.seu_documento &&
      tipo_pessoa_beneficiario == o.tipo_pessoa_beneficiario &&
      documento_beneficiario == o.documento_beneficiario &&
      nome_beneficiario == o.nome_beneficiario &&
      tipo_pessoa_pagador == o.tipo_pessoa_pagador &&
      documento_pagador == o.documento_pagador &&
      nome_pagador == o.nome_pagador &&
      tipo_pessoa_avalista == o.tipo_pessoa_avalista &&
      documento_avalista == o.documento_avalista &&
      nome_avalista == o.nome_avalista &&
      data_vencimento == o.data_vencimento &&
      data_agendamento == o.data_agendamento &&
      valor_nominal == o.valor_nominal &&
      valor_mora_multa == o.valor_mora_multa &&
      valor_desconto == o.valor_desconto &&
      texto == o.texto
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



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
326
327
328
329
330
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 295

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



364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 364

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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 272

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


252
253
254
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 252

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



258
259
260
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 258

def hash
  [codigo_barras, nosso_documento, seu_documento, tipo_pessoa_beneficiario, documento_beneficiario, nome_beneficiario, tipo_pessoa_pagador, documento_pagador, nome_pagador, tipo_pessoa_avalista, documento_avalista, nome_avalista, data_vencimento, data_agendamento, valor_nominal, valor_mora_multa, valor_desconto, texto].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



214
215
216
217
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 214

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



340
341
342
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 340

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



346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 346

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



334
335
336
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 334

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



221
222
223
 
# File 'lib/bb_payments/models/inline_response_200_3_lista_boleto.rb', line 221

def valid?
  true
end