Class: BancoBrasilPayments::RootTypeForBatchTransferPaymentsListGET

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

Overview

Lista de pagamentos para recurso GET Batch Transfers

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RootTypeForBatchTransferPaymentsListGET

Initializes the object

Parameters:

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

    Model attributes in the form of hash



112
113
114
115
116
117
118
119
120
121
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
 
# File 'lib/bb_payments/models/root_type_for_batch_transfer_payments_list_get.rb', line 112

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#bankpayment_amount ⇒ Object

Valor do pagamento em reais (formato 0.00)



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

def bankpayment_amount
  @bankpayment_amount
end

#bankpayment_quantity ⇒ Object

Quantidade total de boletos



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

def bankpayment_quantity
  @bankpayment_quantity
end

#check_digits_debit_current_account ⇒ Object

Dígito do verificador da conta corrente para débito.



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

def 
  @check_digits_debit_current_account
end

#debit_branch_office ⇒ Object

Código da agência para débito.



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

def debit_branch_office
  @debit_branch_office
end

#debit_current_account ⇒ Object

Conta corrente de débito.



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

def 
  @debit_current_account
end

#payment_type ⇒ Object

Modalidade que representa o tipo de pagamento, sendo: 126 pagamento de fornecedores; 127 pagamento de salário e 128 pagamentos diversos



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

def payment_type
  @payment_type
end

#request_date ⇒ Object

Data em que o cliente enviou ao banco a requisição de pagamento (formato ddmmaaaa). Solicitações de pagamentos para dias não úteis ou após o horário limite de processamento serão pagas no próximo dia útil, com exceção de transferências entre contas do Banco do Brasil



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

def request_date
  @request_date
end

#request_payment_message ⇒ Object

Texto de uso livre do cliente.



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

def request_payment_message
  @request_payment_message
end

#request_sent_hour ⇒ Object

Hora do envio da requisição do envio do lote



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

def request_sent_hour
  @request_sent_hour
end

#request_status ⇒ Object

Código do estado da requisição a ser pesquisada: 1 - Requisição com todos os lançamentos com dados consistentes; 2 - Requisição com ao menos um dos lançamentos com dados inconsistentes; 3 - Requisição com todos os lançamentos com dados inconsistentes; 4 - Requisição pendente de ação pelo Conveniado - falta autorizar o pagamento; 5 - Requisição em processamento pelo Banco; 6 - Requisição Processada; 7 - Requisição Rejeitada, 8 - Preparando remessa não liberada, 9 - Requisição liberada via API, 10 - Preparando remessa liberada. As situações 1, 2 e 8 são transitórias e não requerem qualquer ação do Cliente Conveniado. situação 3 sempre será migrada para situação 7. A situação 4 Significa que, ao menos um lançamento, depende de ação do Cliente Conveniado, seja liberando ou cancelando os pagamentos. As situações 5, 6, 7, 9 e 10 não requerem qualquer ação do Cliente Conveniado. A situação 5 significa que, ao menos um lançamento, está agendado. As situações 6 e 7 são definitivas não havendo alteração posterior da situação da requisição.



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

def request_status
  @request_status
end

#sequential_request_id ⇒ Object

ID sequencial da requisição



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

def sequential_request_id
  @sequential_request_id
end

#user_id ⇒ Object

Identificação do usuário que enviou a requisição



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

def user_id
  @user_id
end

#user_name ⇒ Object

Nome do responsável pelo envio do lote. (para casos de login e explícito)



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

def user_name
  @user_name
end

#valid_bankpayment_amount ⇒ Object

Valor total de todos os pagamentos pretendidos válidos a serem processados em lote (formato 0.00)



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

def valid_bankpayment_amount
  @valid_bankpayment_amount
end

#valid_bankpayment_quantity ⇒ Object

Quantidade total de todos os pagamentos pretendidos válidos a serem processados em lote



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

def valid_bankpayment_quantity
  @valid_bankpayment_quantity
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/bb_payments/models/root_type_for_batch_transfer_payments_list_get.rb', line 63

def self.attribute_map
  {
    :'sequential_request_id' => :'sequentialRequestID',
    :'request_payment_message' => :'requestPaymentMessage',
    :'request_status' => :'requestStatus',
    :'debit_branch_office' => :'debitBranchOffice',
    :'debit_current_account' => :'debitCurrentAccount',
    :'check_digits_debit_current_account' => :'checkDigitsDebitCurrentAccount',
    :'request_date' => :'requestDate',
    :'request_sent_hour' => :'requestSentHour',
    :'payment_type' => :'paymentType',
    :'user_id' => :'userID',
    :'user_name' => :'userName',
    :'bankpayment_quantity' => :'bankpaymentQuantity',
    :'bankpayment_amount' => :'bankpaymentAmount',
    :'valid_bankpayment_quantity' => :'validBankpaymentQuantity',
    :'valid_bankpayment_amount' => :'validBankpaymentAmount'
  }
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



236
237
238
 
# File 'lib/bb_payments/models/root_type_for_batch_transfer_payments_list_get.rb', line 236

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



105
106
107
108
 
# File 'lib/bb_payments/models/root_type_for_batch_transfer_payments_list_get.rb', line 105

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

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/bb_payments/models/root_type_for_batch_transfer_payments_list_get.rb', line 84

def self.openapi_types
  {
    :'sequential_request_id' => :'Object',
    :'request_payment_message' => :'Object',
    :'request_status' => :'Object',
    :'debit_branch_office' => :'Object',
    :'debit_current_account' => :'Object',
    :'check_digits_debit_current_account' => :'Object',
    :'request_date' => :'Object',
    :'request_sent_hour' => :'Object',
    :'payment_type' => :'Object',
    :'user_id' => :'Object',
    :'user_name' => :'Object',
    :'bankpayment_quantity' => :'Object',
    :'bankpayment_amount' => :'Object',
    :'valid_bankpayment_quantity' => :'Object',
    :'valid_bankpayment_amount' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/bb_payments/models/root_type_for_batch_transfer_payments_list_get.rb', line 201

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      sequential_request_id == o.sequential_request_id &&
      request_payment_message == o.request_payment_message &&
      request_status == o.request_status &&
      debit_branch_office == o.debit_branch_office &&
       == o. &&
       == o. &&
      request_date == o.request_date &&
      request_sent_hour == o.request_sent_hour &&
      payment_type == o.payment_type &&
      user_id == o.user_id &&
      user_name == o.user_name &&
      bankpayment_quantity == o.bankpayment_quantity &&
      bankpayment_amount == o.bankpayment_amount &&
      valid_bankpayment_quantity == o.valid_bankpayment_quantity &&
      valid_bankpayment_amount == o.valid_bankpayment_amount
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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/bb_payments/models/root_type_for_batch_transfer_payments_list_get.rb', line 266

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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/bb_payments/models/root_type_for_batch_transfer_payments_list_get.rb', line 335

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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/bb_payments/models/root_type_for_batch_transfer_payments_list_get.rb', line 243

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


223
224
225
 
# File 'lib/bb_payments/models/root_type_for_batch_transfer_payments_list_get.rb', line 223

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



229
230
231
 
# File 'lib/bb_payments/models/root_type_for_batch_transfer_payments_list_get.rb', line 229

def hash
  [sequential_request_id, request_payment_message, request_status, debit_branch_office, , , request_date, request_sent_hour, payment_type, user_id, user_name, bankpayment_quantity, bankpayment_amount, valid_bankpayment_quantity, valid_bankpayment_amount].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



188
189
190
191
 
# File 'lib/bb_payments/models/root_type_for_batch_transfer_payments_list_get.rb', line 188

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



311
312
313
 
# File 'lib/bb_payments/models/root_type_for_batch_transfer_payments_list_get.rb', line 311

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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/bb_payments/models/root_type_for_batch_transfer_payments_list_get.rb', line 317

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



305
306
307
 
# File 'lib/bb_payments/models/root_type_for_batch_transfer_payments_list_get.rb', line 305

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



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

def valid?
  true
end