Skip to content

Commit

Permalink
add java sdk docs (#565)
Browse files Browse the repository at this point in the history
* feat(sdks/java): add base for java sdk docs

* feat(sdks/java): add usage apge

* feat(sdks/java): add docs for each item in usage.md

* feat(sdks/java): add contributing

* feat(sdks/java): remame what-is

* feat(sdks/java): add resources.md
  • Loading branch information
aripiprazole committed Aug 1, 2023
1 parent e98d24a commit e0d93df
Show file tree
Hide file tree
Showing 5 changed files with 478 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/sdk/java/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"label": "Java",
"collapsible": true,
"collapsed": true,
"className": "orange",
"link": {
"type": "generated-index",
"title": "SDK de Java"
},
"customProps": {
"description": "Java SDK da OpenPix"
}
}
12 changes: 12 additions & 0 deletions docs/sdk/java/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
id: java-sdk-contributing
title: Como contribuir com o SDK
sidebar_position: 3
tags:
- api
- ruby
- sdk
---

## Contribuindo com o OpenPix Java SDK
O desenvolvimento do nosso Java SDK é opensource e pode ser encontrado em nosso [repositório público](https://github.com/Open-Pix/ruby-sdk). Para contribuir basta ler a sessão de [contributing](https://github.com/Open-Pix/java-sdk#contributing)
216 changes: 216 additions & 0 deletions docs/sdk/java/resources.md
Original file line number Diff line number Diff line change
@@ -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<T>`.

### Paginação

A classe `Paginator<T>` é uma classe que representa uma lista de recursos. Ela possui os seguintes métodos:

- `Future<List<T>> itemsAsync()`: Obtém os itens da página atual.
- `Future<PageInfo> 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();
```
Loading

0 comments on commit e0d93df

Please sign in to comment.