README.md in pagarme-2.2.2 vs README.md in pagarme-2.2.3

- old
+ new

@@ -3,12 +3,12 @@ Pagar.me Ruby library ## Documentation -* [Documentation](https://pagar.me/docs) -* [Full API Guide](https://docs.pagar.me/api) +* [Documentation](https://docs.pagar.me) +* [Full API Guide](https://docs.pagar.me/reference) ## Getting Started ### Install @@ -36,26 +36,26 @@ ### Using Pagar.me Checkout See our [demo checkout](https://pagar.me/checkout). -More about how to use it [here](https://docs.pagar.me/checkout). +More about how to use it [here](https://docs.pagar.me/docs/overview-checkout). ### Transactions #### Creating a Credit Card Transaction -To create a credit card transaction, you need a [card\_hash](https://docs.pagar.me/capturing-card-data). +To create a credit card transaction, you need a [card\_hash](https://docs.pagar.me/docs/obtendo-os-dados-do-cartao). ```ruby PagarMe::Transaction.new( amount: 1000, # in cents card_hash: card_hash # how to get a card hash: docs.pagar.me/capturing-card-data ).charge ``` -More about [Creating a Credit Card Transaction](https://docs.pagar.me/transactions/#realizando-uma-transacao-de-cartao-de-credito). +More about [Creating a Credit Card Transaction](https://docs.pagar.me/docs/realizando-uma-transacao-de-cartao-de-credito). #### Creating a Boleto Transaction ```ruby transaction = PagarMe::Transaction.new( @@ -66,35 +66,35 @@ transaction.boleto_url # => boleto's URL transaction.boleto_barcode # => boleto's barcode ``` -More about [Creating a Boleto Transaction](https://docs.pagar.me/transactions/#realizando-uma-transacao-de-boleto-bancario). +More about [Creating a Boleto Transaction](https://docs.pagar.me/docs/realizando-uma-transacao-de-boleto-bancario). #### Split Rules With split rules, received amount could be splitted between more than one recipient. For example, splitting equally a transaction: ```ruby PagarMe::Transaction.new( amount: 1000, # in cents card_hash: card_hash, # how to get a card hash: docs.pagar.me/capturing-card-data - split\_rules: [ + split_rules: [ { recipient_id: recipient_id_1, percentage: 50 }, { recipient_id: recipient_id_2, percentage: 50 } ] ).charge ``` -More about [Split Rules](https://docs.pagar.me/api/#regras-do-split). +More about [Split Rules](https://docs.pagar.me/reference#retornando-uma-regra-de-divis%C3%A3o-espec%C3%ADfica). ### Plans & Subscriptions -You can use recurring charges, learn more [here](https://docs.pagar.me/plans-subscriptions). +You can use recurring charges, learn more [here](https://docs.pagar.me/docs/overview-recorrencia). -It's important to understand the charges flow, learn more [here](https://docs.pagar.me/plans-subscriptions/#fluxo-de-cobranca) +It's important to understand the charges flow, learn more [here](https://docs.pagar.me/docs/fluxo-de-cobranca) #### Creating a Plan ```ruby PagarMe::Plan.new( @@ -102,11 +102,11 @@ days: 30, name: 'Gold Plan' ).create ``` -More about [Creating a Plan](https://docs.pagar.me/plans-subscriptions/#criando-um-plano). +More about [Creating a Plan](https://docs.pagar.me/docs/criando-um-plano). #### Creating a Subscription ```ruby PagarMe::Subscription.new( @@ -114,11 +114,11 @@ card_hash: card_hash, customer: { email: 'customer_email@pagar.me' } ).create ``` -More about [Creating a Subscription](https://docs.pagar.me/plans-subscriptions/#criando-uma-assinatura). +More about [Creating a Subscription](https://docs.pagar.me/docs/criando-uma-assinatura). ### Recipients #### Creating a Recipient @@ -137,11 +137,11 @@ }, transfer_enabled: false ) ``` -More about [Creating a Recipient](https://docs.pagar.me/api/#recebedores). +More about [Creating a Recipient](https://docs.pagar.me/reference#criando-um-recebedor). #### Transfer Available Amout to Bank Account Manually This is only needed if _transfer\_enabled_ is set to false. If set to true, _transfer\_interval_ and _transfer\_day_ will handle it automatically. @@ -161,11 +161,11 @@ balance.transferred.amount # transferred to your bank account ``` Just that! -More about [Balance](https://docs.pagar.me/api/#saldo) +More about [Balance](https://docs.pagar.me/docs/overview-gerenciamento-de-saldo) #### Checking Balance Operations To access the history of balance operations: @@ -177,11 +177,11 @@ ```ruby PagarMe::BalanceOperation.balance_operations 2, 50 # second page, 50 per page ``` -More about [Balance Operations](https://docs.pagar.me/api/#operacoes-de-saldo) +More about [Balance Operations](https://docs.pagar.me/docs/composicao-do-saldo) #### Checking Recipient Balance ```ruby balance = PagarMe::Recipient.find(recipient_id).balance @@ -206,21 +206,21 @@ ```ruby PagarMe::Recipient.find(recipient_id).balance_operations 2, 50 # second page, 50 per page ``` -More about [Recipient Balance Operations](https://docs.pagar.me/api/#operacoes-de-saldo-de-um-recebedor) +More about [Recipient Balance Operations](https://docs.pagar.me/reference#opera%C3%A7%C3%B5es-de-saldo-de-um-recebedor) ### Request Bulk Anticipation #### Checking limits ```ruby PagarMe::Recipient.default.bulk_anticipations_limits ``` -More about [Checking Bulk Anticipation Limits](https://docs.pagar.me/api/#obtendo-os-limites-de-antecipacao) +More about [Checking Bulk Anticipation Limits](https://docs.pagar.me/reference#obtendo-os-limites-de-antecipa%C3%A7%C3%A3o) #### Requesting Bulk Anticipation ```ruby PagarMe::Recipient.default.bulk_anticipate( @@ -228,29 +228,29 @@ payment_date: Date.new(2016, 12, 25), requested_amount: 10000 # in cents ) ``` -More about [Requesting Bulk Anticipation](https://docs.pagar.me/api/#criando-uma-antecipacao) +More about [Requesting Bulk Anticipation](https://docs.pagar.me/reference#criando-uma-antecipa%C3%A7%C3%A3o) #### Getting Bulk Anticipation ```ruby PagarMe::BulkAnticipation.all page, count ``` -More about [Getting Bulk Anticipation](https://docs.pagar.me/api/#retornando-todas-as-antecipacoes) +More about [Getting Bulk Anticipation](https://docs.pagar.me/reference#retornando-todas-as-antecipa%C3%A7%C3%B5es) ### Payables ### Getting Payable ```ruby PagarMe::Payable.find 'payable_id' ``` -More about [Getting Payable](https://docs.pagar.me/api/#retornando-um-recebivel) +More about [Getting Payable](https://docs.pagar.me/reference#retornando-um-receb%C3%ADvel) #### Querying Payables ```ruby PagarMe::Payable.all page, count @@ -258,20 +258,20 @@ ```ruby PagarMe::Payable.find_by status: 'paid' ``` -More about [Querying Payables](https://docs.pagar.me/api/#retornando-recebiveis) +More about [Querying Payables](https://docs.pagar.me/reference#retornando-receb%C3%ADveis) #### Querying Payables by Transaction ```ruby transaction = PagarMe::Transaction.find 'transaction_id' transaction.payables ``` -More about [Payable Transactions](https://docs.pagar.me/api/#retornando-pagamentos-da-transacao) +More about [Payable Transactions](https://docs.pagar.me/reference#retornando-pagamentos-da-transa%C3%A7%C3%A3o) ### Validating Postback You need to ensure that all received postback are sent by Pagar.me and not from anyone else, to do this, is very important to validate it. @@ -327,18 +327,18 @@ This README is just a quick abstract of it's main features. You can easily browse it's source code to see all [supported resources](https://github.com/pagarme/pagarme-ruby/tree/master/lib/pagarme/resources). We will document everything while adding support to all resources listed in -[Full API Guide](https://docs.pagar.me/api). +[Full API Guide](https://docs.pagar.me/reference). Feel free to help us to add support to features sending pull requests. Thanks! ### TODO -Add support to [ElasticSearch Query DSL](https://docs.pagar.me/api/#buscas-avancadas), +Add support to [ElasticSearch Query DSL](https://docs.pagar.me/reference#elasticsearch), so you can search your data optimally. And document all the source code. ## Support