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 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
Installation
Build a gem
To build the Ruby code into a gem:
gem build pier-sdk-ruby.gemspec
Then either install the gem locally:
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.
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:
ruby -Ilib script.rb
Getting Started
Please follow the installation procedure and then run the following code:
# 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 | POST /v1/contas/idConta/cartoes/idCartao/bloquear | /contas/idConta/cartoes/idCartao/bloquear |
Pier::CartaoApi | consultar_cartao_using_get | GET /v1/contas/idConta/cartoes/idCartao | /contas/idConta/cartoes/idCartao |
Pier::CartaoApi | consultar_cartoes_using_get | GET /v1/contas/idConta/cartoes | /contas/idConta/cartoes |
Pier::CartaoApi | desbloquear_cartao_using_post | POST /v1/contas/idConta/cartoes/idCartao/desbloquear | /contas/idConta/cartoes/idCartao/desbloquear |
Pier::ContaApi | buscar_conta_using_get | GET /v1/contas/buscar | /contas/buscar |
Pier::ContaApi | consultar_conta_using_get | GET /v1/contas/idConta | /contas/idConta |
Pier::ContaApi | consultar_extrato_faturas_using_get | GET /v1/contas/idConta/faturas | /contas/idConta/faturas |
Pier::ContaApi | consultar_saldos_limites_using_get | GET /v1/contas/idConta/limites | /contas/idConta/limites |
Pier::TokenApi | callback_using_post | POST /v1/tokens/callback | /tokens/callback |
Pier::TokenApi | validar_using_post | POST /v1/tokens/validar | /tokens/validar |
Documentation for Models
- Pier::AuthToken
- Pier::BodyAccessToken
- Pier::CancelarCartaoResponse
- Pier::CartaoResponse
- Pier::ConsultarCartaoResponse
- Pier::ConsultarContaCartaoResponse
- Pier::ConsultarContaResponse
- Pier::ConsultarExtratoContaResponse
- Pier::ConsultarSaldoLimitesResponse
- Pier::ContaCartaoResponse
- Pier::ContaResponse
- Pier::DesbloquearCartaoResponse
- Pier::ExtraInfo
- Pier::ExtratoResponse
- Pier::PessoaFisicaResponse
- Pier::SaldoLimiteResponse
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