pier-sdk-ruby 1.0.0

data/docs/ConsultarCartaoResponse.md

@@ -0,0 +1,10 @@
+# Pier::ConsultarCartaoResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cartoes** | [**Array<CartaoResponse>**](CartaoResponse.md) |  | [optional] 
+**codigo_retorno** | **Integer** |  | [optional] 
+**descricao_retorno** | **String** |  | [optional] 
+
+

data/docs/ConsultarContaCartaoResponse.md

@@ -0,0 +1,18 @@
+# Pier::ConsultarContaCartaoResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data_validade** | **String** |  | [optional] 
+**descricao_estagio** | **String** |  | [optional] 
+**descricao_status** | **String** |  | [optional] 
+**estagio** | **Integer** |  | [optional] 
+**flag_cancelamento** | **BOOLEAN** |  | [optional] 
+**id_cartao** | **Integer** |  | [optional] 
+**numero_cartao** | **String** |  | [optional] 
+**portador** | **String** |  | [optional] 
+**portador_id** | **Integer** |  | [optional] 
+**status** | **Integer** |  | [optional] 
+**status_data** | **DateTime** |  | [optional] 
+
+

data/docs/ConsultarContaResponse.md

@@ -0,0 +1,11 @@
+# Pier::ConsultarContaResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cod_retorno** | **Integer** |  | [optional] 
+**codigo_retorno** | **Integer** |  | [optional] 
+**contas** | [**Array<ContaCartaoResponse>**](ContaCartaoResponse.md) |  | [optional] 
+**descricao_retorno** | **String** |  | [optional] 
+
+

data/docs/ConsultarExtratoContaResponse.md

@@ -0,0 +1,23 @@
+# Pier::ConsultarExtratoContaResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**codigo_retorno** | **Integer** |  | [optional] 
+**compras_nacionais** | **Float** |  | [optional] 
+**cpf** | **String** |  | [optional] 
+**creditos_nacionais** | **Float** |  | [optional] 
+**data_vencimento** | **String** |  | [optional] 
+**debitos_nacionais** | **Float** |  | [optional] 
+**descricao_retorno** | **String** |  | [optional] 
+**extrato** | [**Array<ExtratoResponse>**](ExtratoResponse.md) |  | [optional] 
+**id_cartao** | **Integer** |  | [optional] 
+**id_conta** | **Integer** |  | [optional] 
+**multa** | **Float** |  | [optional] 
+**pagamentos** | **Float** |  | [optional] 
+**saldo_atual_final** | **Float** |  | [optional] 
+**saldo_extrato_anterior** | **Float** |  | [optional] 
+**tarifas_nacionais** | **Float** |  | [optional] 
+**valor_minimo_extrato** | **Float** |  | [optional] 
+
+

data/docs/ConsultarSaldoLimitesResponse.md

@@ -0,0 +1,23 @@
+# Pier::ConsultarSaldoLimitesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cod_retorno** | **Integer** |  | [optional] 
+**codigo_retorno** | **Integer** |  | [optional] 
+**descricao_retorno** | **String** |  | [optional] 
+**disponib_compra_nac** | **Float** |  | [optional] 
+**disponib_global_credito** | **Float** |  | [optional] 
+**disponib_parcelado_nac** | **Float** |  | [optional] 
+**disponib_parcelas_nac** | **Float** |  | [optional] 
+**disponib_saque_nac_global** | **Float** |  | [optional] 
+**limite_compra_nac** | **Float** |  | [optional] 
+**limite_global_credito** | **Float** |  | [optional] 
+**limite_parcelado_nac** | **Float** |  | [optional] 
+**limite_parcelas_nac** | **Float** |  | [optional] 
+**limite_saque_nac_global** | **Float** |  | [optional] 
+**limite_saque_nac_periodo** | **Float** |  | [optional] 
+**renda_comprovada** | **Float** |  | [optional] 
+**solicitacao_pendente** | **BOOLEAN** |  | [optional] 
+
+

data/docs/ContaApi.md

@@ -0,0 +1,238 @@
+# Pier::ContaApi
+
+All URIs are relative to *https://localhost/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**buscar_conta_using_get**](ContaApi.md#buscar_conta_using_get) | **GET** /v1/contas/buscar | /contas/buscar
+[**consultar_conta_using_get**](ContaApi.md#consultar_conta_using_get) | **GET** /v1/contas/{idConta} | /contas/{idConta}
+[**consultar_extrato_faturas_using_get**](ContaApi.md#consultar_extrato_faturas_using_get) | **GET** /v1/contas/{idConta}/faturas | /contas/{idConta}/faturas
+[**consultar_saldos_limites_using_get**](ContaApi.md#consultar_saldos_limites_using_get) | **GET** /v1/contas/{idConta}/limites | /contas/{idConta}/limites
+
+
+# **buscar_conta_using_get**
+> ConsultarContaResponse buscar_conta_using_get(opts)
+
+/contas/buscar
+
+Consulte contas filtrando pelos campos id do emissor, n\u00C3\u00BAmero do cart\u00C3\u00A3o, nome ou CPF/CNPJ 
+
+### Example
+```ruby
+# load the gem
+require 'pier-sdk-ruby'
+# setup authorization 
+Pier.configure do |config|
+  # Configure API key authorization: access_token
+  config.api_key['access_token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'BEARER' (defaults to nil)
+  #config.api_key_prefix['access_token'] = 'BEARER'
+end
+
+api_instance = Pier::ContaApi.new
+
+opts = { 
+  nome: "nome_example", # String | Nome
+  cpf: "cpf_example", # String | CPF (opcional caso nao informe o n\u00C3\u00BAmero do cart\u00C3\u00A3o ou id da conta)
+  numero_cartao: "numero_cartao_example", # String | N\u00C3\u00BAmero do cart\u00C3\u00A3o (opcional caso n\u00C3\u00A3o informa o cpf ou id da conta)
+  id_conta: 789 # Integer | ID da Conta (opcional caso n\u00C3\u00A3o informe o n\u00C3\u00BAmero do cart\u00C3\u00A3o ou cpf)
+}
+
+begin
+  #/contas/buscar
+  result = api_instance.buscar_conta_using_get(opts)
+  p result
+rescue Pier::ApiError => e
+  puts "Exception when calling ContaApi->buscar_conta_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **nome** | **String**| Nome | [optional] 
+ **cpf** | **String**| CPF (opcional caso nao informe o n\u00C3\u00BAmero do cart\u00C3\u00A3o ou id da conta) | [optional] 
+ **numero_cartao** | **String**| N\u00C3\u00BAmero do cart\u00C3\u00A3o (opcional caso n\u00C3\u00A3o informa o cpf ou id da conta) | [optional] 
+ **id_conta** | **Integer**| ID da Conta (opcional caso n\u00C3\u00A3o informe o n\u00C3\u00BAmero do cart\u00C3\u00A3o ou cpf) | [optional] 
+
+### Return type
+
+[**ConsultarContaResponse**](ConsultarContaResponse.md)
+
+### Authorization
+
+[access_token](../README.md#access_token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **consultar_conta_using_get**
+> ContaResponse consultar_conta_using_get(id_conta)
+
+/contas/{idConta}
+
+Consulte informa\u00C3\u00A7\u00C3\u00B5es de uma determinada conta
+
+### Example
+```ruby
+# load the gem
+require 'pier-sdk-ruby'
+# setup authorization 
+Pier.configure do |config|
+  # Configure API key authorization: access_token
+  config.api_key['access_token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'BEARER' (defaults to nil)
+  #config.api_key_prefix['access_token'] = 'BEARER'
+end
+
+api_instance = Pier::ContaApi.new
+
+id_conta = 56 # Integer | ID da Conta
+
+
+begin
+  #/contas/{idConta}
+  result = api_instance.consultar_conta_using_get(id_conta)
+  p result
+rescue Pier::ApiError => e
+  puts "Exception when calling ContaApi->consultar_conta_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id_conta** | **Integer**| ID da Conta | 
+
+### Return type
+
+[**ContaResponse**](ContaResponse.md)
+
+### Authorization
+
+[access_token](../README.md#access_token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **consultar_extrato_faturas_using_get**
+> ConsultarExtratoContaResponse consultar_extrato_faturas_using_get(id_conta, data_vencimento)
+
+/contas/{idConta}/faturas
+
+Consulte os extratos/faturas de uma determinada conta
+
+### Example
+```ruby
+# load the gem
+require 'pier-sdk-ruby'
+# setup authorization 
+Pier.configure do |config|
+  # Configure API key authorization: access_token
+  config.api_key['access_token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'BEARER' (defaults to nil)
+  #config.api_key_prefix['access_token'] = 'BEARER'
+end
+
+api_instance = Pier::ContaApi.new
+
+id_conta = 56 # Integer | ID da Conta
+
+data_vencimento = "data_vencimento_example" # String | Data limite para o vencimento das transa\u00C3\u00A7\u00C3\u00B5es
+
+
+begin
+  #/contas/{idConta}/faturas
+  result = api_instance.consultar_extrato_faturas_using_get(id_conta, data_vencimento)
+  p result
+rescue Pier::ApiError => e
+  puts "Exception when calling ContaApi->consultar_extrato_faturas_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id_conta** | **Integer**| ID da Conta | 
+ **data_vencimento** | **String**| Data limite para o vencimento das transa\u00C3\u00A7\u00C3\u00B5es | 
+
+### Return type
+
+[**ConsultarExtratoContaResponse**](ConsultarExtratoContaResponse.md)
+
+### Authorization
+
+[access_token](../README.md#access_token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **consultar_saldos_limites_using_get**
+> ConsultarSaldoLimitesResponse consultar_saldos_limites_using_get(id_conta)
+
+/contas/{idConta}/limites
+
+Consulte os limites de uma determinada conta
+
+### Example
+```ruby
+# load the gem
+require 'pier-sdk-ruby'
+# setup authorization 
+Pier.configure do |config|
+  # Configure API key authorization: access_token
+  config.api_key['access_token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'BEARER' (defaults to nil)
+  #config.api_key_prefix['access_token'] = 'BEARER'
+end
+
+api_instance = Pier::ContaApi.new
+
+id_conta = 56 # Integer | ID da Conta
+
+
+begin
+  #/contas/{idConta}/limites
+  result = api_instance.consultar_saldos_limites_using_get(id_conta)
+  p result
+rescue Pier::ApiError => e
+  puts "Exception when calling ContaApi->consultar_saldos_limites_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id_conta** | **Integer**| ID da Conta | 
+
+### Return type
+
+[**ConsultarSaldoLimitesResponse**](ConsultarSaldoLimitesResponse.md)
+
+### Authorization
+
+[access_token](../README.md#access_token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/ContaCartaoResponse.md

@@ -0,0 +1,21 @@
+# Pier::ContaCartaoResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cnpj_loja** | **String** |  | [optional] 
+**cpf** | **String** |  | [optional] 
+**data_cadastro_conta** | **String** |  | [optional] 
+**data_emissao_identidade** | **String** |  | [optional] 
+**data_nascimento** | **String** |  | [optional] 
+**ddd_celular** | **String** |  | [optional] 
+**id_conta** | **Integer** |  | [optional] 
+**nome** | **String** |  | [optional] 
+**numero_celular** | **String** |  | [optional] 
+**numero_identidade** | **String** |  | [optional] 
+**orgao_identidade** | **String** |  | [optional] 
+**possui_compra_aprovada** | **String** |  | [optional] 
+**status_conta** | **Integer** |  | [optional] 
+**uf_identidade** | **String** |  | [optional] 
+
+

data/docs/ContaResponse.md

@@ -0,0 +1,41 @@
+# Pier::ContaResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**bin** | **Integer** |  | [optional] 
+**cartao** | [**ConsultarContaCartaoResponse**](ConsultarContaCartaoResponse.md) |  | [optional] 
+**data_cadastramento** | **String** |  | [optional] 
+**data_ultimo_pagamento** | **String** |  | [optional] 
+**data_venc_cobranca** | **String** |  | [optional] 
+**dddcelular_sms** | **String** |  | [optional] 
+**descricao_status** | **String** |  | [optional] 
+**dias_em_atraso** | **Integer** |  | [optional] 
+**emissor** | **String** |  | [optional] 
+**flag_cancelamento** | **BOOLEAN** |  | [optional] 
+**forma_envio_fatura** | **String** |  | [optional] 
+**id_bandeira** | **Integer** |  | [optional] 
+**id_conta** | **Integer** |  | [optional] 
+**id_emissor** | **Integer** |  | [optional] 
+**id_endereco** | **Integer** |  | [optional] 
+**id_fantasia_basica** | **Integer** |  | [optional] 
+**id_origem_comercial** | **Integer** |  | [optional] 
+**id_produto** | **Integer** |  | [optional] 
+**id_proposta** | **Integer** |  | [optional] 
+**melhor_dia** | **Integer** |  | [optional] 
+**nome_credor** | **String** |  | [optional] 
+**nome_produto** | **String** |  | [optional] 
+**num_celular_sms** | **String** |  | [optional] 
+**pagamentos** | **Float** |  | [optional] 
+**permite_refinanciamento** | **BOOLEAN** |  | [optional] 
+**pessoa_fisica** | [**PessoaFisicaResponse**](PessoaFisicaResponse.md) |  | [optional] 
+**quantidade_pagamentos** | **Integer** |  | [optional] 
+**saldo_limite** | [**SaldoLimiteResponse**](SaldoLimiteResponse.md) |  | [optional] 
+**status** | **Integer** |  | [optional] 
+**status_data** | **DateTime** |  | [optional] 
+**taxa_refinanciamento** | **String** |  | [optional] 
+**vcto** | **String** |  | [optional] 
+**vencimento1** | **Integer** |  | [optional] 
+**vinculo_origem_usuario** | **BOOLEAN** |  | [optional] 
+
+

data/docs/DesbloquearCartaoResponse.md

@@ -0,0 +1,9 @@
+# Pier::DesbloquearCartaoResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**codigo_retorno** | **Integer** |  | [optional] 
+**descricao_retorno** | **String** |  | [optional] 
+
+

data/docs/ExtraInfo.md

@@ -0,0 +1,8 @@
+# Pier::ExtraInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id_emissor** | **Integer** |  | [optional] 
+
+

data/docs/ExtratoResponse.md

@@ -0,0 +1,35 @@
+# Pier::ExtratoResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cartao** | **String** |  | [optional] 
+**chip** | **String** |  | [optional] 
+**cidade_uf_pais** | **String** |  | [optional] 
+**codigo_autorizacao** | **String** |  | [optional] 
+**codigo_moeda** | **String** |  | [optional] 
+**codigo_moeda_destino** | **String** |  | [optional] 
+**cotacao_dolar** | **Float** |  | [optional] 
+**credito** | **Float** |  | [optional] 
+**data_compra** | **String** |  | [optional] 
+**data_cotacao_dolar** | **DateTime** |  | [optional] 
+**data_entrada_compra** | **String** |  | [optional] 
+**data_transacao_utc** | **String** |  | [optional] 
+**debito** | **Float** |  | [optional] 
+**descricao_modo_entrada** | **String** |  | [optional] 
+**descricao_transacao** | **String** |  | [optional] 
+**encargos_financeiros** | **Float** |  | [optional] 
+**historico** | **String** |  | [optional] 
+**id_evento_externo** | **Integer** |  | [optional] 
+**id_tipo_transacao** | **Integer** |  | [optional] 
+**id_transacao** | **Integer** |  | [optional] 
+**mcc** | **Integer** |  | [optional] 
+**nome_estab_visa** | **String** |  | [optional] 
+**nome_plastico** | **String** |  | [optional] 
+**numero_estabelecimento** | **Integer** |  | [optional] 
+**origem** | **String** |  | [optional] 
+**taxa_embarque** | **Float** |  | [optional] 
+**tipo_evento** | **String** |  | [optional] 
+**valor_dolar** | **Float** |  | [optional] 
+
+