Automated commit message

Author: andreals

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

doc/models/get-movement-object-base-response.md

@@ -28,11 +28,11 @@ Generic response object for getting a MovementObjectBase.
   "status": "status4",
   "amount": "amount4",
   "created_at": "created_at0",
-  "source_type": "source_type6",
-  "source_id": "source_id0",
-  "target_type": "target_type8",
-  "target_id": "target_id4",
-  "fee": "fee8"
+  "product": "product2",
+  "brand": "brand6",
+  "payment_date": "payment_date4",
+  "recipient_id": "recipient_id2",
+  "document_type": "document_type0"
 }
 ```
 

doc/models/get-movement-object-settlement-response.md

@@ -0,0 +1,43 @@
+
+# Get Movement Object Settlement Response
+
+Generic response object for getting a MovementObjectSettlement.
+
+## Structure
+
+`GetMovementObjectSettlementResponse`
+
+## Inherits From
+
+[`GetMovementObjectBaseResponse`](../../doc/models/get-movement-object-base-response.md)
+
+## Fields
+
+| Name | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `product` | `string \| null \| undefined` | Optional | - |
+| `brand` | `string \| null \| undefined` | Optional | - |
+| `paymentDate` | `string \| null \| undefined` | Optional | - |
+| `recipientId` | `string \| null \| undefined` | Optional | - |
+| `documentType` | `string \| null \| undefined` | Optional | - |
+| `document` | `string \| null \| undefined` | Optional | - |
+| `contractObligationId` | `string \| null \| undefined` | Optional | - |
+| `liquidationArrangementId` | `string \| null \| undefined` | Optional | - |
+| `externalEnginePaymentId` | `string \| null \| undefined` | Optional | - |
+
+## Example (as JSON)
+
+```json
+{
+  "id": "id2",
+  "status": "status4",
+  "amount": "amount4",
+  "created_at": "created_at0",
+  "product": "product2",
+  "brand": "brand6",
+  "payment_date": "payment_date4",
+  "recipient_id": "recipient_id2",
+  "document_type": "document_type0"
+}
+```
+

package.json

@@ -1,5 +1,5 @@
 {
-  "version": "6.8.6",
+  "version": "6.8.7",
   "license": "MIT",
   "sideEffects": false,
   "main": "dist/cjs/index.js",
@@ -25,12 +25,12 @@
     "singleQuote": true,
     "trailingComma": "es5"
   },
-  "name": "@pagarme/pagarme-nodejs-sdk",
+  "name": "pagarmeapisdklib",
   "description": "Pagarme API",
   "author": {
     "name": "Pagar.me Pagamentos S/A",
     "email": "suporte@pagar.me",
-    "url": "https://github.com/pagarme/pagarme-nodejs-sdk/issues"
+    "url": "https://github.com/pagarme/"
   },
   "devDependencies": {
     "@types/jest": "^29.4.0",
@@ -49,11 +49,7 @@
     "@apimatic/schema": "^0.7.0"
   },
   "bugs": {
-    "url": "https://github.com/pagarme/pagarme-nodejs-sdk/issues",
+    "url": "https://github.com/pagarme/",
     "email": "suporte@pagar.me"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/pagarme/pagarme-nodejs-sdk.git"
   }
 }

src/client.ts

@@ -59,7 +59,7 @@ export class Client implements ClientInterface {
     }
 
     this._userAgent = updateUserAgent(
-      'PagarmeApiSDK - TypeScript 6.8.6',
+      'PagarmeApiSDK - TypeScript 6.8.7',
     );
     this._requestBuilderFactory = createRequestHandlerFactory(
       server => getBaseUri(server, this._config),

src/index.ts

@@ -162,6 +162,7 @@ export type { GetMovementObjectBaseResponse } from './models/getMovementObjectBa
 export type { GetMovementObjectFeeCollectionResponse } from './models/getMovementObjectFeeCollectionResponse';
 export type { GetMovementObjectPayableResponse } from './models/getMovementObjectPayableResponse';
 export type { GetMovementObjectRefundResponse } from './models/getMovementObjectRefundResponse';
+export type { GetMovementObjectSettlementResponse } from './models/getMovementObjectSettlementResponse';
 export type { GetMovementObjectTransferResponse } from './models/getMovementObjectTransferResponse';
 export type { GetOrderItemResponse } from './models/getOrderItemResponse';
 export type { GetOrderResponse } from './models/getOrderResponse';

src/models/discriminatedSchemas.ts

@@ -30,6 +30,9 @@ import {
 import {
   getMovementObjectRefundResponseSchema,
 } from './getMovementObjectRefundResponse';
+import {
+  getMovementObjectSettlementResponseSchema,
+} from './getMovementObjectSettlementResponse';
 import {
   getMovementObjectTransferResponseSchema,
 } from './getMovementObjectTransferResponse';
@@ -72,6 +75,7 @@ export const discriminatedGetMovementObjectBaseResponseSchema: Schema<any> = dis
     'feeCollection': getMovementObjectFeeCollectionResponseSchema,
     'payable': getMovementObjectPayableResponseSchema,
     'transfer': getMovementObjectTransferResponseSchema,
+    'settlement': getMovementObjectSettlementResponseSchema,
  },
   'MovementObject'
 );

src/models/getMovementObjectSettlementResponse.ts

@@ -0,0 +1,50 @@
+/**
+ * PagarmeApiSDKLib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { literal, nullable, object, optional, Schema, string } from '../schema';
+import { GetMovementObjectBaseResponse } from './getMovementObjectBaseResponse';
+
+/** Generic response object for getting a MovementObjectSettlement. */
+export interface GetMovementObjectSettlementResponse extends GetMovementObjectBaseResponse {
+  product?: string | null;
+  brand?: string | null;
+  paymentDate?: string | null;
+  recipientId?: string | null;
+  documentType?: string | null;
+  document?: string | null;
+  contractObligationId?: string | null;
+  liquidationArrangementId?: string | null;
+  externalEnginePaymentId?: string | null;
+}
+
+export const getMovementObjectSettlementResponseSchema: Schema<any> = object({
+  product: ['product', optional(nullable(string()))],
+  brand: ['brand', optional(nullable(string()))],
+  paymentDate: ['payment_date', optional(nullable(string()))],
+  recipientId: ['recipient_id', optional(nullable(string()))],
+  documentType: ['document_type', optional(nullable(string()))],
+  document: ['document', optional(nullable(string()))],
+  contractObligationId: [
+    'contract_obligation_id',
+    optional(nullable(string())),
+  ],
+  liquidationArrangementId: [
+    'liquidation_arrangement_id',
+    optional(nullable(string())),
+  ],
+  externalEnginePaymentId: [
+    'external_engine_payment_id',
+    optional(nullable(string())),
+  ],
+  id: ['id', optional(nullable(string()))],
+  status: ['status', optional(nullable(string()))],
+  amount: ['amount', optional(nullable(string()))],
+  createdAt: ['created_at', optional(nullable(string()))],
+  type: ['type', optional(nullable(string()))],
+  chargeId: ['charge_id', optional(nullable(string()))],
+  gatewayId: ['gateway_id', optional(nullable(string()))],
+  object: ['object', optional(literal('settlement'))],
+});