bb_payments 0.1.1

data/lib/bb_payments/models/error_o_auth_unauthorized.rb

@@ -0,0 +1,257 @@
+=begin
+#Payments-VPN
+
+#Esta API fornece os serviços de pagamento do Banco do Brasil.
+
+OpenAPI spec version: 3.5
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.24
+=end
+
+require 'date'
+
+module BancoBrasilPayments
+  # Representação de um objeto de erro do OAuth 2.0.
+  class ErrorOAuthUnauthorized
+    # Código de estado do erro.
+    attr_accessor :status_code
+
+    # Tipo de erro.
+    attr_accessor :error
+
+    # Mensagem de erro.
+    attr_accessor :message
+
+    attr_accessor :attributes
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'status_code' => :'statusCode',
+        :'error' => :'error',
+        :'message' => :'message',
+        :'attributes' => :'attributes'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'status_code' => :'Object',
+        :'error' => :'Object',
+        :'message' => :'Object',
+        :'attributes' => :'Object'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+  
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `BancoBrasilPayments::ErrorOAuthUnauthorized` 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::ErrorOAuthUnauthorized`. 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?(:'status_code')
+        self.status_code = attributes[:'status_code']
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      end
+
+      if attributes.key?(:'attributes')
+        self.attributes = attributes[:'attributes']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @status_code.nil?
+        invalid_properties.push('invalid value for "status_code", status_code cannot be nil.')
+      end
+
+      if @error.nil?
+        invalid_properties.push('invalid value for "error", error cannot be nil.')
+      end
+
+      if @message.nil?
+        invalid_properties.push('invalid value for "message", message cannot be nil.')
+      end
+
+      if @attributes.nil?
+        invalid_properties.push('invalid value for "attributes", attributes cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @status_code.nil?
+      return false if @error.nil?
+      return false if @message.nil?
+      return false if @attributes.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          status_code == o.status_code &&
+          error == o.error &&
+          message == o.message &&
+          attributes == o.attributes
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [status_code, error, message, attributes].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # 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
+    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  end
+end

data/lib/bb_payments/models/error_o_auth_unauthorized_attributes.rb

@@ -0,0 +1,213 @@
+=begin
+#Payments-VPN
+
+#Esta API fornece os serviços de pagamento do Banco do Brasil.
+
+OpenAPI spec version: 3.5
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.24
+=end
+
+require 'date'
+
+module BancoBrasilPayments
+  # Atributos de erro.
+  class ErrorOAuthUnauthorizedAttributes
+    # Mensagem de erro.
+    attr_accessor :error
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error' => :'error'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'error' => :'Object'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+  
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `BancoBrasilPayments::ErrorOAuthUnauthorizedAttributes` 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::ErrorOAuthUnauthorizedAttributes`. 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?(:'error')
+        self.error = attributes[:'error']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @error.nil?
+        invalid_properties.push('invalid value for "error", error cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @error.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          error == o.error
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [error].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # 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
+    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  end
+end

data/lib/bb_payments/models/find_batch_payment.rb

@@ -0,0 +1,93 @@
+module BancoBrasilPayments
+  # Objeto de Requisição quando da solicitação para efetuar pagamentos em lote via Transferência PIX.
+  class FindBatchPayment < BaseModel
+    # Número único gerado pelo Banco. 
+    # Deve ser utilizado pelo Cliente Conveniado para efetivar consultas posteriores ao lançamento.
+    attr_accessor :payment_id # identificadorPagamento |	integer($int64)
+
+    # Data em que deverá ser efetuado o pagamento ao favorecido.
+    attr_accessor :payment_date # dataPagamento	| integer($int32) | example: 17042020
+
+    # Valor do Pagamento que deverá ser efetuada a crédito do favorecido.
+    attr_accessor :payment_value # valorPagamento	| number($double) | example: 4000.75 
+
+    # A modalidade que representa a maneira como o crédito foi dado, descrito a seguir: 
+    # 1 significa Crédito em Conta Corrente; 3 significa DOC ou TED; 5 significa Crédito em Conta Poupança; 
+    # 13 significa Liquidação de Guia com Código de Barra; 21 significa Liquidação de Guia sem Código de Barra; 
+    # 30 significa Liquidação de Boleto Bancário; 31 significa Liquidação de Papéis Diversos; 
+    # 71 significa Depósito Judicial.
+    attr_accessor :credit_type # tipoCredito |	integer($int32)
+
+    # Identification of Individual or Corporate Taxpayer Registration with the Federal Revenue Service;   CPF ou CNPJ do beneficiário no pagamento
+    attr_accessor :beneficiary_kind # tipoBeneficiario	| integer($int32)
+    
+    # É o Nº CPF ou um Nº de CNPJ do Favorecido/Beneficiario do pagamento informado no envio do lançamento na requisição
+    attr_accessor :taxpayer_registration # cpfCnpjBeneficiario	| integer($int64)
+
+    # Nome da pessoa ou empresa beneficiária no pagamento
+    attr_accessor :beneficiary_name # nomeBeneficiario |	string
+
+    # 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)horário de processamento,
+    # PAGO - Pagamento realizado ao Favorecido,
+    # 
+    # REJEITADO - Dados do Favorecido inválidos, o que impede a efetivação do pagamento. Dados precisam ser corrigidos e reenviados,
+    # 
+    # DEVOLVIDO - Pagamento efetuado e posteriormente devolvido pelo Favorecido/Banco destinatário,
+    # 
+    # VENCIDO - Pagamento não efetuado na data indicada,
+    # 
+    # CANCELADO - Pagamento cancelado pelo Pagador antes da data de efetivação do crédito.
+    attr_accessor :payment_status # estadoPagamento	| string
+
+    # Campo de uso livre pelo Cliente Conveniado - sem tratamento pelo Banco.
+    attr_accessor :payment_description # descricaoPagamento	| string
+
+    # Códigos de erros a serem verificados para correção dos dados e reenvio em novo lançamento. 
+    # Quando ""0"" significa que não há erros de formatação nos dados.
+    attr_accessor :error_codes_list # erros	| array
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        payment_id: :identificadorPagamento,
+        payment_date: :dataPagamento,
+        payment_value: :valorPagamento,
+        credit_type: :tipoCredito,
+        beneficiary_kind: :tipoBeneficiario,
+        taxpayer_registration: :cpfCnpjBeneficiario,
+        beneficiary_name: :nomeBeneficiario,
+        payment_status: :estadoPagamento,
+        payment_description: :descricaoPagamento,
+        error_codes_list: :erros
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        payment_id: :Integer,
+        payment_date: :NumberDate,
+        payment_value: :Float,
+        credit_type: :Integer,
+        beneficiary_kind: :Integer,
+        taxpayer_registration: :String,
+        beneficiary_name: :String,
+        payment_status: :String,
+        payment_description: :String,
+        error_codes_list: :Object
+      }
+    end
+  end
+end

data/lib/bb_payments/models/find_batch_response.rb

@@ -0,0 +1,71 @@
+module BancoBrasilPayments
+  # Objeto de Requisição quando da solicitação para efetuar pagamentos em lote via Transferência PIX.
+  class FindBatchResponse < BaseModel
+    # Posição do índice. Cada resposta tem um limite de 300 ocorrências na lista paymentList, 
+    # iniciada a partir do valor do índice fornecido. Para todas as ocorrências, itere sobre esse recurso.
+    attr_accessor :next_index # indice ||	integer($int64)
+
+    # Código que identifica o estado da solicitação. 
+    # 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.
+    # A 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.
+    attr_accessor :request_status # estadoRequisicao	|| integer($int32)
+
+    # Informado pela API de acordo com o endpoint utilizado pelo cliente. 
+    # Pode ser: 126=Pagamento a Fornecedores; 127=Pagamento de Salários; 128=Pagamentos Diversos.
+    attr_accessor :payment_type # tipoPagamento	|| integer($int32)
+
+    # Data em que o cliente enviou ao Banco a requisição de pagamento em lote.
+    attr_accessor :request_date # dataRequisicao | integer($int32) || example: 16042020
+
+    # Quantidade total de Pagamentos
+    attr_accessor :payments_total_quantity # quantidadePagamentos | integer($int64)
+
+    # Valor total dos Pagamentos.
+    attr_accessor :payments_total_value # valorPagamentos | 	number($double)
+
+    # Lista de pagamentos a serem processados em lote. Não permitido mais de 500 registros.
+    attr_accessor :payments_list # pagamentos | array
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        next_index: :indice,
+        request_status: :estadoRequisicao,
+        payment_type: :tipoPagamento,
+        request_date: :dataRequisicao,
+        payments_total_quantity: :quantidadePagamentos,
+        payments_total_value: :valorPagamentos,
+        payments_list: :pagamentos
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        next_index: :Integer,
+        request_status: :Integer,
+        payment_type: :Integer,
+        request_date: :NumberDate,
+        payments_total_quantity: :Integer,
+        payments_total_value: :Float,
+        payments_list: 'Array<FindBatchPayment>'
+      }
+    end
+  end
+end