postgrid-node 0.1.0-alpha.2 → 0.1.0-alpha.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +60 -0
- package/README.md +26 -40
- package/_shims/index.d.ts +2 -0
- package/_shims/index.js +5 -1
- package/_shims/index.mjs +5 -1
- package/core.d.ts +19 -5
- package/core.d.ts.map +1 -1
- package/core.js +25 -15
- package/core.js.map +1 -1
- package/core.mjs +26 -16
- package/core.mjs.map +1 -1
- package/index.d.mts +21 -8
- package/index.d.ts +21 -8
- package/index.d.ts.map +1 -1
- package/index.js +28 -5
- package/index.js.map +1 -1
- package/index.mjs +28 -5
- package/index.mjs.map +1 -1
- package/internal/qs/formats.d.ts +6 -0
- package/internal/qs/formats.d.ts.map +1 -0
- package/internal/qs/formats.js +11 -0
- package/internal/qs/formats.js.map +1 -0
- package/internal/qs/formats.mjs +8 -0
- package/internal/qs/formats.mjs.map +1 -0
- package/internal/qs/index.d.ts +10 -0
- package/internal/qs/index.d.ts.map +1 -0
- package/internal/qs/index.js +14 -0
- package/internal/qs/index.js.map +1 -0
- package/internal/qs/index.mjs +10 -0
- package/internal/qs/index.mjs.map +1 -0
- package/internal/qs/stringify.d.ts +3 -0
- package/internal/qs/stringify.d.ts.map +1 -0
- package/internal/qs/stringify.js +280 -0
- package/internal/qs/stringify.js.map +1 -0
- package/internal/qs/stringify.mjs +276 -0
- package/internal/qs/stringify.mjs.map +1 -0
- package/internal/qs/types.d.ts +57 -0
- package/internal/qs/types.d.ts.map +1 -0
- package/internal/qs/types.js +3 -0
- package/internal/qs/types.js.map +1 -0
- package/internal/qs/types.mjs +2 -0
- package/internal/qs/types.mjs.map +1 -0
- package/internal/qs/utils.d.ts +14 -0
- package/internal/qs/utils.d.ts.map +1 -0
- package/internal/qs/utils.js +229 -0
- package/internal/qs/utils.js.map +1 -0
- package/internal/qs/utils.mjs +217 -0
- package/internal/qs/utils.mjs.map +1 -0
- package/package.json +8 -29
- package/pagination.d.ts +2 -0
- package/pagination.d.ts.map +1 -1
- package/pagination.js +2 -1
- package/pagination.js.map +1 -1
- package/pagination.mjs +2 -1
- package/pagination.mjs.map +1 -1
- package/resource.d.ts +1 -1
- package/resource.d.ts.map +1 -1
- package/resource.js.map +1 -1
- package/resource.mjs.map +1 -1
- package/resources/bank-accounts.d.ts +61 -4
- package/resources/bank-accounts.d.ts.map +1 -1
- package/resources/bank-accounts.js +25 -0
- package/resources/bank-accounts.js.map +1 -1
- package/resources/bank-accounts.mjs +25 -0
- package/resources/bank-accounts.mjs.map +1 -1
- package/resources/boxes.d.ts +80 -15
- package/resources/boxes.d.ts.map +1 -1
- package/resources/boxes.js +27 -0
- package/resources/boxes.js.map +1 -1
- package/resources/boxes.mjs +27 -0
- package/resources/boxes.mjs.map +1 -1
- package/resources/campaigns.d.ts +22 -8
- package/resources/campaigns.d.ts.map +1 -1
- package/resources/cheques/cheques.d.ts +43 -4
- package/resources/cheques/cheques.d.ts.map +1 -1
- package/resources/cheques/cheques.js +23 -0
- package/resources/cheques/cheques.js.map +1 -1
- package/resources/cheques/cheques.mjs +23 -0
- package/resources/cheques/cheques.mjs.map +1 -1
- package/resources/cheques/url.d.ts +5 -0
- package/resources/cheques/url.d.ts.map +1 -1
- package/resources/cheques/url.js +5 -0
- package/resources/cheques/url.js.map +1 -1
- package/resources/cheques/url.mjs +5 -0
- package/resources/cheques/url.mjs.map +1 -1
- package/resources/cheques/with-deposit-ready-pdf.d.ts +6 -0
- package/resources/cheques/with-deposit-ready-pdf.d.ts.map +1 -1
- package/resources/cheques/with-deposit-ready-pdf.js +6 -0
- package/resources/cheques/with-deposit-ready-pdf.js.map +1 -1
- package/resources/cheques/with-deposit-ready-pdf.mjs +6 -0
- package/resources/cheques/with-deposit-ready-pdf.mjs.map +1 -1
- package/resources/cheques.d.ts +2 -0
- package/resources/cheques.d.ts.map +1 -0
- package/resources/cheques.js +19 -0
- package/resources/cheques.js.map +1 -0
- package/resources/cheques.mjs +3 -0
- package/resources/cheques.mjs.map +1 -0
- package/resources/contacts.d.ts +37 -3
- package/resources/contacts.d.ts.map +1 -1
- package/resources/contacts.js +20 -0
- package/resources/contacts.js.map +1 -1
- package/resources/contacts.mjs +20 -0
- package/resources/contacts.mjs.map +1 -1
- package/resources/index.d.ts +5 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +12 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +4 -0
- package/resources/index.mjs.map +1 -1
- package/resources/letters.d.ts +50 -6
- package/resources/letters.d.ts.map +1 -1
- package/resources/letters.js +24 -0
- package/resources/letters.js.map +1 -1
- package/resources/letters.mjs +24 -0
- package/resources/letters.mjs.map +1 -1
- package/resources/mailing-list-imports.d.ts +919 -0
- package/resources/mailing-list-imports.d.ts.map +1 -0
- package/resources/mailing-list-imports.js +95 -0
- package/resources/mailing-list-imports.js.map +1 -0
- package/resources/mailing-list-imports.mjs +90 -0
- package/resources/mailing-list-imports.mjs.map +1 -0
- package/resources/mailing-lists.d.ts +398 -0
- package/resources/mailing-lists.d.ts.map +1 -0
- package/resources/mailing-lists.js +101 -0
- package/resources/mailing-lists.js.map +1 -0
- package/resources/mailing-lists.mjs +96 -0
- package/resources/mailing-lists.mjs.map +1 -0
- package/resources/order-profiles/cheques.d.ts +588 -0
- package/resources/order-profiles/cheques.d.ts.map +1 -0
- package/resources/order-profiles/cheques.js +74 -0
- package/resources/order-profiles/cheques.js.map +1 -0
- package/resources/order-profiles/cheques.mjs +69 -0
- package/resources/order-profiles/cheques.mjs.map +1 -0
- package/resources/order-profiles/index.d.ts +6 -0
- package/resources/order-profiles/index.d.ts.map +1 -0
- package/resources/order-profiles/index.js +19 -0
- package/resources/order-profiles/index.js.map +1 -0
- package/resources/order-profiles/index.mjs +7 -0
- package/resources/order-profiles/index.mjs.map +1 -0
- package/resources/order-profiles/letters.d.ts +647 -0
- package/resources/order-profiles/letters.d.ts.map +1 -0
- package/resources/order-profiles/letters.js +80 -0
- package/resources/order-profiles/letters.js.map +1 -0
- package/resources/order-profiles/letters.mjs +75 -0
- package/resources/order-profiles/letters.mjs.map +1 -0
- package/resources/order-profiles/order-profiles.d.ts +22 -0
- package/resources/order-profiles/order-profiles.d.ts.map +1 -0
- package/resources/order-profiles/order-profiles.js +55 -0
- package/resources/order-profiles/order-profiles.js.map +1 -0
- package/resources/order-profiles/order-profiles.mjs +28 -0
- package/resources/order-profiles/order-profiles.mjs.map +1 -0
- package/resources/order-profiles/postcards.d.ts +423 -0
- package/resources/order-profiles/postcards.d.ts.map +1 -0
- package/resources/order-profiles/postcards.js +73 -0
- package/resources/order-profiles/postcards.js.map +1 -0
- package/resources/order-profiles/postcards.mjs +68 -0
- package/resources/order-profiles/postcards.mjs.map +1 -0
- package/resources/order-profiles/self-mailers.d.ts +435 -0
- package/resources/order-profiles/self-mailers.d.ts.map +1 -0
- package/resources/order-profiles/self-mailers.js +75 -0
- package/resources/order-profiles/self-mailers.js.map +1 -0
- package/resources/order-profiles/self-mailers.mjs +70 -0
- package/resources/order-profiles/self-mailers.mjs.map +1 -0
- package/resources/order-profiles.d.ts +2 -0
- package/resources/order-profiles.d.ts.map +1 -0
- package/resources/order-profiles.js +19 -0
- package/resources/order-profiles.js.map +1 -0
- package/resources/order-profiles.mjs +3 -0
- package/resources/order-profiles.mjs.map +1 -0
- package/resources/postcards.d.ts +58 -8
- package/resources/postcards.d.ts.map +1 -1
- package/resources/postcards.js +26 -0
- package/resources/postcards.js.map +1 -1
- package/resources/postcards.mjs +26 -0
- package/resources/postcards.mjs.map +1 -1
- package/resources/reports/exports.d.ts +36 -3
- package/resources/reports/exports.d.ts.map +1 -1
- package/resources/reports/exports.js +27 -0
- package/resources/reports/exports.js.map +1 -1
- package/resources/reports/exports.mjs +27 -0
- package/resources/reports/exports.mjs.map +1 -1
- package/resources/reports/reports.d.ts +76 -8
- package/resources/reports/reports.d.ts.map +1 -1
- package/resources/reports/reports.js +44 -0
- package/resources/reports/reports.js.map +1 -1
- package/resources/reports/reports.mjs +44 -0
- package/resources/reports/reports.mjs.map +1 -1
- package/resources/reports.d.ts +2 -0
- package/resources/reports.d.ts.map +1 -0
- package/resources/reports.js +19 -0
- package/resources/reports.js.map +1 -0
- package/resources/reports.mjs +3 -0
- package/resources/reports.mjs.map +1 -0
- package/resources/self-mailers.d.ts +99 -15
- package/resources/self-mailers.d.ts.map +1 -1
- package/resources/self-mailers.js +38 -0
- package/resources/self-mailers.js.map +1 -1
- package/resources/self-mailers.mjs +38 -0
- package/resources/self-mailers.mjs.map +1 -1
- package/resources/shared.d.ts +6 -2
- package/resources/shared.d.ts.map +1 -1
- package/resources/sub-organizations.d.ts +394 -0
- package/resources/sub-organizations.d.ts.map +1 -0
- package/resources/sub-organizations.js +63 -0
- package/resources/sub-organizations.js.map +1 -0
- package/resources/sub-organizations.mjs +58 -0
- package/resources/sub-organizations.mjs.map +1 -0
- package/resources/templates.d.ts +43 -3
- package/resources/templates.d.ts.map +1 -1
- package/resources/templates.js +26 -0
- package/resources/templates.js.map +1 -1
- package/resources/templates.mjs +26 -0
- package/resources/templates.mjs.map +1 -1
- package/resources.d.ts +2 -0
- package/resources.d.ts.map +1 -0
- package/resources.js +18 -0
- package/resources.js.map +1 -0
- package/resources.mjs +2 -0
- package/resources.mjs.map +1 -0
- package/src/_shims/index.d.ts +2 -0
- package/src/_shims/index.js +5 -1
- package/src/_shims/index.mjs +5 -1
- package/src/core.ts +44 -16
- package/src/index.ts +112 -11
- package/src/internal/qs/LICENSE.md +13 -0
- package/src/internal/qs/README.md +3 -0
- package/src/internal/qs/formats.ts +9 -0
- package/src/internal/qs/index.ts +13 -0
- package/src/internal/qs/stringify.ts +388 -0
- package/src/internal/qs/types.ts +71 -0
- package/src/internal/qs/utils.ts +265 -0
- package/src/pagination.ts +6 -1
- package/src/resource.ts +1 -1
- package/src/resources/bank-accounts.ts +57 -4
- package/src/resources/boxes.ts +50 -15
- package/src/resources/campaigns.ts +8 -8
- package/src/resources/cheques/cheques.ts +35 -4
- package/src/resources/cheques/url.ts +5 -0
- package/src/resources/cheques/with-deposit-ready-pdf.ts +6 -0
- package/src/resources/cheques.ts +3 -0
- package/src/resources/contacts.ts +31 -3
- package/src/resources/index.ts +39 -0
- package/src/resources/letters.ts +38 -6
- package/src/resources/mailing-list-imports.ts +1076 -0
- package/src/resources/mailing-lists.ts +511 -0
- package/src/resources/order-profiles/cheques.ts +888 -0
- package/src/resources/order-profiles/index.ts +55 -0
- package/src/resources/order-profiles/letters.ts +956 -0
- package/src/resources/order-profiles/order-profiles.ts +133 -0
- package/src/resources/order-profiles/postcards.ts +694 -0
- package/src/resources/order-profiles/self-mailers.ts +707 -0
- package/src/resources/order-profiles.ts +3 -0
- package/src/resources/postcards.ts +42 -8
- package/src/resources/reports/exports.ts +30 -3
- package/src/resources/reports/reports.ts +60 -8
- package/src/resources/reports.ts +3 -0
- package/src/resources/self-mailers.ts +80 -14
- package/src/resources/shared.ts +2 -2
- package/src/resources/sub-organizations.ts +518 -0
- package/src/resources/templates.ts +37 -3
- package/src/resources.ts +1 -0
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/boxes.d.ts
CHANGED
|
@@ -21,19 +21,54 @@ export declare class Boxes extends APIResource {
|
|
|
21
21
|
* - `bankAccount`: The bank account ID
|
|
22
22
|
* - `amount`: The amount to be sent
|
|
23
23
|
* - `number`: The cheque number
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* ```ts
|
|
27
|
+
* const box = await client.boxes.create({
|
|
28
|
+
* cheques: [
|
|
29
|
+
* {
|
|
30
|
+
* from: 'contact_456',
|
|
31
|
+
* to: 'contact_123',
|
|
32
|
+
* bankAccount: 'bank_abc',
|
|
33
|
+
* amount: 5000,
|
|
34
|
+
* number: 1042,
|
|
35
|
+
* },
|
|
36
|
+
* ],
|
|
37
|
+
* from: 'contact_456',
|
|
38
|
+
* to: 'contact_123',
|
|
39
|
+
* });
|
|
40
|
+
* ```
|
|
24
41
|
*/
|
|
25
42
|
create(body: BoxCreateParams, options?: Core.RequestOptions): Core.APIPromise<BoxCreateResponse>;
|
|
26
43
|
/**
|
|
27
44
|
* Retrieve a box by ID.
|
|
45
|
+
*
|
|
46
|
+
* @example
|
|
47
|
+
* ```ts
|
|
48
|
+
* const box = await client.boxes.retrieve('id');
|
|
49
|
+
* ```
|
|
28
50
|
*/
|
|
29
51
|
retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<BoxRetrieveResponse>;
|
|
30
52
|
/**
|
|
31
53
|
* List all boxes.
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* ```ts
|
|
57
|
+
* // Automatically fetches more pages as needed.
|
|
58
|
+
* for await (const boxListResponse of client.boxes.list()) {
|
|
59
|
+
* // ...
|
|
60
|
+
* }
|
|
61
|
+
* ```
|
|
32
62
|
*/
|
|
33
63
|
list(query?: BoxListParams, options?: Core.RequestOptions): Core.PagePromise<BoxListResponsesList, BoxListResponse>;
|
|
34
64
|
list(options?: Core.RequestOptions): Core.PagePromise<BoxListResponsesList, BoxListResponse>;
|
|
35
65
|
/**
|
|
36
66
|
* Cancel a box by ID (cannot be undone).
|
|
67
|
+
*
|
|
68
|
+
* @example
|
|
69
|
+
* ```ts
|
|
70
|
+
* const response = await client.boxes.cancel('id');
|
|
71
|
+
* ```
|
|
37
72
|
*/
|
|
38
73
|
cancel(id: string, options?: Core.RequestOptions): Core.APIPromise<BoxCancelResponse>;
|
|
39
74
|
}
|
|
@@ -119,11 +154,15 @@ export interface BoxCreateResponse {
|
|
|
119
154
|
* template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
|
|
120
155
|
* PDFs uploaded with the order.
|
|
121
156
|
*/
|
|
122
|
-
mergeVariables?:
|
|
157
|
+
mergeVariables?: {
|
|
158
|
+
[key: string]: unknown;
|
|
159
|
+
};
|
|
123
160
|
/**
|
|
124
161
|
* See the section on Metadata.
|
|
125
162
|
*/
|
|
126
|
-
metadata?:
|
|
163
|
+
metadata?: {
|
|
164
|
+
[key: string]: unknown;
|
|
165
|
+
};
|
|
127
166
|
/**
|
|
128
167
|
* The tracking number of this order. Populated after an express/certified order
|
|
129
168
|
* has been processed for delivery.
|
|
@@ -169,7 +208,9 @@ export declare namespace BoxCreateResponse {
|
|
|
169
208
|
* A set of dynamic merge variables for customizing the cheque or accompanying
|
|
170
209
|
* documents (optional).
|
|
171
210
|
*/
|
|
172
|
-
mergeVariables?:
|
|
211
|
+
mergeVariables?: {
|
|
212
|
+
[key: string]: unknown;
|
|
213
|
+
};
|
|
173
214
|
/**
|
|
174
215
|
* An optional message template to be printed on or with the cheque.
|
|
175
216
|
*/
|
|
@@ -256,11 +297,15 @@ export interface BoxRetrieveResponse {
|
|
|
256
297
|
* template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
|
|
257
298
|
* PDFs uploaded with the order.
|
|
258
299
|
*/
|
|
259
|
-
mergeVariables?:
|
|
300
|
+
mergeVariables?: {
|
|
301
|
+
[key: string]: unknown;
|
|
302
|
+
};
|
|
260
303
|
/**
|
|
261
304
|
* See the section on Metadata.
|
|
262
305
|
*/
|
|
263
|
-
metadata?:
|
|
306
|
+
metadata?: {
|
|
307
|
+
[key: string]: unknown;
|
|
308
|
+
};
|
|
264
309
|
/**
|
|
265
310
|
* The tracking number of this order. Populated after an express/certified order
|
|
266
311
|
* has been processed for delivery.
|
|
@@ -306,7 +351,9 @@ export declare namespace BoxRetrieveResponse {
|
|
|
306
351
|
* A set of dynamic merge variables for customizing the cheque or accompanying
|
|
307
352
|
* documents (optional).
|
|
308
353
|
*/
|
|
309
|
-
mergeVariables?:
|
|
354
|
+
mergeVariables?: {
|
|
355
|
+
[key: string]: unknown;
|
|
356
|
+
};
|
|
310
357
|
/**
|
|
311
358
|
* An optional message template to be printed on or with the cheque.
|
|
312
359
|
*/
|
|
@@ -393,11 +440,15 @@ export interface BoxListResponse {
|
|
|
393
440
|
* template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
|
|
394
441
|
* PDFs uploaded with the order.
|
|
395
442
|
*/
|
|
396
|
-
mergeVariables?:
|
|
443
|
+
mergeVariables?: {
|
|
444
|
+
[key: string]: unknown;
|
|
445
|
+
};
|
|
397
446
|
/**
|
|
398
447
|
* See the section on Metadata.
|
|
399
448
|
*/
|
|
400
|
-
metadata?:
|
|
449
|
+
metadata?: {
|
|
450
|
+
[key: string]: unknown;
|
|
451
|
+
};
|
|
401
452
|
/**
|
|
402
453
|
* The tracking number of this order. Populated after an express/certified order
|
|
403
454
|
* has been processed for delivery.
|
|
@@ -443,7 +494,9 @@ export declare namespace BoxListResponse {
|
|
|
443
494
|
* A set of dynamic merge variables for customizing the cheque or accompanying
|
|
444
495
|
* documents (optional).
|
|
445
496
|
*/
|
|
446
|
-
mergeVariables?:
|
|
497
|
+
mergeVariables?: {
|
|
498
|
+
[key: string]: unknown;
|
|
499
|
+
};
|
|
447
500
|
/**
|
|
448
501
|
* An optional message template to be printed on or with the cheque.
|
|
449
502
|
*/
|
|
@@ -530,11 +583,15 @@ export interface BoxCancelResponse {
|
|
|
530
583
|
* template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
|
|
531
584
|
* PDFs uploaded with the order.
|
|
532
585
|
*/
|
|
533
|
-
mergeVariables?:
|
|
586
|
+
mergeVariables?: {
|
|
587
|
+
[key: string]: unknown;
|
|
588
|
+
};
|
|
534
589
|
/**
|
|
535
590
|
* See the section on Metadata.
|
|
536
591
|
*/
|
|
537
|
-
metadata?:
|
|
592
|
+
metadata?: {
|
|
593
|
+
[key: string]: unknown;
|
|
594
|
+
};
|
|
538
595
|
/**
|
|
539
596
|
* The tracking number of this order. Populated after an express/certified order
|
|
540
597
|
* has been processed for delivery.
|
|
@@ -580,7 +637,9 @@ export declare namespace BoxCancelResponse {
|
|
|
580
637
|
* A set of dynamic merge variables for customizing the cheque or accompanying
|
|
581
638
|
* documents (optional).
|
|
582
639
|
*/
|
|
583
|
-
mergeVariables?:
|
|
640
|
+
mergeVariables?: {
|
|
641
|
+
[key: string]: unknown;
|
|
642
|
+
};
|
|
584
643
|
/**
|
|
585
644
|
* An optional message template to be printed on or with the cheque.
|
|
586
645
|
*/
|
|
@@ -621,11 +680,15 @@ export interface BoxCreateParams {
|
|
|
621
680
|
* template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
|
|
622
681
|
* PDFs uploaded with the order.
|
|
623
682
|
*/
|
|
624
|
-
mergeVariables?:
|
|
683
|
+
mergeVariables?: {
|
|
684
|
+
[key: string]: unknown;
|
|
685
|
+
};
|
|
625
686
|
/**
|
|
626
687
|
* See the section on Metadata.
|
|
627
688
|
*/
|
|
628
|
-
metadata?:
|
|
689
|
+
metadata?: {
|
|
690
|
+
[key: string]: unknown;
|
|
691
|
+
};
|
|
629
692
|
/**
|
|
630
693
|
* This order will transition from `ready` to `printing` on the day after this
|
|
631
694
|
* date. You can use this parameter to schedule orders for a future date.
|
|
@@ -660,7 +723,9 @@ export declare namespace BoxCreateParams {
|
|
|
660
723
|
* A set of dynamic merge variables for customizing the cheque or accompanying
|
|
661
724
|
* documents (optional).
|
|
662
725
|
*/
|
|
663
|
-
mergeVariables?:
|
|
726
|
+
mergeVariables?: {
|
|
727
|
+
[key: string]: unknown;
|
|
728
|
+
};
|
|
664
729
|
/**
|
|
665
730
|
* An optional message template to be printed on or with the cheque.
|
|
666
731
|
*/
|
package/resources/boxes.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"boxes.d.ts","sourceRoot":"","sources":["../src/resources/boxes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAEtD,qBAAa,KAAM,SAAQ,WAAW;IACpC
|
|
1
|
+
{"version":3,"file":"boxes.d.ts","sourceRoot":"","sources":["../src/resources/boxes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAEtD,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC;IAIhG;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAIzF;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,aAAa,EACrB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE,eAAe,CAAC;IAC1D,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE,eAAe,CAAC;IAW5F;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC;CAGtF;AAED,qBAAa,oBAAqB,SAAQ,IAAI,CAAC,eAAe,CAAC;CAAG;AAElE,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAEzC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,YAAY,EACR,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC;IAEd;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,UAAU,GAAG,wBAAwB,GAAG,WAAW,GAAG,WAAW,CAAC;IAEpF;;;OAGG;IACH,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,YAAY,CAAC;IAEnC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,qBAAqB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE9E;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,MAAM;QACrB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;QAE1B;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;QAExB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,cAAc,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE5C;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAE3C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,YAAY,EACR,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC;IAEd;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,UAAU,GAAG,wBAAwB,GAAG,WAAW,GAAG,WAAW,CAAC;IAEpF;;;OAGG;IACH,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,YAAY,CAAC;IAEnC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,qBAAqB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE9E;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,MAAM;QACrB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;QAE1B;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;QAExB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,cAAc,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE5C;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IAEvC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,YAAY,EACR,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC;IAEd;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,UAAU,GAAG,wBAAwB,GAAG,WAAW,GAAG,WAAW,CAAC;IAEpF;;;OAGG;IACH,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,YAAY,CAAC;IAEnC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,qBAAqB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE9E;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,eAAe,CAAC;IAC/B,UAAiB,MAAM;QACrB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;QAE1B;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;QAExB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,cAAc,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE5C;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAEzC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,YAAY,EACR,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC;IAEd;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,UAAU,GAAG,wBAAwB,GAAG,WAAW,GAAG,WAAW,CAAC;IAEpF;;;OAGG;IACH,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,YAAY,CAAC;IAEnC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,qBAAqB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE9E;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,MAAM;QACrB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;QAE1B;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;QAExB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,cAAc,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE5C;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,OAAO,EAAE,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IAEvC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;IAEvF;;;;;OAKG;IACH,EAAE,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;IAErF;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,YAAY,CAAC,EACT,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;IAE3B;;;;;OAKG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,eAAe,CAAC;IAC/B,UAAiB,MAAM;QACrB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB,IAAI,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEvF;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf,EAAE,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAErF;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,cAAc,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE5C;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,aAAc,SAAQ,UAAU;IAC/C;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAID,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,oBAAoB,IAAI,oBAAoB,EAC5C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;CACH"}
|
package/resources/boxes.js
CHANGED
|
@@ -23,12 +23,34 @@ class Boxes extends resource_1.APIResource {
|
|
|
23
23
|
* - `bankAccount`: The bank account ID
|
|
24
24
|
* - `amount`: The amount to be sent
|
|
25
25
|
* - `number`: The cheque number
|
|
26
|
+
*
|
|
27
|
+
* @example
|
|
28
|
+
* ```ts
|
|
29
|
+
* const box = await client.boxes.create({
|
|
30
|
+
* cheques: [
|
|
31
|
+
* {
|
|
32
|
+
* from: 'contact_456',
|
|
33
|
+
* to: 'contact_123',
|
|
34
|
+
* bankAccount: 'bank_abc',
|
|
35
|
+
* amount: 5000,
|
|
36
|
+
* number: 1042,
|
|
37
|
+
* },
|
|
38
|
+
* ],
|
|
39
|
+
* from: 'contact_456',
|
|
40
|
+
* to: 'contact_123',
|
|
41
|
+
* });
|
|
42
|
+
* ```
|
|
26
43
|
*/
|
|
27
44
|
create(body, options) {
|
|
28
45
|
return this._client.post('/boxes', { body, ...options });
|
|
29
46
|
}
|
|
30
47
|
/**
|
|
31
48
|
* Retrieve a box by ID.
|
|
49
|
+
*
|
|
50
|
+
* @example
|
|
51
|
+
* ```ts
|
|
52
|
+
* const box = await client.boxes.retrieve('id');
|
|
53
|
+
* ```
|
|
32
54
|
*/
|
|
33
55
|
retrieve(id, options) {
|
|
34
56
|
return this._client.get(`/boxes/${id}`, options);
|
|
@@ -41,6 +63,11 @@ class Boxes extends resource_1.APIResource {
|
|
|
41
63
|
}
|
|
42
64
|
/**
|
|
43
65
|
* Cancel a box by ID (cannot be undone).
|
|
66
|
+
*
|
|
67
|
+
* @example
|
|
68
|
+
* ```ts
|
|
69
|
+
* const response = await client.boxes.cancel('id');
|
|
70
|
+
* ```
|
|
44
71
|
*/
|
|
45
72
|
cancel(id, options) {
|
|
46
73
|
return this._client.delete(`/boxes/${id}`, options);
|
package/resources/boxes.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"boxes.js","sourceRoot":"","sources":["../src/resources/boxes.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAI3C,iDAAsD;AAEtD,MAAa,KAAM,SAAQ,sBAAW;IACpC
|
|
1
|
+
{"version":3,"file":"boxes.js","sourceRoot":"","sources":["../src/resources/boxes.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAI3C,iDAAsD;AAEtD,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,IAAqB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAkBD,IAAI,CACF,QAA6C,EAAE,EAC/C,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;CACF;AAzFD,sBAyFC;AAED,MAAa,oBAAqB,SAAQ,iBAAqB;CAAG;AAAlE,oDAAkE;AAw4BlE,KAAK,CAAC,oBAAoB,GAAG,oBAAoB,CAAC"}
|
package/resources/boxes.mjs
CHANGED
|
@@ -20,12 +20,34 @@ export class Boxes extends APIResource {
|
|
|
20
20
|
* - `bankAccount`: The bank account ID
|
|
21
21
|
* - `amount`: The amount to be sent
|
|
22
22
|
* - `number`: The cheque number
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```ts
|
|
26
|
+
* const box = await client.boxes.create({
|
|
27
|
+
* cheques: [
|
|
28
|
+
* {
|
|
29
|
+
* from: 'contact_456',
|
|
30
|
+
* to: 'contact_123',
|
|
31
|
+
* bankAccount: 'bank_abc',
|
|
32
|
+
* amount: 5000,
|
|
33
|
+
* number: 1042,
|
|
34
|
+
* },
|
|
35
|
+
* ],
|
|
36
|
+
* from: 'contact_456',
|
|
37
|
+
* to: 'contact_123',
|
|
38
|
+
* });
|
|
39
|
+
* ```
|
|
23
40
|
*/
|
|
24
41
|
create(body, options) {
|
|
25
42
|
return this._client.post('/boxes', { body, ...options });
|
|
26
43
|
}
|
|
27
44
|
/**
|
|
28
45
|
* Retrieve a box by ID.
|
|
46
|
+
*
|
|
47
|
+
* @example
|
|
48
|
+
* ```ts
|
|
49
|
+
* const box = await client.boxes.retrieve('id');
|
|
50
|
+
* ```
|
|
29
51
|
*/
|
|
30
52
|
retrieve(id, options) {
|
|
31
53
|
return this._client.get(`/boxes/${id}`, options);
|
|
@@ -38,6 +60,11 @@ export class Boxes extends APIResource {
|
|
|
38
60
|
}
|
|
39
61
|
/**
|
|
40
62
|
* Cancel a box by ID (cannot be undone).
|
|
63
|
+
*
|
|
64
|
+
* @example
|
|
65
|
+
* ```ts
|
|
66
|
+
* const response = await client.boxes.cancel('id');
|
|
67
|
+
* ```
|
|
41
68
|
*/
|
|
42
69
|
cancel(id, options) {
|
|
43
70
|
return this._client.delete(`/boxes/${id}`, options);
|
package/resources/boxes.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"boxes.mjs","sourceRoot":"","sources":["../src/resources/boxes.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAIpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC
|
|
1
|
+
{"version":3,"file":"boxes.mjs","sourceRoot":"","sources":["../src/resources/boxes.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAIpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,IAAqB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAkBD,IAAI,CACF,QAA6C,EAAE,EAC/C,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;CACF;AAED,MAAM,OAAO,oBAAqB,SAAQ,IAAqB;CAAG;AAw4BlE,KAAK,CAAC,oBAAoB,GAAG,oBAAoB,CAAC"}
|
package/resources/campaigns.d.ts
CHANGED
|
@@ -107,7 +107,9 @@ export interface CampaignCreateResponse {
|
|
|
107
107
|
/**
|
|
108
108
|
* See the section on Metadata.
|
|
109
109
|
*/
|
|
110
|
-
metadata?:
|
|
110
|
+
metadata?: {
|
|
111
|
+
[key: string]: unknown;
|
|
112
|
+
};
|
|
111
113
|
/**
|
|
112
114
|
* A temporary URL to preview the first rendered order, available once the campaign
|
|
113
115
|
* status is 'draft' or later.
|
|
@@ -204,7 +206,9 @@ export interface CampaignRetrieveResponse {
|
|
|
204
206
|
/**
|
|
205
207
|
* See the section on Metadata.
|
|
206
208
|
*/
|
|
207
|
-
metadata?:
|
|
209
|
+
metadata?: {
|
|
210
|
+
[key: string]: unknown;
|
|
211
|
+
};
|
|
208
212
|
/**
|
|
209
213
|
* A temporary URL to preview the first rendered order, available once the campaign
|
|
210
214
|
* status is 'draft' or later.
|
|
@@ -301,7 +305,9 @@ export interface CampaignUpdateResponse {
|
|
|
301
305
|
/**
|
|
302
306
|
* See the section on Metadata.
|
|
303
307
|
*/
|
|
304
|
-
metadata?:
|
|
308
|
+
metadata?: {
|
|
309
|
+
[key: string]: unknown;
|
|
310
|
+
};
|
|
305
311
|
/**
|
|
306
312
|
* A temporary URL to preview the first rendered order, available once the campaign
|
|
307
313
|
* status is 'draft' or later.
|
|
@@ -398,7 +404,9 @@ export interface CampaignListResponse {
|
|
|
398
404
|
/**
|
|
399
405
|
* See the section on Metadata.
|
|
400
406
|
*/
|
|
401
|
-
metadata?:
|
|
407
|
+
metadata?: {
|
|
408
|
+
[key: string]: unknown;
|
|
409
|
+
};
|
|
402
410
|
/**
|
|
403
411
|
* A temporary URL to preview the first rendered order, available once the campaign
|
|
404
412
|
* status is 'draft' or later.
|
|
@@ -502,7 +510,9 @@ export interface CampaignSendResponse {
|
|
|
502
510
|
/**
|
|
503
511
|
* See the section on Metadata.
|
|
504
512
|
*/
|
|
505
|
-
metadata?:
|
|
513
|
+
metadata?: {
|
|
514
|
+
[key: string]: unknown;
|
|
515
|
+
};
|
|
506
516
|
/**
|
|
507
517
|
* A temporary URL to preview the first rendered order, available once the campaign
|
|
508
518
|
* status is 'draft' or later.
|
|
@@ -567,7 +577,9 @@ export interface CampaignCreateParams {
|
|
|
567
577
|
/**
|
|
568
578
|
* See the section on Metadata.
|
|
569
579
|
*/
|
|
570
|
-
metadata?:
|
|
580
|
+
metadata?: {
|
|
581
|
+
[key: string]: unknown;
|
|
582
|
+
};
|
|
571
583
|
/**
|
|
572
584
|
* The ID of the postcard profile used for this campaign, if applicable.
|
|
573
585
|
*/
|
|
@@ -609,7 +621,9 @@ export interface CampaignUpdateParams {
|
|
|
609
621
|
* Optional key-value data associated with the campaign. Set to `null` to remove
|
|
610
622
|
* existing metadata.
|
|
611
623
|
*/
|
|
612
|
-
metadata?:
|
|
624
|
+
metadata?: {
|
|
625
|
+
[key: string]: string;
|
|
626
|
+
} | null;
|
|
613
627
|
/**
|
|
614
628
|
* The ID of the postcard profile to use. Setting this will remove other profile
|
|
615
629
|
* types. Set to `null` to remove.
|
|
@@ -636,7 +650,7 @@ export interface CampaignSendParams {
|
|
|
636
650
|
* The date and time the campaign should be sent. Must be in the future. If
|
|
637
651
|
* omitted, defaults to the earliest possible processing date.
|
|
638
652
|
*/
|
|
639
|
-
sendDate?: string | string;
|
|
653
|
+
sendDate?: (string & {}) | string;
|
|
640
654
|
}
|
|
641
655
|
export declare namespace Campaigns {
|
|
642
656
|
export { type CampaignCreateResponse as CampaignCreateResponse, type CampaignRetrieveResponse as CampaignRetrieveResponse, type CampaignUpdateResponse as CampaignUpdateResponse, type CampaignListResponse as CampaignListResponse, type CampaignDeleteResponse as CampaignDeleteResponse, type CampaignSendResponse as CampaignSendResponse, CampaignListResponsesList as CampaignListResponsesList, type CampaignCreateParams as CampaignCreateParams, type CampaignUpdateParams as CampaignUpdateParams, type CampaignListParams as CampaignListParams, type CampaignSendParams as CampaignSendParams, };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"campaigns.d.ts","sourceRoot":"","sources":["../src/resources/campaigns.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAEtD,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAI1G;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAI9F;;;;;;OAMG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAI1C;;;;;OAKG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,yBAAyB,EAAE,oBAAoB,CAAC;IACpE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,yBAAyB,EAAE,oBAAoB,CAAC;IAWtG;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAI1F;;;;;;OAMG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;CAGzC;AAED,qBAAa,yBAA0B,SAAQ,IAAI,CAAC,oBAAoB,CAAC;CAAG;AAE5E;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EACF,UAAU,GACV,kBAAkB,GAClB,iBAAiB,GACjB,OAAO,GACP,OAAO,GACP,UAAU,GACV,wBAAwB,CAAC;IAE7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAE7C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,
|
|
1
|
+
{"version":3,"file":"campaigns.d.ts","sourceRoot":"","sources":["../src/resources/campaigns.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAEtD,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAI1G;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAI9F;;;;;;OAMG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAI1C;;;;;OAKG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,yBAAyB,EAAE,oBAAoB,CAAC;IACpE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,yBAAyB,EAAE,oBAAoB,CAAC;IAWtG;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAI1F;;;;;;OAMG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;CAGzC;AAED,qBAAa,yBAA0B,SAAQ,IAAI,CAAC,oBAAoB,CAAC;CAAG;AAE5E;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EACF,UAAU,GACV,kBAAkB,GAClB,iBAAiB,GACjB,OAAO,GACP,OAAO,GACP,UAAU,GACV,wBAAwB,CAAC;IAE7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAE7C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,kBAAkB,GAAG,gBAAgB,CAAC;KAC7C;CACF;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EACF,UAAU,GACV,kBAAkB,GAClB,iBAAiB,GACjB,OAAO,GACP,OAAO,GACP,UAAU,GACV,wBAAwB,CAAC;IAE7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;IAE/C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,kBAAkB,GAAG,gBAAgB,CAAC;KAC7C;CACF;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EACF,UAAU,GACV,kBAAkB,GAClB,iBAAiB,GACjB,OAAO,GACP,OAAO,GACP,UAAU,GACV,wBAAwB,CAAC;IAE7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAE7C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,kBAAkB,GAAG,gBAAgB,CAAC;KAC7C;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EACF,UAAU,GACV,kBAAkB,GAClB,iBAAiB,GACjB,OAAO,GACP,OAAO,GACP,UAAU,GACV,wBAAwB,CAAC;IAE7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAE3C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,kBAAkB,GAAG,gBAAgB,CAAC;KAC7C;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,IAAI,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EACF,UAAU,GACV,kBAAkB,GAClB,iBAAiB,GACjB,OAAO,GACP,OAAO,GACP,UAAU,GACV,wBAAwB,CAAC;IAE7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAE3C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,kBAAkB,GAAG,gBAAgB,CAAC;KAC7C;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACnC;AAED,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,MAAM,CAAC;CACnC;AAID,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,yBAAyB,IAAI,yBAAyB,EACtD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
|
|
@@ -34,19 +34,50 @@ export declare class Cheques extends APIResource {
|
|
|
34
34
|
* }
|
|
35
35
|
* }
|
|
36
36
|
* ```
|
|
37
|
+
*
|
|
38
|
+
* @example
|
|
39
|
+
* ```ts
|
|
40
|
+
* const cheque = await client.cheques.create({
|
|
41
|
+
* amount: 1000,
|
|
42
|
+
* bankAccount: 'bank_123',
|
|
43
|
+
* from: 'contact_123',
|
|
44
|
+
* to: 'contact_123',
|
|
45
|
+
* currencyCode: 'USD',
|
|
46
|
+
* number: 123456,
|
|
47
|
+
* size: 'us_letter',
|
|
48
|
+
* });
|
|
49
|
+
* ```
|
|
37
50
|
*/
|
|
38
51
|
create(body: ChequeCreateParams, options?: Core.RequestOptions): Core.APIPromise<Cheque>;
|
|
39
52
|
/**
|
|
40
53
|
* Retrieve a cheque by ID.
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* ```ts
|
|
57
|
+
* const cheque = await client.cheques.retrieve('id');
|
|
58
|
+
* ```
|
|
41
59
|
*/
|
|
42
60
|
retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Cheque>;
|
|
43
61
|
/**
|
|
44
62
|
* Get a list of cheques.
|
|
63
|
+
*
|
|
64
|
+
* @example
|
|
65
|
+
* ```ts
|
|
66
|
+
* // Automatically fetches more pages as needed.
|
|
67
|
+
* for await (const cheque of client.cheques.list()) {
|
|
68
|
+
* // ...
|
|
69
|
+
* }
|
|
70
|
+
* ```
|
|
45
71
|
*/
|
|
46
72
|
list(query?: ChequeListParams, options?: Core.RequestOptions): Core.PagePromise<ChequesList, Cheque>;
|
|
47
73
|
list(options?: Core.RequestOptions): Core.PagePromise<ChequesList, Cheque>;
|
|
48
74
|
/**
|
|
49
75
|
* Cancel a cheque by ID. Note that this operation cannot be undone.
|
|
76
|
+
*
|
|
77
|
+
* @example
|
|
78
|
+
* ```ts
|
|
79
|
+
* const cheque = await client.cheques.cancel('id');
|
|
80
|
+
* ```
|
|
50
81
|
*/
|
|
51
82
|
cancel(id: string, options?: Core.RequestOptions): Core.APIPromise<Cheque>;
|
|
52
83
|
}
|
|
@@ -171,7 +202,9 @@ export interface Cheque {
|
|
|
171
202
|
* template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
|
|
172
203
|
* PDFs uploaded with the order.
|
|
173
204
|
*/
|
|
174
|
-
mergeVariables?:
|
|
205
|
+
mergeVariables?: {
|
|
206
|
+
[key: string]: unknown;
|
|
207
|
+
};
|
|
175
208
|
/**
|
|
176
209
|
* The message of the cheque.
|
|
177
210
|
*/
|
|
@@ -179,7 +212,9 @@ export interface Cheque {
|
|
|
179
212
|
/**
|
|
180
213
|
* See the section on Metadata.
|
|
181
214
|
*/
|
|
182
|
-
metadata?:
|
|
215
|
+
metadata?: {
|
|
216
|
+
[key: string]: unknown;
|
|
217
|
+
};
|
|
183
218
|
/**
|
|
184
219
|
* The number of the cheque. If you don't provide this, it will automatically be
|
|
185
220
|
* set to an incrementing number starting from 1 across your entire account,
|
|
@@ -286,7 +321,9 @@ export interface ChequeCreateParams {
|
|
|
286
321
|
* template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
|
|
287
322
|
* PDFs uploaded with the order.
|
|
288
323
|
*/
|
|
289
|
-
mergeVariables?:
|
|
324
|
+
mergeVariables?: {
|
|
325
|
+
[key: string]: unknown;
|
|
326
|
+
};
|
|
290
327
|
/**
|
|
291
328
|
* The message of the cheque.
|
|
292
329
|
*/
|
|
@@ -294,7 +331,9 @@ export interface ChequeCreateParams {
|
|
|
294
331
|
/**
|
|
295
332
|
* See the section on Metadata.
|
|
296
333
|
*/
|
|
297
|
-
metadata?:
|
|
334
|
+
metadata?: {
|
|
335
|
+
[key: string]: unknown;
|
|
336
|
+
};
|
|
298
337
|
/**
|
|
299
338
|
* The number of the cheque. If you don't provide this, it will automatically be
|
|
300
339
|
* set to an incrementing number starting from 1 across your entire account,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cheques.d.ts","sourceRoot":"","sources":["../../src/resources/cheques/cheques.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,WAAW,MAAM,aAAa,CAAC;AAC3C,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,MAAM,MAAM,OAAO,CAAC;AAChC,OAAO,EAAE,GAAG,EAAE,mBAAmB,EAAE,MAAM,OAAO,CAAC;AACjD,OAAO,KAAK,sBAAsB,MAAM,0BAA0B,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEzD,qBAAa,OAAQ,SAAQ,WAAW;IACtC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAgC;IAC/C,mBAAmB,EAAE,sBAAsB,CAAC,mBAAmB,CACA;IAE/D
|
|
1
|
+
{"version":3,"file":"cheques.d.ts","sourceRoot":"","sources":["../../src/resources/cheques/cheques.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,WAAW,MAAM,aAAa,CAAC;AAC3C,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,MAAM,MAAM,OAAO,CAAC;AAChC,OAAO,EAAE,GAAG,EAAE,mBAAmB,EAAE,MAAM,OAAO,CAAC;AACjD,OAAO,KAAK,sBAAsB,MAAM,0BAA0B,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEzD,qBAAa,OAAQ,SAAQ,WAAW;IACtC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAgC;IAC/C,mBAAmB,EAAE,sBAAsB,CAAC,mBAAmB,CACA;IAE/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAIxF;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAI5E;;;;;;;;;;OAUG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,CAAC;IACpG,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,CAAC;IAW1E;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;CAG3E;AAED,qBAAa,WAAY,SAAQ,IAAI,CAAC,MAAM,CAAC;CAAG;AAEhD,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,YAAY,EAAE,KAAK,GAAG,KAAK,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,YAAY,EACR,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,WAAW,GAAG,UAAU,CAAC;IAE/B;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,UAAU,GAAG,wBAAwB,GAAG,WAAW,GAAG,WAAW,CAAC;IAEpF;;;OAGG;IACH,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,YAAY,CAAC;IAEnC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;IAEjC;;;OAGG;IACH,QAAQ,CAAC,EAAE,UAAU,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;IAEtC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,qBAAqB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE9E;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,MAAM,CAAC;IACtB;;;OAGG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;IAEvF;;;;;OAKG;IACH,EAAE,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;IAErF;;;;;OAKG;IACH,YAAY,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC;IAE7B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,CAAC,EAAE,kBAAkB,CAAC,WAAW,CAAC;IAE7C;;;OAGG;IACH,QAAQ,CAAC,EAAE,UAAU,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;IAEtC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,YAAY,CAAC,EACT,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;IAE9F;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC;CACjC;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;;OAGG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAMD,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,UAAU,IAAI,UAAU,EAC7B,WAAW,IAAI,WAAW,EAC1B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EAAE,GAAG,IAAI,GAAG,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;IAEvE,OAAO,EAAE,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;CACvD"}
|
|
@@ -62,12 +62,30 @@ class Cheques extends resource_1.APIResource {
|
|
|
62
62
|
* }
|
|
63
63
|
* }
|
|
64
64
|
* ```
|
|
65
|
+
*
|
|
66
|
+
* @example
|
|
67
|
+
* ```ts
|
|
68
|
+
* const cheque = await client.cheques.create({
|
|
69
|
+
* amount: 1000,
|
|
70
|
+
* bankAccount: 'bank_123',
|
|
71
|
+
* from: 'contact_123',
|
|
72
|
+
* to: 'contact_123',
|
|
73
|
+
* currencyCode: 'USD',
|
|
74
|
+
* number: 123456,
|
|
75
|
+
* size: 'us_letter',
|
|
76
|
+
* });
|
|
77
|
+
* ```
|
|
65
78
|
*/
|
|
66
79
|
create(body, options) {
|
|
67
80
|
return this._client.post('/cheques', { body, ...options });
|
|
68
81
|
}
|
|
69
82
|
/**
|
|
70
83
|
* Retrieve a cheque by ID.
|
|
84
|
+
*
|
|
85
|
+
* @example
|
|
86
|
+
* ```ts
|
|
87
|
+
* const cheque = await client.cheques.retrieve('id');
|
|
88
|
+
* ```
|
|
71
89
|
*/
|
|
72
90
|
retrieve(id, options) {
|
|
73
91
|
return this._client.get(`/cheques/${id}`, options);
|
|
@@ -80,6 +98,11 @@ class Cheques extends resource_1.APIResource {
|
|
|
80
98
|
}
|
|
81
99
|
/**
|
|
82
100
|
* Cancel a cheque by ID. Note that this operation cannot be undone.
|
|
101
|
+
*
|
|
102
|
+
* @example
|
|
103
|
+
* ```ts
|
|
104
|
+
* const cheque = await client.cheques.cancel('id');
|
|
105
|
+
* ```
|
|
83
106
|
*/
|
|
84
107
|
cancel(id, options) {
|
|
85
108
|
return this._client.delete(`/cheques/${id}`, options);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cheques.js","sourceRoot":"","sources":["../../src/resources/cheques/cheques.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAI9C,iDAAgC;AAChC,kCAAiD;AACjD,oFAAmE;AACnE,wEAA+D;AAC/D,oDAAyD;AAEzD,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,QAAG,GAAe,IAAI,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/C,wBAAmB,GACjB,IAAI,sBAAsB,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"cheques.js","sourceRoot":"","sources":["../../src/resources/cheques/cheques.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAI9C,iDAAgC;AAChC,kCAAiD;AACjD,oFAAmE;AACnE,wEAA+D;AAC/D,oDAAyD;AAEzD,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,QAAG,GAAe,IAAI,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/C,wBAAmB,GACjB,IAAI,sBAAsB,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA0FjE,CAAC;IAxFC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAeD,IAAI,CACF,QAAgD,EAAE,EAClD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;CACF;AA7FD,0BA6FC;AAED,MAAa,WAAY,SAAQ,iBAAY;CAAG;AAAhD,kCAAgD;AA+YhD,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;AAClC,OAAO,CAAC,GAAG,GAAG,SAAG,CAAC;AAClB,OAAO,CAAC,mBAAmB,GAAG,4CAAmB,CAAC"}
|