Skip to content

Commit cb0422a

Browse files
author
andreals
committed
Automated commit message
1 parent cafa935 commit cb0422a

File tree

60 files changed

+3423
-3666
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+3423
-3666
lines changed

.eslintrc.json

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,9 @@
1919
],
2020

2121
"rules": {
22-
"no-irregular-whitespace": 0,
23-
"no-unused-vars": 0,
24-
"no-explicit-any": 0
22+
"@typescript-eslint/no-explicit-any": "off",
23+
"@typescript-eslint/no-namespace": "off",
24+
"@typescript-eslint/ban-types": "off",
25+
"no-irregular-whitespace": "off"
2526
}
2627
}

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ npm install
7171

7272
## Initialize the API Client
7373

74-
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.9/doc/client.md)
74+
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.10/doc/client.md)
7575

7676
The following parameters are configurable for the API Client:
7777

@@ -81,7 +81,7 @@ The following parameters are configurable for the API Client:
8181
| `timeout` | `number` | Timeout for API calls.<br>*Default*: `0` |
8282
| `httpClientOptions` | `Partial<HttpClientOptions>` | Stable configurable http client options. |
8383
| `unstableHttpClientOptions` | `any` | Unstable configurable http client options. |
84-
| `basicAuthCredentials` | [`BasicAuthCredentials`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.9/doc/$a/https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.9/basic-authentication.md) | The credential object for basicAuth |
84+
| `basicAuthCredentials` | [`BasicAuthCredentials`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.10/doc/$a/https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.10/basic-authentication.md) | The credential object for basicAuth |
8585

8686
### HttpClientOptions
8787

@@ -121,38 +121,38 @@ const client = new Client({
121121

122122
This API uses the following authentication schemes.
123123

124-
* [`httpBasic (Basic Authentication)`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.9/doc/$a/https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.9/basic-authentication.md)
124+
* [`httpBasic (Basic Authentication)`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.10/doc/$a/https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.10/basic-authentication.md)
125125

126126
## API Errors
127127

128128
Here is the list of errors that the API might throw.
129129

130130
| HTTP Status Code | Error Description | Exception Class |
131131
| --- | --- | --- |
132-
| 400 | Invalid request | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.9/doc/models/custom-error.md) |
133-
| 401 | Invalid API key | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.9/doc/models/custom-error.md) |
134-
| 404 | An informed resource was not found | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.9/doc/models/custom-error.md) |
135-
| 412 | Business validation error | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.9/doc/models/custom-error.md) |
136-
| 422 | Contract validation error | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.9/doc/models/custom-error.md) |
137-
| 500 | Internal server error | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.9/doc/models/custom-error.md) |
132+
| 400 | Invalid request | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.10/doc/models/custom-error.md) |
133+
| 401 | Invalid API key | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.10/doc/models/custom-error.md) |
134+
| 404 | An informed resource was not found | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.10/doc/models/custom-error.md) |
135+
| 412 | Business validation error | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.10/doc/models/custom-error.md) |
136+
| 422 | Contract validation error | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.10/doc/models/custom-error.md) |
137+
| 500 | Internal server error | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.10/doc/models/custom-error.md) |
138138

139139
## List of APIs
140140

141-
* [Subscriptions](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.9/doc/controllers/subscriptions.md)
142-
* [Orders](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.9/doc/controllers/orders.md)
143-
* [Plans](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.9/doc/controllers/plans.md)
144-
* [Invoices](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.9/doc/controllers/invoices.md)
145-
* [Customers](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.9/doc/controllers/customers.md)
146-
* [Charges](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.9/doc/controllers/charges.md)
147-
* [Recipients](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.9/doc/controllers/recipients.md)
148-
* [Tokens](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.9/doc/controllers/tokens.md)
149-
* [Transactions](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.9/doc/controllers/transactions.md)
150-
* [Transfers](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.9/doc/controllers/transfers.md)
151-
* [Payables](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.9/doc/controllers/payables.md)
152-
* [Balance Operations](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.9/doc/controllers/balance-operations.md)
141+
* [Subscriptions](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.10/doc/controllers/subscriptions.md)
142+
* [Orders](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.10/doc/controllers/orders.md)
143+
* [Plans](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.10/doc/controllers/plans.md)
144+
* [Invoices](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.10/doc/controllers/invoices.md)
145+
* [Customers](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.10/doc/controllers/customers.md)
146+
* [Charges](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.10/doc/controllers/charges.md)
147+
* [Recipients](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.10/doc/controllers/recipients.md)
148+
* [Tokens](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.10/doc/controllers/tokens.md)
149+
* [Transactions](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.10/doc/controllers/transactions.md)
150+
* [Transfers](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.10/doc/controllers/transfers.md)
151+
* [Payables](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.10/doc/controllers/payables.md)
152+
* [Balance Operations](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.10/doc/controllers/balance-operations.md)
153153

154154
## Classes Documentation
155155

156-
* [ApiResponse](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.9/doc/api-response.md)
157-
* [ApiError](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.9/doc/api-error.md)
156+
* [ApiResponse](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.10/doc/api-response.md)
157+
* [ApiError](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.10/doc/api-error.md)
158158

doc/controllers/balance-operations.md

Lines changed: 21 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -10,41 +10,35 @@ const balanceOperationsController = new BalanceOperationsController(client);
1010

1111
## Methods
1212

13-
* [Get Balance Operations](../../doc/controllers/balance-operations.md#get-balance-operations)
1413
* [Get Balance Operation by Id](../../doc/controllers/balance-operations.md#get-balance-operation-by-id)
14+
* [Get Balance Operations](../../doc/controllers/balance-operations.md#get-balance-operations)
1515

1616

17-
# Get Balance Operations
17+
# Get Balance Operation by Id
1818

1919
```ts
20-
async getBalanceOperations(
21-
status?: string,
22-
createdSince?: string,
23-
createdUntil?: string,
24-
recipientId?: string,
25-
requestOptions?: RequestOptions
26-
): Promise<ApiResponse<ListBalanceOperationResponse>>
20+
async getBalanceOperationById( id: bigint,
21+
requestOptions?: RequestOptions): Promise<ApiResponse<GetBalanceOperationResponse>>
2722
```
2823

2924
## Parameters
3025

3126
| Parameter | Type | Tags | Description |
3227
| --- | --- | --- | --- |
33-
| `status` | `string \| undefined` | Query, Optional | - |
34-
| `createdSince` | `string \| undefined` | Query, Optional | - |
35-
| `createdUntil` | `string \| undefined` | Query, Optional | - |
36-
| `recipientId` | `string \| undefined` | Query, Optional | - |
28+
| `id` | `bigint` | Template, Required | - |
3729
| `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. |
3830

3931
## Response Type
4032

41-
[`ListBalanceOperationResponse`](../../doc/models/list-balance-operation-response.md)
33+
[`GetBalanceOperationResponse`](../../doc/models/get-balance-operation-response.md)
4234

4335
## Example Usage
4436

4537
```ts
38+
const id = BigInt(112);
39+
4640
try {
47-
const { result, ...httpResponse } = await balanceOperationsController.getBalanceOperations();
41+
const { result, ...httpResponse } = await balanceOperationsController.getBalanceOperationById(id);
4842
// Get more response info...
4943
// const { statusCode, headers } = httpResponse;
5044
} catch (error) {
@@ -56,33 +50,35 @@ try {
5650
```
5751

5852

59-
# Get Balance Operation by Id
53+
# Get Balance Operations
6054

6155
```ts
62-
async getBalanceOperationById(
63-
id: bigint,
64-
requestOptions?: RequestOptions
65-
): Promise<ApiResponse<GetBalanceOperationResponse>>
56+
async getBalanceOperations( status?: string,
57+
createdSince?: string,
58+
createdUntil?: string,
59+
recipientId?: string,
60+
requestOptions?: RequestOptions): Promise<ApiResponse<ListBalanceOperationResponse>>
6661
```
6762

6863
## Parameters
6964

7065
| Parameter | Type | Tags | Description |
7166
| --- | --- | --- | --- |
72-
| `id` | `bigint` | Template, Required | - |
67+
| `status` | `string \| undefined` | Query, Optional | - |
68+
| `createdSince` | `string \| undefined` | Query, Optional | - |
69+
| `createdUntil` | `string \| undefined` | Query, Optional | - |
70+
| `recipientId` | `string \| undefined` | Query, Optional | - |
7371
| `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. |
7472

7573
## Response Type
7674

77-
[`GetBalanceOperationResponse`](../../doc/models/get-balance-operation-response.md)
75+
[`ListBalanceOperationResponse`](../../doc/models/list-balance-operation-response.md)
7876

7977
## Example Usage
8078

8179
```ts
82-
const id = BigInt(112);
83-
8480
try {
85-
const { result, ...httpResponse } = await balanceOperationsController.getBalanceOperationById(id);
81+
const { result, ...httpResponse } = await balanceOperationsController.getBalanceOperations();
8682
// Get more response info...
8783
// const { statusCode, headers } = httpResponse;
8884
} catch (error) {

0 commit comments

Comments
 (0)