bb_payments 0.1.1

data/lib/bb_payments/configuration.rb

@@ -0,0 +1,246 @@
+=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
+
+module BancoBrasilPayments
+  class Configuration
+    # Defines url scheme
+    attr_accessor :scheme
+
+    # Defines url host
+    attr_accessor :host
+
+    # Defines url for oauth
+    attr_accessor :oauth_host
+
+    # Defines url base path
+    attr_accessor :base_path
+
+    # Defines API keys used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: parameter value (API key)
+    #
+    # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
+    #   config.api_key['api_key'] = 'xxx'
+    attr_accessor :api_key
+
+    # Defines API key prefixes used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: API key prefix
+    #
+    # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
+    #   config.api_key_prefix['api_key'] = 'Token'
+    attr_accessor :api_key_prefix
+
+    # Chave de acesso do aplicativo do desenvolvedor.
+    # Esta chave é única e obtida no Portal “BB for Developers”
+    # Usada para identificar as requisições da aplicação do desenvolvedor.
+    attr_accessor :gw_app_key
+
+    # Defines the username used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :username
+
+    # Defines the password used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :password
+
+    # Defines the access token (Bearer) used with OAuth2.
+    attr_accessor :access_token
+
+    # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
+    # details will be logged with `logger.debug` (see the `logger` attribute).
+    # Default to false.
+    #
+    # @return [true, false]
+    attr_accessor :debugging
+
+    # Defines the logger used for debugging.
+    # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
+    #
+    # @return [#debug]
+    attr_accessor :logger
+
+    # Defines the temporary folder to store downloaded files
+    # (for API endpoints that have file response).
+    # Default to use `Tempfile`.
+    #
+    # @return [String]
+    attr_accessor :temp_folder_path
+
+    # The time limit for HTTP request in seconds.
+    # Default to 0 (never times out).
+    attr_accessor :timeout
+
+    # Set this to false to skip client side validation in the operation.
+    # Default to true.
+    # @return [true, false]
+    attr_accessor :client_side_validation
+
+    ### TLS/SSL setting
+    # Set this to false to skip verifying SSL certificate when calling API from https server.
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :verify_ssl
+
+    ### TLS/SSL setting
+    # Set this to false to skip verifying SSL host name
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :verify_ssl_host
+
+    ### TLS/SSL setting
+    # Set this to customize the certificate file to verify the peer.
+    #
+    # @return [String] the path to the certificate file
+    #
+    # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
+    # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
+    attr_accessor :ssl_ca_cert
+
+    ### TLS/SSL setting
+    # Client certificate file (for client certificate)
+    attr_accessor :cert_file
+
+    ### TLS/SSL setting
+    # Client private key file (for client certificate)
+    attr_accessor :key_file
+
+    ### TLS/SSL setting
+    # Client private key passphrase (for client certificate)
+    attr_accessor :ssl_key_passwd
+
+    # Set this to customize parameters encoding of array parameter with multi collectionFormat.
+    # Default to nil.
+    #
+    # @see The params_encoding option of Ethon. Related source code:
+    # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
+    attr_accessor :params_encoding
+
+    attr_accessor :inject_format
+
+    attr_accessor :force_ending_format
+
+    attr_accessor :access_token_scopes
+
+    attr_accessor :app_key_name
+
+    def initialize
+      @scheme = 'https'
+      @app_key_name = 'gw-app-key'
+      @host = 'api-ip.bb.com.br'
+      @oauth_host = 'oauth.bb.com.br'
+      @base_path = 'pagamentos-lote/v1'
+      @api_key = {}
+      @api_key_prefix = {}
+      @timeout = 0
+      @client_side_validation = true
+      @verify_ssl = true
+      @verify_ssl_host = true
+      @params_encoding = nil
+      @cert_file = nil
+      @key_file = nil
+      @debugging = false
+      @inject_format = false
+      @force_ending_format = false
+      @logger = defined?(Jets) ? Jets.logger : Logger.new(STDOUT)
+      @access_token_scopes = 'payments.transfers-info payments.transfer-batch-request '\
+                             'pagamentos-lote.lotes-requisicao pagamentos-lote.lotes-info '\
+                             'pagamentos-lote.transferencias-pix-info pagamentos-lote.transferencias-pix-requisicao '\
+                             'pagamentos-lote.cancelar-requisicao pagamentos-lote.transferencias-requisicao'
+
+      yield(self) if block_given?
+    end
+
+    def client_credentials_api
+      @client_credentials_api ||= BancoBrasilClientCredentials::ApiClient.new oauth_config
+    end
+
+    def oauth_config
+      oauth_config = BancoBrasilClientCredentials::Configuration.new
+      oauth_config.host = oauth_host
+      oauth_config.base_path = ''
+      oauth_config.logger = logger
+      oauth_config.debugging = debugging
+      oauth_config.verify_ssl = verify_ssl
+      oauth_config.verify_ssl_host = verify_ssl_host
+      oauth_config.access_token = access_token
+      oauth_config.username = username
+      oauth_config.password = password
+      oauth_config.ssl_ca_cert = ssl_ca_cert
+      oauth_config
+    end
+
+    # The default Configuration object.
+    def self.default
+      @@default ||= Configuration.new
+    end
+
+    def configure
+      yield(self) if block_given?
+    end
+
+    def scheme=(scheme)
+      # remove :// from scheme
+      @scheme = scheme.sub(/:\/\//, '')
+    end
+
+    def host=(host)
+      # remove http(s):// and anything after a slash
+      @host = host.sub(/https?:\/\//, '').split('/').first
+    end
+
+    def base_path=(base_path)
+      # Add leading and trailing slashes to base_path
+      @base_path = "/#{base_path}".gsub(/\/+/, '/')
+      @base_path = '' if @base_path == '/'
+    end
+
+    def base_url(base_path)
+      "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+    end
+
+    # Gets API key (with prefix if set).
+    # @param [String] param_name the parameter name of API key auth
+    def api_key_with_prefix(param_name)
+      if @api_key_prefix[param_name]
+        "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
+      else
+        @api_key[param_name]
+      end
+    end
+
+    # Gets Basic Auth token string
+    def basic_auth_token
+      'Basic ' + Base64.encode64("#{username}:#{password}").delete("\r\n")
+    end
+
+    # Returns Auth Settings hash for api client.
+    def auth_settings
+      {
+        'OAuth2-CC' =>
+          {
+            type: 'oauth2',
+            in: 'header',
+            key: 'Authorization',
+            value: "Bearer #{access_token}"
+          },
+      }
+    end
+  end
+end

data/lib/bb_payments/models/base_model.rb

@@ -0,0 +1,177 @@
+require 'date'
+
+module BancoBrasilPayments
+  # Representação dos campos de uma solicitação de transferência em lote.
+  class BaseModel
+    
+    # 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 `#{self.class.name}` 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 `#{self.class.name}`."\
+                              ' 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
+      }
+
+      attributes.each { |key, value| self.send("#{key}=", value) }
+    end
+
+    def list_invalid_properties
+      Array.new      
+    end
+    
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      list_invalid_properties.empty?
+    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 && self.class.attribute_map.keys.all? {|attr| self.send(attr) == o.send(attr) }
+    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
+      self.class.attribute_map.keys.map {|attr| self.send(attr) }.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 :NumberDate
+        Date.strptime(value.to_s.rjust(8, '0'), '%d%m%Y')
+      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/batch_pix_body.rb

@@ -0,0 +1,30 @@
+module BancoBrasilPayments
+  # Objeto de Requisição quando da solicitação para efetuar pagamentos em lote via Transferência PIX.
+  class BatchPixBody < Body    
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        request_identification: :numeroRequisicao,
+        payment_contract: :numeroContrato,
+        debit_branch_office: :agenciaDebito,
+        debit_current_account: :contaCorrenteDebito,
+        check_digits_debit_current_account: :digitoVerificadorContaCorrente,
+        payment_type: :tipoPagamento,
+        payments_list: :listaTransferencias
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        request_identification: :Integer,
+        payment_contract: :Integer,
+        debit_branch_office: :Integer,
+        debit_current_account: :Integer,
+        check_digits_debit_current_account: :String,
+        payment_type: :Integer,
+        payments_list: :'Array<TransferPixBase>'
+      }
+    end
+  end
+end

data/lib/bb_payments/models/batch_pix_response.rb

@@ -0,0 +1,69 @@
+module BancoBrasilPayments
+  # Objeto de Requisição quando da solicitação para efetuar pagamentos em lote via Transferência PIX.
+  class BatchPixResponse < BaseModel
+
+    # Identificador da requisição de pagamento em lote. Valor do identificador é controlado pelo cliente.
+    attr_accessor :request_identification
+
+    # 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.
+    # 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
+
+    # Quantidade total dos lançamentos enviados para pagamento.
+    attr_accessor :payments_total_quantity
+
+    # Valor total dos lançamentos enviados para pagamento.
+    attr_accessor :payments_total_value
+
+    # Quantidade total de lançamentos válidos.
+    attr_accessor :valid_payments_total_quantity
+
+    # Valor total dos lançamentos válidos.
+    attr_accessor :valid_payments_total_value
+
+    # Lista de transferências enviada. Os campos desta lista dizem respeito a crédito a determinado beneficiário.
+    attr_accessor :payments_list
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        request_identification: :numeroRequisicao,
+        request_status: :estadoRequisicao,
+        payments_total_quantity: :quantidadeTransferencias,
+        payments_total_value: :valorTransferencias,
+        valid_payments_total_quantity: :quantidadeTransferenciasValidas,
+        valid_payments_total_value: :valorTransferenciasValidas,
+        payments_list: :listaTransferencias
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        request_identification: :Integer,
+        request_status: :Integer,
+        payments_total_quantity: :Integer,
+        payments_total_value: :Float,
+        valid_payments_total_quantity: :String,
+        valid_payments_total_value: :Float,
+        payments_list: :'Array<TransferPix>'
+      }
+    end
+  end
+end

data/lib/bb_payments/models/batch_transfers_body.rb

@@ -0,0 +1,30 @@
+module BancoBrasilPayments
+  # Objeto de Requisição quando da solicitação para efetuar pagamentos em lote via Transferência PIX.
+  class BatchTransfersBody < Body
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        request_identification: :numeroRequisicao,
+        payment_contract: :numeroContratoPagamento,
+        debit_branch_office: :agenciaDebito,
+        debit_current_account: :contaCorrenteDebito,
+        check_digits_debit_current_account: :digitoVerificadorContaCorrente,
+        payment_type: :tipoPagamento,
+        payments_list: :listaTransferencias
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        request_identification: :Integer,
+        payment_contract: :Integer,
+        debit_branch_office: :Integer,
+        debit_current_account: :Integer,
+        check_digits_debit_current_account: :String,
+        payment_type: :Integer,
+        payments_list: :'Array<TransferBase>'
+      }
+    end
+  end
+end

data/lib/bb_payments/models/batch_transfers_response.rb

@@ -0,0 +1,64 @@
+module BancoBrasilPayments
+  # Objeto de Requisição quando da solicitação para efetuar pagamentos em lote via Transferência PIX.
+  class BatchTransfersResponse < BaseModel
+
+    # 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.
+    # 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
+
+    # Quantidade total dos lançamentos enviados para pagamento.
+    attr_accessor :payments_total_quantity
+
+    # Valor total dos lançamentos enviados para pagamento.
+    attr_accessor :payments_total_value
+
+    # Quantidade total de lançamentos válidos.
+    attr_accessor :valid_payments_total_quantity
+
+    # Valor total dos lançamentos válidos.
+    attr_accessor :valid_payments_total_value
+
+    # Lista de transferências enviada. Os campos desta lista dizem respeito a crédito a determinado beneficiário.
+    attr_accessor :payments_list
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        request_status: :estadoRequisicao,
+        payments_total_quantity: :quantidadeTransferencias,
+        payments_total_value: :valorTransferencias,
+        valid_payments_total_quantity: :quantidadeTransferenciasValidas,
+        valid_payments_total_value: :valorTransferenciasValidas,
+        payments_list: :transferencias
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        request_status: :Integer,
+        payments_total_quantity: :Integer,
+        payments_total_value: :Float,
+        valid_payments_total_quantity: :String,
+        valid_payments_total_value: :Float,
+        payments_list: :'Object'
+      }
+    end
+  end
+end