Class: BancoBrasilPayments::RootTypeForSlipsDetailsObject

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

Overview

Objeto de detalhamento de Boletos para o recurso Batch Slips (Pagamento de boletos em lote)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RootTypeForSlipsDetailsObject

Initializes the object

Parameters:

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

    Model attributes in the form of hash



122
123
124
125
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
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 122

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#bank_slip_value ⇒ Object

Valor de registro do boleto, sem descontos ou multas (formato 0.00). Campo Obrigatório



33
34
35
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 33

def bank_slip_value
  @bank_slip_value
end

#beneficiary_taxpayer_registration ⇒ Object

CPF ou CNPJ do beneficiário no pagamento.



57
58
59
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 57

def beneficiary_taxpayer_registration
  @beneficiary_taxpayer_registration
end

#beneficiary_taxpayer_type ⇒ Object

Identifica o tipo de pessoa, como: 1 - Pessoa física 2 - Pessoa Jurídica.



54
55
56
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 54

def beneficiary_taxpayer_type
  @beneficiary_taxpayer_type
end

#client_description ⇒ Object

Descrição do pagamento de Boletos. Pode ser preenchido livremente pelo cliente como forma de identificação para o pagamento.



66
67
68
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 66

def client_description
  @client_description
end

#discount_value ⇒ Object

Valor do desconto ou do abatimento do boleto ou do desconto + abatimento (formato 0.00)



36
37
38
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 36

def discount_value
  @discount_value
end

#due_date ⇒ Object

Data de vencimento do boleto (formato: ddmmaaaa). Campo Obrigatório



30
31
32
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 30

def due_date
  @due_date
end

#guarantor_taxpayer_registration ⇒ Object

CPF ou CNPJ do avalista.



63
64
65
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 63

def guarantor_taxpayer_registration
  @guarantor_taxpayer_registration
end

#guarantor_taxpayer_type ⇒ Object

Identifica o tipo de pessoa, como: 1 - Pessoa física 2 - Pessoa Jurídica.



60
61
62
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 60

def guarantor_taxpayer_type
  @guarantor_taxpayer_type
end

#late_payment_value ⇒ Object

Valor do juros ou de mora ou multa ou juros + mora+ multa, adicionado valor do boleto (formato 0.00)



39
40
41
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 39

def late_payment_value
  @late_payment_value
end

#numeric_bar_code ⇒ Object

Código de barras numérico do boleto. Campo obrigatório



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

def numeric_bar_code
  @numeric_bar_code
end

#our_number ⇒ Object

Número indicado no boleto no campo Nosso Número, no formato STRING, com 20 dígitos. Ex: 31285570000088000



42
43
44
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 42

def our_number
  @our_number
end

#payer_taxpayer_registration ⇒ Object

CPF ou CNPJ do pagador.



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

def payer_taxpayer_registration
  @payer_taxpayer_registration
end

#payer_taxpayer_type ⇒ Object

Identifica o tipo de pessoa, como: 1 - Pessoa física 2 - Pessoa Jurídica.



48
49
50
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 48

def payer_taxpayer_type
  @payer_taxpayer_type
end

#payment_date ⇒ Object

Data em que deverá ser efetivado o pagamento do boleto (formato: ddmmaaaa). Campo Obrigatório. Agendamentos poderão ser afetuados para até 180 dias



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

def payment_date
  @payment_date
end

#payment_value ⇒ Object

Valor do pagamento do boleto (formato 0.00). Campo Obrigatório



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

def payment_value
  @payment_value
end

#slip_id ⇒ Object

Código identificador do pagamento.



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

def slip_id
  @slip_id
end

#your_number ⇒ Object

Nº de uso livre pelo cliente conveniado. Equivalente ao Seu Número (Limitado a 20 caracteres).



45
46
47
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 45

def your_number
  @your_number
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'slip_id' => :'slipID',
    :'payment_date' => :'paymentDate',
    :'payment_value' => :'paymentValue',
    :'numeric_bar_code' => :'numericBarCode',
    :'due_date' => :'dueDate',
    :'bank_slip_value' => :'bankSlipValue',
    :'discount_value' => :'discountValue',
    :'late_payment_value' => :'latePaymentValue',
    :'our_number' => :'ourNumber',
    :'your_number' => :'yourNumber',
    :'payer_taxpayer_type' => :'payerTaxpayerType',
    :'payer_taxpayer_registration' => :'payerTaxpayerRegistration',
    :'beneficiary_taxpayer_type' => :'beneficiaryTaxpayerType',
    :'beneficiary_taxpayer_registration' => :'beneficiaryTaxpayerRegistration',
    :'guarantor_taxpayer_type' => :'guarantorTaxpayerType',
    :'guarantor_taxpayer_registration' => :'guarantorTaxpayerRegistration',
    :'client_description' => :'clientDescription'
  }
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



296
297
298
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 296

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



115
116
117
118
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 115

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

.openapi_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 92

def self.openapi_types
  {
    :'slip_id' => :'Object',
    :'payment_date' => :'Object',
    :'payment_value' => :'Object',
    :'numeric_bar_code' => :'Object',
    :'due_date' => :'Object',
    :'bank_slip_value' => :'Object',
    :'discount_value' => :'Object',
    :'late_payment_value' => :'Object',
    :'our_number' => :'Object',
    :'your_number' => :'Object',
    :'payer_taxpayer_type' => :'Object',
    :'payer_taxpayer_registration' => :'Object',
    :'beneficiary_taxpayer_type' => :'Object',
    :'beneficiary_taxpayer_registration' => :'Object',
    :'guarantor_taxpayer_type' => :'Object',
    :'guarantor_taxpayer_registration' => :'Object',
    :'client_description' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 259

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      slip_id == o.slip_id &&
      payment_date == o.payment_date &&
      payment_value == o.payment_value &&
      numeric_bar_code == o.numeric_bar_code &&
      due_date == o.due_date &&
      bank_slip_value == o.bank_slip_value &&
      discount_value == o.discount_value &&
      late_payment_value == o.late_payment_value &&
      our_number == o.our_number &&
      your_number == o.your_number &&
      payer_taxpayer_type == o.payer_taxpayer_type &&
      payer_taxpayer_registration == o.payer_taxpayer_registration &&
      beneficiary_taxpayer_type == o.beneficiary_taxpayer_type &&
      beneficiary_taxpayer_registration == o.beneficiary_taxpayer_registration &&
      guarantor_taxpayer_type == o.guarantor_taxpayer_type &&
      guarantor_taxpayer_registration == o.guarantor_taxpayer_registration &&
      client_description == o.client_description
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



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 326

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



395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 395

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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 303

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


283
284
285
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 283

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



289
290
291
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 289

def hash
  [slip_id, payment_date, payment_value, numeric_bar_code, due_date, bank_slip_value, discount_value, late_payment_value, our_number, your_number, payer_taxpayer_type, payer_taxpayer_registration, beneficiary_taxpayer_type, beneficiary_taxpayer_registration, guarantor_taxpayer_type, guarantor_taxpayer_registration, client_description].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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 206

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

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

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

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

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

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

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

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



371
372
373
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 371

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



377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 377

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



365
366
367
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 365

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



245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/bb_payments/models/root_type_for_slips_details_object.rb', line 245

def valid?
  return false if @payment_date.nil?
  return false if @payment_value.nil?
  return false if @numeric_bar_code.nil?
  return false if @due_date.nil?
  return false if @bank_slip_value.nil?
  return false if @beneficiary_taxpayer_type.nil?
  return false if @beneficiary_taxpayer_registration.nil?
  return false if @client_description.nil?
  true
end