pier-sdk-ruby 1.0.0

data/README.md

@@ -0,0 +1,141 @@
+# pier-sdk-ruby
+
+Pier - the Ruby gem for the CaaS - Conductor as a Service
+
+Gest\u00C3\u00A3o de pagamento eletr\u00C3\u00B4nicos como servi\u00C3\u00A7o
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 0.0.1
+- Package version: 1.0.0
+- Build date: 2016-05-19T15:36:51.481-03:00
+- Build package: class io.swagger.codegen.languages.RubyClientCodegen
+For more information, please visit [http://www.conductor.com.br](http://www.conductor.com.br)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build pier-sdk-ruby.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./pier-sdk-ruby-1.0.0.gem
+```
+(for development, run `gem install --dev ./pier-sdk-ruby-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'pier-sdk-ruby', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:
+
+    gem 'pier-sdk-ruby', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```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::CartaoApi.new
+
+id_conta = 56 # Integer | ID da Conta
+
+id_cartao = 56 # Integer | ID do Cart\u00C3\u00A3o que deseja cancelar
+
+motivo = 56 # Integer | Motivo do bloqueio
+
+opts = { 
+  observacao: "observacao_example" # String | Alguma observa\u00C3\u00A7\u00C3\u00A3o para o bloqueio
+}
+
+begin
+  #/contas/{idConta}/cartoes/{idCartao}/bloquear
+  result = api_instance.bloquear_cartao_using_post(id_conta, id_cartao, motivo, opts)
+  p result
+rescue Pier::ApiError => e
+  puts "Exception when calling CartaoApi->bloquear_cartao_using_post: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://localhost/*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*Pier::CartaoApi* | [**bloquear_cartao_using_post**](docs/CartaoApi.md#bloquear_cartao_using_post) | **POST** /v1/contas/{idConta}/cartoes/{idCartao}/bloquear | /contas/{idConta}/cartoes/{idCartao}/bloquear
+*Pier::CartaoApi* | [**consultar_cartao_using_get**](docs/CartaoApi.md#consultar_cartao_using_get) | **GET** /v1/contas/{idConta}/cartoes/{idCartao} | /contas/{idConta}/cartoes/{idCartao}
+*Pier::CartaoApi* | [**consultar_cartoes_using_get**](docs/CartaoApi.md#consultar_cartoes_using_get) | **GET** /v1/contas/{idConta}/cartoes | /contas/{idConta}/cartoes
+*Pier::CartaoApi* | [**desbloquear_cartao_using_post**](docs/CartaoApi.md#desbloquear_cartao_using_post) | **POST** /v1/contas/{idConta}/cartoes/{idCartao}/desbloquear | /contas/{idConta}/cartoes/{idCartao}/desbloquear
+*Pier::ContaApi* | [**buscar_conta_using_get**](docs/ContaApi.md#buscar_conta_using_get) | **GET** /v1/contas/buscar | /contas/buscar
+*Pier::ContaApi* | [**consultar_conta_using_get**](docs/ContaApi.md#consultar_conta_using_get) | **GET** /v1/contas/{idConta} | /contas/{idConta}
+*Pier::ContaApi* | [**consultar_extrato_faturas_using_get**](docs/ContaApi.md#consultar_extrato_faturas_using_get) | **GET** /v1/contas/{idConta}/faturas | /contas/{idConta}/faturas
+*Pier::ContaApi* | [**consultar_saldos_limites_using_get**](docs/ContaApi.md#consultar_saldos_limites_using_get) | **GET** /v1/contas/{idConta}/limites | /contas/{idConta}/limites
+*Pier::TokenApi* | [**callback_using_post**](docs/TokenApi.md#callback_using_post) | **POST** /v1/tokens/callback | /tokens/callback
+*Pier::TokenApi* | [**validar_using_post**](docs/TokenApi.md#validar_using_post) | **POST** /v1/tokens/validar | /tokens/validar
+
+
+## Documentation for Models
+
+ - [Pier::AuthToken](docs/AuthToken.md)
+ - [Pier::BodyAccessToken](docs/BodyAccessToken.md)
+ - [Pier::CancelarCartaoResponse](docs/CancelarCartaoResponse.md)
+ - [Pier::CartaoResponse](docs/CartaoResponse.md)
+ - [Pier::ConsultarCartaoResponse](docs/ConsultarCartaoResponse.md)
+ - [Pier::ConsultarContaCartaoResponse](docs/ConsultarContaCartaoResponse.md)
+ - [Pier::ConsultarContaResponse](docs/ConsultarContaResponse.md)
+ - [Pier::ConsultarExtratoContaResponse](docs/ConsultarExtratoContaResponse.md)
+ - [Pier::ConsultarSaldoLimitesResponse](docs/ConsultarSaldoLimitesResponse.md)
+ - [Pier::ContaCartaoResponse](docs/ContaCartaoResponse.md)
+ - [Pier::ContaResponse](docs/ContaResponse.md)
+ - [Pier::DesbloquearCartaoResponse](docs/DesbloquearCartaoResponse.md)
+ - [Pier::ExtraInfo](docs/ExtraInfo.md)
+ - [Pier::ExtratoResponse](docs/ExtratoResponse.md)
+ - [Pier::PessoaFisicaResponse](docs/PessoaFisicaResponse.md)
+ - [Pier::SaldoLimiteResponse](docs/SaldoLimiteResponse.md)
+
+
+## Documentation for Authorization
+
+
+### access_token
+
+- **Type**: API key
+- **API key parameter name**: access_token
+- **Location**: HTTP header
+
+### client_id
+
+- **Type**: API key
+- **API key parameter name**: client_id
+- **Location**: HTTP header
+

data/docs/AuthToken.md

@@ -0,0 +1,12 @@
+# Pier::AuthToken
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** |  | [optional] 
+**extra_info** | [**ExtraInfo**](ExtraInfo.md) |  | [optional] 
+**id** | **Integer** |  | [optional] 
+**owner** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+
+

data/docs/BodyAccessToken.md

@@ -0,0 +1,10 @@
+# Pier::BodyAccessToken
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**auth_token** | [**AuthToken**](AuthToken.md) |  | [optional] 
+**action** | **String** |  | [optional] 
+**user** | **String** |  | [optional] 
+
+

data/docs/CancelarCartaoResponse.md

@@ -0,0 +1,11 @@
+# Pier::CancelarCartaoResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**codigo_retorno** | **Integer** |  | [optional] 
+**descricao_retorno** | **String** |  | [optional] 
+**id_cartao** | **Integer** |  | [optional] 
+**id_conta** | **Integer** |  | [optional] 
+
+

data/docs/CartaoApi.md

@@ -0,0 +1,252 @@
+# Pier::CartaoApi
+
+All URIs are relative to *https://localhost/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**bloquear_cartao_using_post**](CartaoApi.md#bloquear_cartao_using_post) | **POST** /v1/contas/{idConta}/cartoes/{idCartao}/bloquear | /contas/{idConta}/cartoes/{idCartao}/bloquear
+[**consultar_cartao_using_get**](CartaoApi.md#consultar_cartao_using_get) | **GET** /v1/contas/{idConta}/cartoes/{idCartao} | /contas/{idConta}/cartoes/{idCartao}
+[**consultar_cartoes_using_get**](CartaoApi.md#consultar_cartoes_using_get) | **GET** /v1/contas/{idConta}/cartoes | /contas/{idConta}/cartoes
+[**desbloquear_cartao_using_post**](CartaoApi.md#desbloquear_cartao_using_post) | **POST** /v1/contas/{idConta}/cartoes/{idCartao}/desbloquear | /contas/{idConta}/cartoes/{idCartao}/desbloquear
+
+
+# **bloquear_cartao_using_post**
+> CancelarCartaoResponse bloquear_cartao_using_post(id_conta, id_cartao, motivo, opts)
+
+/contas/{idConta}/cartoes/{idCartao}/bloquear
+
+Bloquear um determinado cart\u00C3\u00A3o
+
+### 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::CartaoApi.new
+
+id_conta = 56 # Integer | ID da Conta
+
+id_cartao = 56 # Integer | ID do Cart\u00C3\u00A3o que deseja cancelar
+
+motivo = 56 # Integer | Motivo do bloqueio
+
+opts = { 
+  observacao: "observacao_example" # String | Alguma observa\u00C3\u00A7\u00C3\u00A3o para o bloqueio
+}
+
+begin
+  #/contas/{idConta}/cartoes/{idCartao}/bloquear
+  result = api_instance.bloquear_cartao_using_post(id_conta, id_cartao, motivo, opts)
+  p result
+rescue Pier::ApiError => e
+  puts "Exception when calling CartaoApi->bloquear_cartao_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id_conta** | **Integer**| ID da Conta | 
+ **id_cartao** | **Integer**| ID do Cart\u00C3\u00A3o que deseja cancelar | 
+ **motivo** | **Integer**| Motivo do bloqueio | 
+ **observacao** | **String**| Alguma observa\u00C3\u00A7\u00C3\u00A3o para o bloqueio | [optional] 
+
+### Return type
+
+[**CancelarCartaoResponse**](CancelarCartaoResponse.md)
+
+### Authorization
+
+[access_token](../README.md#access_token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **consultar_cartao_using_get**
+> ConsultarCartaoResponse consultar_cartao_using_get(id_conta, id_cartao, opts)
+
+/contas/{idConta}/cartoes/{idCartao}
+
+Consultar as informa\u00C3\u00A7\u00C3\u00B5es de um determinado cart\u00C3\u00A3o de uma 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::CartaoApi.new
+
+id_conta = 56 # Integer | ID da Conta que pertence o cart\u00C3\u00A3o
+
+id_cartao = 56 # Integer | ID do Cart\u00C3\u00A3o que deseja consultar
+
+opts = { 
+  numero_cartao: "numero_cartao_example" # String | N\u00C3\u00BAmero do Cart\u00C3\u00A3o que deseja consultar (opcional)
+}
+
+begin
+  #/contas/{idConta}/cartoes/{idCartao}
+  result = api_instance.consultar_cartao_using_get(id_conta, id_cartao, opts)
+  p result
+rescue Pier::ApiError => e
+  puts "Exception when calling CartaoApi->consultar_cartao_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id_conta** | **Integer**| ID da Conta que pertence o cart\u00C3\u00A3o | 
+ **id_cartao** | **Integer**| ID do Cart\u00C3\u00A3o que deseja consultar | 
+ **numero_cartao** | **String**| N\u00C3\u00BAmero do Cart\u00C3\u00A3o que deseja consultar (opcional) | [optional] 
+
+### Return type
+
+[**ConsultarCartaoResponse**](ConsultarCartaoResponse.md)
+
+### Authorization
+
+[access_token](../README.md#access_token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **consultar_cartoes_using_get**
+> ConsultarCartaoResponse consultar_cartoes_using_get(id_conta)
+
+/contas/{idConta}/cartoes
+
+Consultar todos os cart\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::CartaoApi.new
+
+id_conta = 56 # Integer | ID da Conta
+
+
+begin
+  #/contas/{idConta}/cartoes
+  result = api_instance.consultar_cartoes_using_get(id_conta)
+  p result
+rescue Pier::ApiError => e
+  puts "Exception when calling CartaoApi->consultar_cartoes_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id_conta** | **Integer**| ID da Conta | 
+
+### Return type
+
+[**ConsultarCartaoResponse**](ConsultarCartaoResponse.md)
+
+### Authorization
+
+[access_token](../README.md#access_token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **desbloquear_cartao_using_post**
+> DesbloquearCartaoResponse desbloquear_cartao_using_post(id_conta, id_cartao, opts)
+
+/contas/{idConta}/cartoes/{idCartao}/desbloquear
+
+Desbloquear cart\u00C3\u00A3o 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::CartaoApi.new
+
+id_conta = 56 # Integer | ID da Conta
+
+id_cartao = 56 # Integer | ID do Cart\u00C3\u00A3o que deseja consultar o saldo/limite
+
+opts = { 
+  codigo_segurancao: "codigo_segurancao_example" # String | C\u00C3\u00B3digo seguran\u00C3\u00A7a do cart\u00C3\u00A3o
+}
+
+begin
+  #/contas/{idConta}/cartoes/{idCartao}/desbloquear
+  result = api_instance.desbloquear_cartao_using_post(id_conta, id_cartao, opts)
+  p result
+rescue Pier::ApiError => e
+  puts "Exception when calling CartaoApi->desbloquear_cartao_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id_conta** | **Integer**| ID da Conta | 
+ **id_cartao** | **Integer**| ID do Cart\u00C3\u00A3o que deseja consultar o saldo/limite | 
+ **codigo_segurancao** | **String**| C\u00C3\u00B3digo seguran\u00C3\u00A7a do cart\u00C3\u00A3o | [optional] 
+
+### Return type
+
+[**DesbloquearCartaoResponse**](DesbloquearCartaoResponse.md)
+
+### Authorization
+
+[access_token](../README.md#access_token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/CartaoResponse.md

@@ -0,0 +1,29 @@
+# Pier::CartaoResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**bin** | **Integer** |  | [optional] 
+**cod_retorno** | **Integer** |  | [optional] 
+**codigo_desbloqueio** | **String** |  | [optional] 
+**criptografia_hsm** | **String** |  | [optional] 
+**data_emissao** | **DateTime** |  | [optional] 
+**data_validade** | **DateTime** |  | [optional] 
+**data_vencimento_padrao** | **String** |  | [optional] 
+**descricao_retorno** | **String** |  | [optional] 
+**estagio_cartao** | **Integer** |  | [optional] 
+**estagio_data** | **DateTime** |  | [optional] 
+**flag_reversao** | **BOOLEAN** |  | [optional] 
+**flag_senha** | **BOOLEAN** |  | [optional] 
+**id_cartao** | **Integer** |  | [optional] 
+**id_conta** | **Integer** |  | [optional] 
+**id_emissor** | **Integer** |  | [optional] 
+**id_log** | **String** |  | [optional] 
+**id_pessoa_fisica** | **Integer** |  | [optional] 
+**id_produto** | **Integer** |  | [optional] 
+**numero_cartao** | **String** |  | [optional] 
+**numero_cartao_real** | **String** |  | [optional] 
+**status_cartao** | **Integer** |  | [optional] 
+**status_data** | **DateTime** |  | [optional] 
+
+