Skip to content

Commit 509cb8e

Browse files
author
andreals
committed
Automated commit message
1 parent 82dcc74 commit 509cb8e

22 files changed

+147
-544
lines changed

‎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.7/doc/client.md)
74+
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.8/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.7/doc/$a/https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.7/basic-authentication.md) | The credential object for basicAuth |
84+
| `basicAuthCredentials` | [`BasicAuthCredentials`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.8/doc/$a/https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.8/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.7/doc/$a/https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.7/basic-authentication.md)
124+
* [`httpBasic (Basic Authentication)`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.8/doc/$a/https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.8/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.7/doc/models/custom-error.md) |
133-
| 401 | Invalid API key | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.7/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.7/doc/models/custom-error.md) |
135-
| 412 | Business validation error | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.7/doc/models/custom-error.md) |
136-
| 422 | Contract validation error | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.7/doc/models/custom-error.md) |
137-
| 500 | Internal server error | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.7/doc/models/custom-error.md) |
132+
| 400 | Invalid request | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.8/doc/models/custom-error.md) |
133+
| 401 | Invalid API key | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.8/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.8/doc/models/custom-error.md) |
135+
| 412 | Business validation error | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.8/doc/models/custom-error.md) |
136+
| 422 | Contract validation error | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.8/doc/models/custom-error.md) |
137+
| 500 | Internal server error | [`CustomError`](https://www.github.com/pagarme/pagarme-nodejs-sdk/tree/6.8.8/doc/models/custom-error.md) |
138138

139139
## List of APIs
140140

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

154154
## Classes Documentation
155155

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

‎doc/controllers/balance-operations.md‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,11 @@ async getBalanceOperations(
4444

4545
```ts
4646
try {
47-
// @ts-expect-error: unused variables
48-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
4947
const { result, ...httpResponse } = await balanceOperationsController.getBalanceOperations();
5048
// Get more response info...
5149
// const { statusCode, headers } = httpResponse;
5250
} catch (error) {
5351
if (error instanceof ApiError) {
54-
// @ts-expect-error: unused variables
55-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
5652
const errors = error.result;
5753
// const { statusCode, headers } = error;
5854
}
@@ -86,15 +82,11 @@ async getBalanceOperationById(
8682
const id = BigInt(112);
8783

8884
try {
89-
// @ts-expect-error: unused variables
90-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
9185
const { result, ...httpResponse } = await balanceOperationsController.getBalanceOperationById(id);
9286
// Get more response info...
9387
// const { statusCode, headers } = httpResponse;
9488
} catch (error) {
9589
if (error instanceof ApiError) {
96-
// @ts-expect-error: unused variables
97-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
9890
const errors = error.result;
9991
// const { statusCode, headers } = error;
10092
}

‎doc/controllers/charges.md‎

Lines changed: 0 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,6 @@ const request: UpdateMetadataRequest = {
6363
};
6464

6565
try {
66-
// @ts-expect-error: unused variables
67-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
6866
const { result, ...httpResponse } = await chargesController.updateChargeMetadata(
6967
chargeId,
7068
request
@@ -73,8 +71,6 @@ try {
7371
// const { statusCode, headers } = httpResponse;
7472
} catch (error) {
7573
if (error instanceof ApiError) {
76-
// @ts-expect-error: unused variables
77-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
7874
const errors = error.result;
7975
// const { statusCode, headers } = error;
8076
}
@@ -159,8 +155,6 @@ const request: UpdateChargePaymentMethodRequest = {
159155
};
160156

161157
try {
162-
// @ts-expect-error: unused variables
163-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
164158
const { result, ...httpResponse } = await chargesController.updateChargePaymentMethod(
165159
chargeId,
166160
request
@@ -169,8 +163,6 @@ try {
169163
// const { statusCode, headers } = httpResponse;
170164
} catch (error) {
171165
if (error instanceof ApiError) {
172-
// @ts-expect-error: unused variables
173-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
174166
const errors = error.result;
175167
// const { statusCode, headers } = error;
176168
}
@@ -208,15 +200,11 @@ async getChargeTransactions(
208200
const chargeId = 'charge_id8';
209201

210202
try {
211-
// @ts-expect-error: unused variables
212-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
213203
const { result, ...httpResponse } = await chargesController.getChargeTransactions(chargeId);
214204
// Get more response info...
215205
// const { statusCode, headers } = httpResponse;
216206
} catch (error) {
217207
if (error instanceof ApiError) {
218-
// @ts-expect-error: unused variables
219-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
220208
const errors = error.result;
221209
// const { statusCode, headers } = error;
222210
}
@@ -258,8 +246,6 @@ const chargeId = 'charge_id8';
258246
const request: UpdateChargeDueDateRequest = {};
259247

260248
try {
261-
// @ts-expect-error: unused variables
262-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
263249
const { result, ...httpResponse } = await chargesController.updateChargeDueDate(
264250
chargeId,
265251
request
@@ -268,8 +254,6 @@ try {
268254
// const { statusCode, headers } = httpResponse;
269255
} catch (error) {
270256
if (error instanceof ApiError) {
271-
// @ts-expect-error: unused variables
272-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
273257
const errors = error.result;
274258
// const { statusCode, headers } = error;
275259
}
@@ -319,15 +303,11 @@ async getCharges(
319303

320304
```ts
321305
try {
322-
// @ts-expect-error: unused variables
323-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
324306
const { result, ...httpResponse } = await chargesController.getCharges();
325307
// Get more response info...
326308
// const { statusCode, headers } = httpResponse;
327309
} catch (error) {
328310
if (error instanceof ApiError) {
329-
// @ts-expect-error: unused variables
330-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
331311
const errors = error.result;
332312
// const { statusCode, headers } = error;
333313
}
@@ -367,15 +347,11 @@ async captureCharge(
367347
const chargeId = 'charge_id8';
368348

369349
try {
370-
// @ts-expect-error: unused variables
371-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
372350
const { result, ...httpResponse } = await chargesController.captureCharge(chargeId);
373351
// Get more response info...
374352
// const { statusCode, headers } = httpResponse;
375353
} catch (error) {
376354
if (error instanceof ApiError) {
377-
// @ts-expect-error: unused variables
378-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
379355
const errors = error.result;
380356
// const { statusCode, headers } = error;
381357
}
@@ -424,8 +400,6 @@ const request: UpdateChargeCardRequest = {
424400
};
425401

426402
try {
427-
// @ts-expect-error: unused variables
428-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
429403
const { result, ...httpResponse } = await chargesController.updateChargeCard(
430404
chargeId,
431405
request
@@ -434,8 +408,6 @@ try {
434408
// const { statusCode, headers } = httpResponse;
435409
} catch (error) {
436410
if (error instanceof ApiError) {
437-
// @ts-expect-error: unused variables
438-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
439411
const errors = error.result;
440412
// const { statusCode, headers } = error;
441413
}
@@ -471,15 +443,11 @@ async getCharge(
471443
const chargeId = 'charge_id8';
472444

473445
try {
474-
// @ts-expect-error: unused variables
475-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
476446
const { result, ...httpResponse } = await chargesController.getCharge(chargeId);
477447
// Get more response info...
478448
// const { statusCode, headers } = httpResponse;
479449
} catch (error) {
480450
if (error instanceof ApiError) {
481-
// @ts-expect-error: unused variables
482-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
483451
const errors = error.result;
484452
// const { statusCode, headers } = error;
485453
}
@@ -517,15 +485,11 @@ async getChargesSummary(
517485
const status = 'status8';
518486

519487
try {
520-
// @ts-expect-error: unused variables
521-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
522488
const { result, ...httpResponse } = await chargesController.getChargesSummary(status);
523489
// Get more response info...
524490
// const { statusCode, headers } = httpResponse;
525491
} catch (error) {
526492
if (error instanceof ApiError) {
527-
// @ts-expect-error: unused variables
528-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
529493
const errors = error.result;
530494
// const { statusCode, headers } = error;
531495
}
@@ -563,15 +527,11 @@ async retryCharge(
563527
const chargeId = 'charge_id8';
564528

565529
try {
566-
// @ts-expect-error: unused variables
567-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
568530
const { result, ...httpResponse } = await chargesController.retryCharge(chargeId);
569531
// Get more response info...
570532
// const { statusCode, headers } = httpResponse;
571533
} catch (error) {
572534
if (error instanceof ApiError) {
573-
// @ts-expect-error: unused variables
574-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
575535
const errors = error.result;
576536
// const { statusCode, headers } = error;
577537
}
@@ -611,15 +571,11 @@ async cancelCharge(
611571
const chargeId = 'charge_id8';
612572

613573
try {
614-
// @ts-expect-error: unused variables
615-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
616574
const { result, ...httpResponse } = await chargesController.cancelCharge(chargeId);
617575
// Get more response info...
618576
// const { statusCode, headers } = httpResponse;
619577
} catch (error) {
620578
if (error instanceof ApiError) {
621-
// @ts-expect-error: unused variables
622-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
623579
const errors = error.result;
624580
// const { statusCode, headers } = error;
625581
}
@@ -663,15 +619,11 @@ const request: CreateChargeRequest = {
663619
};
664620

665621
try {
666-
// @ts-expect-error: unused variables
667-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
668622
const { result, ...httpResponse } = await chargesController.createCharge(request);
669623
// Get more response info...
670624
// const { statusCode, headers } = httpResponse;
671625
} catch (error) {
672626
if (error instanceof ApiError) {
673-
// @ts-expect-error: unused variables
674-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
675627
const errors = error.result;
676628
// const { statusCode, headers } = error;
677629
}
@@ -709,15 +661,11 @@ async confirmPayment(
709661
const chargeId = 'charge_id8';
710662

711663
try {
712-
// @ts-expect-error: unused variables
713-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
714664
const { result, ...httpResponse } = await chargesController.confirmPayment(chargeId);
715665
// Get more response info...
716666
// const { statusCode, headers } = httpResponse;
717667
} catch (error) {
718668
if (error instanceof ApiError) {
719-
// @ts-expect-error: unused variables
720-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
721669
const errors = error.result;
722670
// const { statusCode, headers } = error;
723671
}

0 commit comments

Comments
 (0)