postgrid-node 0.1.0-alpha.3 → 0.1.0-alpha.5
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 +56 -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 +4 -5
- 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/resources/contacts.js
CHANGED
|
@@ -20,12 +20,27 @@ class Contacts extends resource_1.APIResource {
|
|
|
20
20
|
* _Note that if you create a contact that has identical information to another
|
|
21
21
|
* contact, this will simply update the description of the existing contact and
|
|
22
22
|
* return it. This avoids creating duplicate contacts._
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```ts
|
|
26
|
+
* const contact = await client.contacts.create({
|
|
27
|
+
* addressLine1: '90 Canal St Suite 600, Boston MA 90210',
|
|
28
|
+
* countryCode: 'US',
|
|
29
|
+
* firstName: 'Kevin',
|
|
30
|
+
* companyName: 'PostGrid',
|
|
31
|
+
* });
|
|
32
|
+
* ```
|
|
23
33
|
*/
|
|
24
34
|
create(body, options) {
|
|
25
35
|
return this._client.post('/contacts', { body, ...options });
|
|
26
36
|
}
|
|
27
37
|
/**
|
|
28
38
|
* Retrieve a contact.
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* ```ts
|
|
42
|
+
* const contact = await client.contacts.retrieve('id');
|
|
43
|
+
* ```
|
|
29
44
|
*/
|
|
30
45
|
retrieve(id, options) {
|
|
31
46
|
return this._client.get(`/contacts/${id}`, options);
|
|
@@ -39,6 +54,11 @@ class Contacts extends resource_1.APIResource {
|
|
|
39
54
|
/**
|
|
40
55
|
* Delete a contact. Note that this will not affect orders that were sent to this
|
|
41
56
|
* contact.
|
|
57
|
+
*
|
|
58
|
+
* @example
|
|
59
|
+
* ```ts
|
|
60
|
+
* const contact = await client.contacts.delete('id');
|
|
61
|
+
* ```
|
|
42
62
|
*/
|
|
43
63
|
delete(id, options) {
|
|
44
64
|
return this._client.delete(`/contacts/${id}`, options);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contacts.js","sourceRoot":"","sources":["../src/resources/contacts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAE3C,iDAAsD;AAEtD,MAAa,QAAS,SAAQ,sBAAW;IACvC
|
|
1
|
+
{"version":3,"file":"contacts.js","sourceRoot":"","sources":["../src/resources/contacts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAE3C,iDAAsD;AAEtD,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CAAC,IAAyB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAeD,IAAI,CACF,QAAiD,EAAE,EACnD,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,WAAW,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;CACF;AA7ED,4BA6EC;AAED,MAAa,YAAa,SAAQ,iBAAa;CAAG;AAAlD,oCAAkD;AA8TlD,QAAQ,CAAC,YAAY,GAAG,YAAY,CAAC"}
|
package/resources/contacts.mjs
CHANGED
|
@@ -17,12 +17,27 @@ export class Contacts extends APIResource {
|
|
|
17
17
|
* _Note that if you create a contact that has identical information to another
|
|
18
18
|
* contact, this will simply update the description of the existing contact and
|
|
19
19
|
* return it. This avoids creating duplicate contacts._
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* ```ts
|
|
23
|
+
* const contact = await client.contacts.create({
|
|
24
|
+
* addressLine1: '90 Canal St Suite 600, Boston MA 90210',
|
|
25
|
+
* countryCode: 'US',
|
|
26
|
+
* firstName: 'Kevin',
|
|
27
|
+
* companyName: 'PostGrid',
|
|
28
|
+
* });
|
|
29
|
+
* ```
|
|
20
30
|
*/
|
|
21
31
|
create(body, options) {
|
|
22
32
|
return this._client.post('/contacts', { body, ...options });
|
|
23
33
|
}
|
|
24
34
|
/**
|
|
25
35
|
* Retrieve a contact.
|
|
36
|
+
*
|
|
37
|
+
* @example
|
|
38
|
+
* ```ts
|
|
39
|
+
* const contact = await client.contacts.retrieve('id');
|
|
40
|
+
* ```
|
|
26
41
|
*/
|
|
27
42
|
retrieve(id, options) {
|
|
28
43
|
return this._client.get(`/contacts/${id}`, options);
|
|
@@ -36,6 +51,11 @@ export class Contacts extends APIResource {
|
|
|
36
51
|
/**
|
|
37
52
|
* Delete a contact. Note that this will not affect orders that were sent to this
|
|
38
53
|
* contact.
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* ```ts
|
|
57
|
+
* const contact = await client.contacts.delete('id');
|
|
58
|
+
* ```
|
|
39
59
|
*/
|
|
40
60
|
delete(id, options) {
|
|
41
61
|
return this._client.delete(`/contacts/${id}`, options);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contacts.mjs","sourceRoot":"","sources":["../src/resources/contacts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC
|
|
1
|
+
{"version":3,"file":"contacts.mjs","sourceRoot":"","sources":["../src/resources/contacts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CAAC,IAAyB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAeD,IAAI,CACF,QAAiD,EAAE,EACnD,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,WAAW,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;CACF;AAED,MAAM,OAAO,YAAa,SAAQ,IAAa;CAAG;AA8TlD,QAAQ,CAAC,YAAY,GAAG,YAAY,CAAC"}
|
package/resources/index.d.ts
CHANGED
|
@@ -5,8 +5,12 @@ export { CampaignListResponsesList, Campaigns, type CampaignCreateResponse, type
|
|
|
5
5
|
export { ChequesList, Cheques, type Cheque, type ChequeList, type ChequeCreateParams, type ChequeListParams, } from "./cheques/cheques.js";
|
|
6
6
|
export { ContactsList, Contacts, type Contact, type ContactDeleteResponse, type ContactCreateParams, type ContactListParams, } from "./contacts.js";
|
|
7
7
|
export { LettersList, Letters, type Letter, type LetterList, type LetterURLResponse, type LetterCreateParams, type LetterListParams, } from "./letters.js";
|
|
8
|
+
export { MailingListImportListResponsesList, MailingListImports, type MailingListImportCreateResponse, type MailingListImportRetrieveResponse, type MailingListImportUpdateResponse, type MailingListImportListResponse, type MailingListImportDeleteResponse, type MailingListImportCreateParams, type MailingListImportUpdateParams, type MailingListImportListParams, } from "./mailing-list-imports.js";
|
|
9
|
+
export { MailingListListResponsesList, MailingLists, type MailingListCreateResponse, type MailingListRetrieveResponse, type MailingListUpdateResponse, type MailingListListResponse, type MailingListDeleteResponse, type MailingListSubmitJobResponse, type MailingListCreateParams, type MailingListUpdateParams, type MailingListListParams, type MailingListSubmitJobParams, } from "./mailing-lists.js";
|
|
10
|
+
export { OrderProfiles } from "./order-profiles/order-profiles.js";
|
|
8
11
|
export { PostcardsList, Postcards, type Postcard, type PostcardList, type PostcardURLResponse, type PostcardCreateParams, type PostcardListParams, } from "./postcards.js";
|
|
9
12
|
export { ReportListResponsesList, Reports, type ReportCreateResponse, type ReportRetrieveResponse, type ReportUpdateResponse, type ReportListResponse, type ReportDeleteResponse, type ReportRunAdHocQueryResponse, type ReportSampleResponse, type ReportCreateParams, type ReportUpdateParams, type ReportListParams, type ReportRunAdHocQueryParams, type ReportSampleParams, } from "./reports/reports.js";
|
|
10
|
-
export { SelfMailerListResponsesList, SelfMailers, type SelfMailerCreateResponse, type SelfMailerRetrieveResponse, type SelfMailerListResponse, type SelfMailerCancelResponse, type SelfMailerCreateParams, type SelfMailerListParams, } from "./self-mailers.js";
|
|
13
|
+
export { SelfMailerListResponsesList, SelfMailers, type SelfMailerCreateResponse, type SelfMailerRetrieveResponse, type SelfMailerListResponse, type SelfMailerCancelResponse, type SelfMailerRetrievePreviewURLResponse, type SelfMailerCreateParams, type SelfMailerListParams, } from "./self-mailers.js";
|
|
14
|
+
export { SubOrganizationListResponsesList, SubOrganizations, type SubOrganizationCreateResponse, type SubOrganizationRetrieveResponse, type SubOrganizationListResponse, type SubOrganizationListUsersResponse, type SubOrganizationCreateParams, type SubOrganizationListParams, type SubOrganizationListUsersParams, } from "./sub-organizations.js";
|
|
11
15
|
export { TemplatesList, Templates, type Template, type TemplateList, type TemplateDeleteResponse, type TemplateCreateParams, type TemplateUpdateParams, type TemplateListParams, } from "./templates.js";
|
|
12
16
|
//# sourceMappingURL=index.d.ts.map
|
package/resources/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAEA,cAAc,UAAU,CAAC;AACzB,OAAO,EACL,gBAAgB,EAChB,YAAY,EACZ,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,GAC3B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,oBAAoB,EACpB,KAAK,EACL,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,aAAa,GACnB,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,yBAAyB,EACzB,SAAS,EACT,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,GACxB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,WAAW,EACX,OAAO,EACP,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,GACtB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,YAAY,EACZ,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,GACvB,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,WAAW,EACX,OAAO,EACP,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,GACtB,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,aAAa,EACb,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,GACxB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,uBAAuB,EACvB,OAAO,EACP,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,2BAA2B,EAChC,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,yBAAyB,EAC9B,KAAK,kBAAkB,GACxB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,2BAA2B,EAC3B,WAAW,EACX,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,GAC1B,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,aAAa,EACb,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,GACxB,MAAM,aAAa,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAEA,cAAc,UAAU,CAAC;AACzB,OAAO,EACL,gBAAgB,EAChB,YAAY,EACZ,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,GAC3B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,oBAAoB,EACpB,KAAK,EACL,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,aAAa,GACnB,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,yBAAyB,EACzB,SAAS,EACT,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,GACxB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,WAAW,EACX,OAAO,EACP,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,GACtB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,YAAY,EACZ,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,GACvB,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,WAAW,EACX,OAAO,EACP,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,GACtB,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,kCAAkC,EAClC,kBAAkB,EAClB,KAAK,+BAA+B,EACpC,KAAK,iCAAiC,EACtC,KAAK,+BAA+B,EACpC,KAAK,6BAA6B,EAClC,KAAK,+BAA+B,EACpC,KAAK,6BAA6B,EAClC,KAAK,6BAA6B,EAClC,KAAK,2BAA2B,GACjC,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,4BAA4B,EAC5B,YAAY,EACZ,KAAK,yBAAyB,EAC9B,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,yBAAyB,EAC9B,KAAK,4BAA4B,EACjC,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,0BAA0B,GAChC,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAChE,OAAO,EACL,aAAa,EACb,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,GACxB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,uBAAuB,EACvB,OAAO,EACP,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,2BAA2B,EAChC,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,yBAAyB,EAC9B,KAAK,kBAAkB,GACxB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,2BAA2B,EAC3B,WAAW,EACX,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,oCAAoC,EACzC,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,GAC1B,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,gCAAgC,EAChC,gBAAgB,EAChB,KAAK,6BAA6B,EAClC,KAAK,+BAA+B,EACpC,KAAK,2BAA2B,EAChC,KAAK,gCAAgC,EACrC,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,EAC9B,KAAK,8BAA8B,GACpC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,aAAa,EACb,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,GACxB,MAAM,aAAa,CAAC"}
|
package/resources/index.js
CHANGED
|
@@ -15,7 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
15
15
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
16
16
|
};
|
|
17
17
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
18
|
-
exports.Templates = exports.TemplatesList = exports.SelfMailers = exports.SelfMailerListResponsesList = exports.Reports = exports.ReportListResponsesList = exports.Postcards = exports.PostcardsList = exports.Letters = exports.LettersList = exports.Contacts = exports.ContactsList = exports.Cheques = exports.ChequesList = exports.Campaigns = exports.CampaignListResponsesList = exports.Boxes = exports.BoxListResponsesList = exports.BankAccounts = exports.BankAccountsList = void 0;
|
|
18
|
+
exports.Templates = exports.TemplatesList = exports.SubOrganizations = exports.SubOrganizationListResponsesList = exports.SelfMailers = exports.SelfMailerListResponsesList = exports.Reports = exports.ReportListResponsesList = exports.Postcards = exports.PostcardsList = exports.OrderProfiles = exports.MailingLists = exports.MailingListListResponsesList = exports.MailingListImports = exports.MailingListImportListResponsesList = exports.Letters = exports.LettersList = exports.Contacts = exports.ContactsList = exports.Cheques = exports.ChequesList = exports.Campaigns = exports.CampaignListResponsesList = exports.Boxes = exports.BoxListResponsesList = exports.BankAccounts = exports.BankAccountsList = void 0;
|
|
19
19
|
__exportStar(require("./shared.js"), exports);
|
|
20
20
|
var bank_accounts_1 = require("./bank-accounts.js");
|
|
21
21
|
Object.defineProperty(exports, "BankAccountsList", { enumerable: true, get: function () { return bank_accounts_1.BankAccountsList; } });
|
|
@@ -35,6 +35,14 @@ Object.defineProperty(exports, "Contacts", { enumerable: true, get: function ()
|
|
|
35
35
|
var letters_1 = require("./letters.js");
|
|
36
36
|
Object.defineProperty(exports, "LettersList", { enumerable: true, get: function () { return letters_1.LettersList; } });
|
|
37
37
|
Object.defineProperty(exports, "Letters", { enumerable: true, get: function () { return letters_1.Letters; } });
|
|
38
|
+
var mailing_list_imports_1 = require("./mailing-list-imports.js");
|
|
39
|
+
Object.defineProperty(exports, "MailingListImportListResponsesList", { enumerable: true, get: function () { return mailing_list_imports_1.MailingListImportListResponsesList; } });
|
|
40
|
+
Object.defineProperty(exports, "MailingListImports", { enumerable: true, get: function () { return mailing_list_imports_1.MailingListImports; } });
|
|
41
|
+
var mailing_lists_1 = require("./mailing-lists.js");
|
|
42
|
+
Object.defineProperty(exports, "MailingListListResponsesList", { enumerable: true, get: function () { return mailing_lists_1.MailingListListResponsesList; } });
|
|
43
|
+
Object.defineProperty(exports, "MailingLists", { enumerable: true, get: function () { return mailing_lists_1.MailingLists; } });
|
|
44
|
+
var order_profiles_1 = require("./order-profiles/order-profiles.js");
|
|
45
|
+
Object.defineProperty(exports, "OrderProfiles", { enumerable: true, get: function () { return order_profiles_1.OrderProfiles; } });
|
|
38
46
|
var postcards_1 = require("./postcards.js");
|
|
39
47
|
Object.defineProperty(exports, "PostcardsList", { enumerable: true, get: function () { return postcards_1.PostcardsList; } });
|
|
40
48
|
Object.defineProperty(exports, "Postcards", { enumerable: true, get: function () { return postcards_1.Postcards; } });
|
|
@@ -44,6 +52,9 @@ Object.defineProperty(exports, "Reports", { enumerable: true, get: function () {
|
|
|
44
52
|
var self_mailers_1 = require("./self-mailers.js");
|
|
45
53
|
Object.defineProperty(exports, "SelfMailerListResponsesList", { enumerable: true, get: function () { return self_mailers_1.SelfMailerListResponsesList; } });
|
|
46
54
|
Object.defineProperty(exports, "SelfMailers", { enumerable: true, get: function () { return self_mailers_1.SelfMailers; } });
|
|
55
|
+
var sub_organizations_1 = require("./sub-organizations.js");
|
|
56
|
+
Object.defineProperty(exports, "SubOrganizationListResponsesList", { enumerable: true, get: function () { return sub_organizations_1.SubOrganizationListResponsesList; } });
|
|
57
|
+
Object.defineProperty(exports, "SubOrganizations", { enumerable: true, get: function () { return sub_organizations_1.SubOrganizations; } });
|
|
47
58
|
var templates_1 = require("./templates.js");
|
|
48
59
|
Object.defineProperty(exports, "TemplatesList", { enumerable: true, get: function () { return templates_1.TemplatesList; } });
|
|
49
60
|
Object.defineProperty(exports, "Templates", { enumerable: true, get: function () { return templates_1.Templates; } });
|
package/resources/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;AAEtF,8CAAyB;AACzB,oDAQyB;AAPvB,iHAAA,gBAAgB,OAAA;AAChB,6GAAA,YAAY,OAAA;AAOd,oCASiB;AARf,6GAAA,oBAAoB,OAAA;AACpB,8FAAA,KAAK,OAAA;AAQP,4CAaqB;AAZnB,sHAAA,yBAAyB,OAAA;AACzB,sGAAA,SAAS,OAAA;AAYX,gDAO2B;AANzB,sGAAA,WAAW,OAAA;AACX,kGAAA,OAAO,OAAA;AAMT,0CAOoB;AANlB,wGAAA,YAAY,OAAA;AACZ,oGAAA,QAAQ,OAAA;AAMV,wCAQmB;AAPjB,sGAAA,WAAW,OAAA;AACX,kGAAA,OAAO,OAAA;AAOT,4CAQqB;AAPnB,0GAAA,aAAa,OAAA;AACb,sGAAA,SAAS,OAAA;AAOX,gDAe2B;AAdzB,kHAAA,uBAAuB,OAAA;AACvB,kGAAA,OAAO,OAAA;AAcT,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;AAEtF,8CAAyB;AACzB,oDAQyB;AAPvB,iHAAA,gBAAgB,OAAA;AAChB,6GAAA,YAAY,OAAA;AAOd,oCASiB;AARf,6GAAA,oBAAoB,OAAA;AACpB,8FAAA,KAAK,OAAA;AAQP,4CAaqB;AAZnB,sHAAA,yBAAyB,OAAA;AACzB,sGAAA,SAAS,OAAA;AAYX,gDAO2B;AANzB,sGAAA,WAAW,OAAA;AACX,kGAAA,OAAO,OAAA;AAMT,0CAOoB;AANlB,wGAAA,YAAY,OAAA;AACZ,oGAAA,QAAQ,OAAA;AAMV,wCAQmB;AAPjB,sGAAA,WAAW,OAAA;AACX,kGAAA,OAAO,OAAA;AAOT,kEAWgC;AAV9B,0IAAA,kCAAkC,OAAA;AAClC,0HAAA,kBAAkB,OAAA;AAUpB,oDAayB;AAZvB,6HAAA,4BAA4B,OAAA;AAC5B,6GAAA,YAAY,OAAA;AAYd,qEAAgE;AAAvD,+GAAA,aAAa,OAAA;AACtB,4CAQqB;AAPnB,0GAAA,aAAa,OAAA;AACb,sGAAA,SAAS,OAAA;AAOX,gDAe2B;AAdzB,kHAAA,uBAAuB,OAAA;AACvB,kGAAA,OAAO,OAAA;AAcT,kDAUwB;AATtB,2HAAA,2BAA2B,OAAA;AAC3B,2GAAA,WAAW,OAAA;AASb,4DAU6B;AAT3B,qIAAA,gCAAgC,OAAA;AAChC,qHAAA,gBAAgB,OAAA;AASlB,4CASqB;AARnB,0GAAA,aAAa,OAAA;AACb,sGAAA,SAAS,OAAA"}
|
package/resources/index.mjs
CHANGED
|
@@ -6,8 +6,12 @@ export { CampaignListResponsesList, Campaigns, } from "./campaigns.mjs";
|
|
|
6
6
|
export { ChequesList, Cheques, } from "./cheques/cheques.mjs";
|
|
7
7
|
export { ContactsList, Contacts, } from "./contacts.mjs";
|
|
8
8
|
export { LettersList, Letters, } from "./letters.mjs";
|
|
9
|
+
export { MailingListImportListResponsesList, MailingListImports, } from "./mailing-list-imports.mjs";
|
|
10
|
+
export { MailingListListResponsesList, MailingLists, } from "./mailing-lists.mjs";
|
|
11
|
+
export { OrderProfiles } from "./order-profiles/order-profiles.mjs";
|
|
9
12
|
export { PostcardsList, Postcards, } from "./postcards.mjs";
|
|
10
13
|
export { ReportListResponsesList, Reports, } from "./reports/reports.mjs";
|
|
11
14
|
export { SelfMailerListResponsesList, SelfMailers, } from "./self-mailers.mjs";
|
|
15
|
+
export { SubOrganizationListResponsesList, SubOrganizations, } from "./sub-organizations.mjs";
|
|
12
16
|
export { TemplatesList, Templates, } from "./templates.mjs";
|
|
13
17
|
//# sourceMappingURL=index.mjs.map
|
package/resources/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;OAG/E,EACL,gBAAgB,EAChB,YAAY,GAMb;OACM,EACL,oBAAoB,EACpB,KAAK,GAON;OACM,EACL,yBAAyB,EACzB,SAAS,GAWV;OACM,EACL,WAAW,EACX,OAAO,GAKR;OACM,EACL,YAAY,EACZ,QAAQ,GAKT;OACM,EACL,WAAW,EACX,OAAO,GAMR;OACM,EACL,aAAa,EACb,SAAS,GAMV;OACM,EACL,uBAAuB,EACvB,OAAO,GAaR;OACM,EACL,2BAA2B,EAC3B,WAAW,
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;OAG/E,EACL,gBAAgB,EAChB,YAAY,GAMb;OACM,EACL,oBAAoB,EACpB,KAAK,GAON;OACM,EACL,yBAAyB,EACzB,SAAS,GAWV;OACM,EACL,WAAW,EACX,OAAO,GAKR;OACM,EACL,YAAY,EACZ,QAAQ,GAKT;OACM,EACL,WAAW,EACX,OAAO,GAMR;OACM,EACL,kCAAkC,EAClC,kBAAkB,GASnB;OACM,EACL,4BAA4B,EAC5B,YAAY,GAWb;OACM,EAAE,aAAa,EAAE;OACjB,EACL,aAAa,EACb,SAAS,GAMV;OACM,EACL,uBAAuB,EACvB,OAAO,GAaR;OACM,EACL,2BAA2B,EAC3B,WAAW,GAQZ;OACM,EACL,gCAAgC,EAChC,gBAAgB,GAQjB;OACM,EACL,aAAa,EACb,SAAS,GAOV"}
|
package/resources/letters.d.ts
CHANGED
|
@@ -11,19 +11,46 @@ export declare class Letters extends APIResource {
|
|
|
11
11
|
* - A template ID for the letter
|
|
12
12
|
* - A URL or file for a PDF for the letter
|
|
13
13
|
* - Upload the aforementioned PDF file via a multipart form upload request
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ```ts
|
|
17
|
+
* const letter = await client.letters.create({
|
|
18
|
+
* from: 'contact_123',
|
|
19
|
+
* html: '<html>Content</html>',
|
|
20
|
+
* to: 'contact_123',
|
|
21
|
+
* });
|
|
22
|
+
* ```
|
|
14
23
|
*/
|
|
15
24
|
create(body: LetterCreateParams, options?: Core.RequestOptions): Core.APIPromise<Letter>;
|
|
16
25
|
/**
|
|
17
26
|
* Retrieve a letter by ID.
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* ```ts
|
|
30
|
+
* const letter = await client.letters.retrieve('id');
|
|
31
|
+
* ```
|
|
18
32
|
*/
|
|
19
33
|
retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Letter>;
|
|
20
34
|
/**
|
|
21
35
|
* Get a list of letters.
|
|
36
|
+
*
|
|
37
|
+
* @example
|
|
38
|
+
* ```ts
|
|
39
|
+
* // Automatically fetches more pages as needed.
|
|
40
|
+
* for await (const letter of client.letters.list()) {
|
|
41
|
+
* // ...
|
|
42
|
+
* }
|
|
43
|
+
* ```
|
|
22
44
|
*/
|
|
23
45
|
list(query?: LetterListParams, options?: Core.RequestOptions): Core.PagePromise<LettersList, Letter>;
|
|
24
46
|
list(options?: Core.RequestOptions): Core.PagePromise<LettersList, Letter>;
|
|
25
47
|
/**
|
|
26
48
|
* Cancel a letter by ID. Note that this operation cannot be undone.
|
|
49
|
+
*
|
|
50
|
+
* @example
|
|
51
|
+
* ```ts
|
|
52
|
+
* const letter = await client.letters.delete('id');
|
|
53
|
+
* ```
|
|
27
54
|
*/
|
|
28
55
|
delete(id: string, options?: Core.RequestOptions): Core.APIPromise<Letter>;
|
|
29
56
|
/**
|
|
@@ -33,6 +60,11 @@ export declare class Letters extends APIResource {
|
|
|
33
60
|
* offers document generation and hosting capabilities. This endpoint has a much
|
|
34
61
|
* higher rate limit than the regular order retrieval endpoint, so it is suitable
|
|
35
62
|
* for customer-facing use-cases.
|
|
63
|
+
*
|
|
64
|
+
* @example
|
|
65
|
+
* ```ts
|
|
66
|
+
* const response = await client.letters.url('id');
|
|
67
|
+
* ```
|
|
36
68
|
*/
|
|
37
69
|
url(id: string, options?: Core.RequestOptions): Core.APIPromise<LetterURLResponse>;
|
|
38
70
|
}
|
|
@@ -143,11 +175,15 @@ export interface Letter {
|
|
|
143
175
|
* template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
|
|
144
176
|
* PDFs uploaded with the order.
|
|
145
177
|
*/
|
|
146
|
-
mergeVariables?:
|
|
178
|
+
mergeVariables?: {
|
|
179
|
+
[key: string]: unknown;
|
|
180
|
+
};
|
|
147
181
|
/**
|
|
148
182
|
* See the section on Metadata.
|
|
149
183
|
*/
|
|
150
|
-
metadata?:
|
|
184
|
+
metadata?: {
|
|
185
|
+
[key: string]: unknown;
|
|
186
|
+
};
|
|
151
187
|
/**
|
|
152
188
|
* The ID of the PDF workflow run that created the letter, if any.
|
|
153
189
|
*/
|
|
@@ -347,11 +383,15 @@ export declare namespace LetterCreateParams {
|
|
|
347
383
|
* template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
|
|
348
384
|
* PDFs uploaded with the order.
|
|
349
385
|
*/
|
|
350
|
-
mergeVariables?:
|
|
386
|
+
mergeVariables?: {
|
|
387
|
+
[key: string]: unknown;
|
|
388
|
+
};
|
|
351
389
|
/**
|
|
352
390
|
* See the section on Metadata.
|
|
353
391
|
*/
|
|
354
|
-
metadata?:
|
|
392
|
+
metadata?: {
|
|
393
|
+
[key: string]: unknown;
|
|
394
|
+
};
|
|
355
395
|
/**
|
|
356
396
|
* If specified, indicates which letter page is perforated. Currently, only the
|
|
357
397
|
* first page can be perforated.
|
|
@@ -515,11 +555,15 @@ export declare namespace LetterCreateParams {
|
|
|
515
555
|
* template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
|
|
516
556
|
* PDFs uploaded with the order.
|
|
517
557
|
*/
|
|
518
|
-
mergeVariables?:
|
|
558
|
+
mergeVariables?: {
|
|
559
|
+
[key: string]: unknown;
|
|
560
|
+
};
|
|
519
561
|
/**
|
|
520
562
|
* See the section on Metadata.
|
|
521
563
|
*/
|
|
522
|
-
metadata?:
|
|
564
|
+
metadata?: {
|
|
565
|
+
[key: string]: unknown;
|
|
566
|
+
};
|
|
523
567
|
/**
|
|
524
568
|
* If specified, indicates which letter page is perforated. Currently, only the
|
|
525
569
|
* first page can be perforated.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"letters.d.ts","sourceRoot":"","sources":["../src/resources/letters.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,OAAQ,SAAQ,WAAW;IACtC
|
|
1
|
+
{"version":3,"file":"letters.d.ts","sourceRoot":"","sources":["../src/resources/letters.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,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;OAgBG;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;IAI1E;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC;CAGnF;AAED,qBAAa,WAAY,SAAQ,IAAI,CAAC,MAAM,CAAC;CAAG;AAEhD,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,gBAAgB,GAAG,mBAAmB,CAAC;IAEzD;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;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,IAAI,CAAC;IAEzB;;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;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;IAEjC;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,YAAY,CAAC;IAEnC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;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;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;IAEjC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,SAAS,EAAE,iBAAiB,GAAG,gBAAgB,CAAC;KACjD;IAED;;OAEG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,IAAI,EAAE,UAAU,CAAC;QAEjB;;WAEG;QACH,WAAW,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC;QAEtC;;WAEG;QACH,WAAW,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC;KACvC;IAED,UAAiB,WAAW,CAAC;QAC3B;;WAEG;QACH,UAAiB,WAAW;YAC1B;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,CAAC;YAEvB;;;eAGG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;SACd;QAED;;WAEG;QACH,UAAiB,WAAW;YAC1B;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;;eAGG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;SACnB;KACF;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,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,MAAM,kBAAkB,GAC1B,kBAAkB,CAAC,oBAAoB,GACvC,kBAAkB,CAAC,wBAAwB,GAC3C,kBAAkB,CAAC,mBAAmB,CAAC;AAE3C,MAAM,CAAC,OAAO,WAAW,kBAAkB,CAAC;IAC1C,UAAiB,oBAAoB;QACnC;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEvF;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;;;;WAKG;QACH,EAAE,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAErF;;WAEG;QACH,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,mBAAmB,CAAC;QAE1D;;WAEG;QACH,WAAW,CAAC,EAAE,oBAAoB,CAAC,WAAW,CAAC;QAE/C;;WAEG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;QAEhB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,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;QAE3B;;;;;WAKG;QACH,cAAc,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE5C;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;;WAGG;QACH,cAAc,CAAC,EAAE,CAAC,CAAC;QAEnB;;WAEG;QACH,WAAW,CAAC,EAAE,oBAAoB,CAAC,WAAW,CAAC;QAE/C;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;KAC3B;IAED,UAAiB,oBAAoB,CAAC;QACpC;;WAEG;QACH,UAAiB,WAAW;YAC1B;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,SAAS,EAAE,iBAAiB,GAAG,gBAAgB,CAAC;SACjD;QAED;;WAEG;QACH,UAAiB,WAAW;YAC1B;;eAEG;YACH,IAAI,EAAE,UAAU,CAAC;YAEjB;;eAEG;YACH,WAAW,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC;YAEtC;;eAEG;YACH,WAAW,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC;SACvC;QAED,UAAiB,WAAW,CAAC;YAC3B;;eAEG;YACH,UAAiB,WAAW;gBAC1B;;mBAEG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;mBAEG;gBACH,YAAY,CAAC,EAAE,MAAM,CAAC;gBAEtB;;mBAEG;gBACH,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,aAAa,CAAC,EAAE,MAAM,CAAC;gBAEvB;;;mBAGG;gBACH,GAAG,CAAC,EAAE,MAAM,CAAC;aACd;YAED;;eAEG;YACH,UAAiB,WAAW;gBAC1B;;;mBAGG;gBACH,IAAI,CAAC,EAAE,MAAM,CAAC;gBAEd;;;mBAGG;gBACH,GAAG,CAAC,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;aACnB;SACF;KACF;IAED,UAAiB,wBAAwB;QACvC;;;WAGG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;IAED,UAAiB,mBAAmB;QAClC;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEvF;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;;;;WAKG;QACH,EAAE,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAErF;;WAEG;QACH,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,mBAAmB,CAAC;QAE1D;;WAEG;QACH,WAAW,CAAC,EAAE,mBAAmB,CAAC,WAAW,CAAC;QAE9C;;WAEG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;QAEhB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,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;QAE3B;;;;;WAKG;QACH,cAAc,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE5C;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;;WAGG;QACH,cAAc,CAAC,EAAE,CAAC,CAAC;QAEnB;;WAEG;QACH,WAAW,CAAC,EAAE,mBAAmB,CAAC,WAAW,CAAC;QAE9C;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;KAC3B;IAED,UAAiB,mBAAmB,CAAC;QACnC;;WAEG;QACH,UAAiB,WAAW;YAC1B;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,SAAS,EAAE,iBAAiB,GAAG,gBAAgB,CAAC;SACjD;QAED;;WAEG;QACH,UAAiB,WAAW;YAC1B;;eAEG;YACH,IAAI,EAAE,UAAU,CAAC;YAEjB;;eAEG;YACH,WAAW,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC;YAEtC;;eAEG;YACH,WAAW,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC;SACvC;QAED,UAAiB,WAAW,CAAC;YAC3B;;eAEG;YACH,UAAiB,WAAW;gBAC1B;;mBAEG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;mBAEG;gBACH,YAAY,CAAC,EAAE,MAAM,CAAC;gBAEtB;;mBAEG;gBACH,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,aAAa,CAAC,EAAE,MAAM,CAAC;gBAEvB;;;mBAGG;gBACH,GAAG,CAAC,EAAE,MAAM,CAAC;aACd;YAED;;eAEG;YACH,UAAiB,WAAW;gBAC1B;;;mBAGG;gBACH,IAAI,CAAC,EAAE,MAAM,CAAC;gBAEd;;;mBAGG;gBACH,GAAG,CAAC,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;aACnB;SACF;KACF;CACF;AAED,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAID,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,WAAW,IAAI,WAAW,EAC1B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
|
package/resources/letters.js
CHANGED
|
@@ -13,12 +13,26 @@ class Letters extends resource_1.APIResource {
|
|
|
13
13
|
* - A template ID for the letter
|
|
14
14
|
* - A URL or file for a PDF for the letter
|
|
15
15
|
* - Upload the aforementioned PDF file via a multipart form upload request
|
|
16
|
+
*
|
|
17
|
+
* @example
|
|
18
|
+
* ```ts
|
|
19
|
+
* const letter = await client.letters.create({
|
|
20
|
+
* from: 'contact_123',
|
|
21
|
+
* html: '<html>Content</html>',
|
|
22
|
+
* to: 'contact_123',
|
|
23
|
+
* });
|
|
24
|
+
* ```
|
|
16
25
|
*/
|
|
17
26
|
create(body, options) {
|
|
18
27
|
return this._client.post('/letters', { body, ...options });
|
|
19
28
|
}
|
|
20
29
|
/**
|
|
21
30
|
* Retrieve a letter by ID.
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* ```ts
|
|
34
|
+
* const letter = await client.letters.retrieve('id');
|
|
35
|
+
* ```
|
|
22
36
|
*/
|
|
23
37
|
retrieve(id, options) {
|
|
24
38
|
return this._client.get(`/letters/${id}`, options);
|
|
@@ -31,6 +45,11 @@ class Letters extends resource_1.APIResource {
|
|
|
31
45
|
}
|
|
32
46
|
/**
|
|
33
47
|
* Cancel a letter by ID. Note that this operation cannot be undone.
|
|
48
|
+
*
|
|
49
|
+
* @example
|
|
50
|
+
* ```ts
|
|
51
|
+
* const letter = await client.letters.delete('id');
|
|
52
|
+
* ```
|
|
34
53
|
*/
|
|
35
54
|
delete(id, options) {
|
|
36
55
|
return this._client.delete(`/letters/${id}`, options);
|
|
@@ -42,6 +61,11 @@ class Letters extends resource_1.APIResource {
|
|
|
42
61
|
* offers document generation and hosting capabilities. This endpoint has a much
|
|
43
62
|
* higher rate limit than the regular order retrieval endpoint, so it is suitable
|
|
44
63
|
* for customer-facing use-cases.
|
|
64
|
+
*
|
|
65
|
+
* @example
|
|
66
|
+
* ```ts
|
|
67
|
+
* const response = await client.letters.url('id');
|
|
68
|
+
* ```
|
|
45
69
|
*/
|
|
46
70
|
url(id, options) {
|
|
47
71
|
return this._client.get(`/letters/${id}/url`, options);
|
package/resources/letters.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"letters.js","sourceRoot":"","sources":["../src/resources/letters.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAI3C,iDAAsD;AAEtD,MAAa,OAAQ,SAAQ,sBAAW;IACtC
|
|
1
|
+
{"version":3,"file":"letters.js","sourceRoot":"","sources":["../src/resources/letters.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAI3C,iDAAsD;AAEtD,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;OAgBG;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;IAED;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,EAAU,EAAE,OAA6B;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;CACF;AArFD,0BAqFC;AAED,MAAa,WAAY,SAAQ,iBAAY;CAAG;AAAhD,kCAAgD;AA0xBhD,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC"}
|
package/resources/letters.mjs
CHANGED
|
@@ -10,12 +10,26 @@ export class Letters extends APIResource {
|
|
|
10
10
|
* - A template ID for the letter
|
|
11
11
|
* - A URL or file for a PDF for the letter
|
|
12
12
|
* - Upload the aforementioned PDF file via a multipart form upload request
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* const letter = await client.letters.create({
|
|
17
|
+
* from: 'contact_123',
|
|
18
|
+
* html: '<html>Content</html>',
|
|
19
|
+
* to: 'contact_123',
|
|
20
|
+
* });
|
|
21
|
+
* ```
|
|
13
22
|
*/
|
|
14
23
|
create(body, options) {
|
|
15
24
|
return this._client.post('/letters', { body, ...options });
|
|
16
25
|
}
|
|
17
26
|
/**
|
|
18
27
|
* Retrieve a letter by ID.
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* ```ts
|
|
31
|
+
* const letter = await client.letters.retrieve('id');
|
|
32
|
+
* ```
|
|
19
33
|
*/
|
|
20
34
|
retrieve(id, options) {
|
|
21
35
|
return this._client.get(`/letters/${id}`, options);
|
|
@@ -28,6 +42,11 @@ export class Letters extends APIResource {
|
|
|
28
42
|
}
|
|
29
43
|
/**
|
|
30
44
|
* Cancel a letter by ID. Note that this operation cannot be undone.
|
|
45
|
+
*
|
|
46
|
+
* @example
|
|
47
|
+
* ```ts
|
|
48
|
+
* const letter = await client.letters.delete('id');
|
|
49
|
+
* ```
|
|
31
50
|
*/
|
|
32
51
|
delete(id, options) {
|
|
33
52
|
return this._client.delete(`/letters/${id}`, options);
|
|
@@ -39,6 +58,11 @@ export class Letters extends APIResource {
|
|
|
39
58
|
* offers document generation and hosting capabilities. This endpoint has a much
|
|
40
59
|
* higher rate limit than the regular order retrieval endpoint, so it is suitable
|
|
41
60
|
* for customer-facing use-cases.
|
|
61
|
+
*
|
|
62
|
+
* @example
|
|
63
|
+
* ```ts
|
|
64
|
+
* const response = await client.letters.url('id');
|
|
65
|
+
* ```
|
|
42
66
|
*/
|
|
43
67
|
url(id, options) {
|
|
44
68
|
return this._client.get(`/letters/${id}/url`, options);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"letters.mjs","sourceRoot":"","sources":["../src/resources/letters.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAIpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC
|
|
1
|
+
{"version":3,"file":"letters.mjs","sourceRoot":"","sources":["../src/resources/letters.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAIpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;OAgBG;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,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,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;IAED;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,EAAU,EAAE,OAA6B;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;CACF;AAED,MAAM,OAAO,WAAY,SAAQ,IAAY;CAAG;AA0xBhD,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC"}
|