Automated commit message

pagarme · Oct 22, 2024 · 9dbd03c · 9dbd03c
1 parent 3f68f3a
commit 9dbd03c
Show file tree

Hide file tree

Showing 39 changed files with 3,362 additions and 3,214 deletions.
diff --git a/README.md b/README.md
@@ -71,7 +71,7 @@ npm install
 
 ## Initialize the API Client
 
-**_Note:_** Documentation for the client can be found [here.](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.13/doc/client.md)
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.14/doc/client.md)
 
 The following parameters are configurable for the API Client:
 
@@ -81,7 +81,7 @@ The following parameters are configurable for the API Client:
 | `timeout` | `number` | Timeout for API calls.<br>*Default*: `0` |
 | `httpClientOptions` | `Partial<HttpClientOptions>` | Stable configurable http client options. |
 | `unstableHttpClientOptions` | `any` | Unstable configurable http client options. |
-| `basicAuthCredentials` | [`BasicAuthCredentials`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.13/doc/auth/basic-authentication.md) | The credential object for basicAuth |
+| `basicAuthCredentials` | [`BasicAuthCredentials`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.14/doc/auth/basic-authentication.md) | The credential object for basicAuth |
 
 ### HttpClientOptions
 
@@ -121,38 +121,38 @@ const client = new Client({
 
 This API uses the following authentication schemes.
 
-* [`httpBasic (Basic Authentication)`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.13/doc/auth/basic-authentication.md)
+* [`httpBasic (Basic Authentication)`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.14/doc/auth/basic-authentication.md)
 
 ## API Errors
 
 Here is the list of errors that the API might throw.
 
 | HTTP Status Code | Error Description | Exception Class |
 |  --- | --- | --- |
-| 400 | Invalid request | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.13/doc/models/custom-error.md) |
-| 401 | Invalid API key | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.13/doc/models/custom-error.md) |
-| 404 | An informed resource was not found | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.13/doc/models/custom-error.md) |
-| 412 | Business validation error | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.13/doc/models/custom-error.md) |
-| 422 | Contract validation error | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.13/doc/models/custom-error.md) |
-| 500 | Internal server error | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.13/doc/models/custom-error.md) |
+| 400 | Invalid request | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.14/doc/models/custom-error.md) |
+| 401 | Invalid API key | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.14/doc/models/custom-error.md) |
+| 404 | An informed resource was not found | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.14/doc/models/custom-error.md) |
+| 412 | Business validation error | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.14/doc/models/custom-error.md) |
+| 422 | Contract validation error | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.14/doc/models/custom-error.md) |
+| 500 | Internal server error | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.14/doc/models/custom-error.md) |
 
 ## List of APIs
 
-* [Subscriptions](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.13/doc/controllers/subscriptions.md)
-* [Orders](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.13/doc/controllers/orders.md)
-* [Plans](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.13/doc/controllers/plans.md)
-* [Invoices](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.13/doc/controllers/invoices.md)
-* [Customers](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.13/doc/controllers/customers.md)
-* [Charges](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.13/doc/controllers/charges.md)
-* [Recipients](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.13/doc/controllers/recipients.md)
-* [Tokens](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.13/doc/controllers/tokens.md)
-* [Transactions](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.13/doc/controllers/transactions.md)
-* [Transfers](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.13/doc/controllers/transfers.md)
-* [Payables](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.13/doc/controllers/payables.md)
-* [Balance Operations](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.13/doc/controllers/balance-operations.md)
+* [Subscriptions](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.14/doc/controllers/subscriptions.md)
+* [Orders](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.14/doc/controllers/orders.md)
+* [Plans](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.14/doc/controllers/plans.md)
+* [Invoices](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.14/doc/controllers/invoices.md)
+* [Customers](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.14/doc/controllers/customers.md)
+* [Charges](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.14/doc/controllers/charges.md)
+* [Recipients](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.14/doc/controllers/recipients.md)
+* [Tokens](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.14/doc/controllers/tokens.md)
+* [Transactions](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.14/doc/controllers/transactions.md)
+* [Transfers](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.14/doc/controllers/transfers.md)
+* [Payables](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.14/doc/controllers/payables.md)
+* [Balance Operations](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.14/doc/controllers/balance-operations.md)
 
 ## Classes Documentation
 
-* [ApiResponse](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.13/doc/api-response.md)
-* [ApiError](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.13/doc/api-error.md)
+* [ApiResponse](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.14/doc/api-response.md)
+* [ApiError](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.14/doc/api-error.md)
 
diff --git a/doc/controllers/balance-operations.md b/doc/controllers/balance-operations.md
@@ -10,39 +10,35 @@ const balanceOperationsController = new BalanceOperationsController(client);
 
 ## Methods
 
-* [Get Balance Operations](../../doc/controllers/balance-operations.md#get-balance-operations)
 * [Get Balance Operation by Id](../../doc/controllers/balance-operations.md#get-balance-operation-by-id)
+* [Get Balance Operations](../../doc/controllers/balance-operations.md#get-balance-operations)
 
 
-# Get Balance Operations
+# Get Balance Operation by Id
 
 ```ts
-async getBalanceOperations(  status?: string,
-  createdSince?: string,
-  createdUntil?: string,
-  recipientId?: string,
-requestOptions?: RequestOptions): Promise<ApiResponse<ListBalanceOperationResponse>>
+async getBalanceOperationById(  id: bigint,
+requestOptions?: RequestOptions): Promise<ApiResponse<GetBalanceOperationResponse>>
 ```
 
 ## Parameters
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `status` | `string \| undefined` | Query, Optional | - |
-| `createdSince` | `string \| undefined` | Query, Optional | - |
-| `createdUntil` | `string \| undefined` | Query, Optional | - |
-| `recipientId` | `string \| undefined` | Query, Optional | - |
+| `id` | `bigint` | Template, Required | - |
 | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. |
 
 ## Response Type
 
-[`ListBalanceOperationResponse`](../../doc/models/list-balance-operation-response.md)
+[`GetBalanceOperationResponse`](../../doc/models/get-balance-operation-response.md)
 
 ## Example Usage
 
 ```ts
+const id = BigInt(112);
+
 try {
-  const { result, ...httpResponse } = await balanceOperationsController.getBalanceOperations();
+  const { result, ...httpResponse } = await balanceOperationsController.getBalanceOperationById(id);
   // Get more response info...
   // const { statusCode, headers } = httpResponse;
 } catch (error) {
@@ -54,31 +50,35 @@ try {
 ```
 
 
-# Get Balance Operation by Id
+# Get Balance Operations
 
 ```ts
-async getBalanceOperationById(  id: bigint,
-requestOptions?: RequestOptions): Promise<ApiResponse<GetBalanceOperationResponse>>
+async getBalanceOperations(  status?: string,
+  createdSince?: string,
+  createdUntil?: string,
+  recipientId?: string,
+requestOptions?: RequestOptions): Promise<ApiResponse<ListBalanceOperationResponse>>
 ```
 
 ## Parameters
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `id` | `bigint` | Template, Required | - |
+| `status` | `string \| undefined` | Query, Optional | - |
+| `createdSince` | `string \| undefined` | Query, Optional | - |
+| `createdUntil` | `string \| undefined` | Query, Optional | - |
+| `recipientId` | `string \| undefined` | Query, Optional | - |
 | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. |
 
 ## Response Type
 
-[`GetBalanceOperationResponse`](../../doc/models/get-balance-operation-response.md)
+[`ListBalanceOperationResponse`](../../doc/models/list-balance-operation-response.md)
 
 ## Example Usage
 
 ```ts
-const id = BigInt(112);
-
 try {
-  const { result, ...httpResponse } = await balanceOperationsController.getBalanceOperationById(id);
+  const { result, ...httpResponse } = await balanceOperationsController.getBalanceOperations();
   // Get more response info...
   // const { statusCode, headers } = httpResponse;
 } catch (error) {