Merge pull request #48 from pagarme/CodeGen-NodeJS

Adding property legal_name with sdk version 6.8.16

Author: JefersonCAugusto

LICENSE

@@ -3,7 +3,7 @@ License:
 The MIT License (MIT)
 http://opensource.org/licenses/MIT
 
-Copyright (c) 2014 - 2024 APIMATIC Limited
+Copyright (c) 2014 - 2025 APIMATIC Limited
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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.15/doc/client.md)
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.16/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.15/doc/auth/basic-authentication.md) | The credential object for basicAuth |
+| `basicAuthCredentials` | [`BasicAuthCredentials`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.16/doc/auth/basic-authentication.md) | The credential object for basicAuth |
 
 ### HttpClientOptions
 
@@ -121,38 +121,39 @@ 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.15/doc/auth/basic-authentication.md)
+* [`httpBasic (Basic Authentication)`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.16/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.15/doc/models/custom-error.md) |
-| 401 | Invalid API key | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.15/doc/models/custom-error.md) |
-| 404 | An informed resource was not found | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.15/doc/models/custom-error.md) |
-| 412 | Business validation error | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.15/doc/models/custom-error.md) |
-| 422 | Contract validation error | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.15/doc/models/custom-error.md) |
-| 500 | Internal server error | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.15/doc/models/custom-error.md) |
+| 400 | Invalid request | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.16/doc/models/custom-error.md) |
+| 401 | Invalid API key | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.16/doc/models/custom-error.md) |
+| 404 | An informed resource was not found | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.16/doc/models/custom-error.md) |
+| 412 | Business validation error | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.16/doc/models/custom-error.md) |
+| 422 | Contract validation error | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.16/doc/models/custom-error.md) |
+| 500 | Internal server error | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.16/doc/models/custom-error.md) |
 
 ## List of APIs
 
-* [Subscriptions](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.15/doc/controllers/subscriptions.md)
-* [Orders](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.15/doc/controllers/orders.md)
-* [Plans](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.15/doc/controllers/plans.md)
-* [Invoices](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.15/doc/controllers/invoices.md)
-* [Customers](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.15/doc/controllers/customers.md)
-* [Charges](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.15/doc/controllers/charges.md)
-* [Recipients](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.15/doc/controllers/recipients.md)
-* [Tokens](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.15/doc/controllers/tokens.md)
-* [Transactions](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.15/doc/controllers/transactions.md)
-* [Transfers](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.15/doc/controllers/transfers.md)
-* [Payables](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.15/doc/controllers/payables.md)
-* [Balance Operations](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.15/doc/controllers/balance-operations.md)
+* [Subscriptions](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.16/doc/controllers/subscriptions.md)
+* [Orders](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.16/doc/controllers/orders.md)
+* [Plans](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.16/doc/controllers/plans.md)
+* [Invoices](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.16/doc/controllers/invoices.md)
+* [Customers](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.16/doc/controllers/customers.md)
+* [Charges](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.16/doc/controllers/charges.md)
+* [Recipients](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.16/doc/controllers/recipients.md)
+* [Tokens](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.16/doc/controllers/tokens.md)
+* [Transactions](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.16/doc/controllers/transactions.md)
+* [Transfers](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.16/doc/controllers/transfers.md)
+* [Payables](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.16/doc/controllers/payables.md)
+* [Balance Operations](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.16/doc/controllers/balance-operations.md)
 
 ## Classes Documentation
 
-* [ApiResponse](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.15/doc/api-response.md)
-* [ApiError](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.15/doc/api-error.md)
+* [ApiResponse](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.16/doc/api-response.md)
+* [HttpRequest](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.16/doc/http-request.md)
+* [ApiError](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.16/doc/api-error.md)
 

doc/api-response.md

@@ -1,15 +1,32 @@
 
 # ApiResponse
 
-An interface for the result of an API call.
+Represents the result of an API call, including response metadata and the returned data of type `T`.
 
 ## Properties
 
 | Name | Type | Description |
 |  --- | --- | --- |
-| request | HttpRequest | Original request that resulted in this response. |
-| statusCode | number | Response status codee. |
-| headers | Record<string, string> | Response headers. |
-| result | T | Response data. |
-| body | string \| Blob \| NodeJS.ReadableStream | Original body from the response. |
+| request | [`HttpRequest`](http-request.md) | Original request that resulted in this response. |
+| statusCode | `number` | Response status codee. |
+| headers | `Record<string, string>` | Response headers. |
+| result | `T` | Response data. |
+| body | `string \| Blob \| NodeJS.ReadableStream` | Original body from the response. |
+
+## Example Usage
+
+```ts
+try {
+  const exampleController = new ExampleController(client);
+  const response = exampleController.getExampleType(body);
+  console.log('Success! Result:', response.result);
+  console.log('Status Code:', response.statusCode);
+} catch (error) {
+  if (error instanceof ApiError) {
+    console.log('Error:', error.message);
+    console.log('Result:', error.body);
+    console.log('Status Code:', error.statusCode);
+  }
+}
+```
 

doc/controllers/balance-operations.md

@@ -10,35 +10,41 @@ const balanceOperationsController = new BalanceOperationsController(client);
 
 ## Methods
 
-* [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 Operation by Id](../../doc/controllers/balance-operations.md#get-balance-operation-by-id)
 
 
-# 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)
+This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [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) {
@@ -50,35 +56,33 @@ try {
 ```
 
 
-# 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)
+This method returns an [`ApiResponse`](../../doc/api-response.md) instance. The `result` property of this instance returns the response data which is of type [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) {