postgrid-node 0.1.0-alpha.3 → 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 +47 -0
- package/README.md +25 -39
- package/core.d.ts +7 -4
- package/core.d.ts.map +1 -1
- package/core.js +16 -9
- package/core.js.map +1 -1
- package/core.mjs +16 -9
- 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 +1 -1
- 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 +21 -7
- 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/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/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/src/core.ts +17 -8
- 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 +7 -7
- 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/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/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/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/pagination.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pagination.js","sourceRoot":"","sources":["src/pagination.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,oCAA0F;
|
|
1
|
+
{"version":3,"file":"pagination.js","sourceRoot":"","sources":["src/pagination.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,oCAA0F;AAsB1F,MAAa,IAAW,SAAQ,mBAAkB;IAOhD,YAAY,MAAiB,EAAE,QAAkB,EAAE,IAAwB,EAAE,OAA4B;QACvG,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAEvC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;QAC5B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,iBAAiB;QACf,OAAO,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;IACzB,CAAC;IAED,kDAAkD;IAClD,cAAc;QACZ,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QACjC,IAAI,CAAC,IAAI;YAAE,OAAO,IAAI,CAAC;QACvB,IAAI,QAAQ,IAAI,IAAI;YAAE,OAAO,IAAI,CAAC,MAAM,CAAC;QACzC,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACzD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC;QAC7C,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,YAAY;QACV,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC;QAC1B,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,IAAI,CAAC;SACb;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC,MAAM,CAAC;QAC/C,MAAM,YAAY,GAAG,MAAM,GAAG,MAAM,CAAC;QAErC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACnC,IAAI,CAAC,UAAU,EAAE;YACf,OAAO,IAAI,CAAC;SACb;QAED,IAAI,YAAY,GAAG,UAAU,EAAE;YAC7B,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,EAAE,CAAC;SAC3C;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAjDD,oBAiDC"}
|
package/pagination.mjs
CHANGED
|
@@ -5,6 +5,7 @@ export class List extends AbstractPage {
|
|
|
5
5
|
super(client, response, body, options);
|
|
6
6
|
this.data = body.data || [];
|
|
7
7
|
this.totalCount = body.totalCount || 0;
|
|
8
|
+
this.limit = body.limit || 0;
|
|
8
9
|
}
|
|
9
10
|
getPaginatedItems() {
|
|
10
11
|
return this.data ?? [];
|
|
@@ -22,7 +23,7 @@ export class List extends AbstractPage {
|
|
|
22
23
|
return params;
|
|
23
24
|
}
|
|
24
25
|
nextPageInfo() {
|
|
25
|
-
const offset = this.
|
|
26
|
+
const offset = this.limit;
|
|
26
27
|
if (!offset) {
|
|
27
28
|
return null;
|
|
28
29
|
}
|
package/pagination.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pagination.mjs","sourceRoot":"","sources":["src/pagination.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,YAAY,EAAsD;
|
|
1
|
+
{"version":3,"file":"pagination.mjs","sourceRoot":"","sources":["src/pagination.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,YAAY,EAAsD;AAsB3E,MAAM,OAAO,IAAW,SAAQ,YAAkB;IAOhD,YAAY,MAAiB,EAAE,QAAkB,EAAE,IAAwB,EAAE,OAA4B;QACvG,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAEvC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;QAC5B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,iBAAiB;QACf,OAAO,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;IACzB,CAAC;IAED,kDAAkD;IAClD,cAAc;QACZ,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QACjC,IAAI,CAAC,IAAI;YAAE,OAAO,IAAI,CAAC;QACvB,IAAI,QAAQ,IAAI,IAAI;YAAE,OAAO,IAAI,CAAC,MAAM,CAAC;QACzC,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACzD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC;QAC7C,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,YAAY;QACV,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC;QAC1B,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,IAAI,CAAC;SACb;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC,MAAM,CAAC;QAC/C,MAAM,YAAY,GAAG,MAAM,GAAG,MAAM,CAAC;QAErC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACnC,IAAI,CAAC,UAAU,EAAE;YACf,OAAO,IAAI,CAAC;SACb;QAED,IAAI,YAAY,GAAG,UAAU,EAAE;YAC7B,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,EAAE,CAAC;SAC3C;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}
|
package/resource.d.ts
CHANGED
package/resource.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["src/resource.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAExC,
|
|
1
|
+
{"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["src/resource.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAExC,8BAAsB,WAAW;IAC/B,SAAS,CAAC,OAAO,EAAE,QAAQ,CAAC;gBAEhB,MAAM,EAAE,QAAQ;CAG7B"}
|
package/resource.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"resource.js","sourceRoot":"","sources":["src/resource.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAItF,
|
|
1
|
+
{"version":3,"file":"resource.js","sourceRoot":"","sources":["src/resource.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAItF,MAAsB,WAAW;IAG/B,YAAY,MAAgB;QAC1B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;CACF;AAND,kCAMC"}
|
package/resource.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"resource.mjs","sourceRoot":"","sources":["src/resource.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAItF,MAAM,
|
|
1
|
+
{"version":3,"file":"resource.mjs","sourceRoot":"","sources":["src/resource.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAItF,MAAM,OAAgB,WAAW;IAG/B,YAAY,MAAgB;QAC1B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;CACF"}
|
|
@@ -10,19 +10,52 @@ export declare class BankAccounts extends APIResource {
|
|
|
10
10
|
*
|
|
11
11
|
* You must specify _either_ `signatureImage` or `signatureText`. The image can be
|
|
12
12
|
* supplied as either a URL or a multipart file upload.
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* const bankAccount = await client.bankAccounts.create({
|
|
17
|
+
* accountNumber: '1234567',
|
|
18
|
+
* bankCountryCode: 'US',
|
|
19
|
+
* bankName: 'Test Bank',
|
|
20
|
+
* signatureText: 'Example',
|
|
21
|
+
* bankPrimaryLine: '145 mulberry st',
|
|
22
|
+
* bankSecondaryLine: 'new york ny 10013',
|
|
23
|
+
* routingNumber: '123456789',
|
|
24
|
+
* });
|
|
25
|
+
* ```
|
|
13
26
|
*/
|
|
14
27
|
create(body: BankAccountCreateParams, options?: Core.RequestOptions): Core.APIPromise<BankAccount>;
|
|
15
28
|
/**
|
|
16
29
|
* Retrieve a bank account by ID.
|
|
30
|
+
*
|
|
31
|
+
* @example
|
|
32
|
+
* ```ts
|
|
33
|
+
* const bankAccount = await client.bankAccounts.retrieve(
|
|
34
|
+
* 'id',
|
|
35
|
+
* );
|
|
36
|
+
* ```
|
|
17
37
|
*/
|
|
18
38
|
retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<BankAccount>;
|
|
19
39
|
/**
|
|
20
40
|
* Get a list of bank accounts.
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* ```ts
|
|
44
|
+
* // Automatically fetches more pages as needed.
|
|
45
|
+
* for await (const bankAccount of client.bankAccounts.list()) {
|
|
46
|
+
* // ...
|
|
47
|
+
* }
|
|
48
|
+
* ```
|
|
21
49
|
*/
|
|
22
50
|
list(query?: BankAccountListParams, options?: Core.RequestOptions): Core.PagePromise<BankAccountsList, BankAccount>;
|
|
23
51
|
list(options?: Core.RequestOptions): Core.PagePromise<BankAccountsList, BankAccount>;
|
|
24
52
|
/**
|
|
25
53
|
* Delete a bank account by ID. Note that this operation cannot be undone.
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* ```ts
|
|
57
|
+
* const bankAccount = await client.bankAccounts.delete('id');
|
|
58
|
+
* ```
|
|
26
59
|
*/
|
|
27
60
|
delete(id: string, options?: Core.RequestOptions): Core.APIPromise<BankAccountDeleteResponse>;
|
|
28
61
|
}
|
|
@@ -70,6 +103,10 @@ export interface BankAccount {
|
|
|
70
103
|
* The secondary address line of the bank.
|
|
71
104
|
*/
|
|
72
105
|
bankSecondaryLine?: string;
|
|
106
|
+
/**
|
|
107
|
+
* The designation number of the bank account (for CA).
|
|
108
|
+
*/
|
|
109
|
+
caDesignationNumber?: string;
|
|
73
110
|
/**
|
|
74
111
|
* An optional string describing this resource. Will be visible in the API and the
|
|
75
112
|
* dashboard.
|
|
@@ -78,7 +115,9 @@ export interface BankAccount {
|
|
|
78
115
|
/**
|
|
79
116
|
* See the section on Metadata.
|
|
80
117
|
*/
|
|
81
|
-
metadata?:
|
|
118
|
+
metadata?: {
|
|
119
|
+
[key: string]: unknown;
|
|
120
|
+
};
|
|
82
121
|
/**
|
|
83
122
|
* The route number of the bank account (for CA).
|
|
84
123
|
*/
|
|
@@ -148,6 +187,10 @@ export declare namespace BankAccountCreateParams {
|
|
|
148
187
|
* The secondary address line of the bank.
|
|
149
188
|
*/
|
|
150
189
|
bankSecondaryLine?: string;
|
|
190
|
+
/**
|
|
191
|
+
* The designation number of the bank account (for CA).
|
|
192
|
+
*/
|
|
193
|
+
caDesignationNumber?: string;
|
|
151
194
|
/**
|
|
152
195
|
* An optional string describing this resource. Will be visible in the API and the
|
|
153
196
|
* dashboard.
|
|
@@ -156,7 +199,9 @@ export declare namespace BankAccountCreateParams {
|
|
|
156
199
|
/**
|
|
157
200
|
* See the section on Metadata.
|
|
158
201
|
*/
|
|
159
|
-
metadata?:
|
|
202
|
+
metadata?: {
|
|
203
|
+
[key: string]: unknown;
|
|
204
|
+
};
|
|
160
205
|
/**
|
|
161
206
|
* The route number of the bank account (for CA).
|
|
162
207
|
*/
|
|
@@ -197,6 +242,10 @@ export declare namespace BankAccountCreateParams {
|
|
|
197
242
|
* The secondary address line of the bank.
|
|
198
243
|
*/
|
|
199
244
|
bankSecondaryLine?: string;
|
|
245
|
+
/**
|
|
246
|
+
* The designation number of the bank account (for CA).
|
|
247
|
+
*/
|
|
248
|
+
caDesignationNumber?: string;
|
|
200
249
|
/**
|
|
201
250
|
* An optional string describing this resource. Will be visible in the API and the
|
|
202
251
|
* dashboard.
|
|
@@ -205,7 +254,9 @@ export declare namespace BankAccountCreateParams {
|
|
|
205
254
|
/**
|
|
206
255
|
* See the section on Metadata.
|
|
207
256
|
*/
|
|
208
|
-
metadata?:
|
|
257
|
+
metadata?: {
|
|
258
|
+
[key: string]: unknown;
|
|
259
|
+
};
|
|
209
260
|
/**
|
|
210
261
|
* The route number of the bank account (for CA).
|
|
211
262
|
*/
|
|
@@ -246,6 +297,10 @@ export declare namespace BankAccountCreateParams {
|
|
|
246
297
|
* The secondary address line of the bank.
|
|
247
298
|
*/
|
|
248
299
|
bankSecondaryLine?: string;
|
|
300
|
+
/**
|
|
301
|
+
* The designation number of the bank account (for CA).
|
|
302
|
+
*/
|
|
303
|
+
caDesignationNumber?: string;
|
|
249
304
|
/**
|
|
250
305
|
* An optional string describing this resource. Will be visible in the API and the
|
|
251
306
|
* dashboard.
|
|
@@ -254,7 +309,9 @@ export declare namespace BankAccountCreateParams {
|
|
|
254
309
|
/**
|
|
255
310
|
* See the section on Metadata.
|
|
256
311
|
*/
|
|
257
|
-
metadata?:
|
|
312
|
+
metadata?: {
|
|
313
|
+
[key: string]: unknown;
|
|
314
|
+
};
|
|
258
315
|
/**
|
|
259
316
|
* The route number of the bank account (for CA).
|
|
260
317
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bank-accounts.d.ts","sourceRoot":"","sources":["../src/resources/bank-accounts.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,YAAa,SAAQ,WAAW;IAC3C
|
|
1
|
+
{"version":3,"file":"bank-accounts.d.ts","sourceRoot":"","sources":["../src/resources/bank-accounts.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,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;IAIlG;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;IAIjF;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,gBAAgB,EAAE,WAAW,CAAC;IAClD,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,gBAAgB,EAAE,WAAW,CAAC;IAWpF;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;CAG9F;AAED,qBAAa,gBAAiB,SAAQ,IAAI,CAAC,WAAW,CAAC;CAAG;AAE1D,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,eAAe,EAAE,IAAI,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAEzB,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC;CACxB;AAED,MAAM,MAAM,uBAAuB,GAC/B,uBAAuB,CAAC,8BAA8B,GACtD,uBAAuB,CAAC,kCAAkC,GAC1D,uBAAuB,CAAC,mCAAmC,CAAC;AAEhE,MAAM,CAAC,OAAO,WAAW,uBAAuB,CAAC;IAC/C,UAAiB,8BAA8B;QAC7C;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,eAAe,EAAE,IAAI,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;IAED,UAAiB,kCAAkC;QACjD;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,eAAe,EAAE,IAAI,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;IAED,UAAiB,mCAAmC;QAClD;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,eAAe,EAAE,IAAI,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;CACF;AAED,MAAM,WAAW,qBAAsB,SAAQ,UAAU;IACvD;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAID,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,gBAAgB,IAAI,gBAAgB,EACpC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
|
|
@@ -14,12 +14,32 @@ class BankAccounts extends resource_1.APIResource {
|
|
|
14
14
|
*
|
|
15
15
|
* You must specify _either_ `signatureImage` or `signatureText`. The image can be
|
|
16
16
|
* supplied as either a URL or a multipart file upload.
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* ```ts
|
|
20
|
+
* const bankAccount = await client.bankAccounts.create({
|
|
21
|
+
* accountNumber: '1234567',
|
|
22
|
+
* bankCountryCode: 'US',
|
|
23
|
+
* bankName: 'Test Bank',
|
|
24
|
+
* signatureText: 'Example',
|
|
25
|
+
* bankPrimaryLine: '145 mulberry st',
|
|
26
|
+
* bankSecondaryLine: 'new york ny 10013',
|
|
27
|
+
* routingNumber: '123456789',
|
|
28
|
+
* });
|
|
29
|
+
* ```
|
|
17
30
|
*/
|
|
18
31
|
create(body, options) {
|
|
19
32
|
return this._client.post('/bank_accounts', { body, ...options });
|
|
20
33
|
}
|
|
21
34
|
/**
|
|
22
35
|
* Retrieve a bank account by ID.
|
|
36
|
+
*
|
|
37
|
+
* @example
|
|
38
|
+
* ```ts
|
|
39
|
+
* const bankAccount = await client.bankAccounts.retrieve(
|
|
40
|
+
* 'id',
|
|
41
|
+
* );
|
|
42
|
+
* ```
|
|
23
43
|
*/
|
|
24
44
|
retrieve(id, options) {
|
|
25
45
|
return this._client.get(`/bank_accounts/${id}`, options);
|
|
@@ -32,6 +52,11 @@ class BankAccounts extends resource_1.APIResource {
|
|
|
32
52
|
}
|
|
33
53
|
/**
|
|
34
54
|
* Delete a bank account by ID. Note that this operation cannot be undone.
|
|
55
|
+
*
|
|
56
|
+
* @example
|
|
57
|
+
* ```ts
|
|
58
|
+
* const bankAccount = await client.bankAccounts.delete('id');
|
|
59
|
+
* ```
|
|
35
60
|
*/
|
|
36
61
|
delete(id, options) {
|
|
37
62
|
return this._client.delete(`/bank_accounts/${id}`, options);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bank-accounts.js","sourceRoot":"","sources":["../src/resources/bank-accounts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAE3C,iDAAsD;AAEtD,MAAa,YAAa,SAAQ,sBAAW;IAC3C
|
|
1
|
+
{"version":3,"file":"bank-accounts.js","sourceRoot":"","sources":["../src/resources/bank-accounts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAE3C,iDAAsD;AAEtD,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,IAA6B,EAAE,OAA6B;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAkBD,IAAI,CACF,QAAqD,EAAE,EACvD,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,gBAAgB,EAAE,gBAAgB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,kBAAkB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;CACF;AA9ED,oCA8EC;AAED,MAAa,gBAAiB,SAAQ,iBAAiB;CAAG;AAA1D,4CAA0D;AAgV1D,YAAY,CAAC,gBAAgB,GAAG,gBAAgB,CAAC"}
|
|
@@ -11,12 +11,32 @@ export class BankAccounts extends APIResource {
|
|
|
11
11
|
*
|
|
12
12
|
* You must specify _either_ `signatureImage` or `signatureText`. The image can be
|
|
13
13
|
* supplied as either a URL or a multipart file upload.
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ```ts
|
|
17
|
+
* const bankAccount = await client.bankAccounts.create({
|
|
18
|
+
* accountNumber: '1234567',
|
|
19
|
+
* bankCountryCode: 'US',
|
|
20
|
+
* bankName: 'Test Bank',
|
|
21
|
+
* signatureText: 'Example',
|
|
22
|
+
* bankPrimaryLine: '145 mulberry st',
|
|
23
|
+
* bankSecondaryLine: 'new york ny 10013',
|
|
24
|
+
* routingNumber: '123456789',
|
|
25
|
+
* });
|
|
26
|
+
* ```
|
|
14
27
|
*/
|
|
15
28
|
create(body, options) {
|
|
16
29
|
return this._client.post('/bank_accounts', { body, ...options });
|
|
17
30
|
}
|
|
18
31
|
/**
|
|
19
32
|
* Retrieve a bank account by ID.
|
|
33
|
+
*
|
|
34
|
+
* @example
|
|
35
|
+
* ```ts
|
|
36
|
+
* const bankAccount = await client.bankAccounts.retrieve(
|
|
37
|
+
* 'id',
|
|
38
|
+
* );
|
|
39
|
+
* ```
|
|
20
40
|
*/
|
|
21
41
|
retrieve(id, options) {
|
|
22
42
|
return this._client.get(`/bank_accounts/${id}`, options);
|
|
@@ -29,6 +49,11 @@ export class BankAccounts extends APIResource {
|
|
|
29
49
|
}
|
|
30
50
|
/**
|
|
31
51
|
* Delete a bank account by ID. Note that this operation cannot be undone.
|
|
52
|
+
*
|
|
53
|
+
* @example
|
|
54
|
+
* ```ts
|
|
55
|
+
* const bankAccount = await client.bankAccounts.delete('id');
|
|
56
|
+
* ```
|
|
32
57
|
*/
|
|
33
58
|
delete(id, options) {
|
|
34
59
|
return this._client.delete(`/bank_accounts/${id}`, options);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bank-accounts.mjs","sourceRoot":"","sources":["../src/resources/bank-accounts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C
|
|
1
|
+
{"version":3,"file":"bank-accounts.mjs","sourceRoot":"","sources":["../src/resources/bank-accounts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,IAA6B,EAAE,OAA6B;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAkBD,IAAI,CACF,QAAqD,EAAE,EACvD,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,gBAAgB,EAAE,gBAAgB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,kBAAkB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;CACF;AAED,MAAM,OAAO,gBAAiB,SAAQ,IAAiB;CAAG;AAgV1D,YAAY,CAAC,gBAAgB,GAAG,gBAAgB,CAAC"}
|
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"}
|