From e4d4dbc886f9a4628ab4d3973a508e00987b4f48 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gabrielle=20Guimar=C3=A3es=20de=20Oliveira?= Date: Mon, 31 Jul 2023 18:14:56 +0000 Subject: [PATCH] feat(sdks/java): add resources.md --- docs/sdk/java/contributing.md | 2 +- docs/sdk/java/resources.md | 216 ++++++++++++++++++++++++++++++++++ 2 files changed, 217 insertions(+), 1 deletion(-) create mode 100644 docs/sdk/java/resources.md diff --git a/docs/sdk/java/contributing.md b/docs/sdk/java/contributing.md index 92486592..945eff5f 100644 --- a/docs/sdk/java/contributing.md +++ b/docs/sdk/java/contributing.md @@ -1,5 +1,5 @@ --- -id: ruby-sdk-contributing +id: java-sdk-contributing title: Como contribuir com o SDK sidebar_position: 3 tags: diff --git a/docs/sdk/java/resources.md b/docs/sdk/java/resources.md new file mode 100644 index 00000000..700c7a40 --- /dev/null +++ b/docs/sdk/java/resources.md @@ -0,0 +1,216 @@ +--- +id: java-sdk-resources +title: Recursos +sidebar_position: 2 +tags: +- api +- ruby +- sdk +--- + +## Lista de recursos disponíveis + +Existem recursos disponíveis para cada tipo de operação. Para cada recurso, existe uma classe que representa o recurso e uma classe que representa uma lista de recursos. Essas classes são as classes de paginação: `Paginator`. + +### Paginação + +A classe `Paginator` é uma classe que representa uma lista de recursos. Ela possui os seguintes métodos: + +- `Future> itemsAsync()`: Obtém os itens da página atual. +- `Future pageInfoAsync()`: Obtém as informações da página atual. +- `void next()`: Vai para a próxima página. +- `void previous()`: Vai para a página anterior. + +As funções `next` e `previous` atualizam uma informação da classe, e os dados só serão lidos +da próxima vez que for chamado o método `itemsAsync` ou `pageInfoAsync`. + +### Charge + +- `Charge`: Representa uma cobrança. + +#### Criar uma cobrança + +```java,no +// Cria uma charge +ChargeBuilder charge = new ChargeBuilder() + .value(100) + .comment("comment") + .correlationID("correlationId") + .destinationAlias("destinationAlias") + .sourceAccountId("sourceAccountId"); + +sdk.createChargeAsync(charge).get(); +``` + +#### Obter uma cobrança + +```java,no +// Obtém uma cobrança pelo ID. string. +sdk.getChargeAsync(correlationID).get(); +``` + +#### Remover uma cobrança + +```java,no +// Remove uma cobrança pelo ID. string. +sdk.deleteChargeAsync(correlationID).get(); +``` + +### PixQrCode + +- `PixQrCode`: Representa um pix qr code. + +#### Criar um pix qr code + +```java,no +// Cria um pix qr code +PixQrCodeBuilder pixQrCode = new PixQrCodeBuilder() + .value(100) + .comment("comment") + .correlationID("correlationId") + .destinationAlias("destinationAlias") + .sourceAccountId("sourceAccountId"); + +sdk.createPixQrCodeAsync(pixQrCode).get(); +``` + +#### Obter um pix qr code + +```java,no +// Obtém um pix qr code pelo ID. string. +sdk.getPixQrCodeAsync(correlationID).get(); +``` + +### Transação + +- `Transaction`: Representa uma transação. + +#### Obter uma transação + +```java,no +// Obtém uma transação pelo ID. string. +sdk.getTransactionAsync(correlationID).get(); +``` + +### Conta + +- `Account`: Representa uma conta. + +#### Obter uma conta + +```java,no +// Obtém uma conta pelo ID. string. +sdk.getAccountAsync(correlationID).get(); +``` + +#### Obter uma lista de contas + +```java,no +// Obtém uma lista de contas. +sdk.getAccountsAsync().get(); +``` + +#### Performar saque + +```java,no +// Performa um saque. +sdk.withdrawAsync(id, value).get(); +``` + +### Reembolso + +- `Refund`: Representa um reembolso. + +#### Criar um reembolso + +```java,no +// Cria um reembolso +RefundBuilder refund = new RefundBuilder() + .value(100) + .comment("comment") + .correlationID("correlationId") + .destinationAccountId("destinationAccountId") + .sourceAccountId("sourceAccountId"); + +sdk.createRefundAsync(refund).get(); +``` + +#### Obter um reembolso + +```java,no +// Obtém um reembolso pelo ID. string. +sdk.getRefundAsync(correlationID).get(); +``` + +### Webhook + +- `Webhook`: Representa um webhook. + +#### Criar um webhook + +```java,no +// Cria um webhook +WebhookBuilder builder = new WebhookBuilder() + .number(100) + .url("https://google.com") + .enableWebhook(); + +sdk.createWebhookAsync(builder).get(); +``` + +#### Deletar um webhook + +```java,no +// Deleta um webhook pelo ID. string. +sdk.deleteWebhookAsync(correlationID).get(); +``` + +### Customer + +- `Customer`: Representa um customer. + +#### Criar um customer + +```java,no +// Cria um customer +CustomerBuilder builder = new CustomerBuilder() + .name("name") + .email("email@gmail.com") + .taxIdNumber("947.761.930-04") + .phoneNumber("4299999-9999") + .address(address); + +sdk.createCustomerAsync(builder).get(); +``` + +#### Obter um customer + +```java,no +// Obtém um customer pelo ID. string. +sdk.getCustomerAsync(correlationID).get(); +``` + +### Pagamento + +- `Payment`: Representa um pagamento. + +#### Criar um pagamento + +```java,no +// Cria um pagamento +PaymentBuilder payment = new PaymentBuilder() + .value(100) + .comment("comment") + .correlationID("correlationId") + .destinationAccountId("destinationAccountId") + .sourceAccountId("sourceAccountId"); + +sdk.createPaymentAsync(payment).get(); +``` + +#### Obter um pagamento + +```java,no +// Obtém um pagamento pelo ID. string. +sdk.getPaymentAsync(correlationID).get(); +``` \ No newline at end of file