README.md in moip2-1.0.0 vs README.md in moip2-1.1.0
- old
+ new
@@ -5,11 +5,11 @@
[](https://travis-ci.org/moip/moip-sdk-ruby)
[](https://codeclimate.com/github/moip/moip-sdk-ruby)
[](https://codeclimate.com/github/moip/moip-sdk-ruby/coverage)
-**Índice**
+**Índice**
- [Instalação](#instalação)
- [Configurando a autenticação](#configurando-a-autenticação)
- [Por BasicAuth](#por-basicauth)
- [Por OAuth](#por-oauth)
@@ -26,10 +26,11 @@
- [Pedido Específico](#pedido-específico)
- [Todos os Pedidos](#todos-os-pedidos)
- [Sem Filtro](#sem-filtro)
- [Com Filtros](#com-filtros)
- [Com Paginação](#com-paginação)
+ - [Consulta Valor Específico](#consulta-valor-específico)
- [Pagamentos](#pagamentos)
- [Criação](#criação-2)
- [Cartão de Crédito](#cartão-de-crédito)
- [Com Hash](#com-hash)
- [Com Dados do Cartão](#com-dados-do-cartão)
@@ -46,23 +47,39 @@
- [Criação](#criação-4)
- [Consulta](#consulta-4)
- [Multipagamentos](#multipagamentos)
- [Criação](#criação-5)
- [Consulta](#consulta-5)
+ - [Capturar multipagamento pré-autorizado](#capturar-multipagamento-pré-autorizado)
+ - [Cancelar multipagamento pré-autorizado](#cancelar-multipagamento-pré-autorizado)
- [Conta Moip](#conta-moip)
- [Criação](#criação-6)
- [Consulta](#consulta-6)
- [Verifica se usuário já possui Conta Moip](#verifica-se-usuário-já-possui-conta-moip)
+ - [Conta Bancária](#conta-bancária)
+ - [Criação](#criação-7)
+ - [Consulta](#consulta-7)
+ - [Listagem](#listagem)
+ - [Atualizar conta bancária](#atualizar-conta-bancaria)
+ - [Deletar conta bancária](#deletar-conta-bancaria)
- [OAuth (Moip Connect)](#oauth-(moip-connect))
- [Solicitar permissões de acesso ao usuário](#solicitar-permissões-de-acesso-ao-usuário)
- [Gerar Token OAuth](#gerar-token-oauth)
- [Atualizar Token OAuth](#atualizar-token-oauth)
+ - [Obter Chave Pública](#obter-chave-pública)
- [Preferências de Notificação](#preferências-de-notificação)
- - [Criação](#criação-7)
- - [Consulta](#consulta-7)
+ - [Criação](#criação-8)
+ - [Consulta](#consulta-8)
- [Exclusão](#exclusão)
- [Listagem](#listagem)
+ - [Webhooks](#webhooks)
+ - [Todos Webhooks](#todos-webhooks)
+ - [Com Paginação](#com-paginação2)
+ - [Evento Específico](#evento-específico)
+ - [Recurso Específico](#recurso-específico)
+ - [Saldo Moip](#saldo-moip)
+ - [Consulta](#consulta-10)
- [Tratamento de Exceções](#tratamento-de-exceções)
- [Documentação](#documentação)
- [Licença](#licença)
@@ -94,10 +111,17 @@
```ruby
api = Moip2::Api.new(client)
```
+Você pode customizar o client passando um hash de opções na inicialização. Essas opções serão passadas adiante para o client HTTParty, que aceita as opções descritas [na documentação](http://www.rubydoc.info/github/jnunemaker/httparty/HTTParty/ClassMethods).
+
+Por exemplo, para alterar o timeout das requisições para 5 segundos:
+```ruby
+client = Moip2::Client.new(:sandbox/:production, auth, timeout: 5)
+```
+
## Clientes
### Criação
```ruby
customer = api.customer.create({
ownId: "meu_id_de_cliente",
@@ -123,11 +147,11 @@
customer = api.customer.show("CUS-V41BR451L")
```
### Adicionar cartão de crédito
```ruby
-credit_card = api.customer.add_credit_card("CUSTOMER-ID",
+credit_card = api.customer.add_credit_card("CUSTOMER-ID",
{
method: "CREDIT_CARD",
creditCard: {
expirationMonth: "05",
expirationYear: "22",
@@ -151,22 +175,16 @@
)
```
### Deletar cartão de crédito
-> Retorna uma Exception do tipo `NotFoundError` caso não encontre o cartão de crédito para deletar
+> Retorna uma Exception do tipo `NotFoundError` caso não encontre o cartão de crédito para deletar.
```ruby
api.customer.delete_credit_card!("CREDIT-CARD-ID")
```
-> Retorna `false` caso não encontre o cartão de crédito para deletar
-
-```ruby
-api.customer.delete_credit_card("CREDIT-CARD-ID")
-```
-
## Pedidos
### Criação
```ruby
order = api.order.create({
@@ -206,14 +224,19 @@
##### Com Paginação
```ruby
orders = api.order.find_all(limit: 10, offset: 50)
```
+##### Consulta Valor Específico
+```ruby
+orders = api.order.find_all(q: "your_value")
+```
+
## Pagamentos
### Criação
-#### Cartão de Crédito
+#### Cartão de Crédito
##### Com Hash
```ruby
api.payment.create(order.id,
{
@@ -234,11 +257,11 @@
}
}
)
```
-##### Com Dados do Cartão
+##### Com Dados do Cartão
> Esses método requer certificação PCI. [Consulte a documentação.](https://documentao-moip.readme.io/v2.0/reference#criar-pagamento)
```ruby
api.payment.create(order.id,
{
@@ -342,20 +365,29 @@
```ruby
multi_pag = api.multi_payment.create("MOR-V41BR451L",
{
installmentCount: 1,
fundingInstrument: {
- # ...
+ # ...
}
}
)
```
### Consulta
```ruby
multi_pag = api.multi_payment.show("MPY-V41BR451L")
```
+### Capturar multipagamento pré-autorizado
+```ruby
+multi = api.multi_payment.capture("MPY-V41BR451L")
+```
+### Cancelar multipagamento pré-autorizado
+```ruby
+multi = api.multi_payment.void("MPY-V41BR451L")
+```
+
## Conta Moip
### Criação
```ruby
account = api.accounts.create(
{
@@ -404,10 +436,63 @@
### Verifica se usuário já possui Conta Moip
```ruby
api.accounts.exists?("123.456.789.10")
```
+## Conta bancária
+### Criação
+```ruby
+bank_account = api.bank_accounts.create("MPA-14C9EE706C55",
+ bank_number: "237",
+ agency_number: "12345",
+ agency_check_number: "0",
+ account_number: "12345678",
+ account_check_number: "7",
+ type: "CHECKING",
+ holder: {
+ tax_document: {
+ type: "CPF",
+ number: "164.664.426-32",
+ },
+ fullname: "Sales Machine da Silva",
+ })
+```
+
+### Consulta
+```ruby
+api.bank_accounts.show("BKA-DWTSK16UQI9N")
+```
+
+### Listagem
+```ruby
+api.bank_accounts.find_all("MPA-14C9EE706C55")
+```
+
+### Atualizar conta bancaria
+```ruby
+api.bank_accounts.update("BKA-DWTSK16UQI9N",
+ bank_number: "237",
+ agency_number: "12345",
+ agency_check_number: "0",
+ account_number: "87654323",
+ account_check_number: "7",
+ type: "CHECKING",
+ holder: {
+ tax_document: {
+ type: "CPF",
+ number: "164.664.426-32",
+ },
+ fullname: "Sales Machine da Silva",
+ })
+```
+
+### Deletar conta bancaria
+> Retorna uma Exception do tipo `NotFoundError` caso não encontre a conta bancária para deletar
+```ruby
+ api.bank_accounts.delete("BKA-DWTSK16UQI9N")
+```
+
## OAuth (Moip Connect)
### Solicitar permissões de acesso ao usuário
```ruby
api.connect.authorize_url("APP-ID","http://localhost/moip/callback","RECEIVE_FUNDS,REFUND")
```
@@ -429,10 +514,15 @@
refresh_token: "1d5dc51e71674683b4ed79cd7a988fa1_v2",
grant_type: "refresh_token"
)
```
+### Obter Chave Pública
+```ruby
+keys = api.keys.show
+```
+
## Preferências de notificação
### Criação
```ruby
api.notifications.create(
@@ -457,9 +547,47 @@
### Listagem
```ruby
api.notifications.find_all
```
+## Webhooks
+### Consulta
+
+##### Todos Webhooks
+```ruby
+webhooks = api.webhooks.find_all
+```
+
+##### Com Paginação
+```ruby
+webhooks = api.webhooks.find_all(limit: 10, offset: 50)
+```
+
+##### Consulta Evento
+```ruby
+webhooks = api.webhooks.find_all(event: "PAYMENT.WAITING")
+```
+
+##### Consulta Valor Específico
+```ruby
+webhooks = api.webhooks.find_all(resource_id: "PAY-REJJ9F12MF7R")
+```
+
+
+## Saldo Moip
+### Consulta
+```ruby
+api.balances.show()
+```
+
+### Show all entries
+```ruby
+ api.entries.find_all
+```
+### Show one entry
+```ruby
+ api.entries.show(entry_id)
+```
## Tratamento de Exceções
Caso algum recurso não seja encontrado uma exceção do tipo `NotFoundError` será lançada.
```ruby