postgrid-node 0.4.2 → 0.6.1
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 +93 -0
- package/LICENSE +1 -1
- package/README.md +15 -12
- package/client.d.mts +35 -15
- package/client.d.mts.map +1 -1
- package/client.d.ts +35 -15
- package/client.d.ts.map +1 -1
- package/client.js +61 -15
- package/client.js.map +1 -1
- package/client.mjs +62 -16
- package/client.mjs.map +1 -1
- package/internal/parse.d.mts.map +1 -1
- package/internal/parse.d.ts.map +1 -1
- package/internal/parse.js +5 -0
- package/internal/parse.js.map +1 -1
- package/internal/parse.mjs +5 -0
- package/internal/parse.mjs.map +1 -1
- package/internal/types.d.mts +6 -6
- package/internal/types.d.mts.map +1 -1
- package/internal/types.d.ts +6 -6
- package/internal/types.d.ts.map +1 -1
- package/internal/utils/env.js +2 -2
- package/internal/utils/env.js.map +1 -1
- package/internal/utils/env.mjs +2 -2
- package/internal/utils/env.mjs.map +1 -1
- package/internal/utils/log.d.mts.map +1 -1
- package/internal/utils/log.d.ts.map +1 -1
- package/internal/utils/log.js +3 -2
- package/internal/utils/log.js.map +1 -1
- package/internal/utils/log.mjs +3 -2
- package/internal/utils/log.mjs.map +1 -1
- package/internal/utils/query.d.mts +5 -0
- package/internal/utils/query.d.mts.map +1 -0
- package/internal/utils/query.d.ts +5 -0
- package/internal/utils/query.d.ts.map +1 -0
- package/internal/utils/query.js +23 -0
- package/internal/utils/query.js.map +1 -0
- package/internal/utils/query.mjs +20 -0
- package/internal/utils/query.mjs.map +1 -0
- package/internal/utils.d.mts +1 -0
- package/internal/utils.d.ts +1 -0
- package/internal/utils.js +1 -0
- package/internal/utils.js.map +1 -1
- package/internal/utils.mjs +1 -0
- package/package.json +9 -3
- package/resources/address-verification.d.mts +1689 -15
- package/resources/address-verification.d.mts.map +1 -1
- package/resources/address-verification.d.ts +1689 -15
- package/resources/address-verification.d.ts.map +1 -1
- package/resources/address-verification.js +200 -0
- package/resources/address-verification.js.map +1 -1
- package/resources/address-verification.mjs +200 -0
- package/resources/address-verification.mjs.map +1 -1
- package/resources/index.d.mts +3 -3
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +3 -3
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/intl-address-verification.d.mts +956 -35
- package/resources/intl-address-verification.d.mts.map +1 -1
- package/resources/intl-address-verification.d.ts +956 -35
- package/resources/intl-address-verification.d.ts.map +1 -1
- package/resources/intl-address-verification.js +121 -27
- package/resources/intl-address-verification.js.map +1 -1
- package/resources/intl-address-verification.mjs +121 -27
- package/resources/intl-address-verification.mjs.map +1 -1
- package/resources/print-mail/boxes.d.mts +733 -59
- package/resources/print-mail/boxes.d.mts.map +1 -1
- package/resources/print-mail/boxes.d.ts +733 -59
- package/resources/print-mail/boxes.d.ts.map +1 -1
- package/resources/print-mail/boxes.js +19 -1
- package/resources/print-mail/boxes.js.map +1 -1
- package/resources/print-mail/boxes.mjs +19 -1
- package/resources/print-mail/boxes.mjs.map +1 -1
- package/resources/print-mail/campaigns.d.mts +923 -34
- package/resources/print-mail/campaigns.d.mts.map +1 -1
- package/resources/print-mail/campaigns.d.ts +923 -34
- package/resources/print-mail/campaigns.d.ts.map +1 -1
- package/resources/print-mail/campaigns.js +10 -3
- package/resources/print-mail/campaigns.js.map +1 -1
- package/resources/print-mail/campaigns.mjs +10 -3
- package/resources/print-mail/campaigns.mjs.map +1 -1
- package/resources/print-mail/cheques.d.mts +60 -11
- package/resources/print-mail/cheques.d.mts.map +1 -1
- package/resources/print-mail/cheques.d.ts +60 -11
- package/resources/print-mail/cheques.d.ts.map +1 -1
- package/resources/print-mail/cheques.js +32 -0
- package/resources/print-mail/cheques.js.map +1 -1
- package/resources/print-mail/cheques.mjs +32 -0
- package/resources/print-mail/cheques.mjs.map +1 -1
- package/resources/print-mail/contacts.d.mts +138 -3
- package/resources/print-mail/contacts.d.mts.map +1 -1
- package/resources/print-mail/contacts.d.ts +138 -3
- package/resources/print-mail/contacts.d.ts.map +1 -1
- package/resources/print-mail/contacts.js.map +1 -1
- package/resources/print-mail/contacts.mjs.map +1 -1
- package/resources/print-mail/index.d.mts +12 -8
- package/resources/print-mail/index.d.mts.map +1 -1
- package/resources/print-mail/index.d.ts +12 -8
- package/resources/print-mail/index.d.ts.map +1 -1
- package/resources/print-mail/index.js +13 -5
- package/resources/print-mail/index.js.map +1 -1
- package/resources/print-mail/index.mjs +5 -1
- package/resources/print-mail/index.mjs.map +1 -1
- package/resources/print-mail/letters.d.mts +62 -13
- package/resources/print-mail/letters.d.mts.map +1 -1
- package/resources/print-mail/letters.d.ts +62 -13
- package/resources/print-mail/letters.d.ts.map +1 -1
- package/resources/print-mail/letters.js +32 -0
- package/resources/print-mail/letters.js.map +1 -1
- package/resources/print-mail/letters.mjs +32 -0
- package/resources/print-mail/letters.mjs.map +1 -1
- package/resources/print-mail/mailing-list-imports.d.mts +5 -1
- package/resources/print-mail/mailing-list-imports.d.mts.map +1 -1
- package/resources/print-mail/mailing-list-imports.d.ts +5 -1
- package/resources/print-mail/mailing-list-imports.d.ts.map +1 -1
- package/resources/print-mail/mailing-list-imports.js +4 -0
- package/resources/print-mail/mailing-list-imports.js.map +1 -1
- package/resources/print-mail/mailing-list-imports.mjs +4 -0
- package/resources/print-mail/mailing-list-imports.mjs.map +1 -1
- package/resources/print-mail/mailing-lists.d.mts +5 -1
- package/resources/print-mail/mailing-lists.d.mts.map +1 -1
- package/resources/print-mail/mailing-lists.d.ts +5 -1
- package/resources/print-mail/mailing-lists.d.ts.map +1 -1
- package/resources/print-mail/mailing-lists.js +4 -0
- package/resources/print-mail/mailing-lists.js.map +1 -1
- package/resources/print-mail/mailing-lists.mjs +4 -0
- package/resources/print-mail/mailing-lists.mjs.map +1 -1
- package/resources/print-mail/postcards.d.mts +90 -21
- package/resources/print-mail/postcards.d.mts.map +1 -1
- package/resources/print-mail/postcards.d.ts +90 -21
- package/resources/print-mail/postcards.d.ts.map +1 -1
- package/resources/print-mail/postcards.js +33 -0
- package/resources/print-mail/postcards.js.map +1 -1
- package/resources/print-mail/postcards.mjs +33 -0
- package/resources/print-mail/postcards.mjs.map +1 -1
- package/resources/print-mail/print-mail.d.mts +41 -162
- package/resources/print-mail/print-mail.d.mts.map +1 -1
- package/resources/print-mail/print-mail.d.ts +41 -162
- package/resources/print-mail/print-mail.d.ts.map +1 -1
- package/resources/print-mail/print-mail.js +34 -18
- package/resources/print-mail/print-mail.js.map +1 -1
- package/resources/print-mail/print-mail.mjs +34 -18
- package/resources/print-mail/print-mail.mjs.map +1 -1
- package/resources/print-mail/reports/exports.d.mts +7 -0
- package/resources/print-mail/reports/exports.d.mts.map +1 -1
- package/resources/print-mail/reports/exports.d.ts +7 -0
- package/resources/print-mail/reports/exports.d.ts.map +1 -1
- package/resources/print-mail/reports/exports.js +7 -0
- package/resources/print-mail/reports/exports.js.map +1 -1
- package/resources/print-mail/reports/exports.mjs +7 -0
- package/resources/print-mail/reports/exports.mjs.map +1 -1
- package/resources/print-mail/reports/reports.d.mts +7 -0
- package/resources/print-mail/reports/reports.d.mts.map +1 -1
- package/resources/print-mail/reports/reports.d.ts +7 -0
- package/resources/print-mail/reports/reports.d.ts.map +1 -1
- package/resources/print-mail/reports/reports.js +7 -0
- package/resources/print-mail/reports/reports.js.map +1 -1
- package/resources/print-mail/reports/reports.mjs +7 -0
- package/resources/print-mail/reports/reports.mjs.map +1 -1
- package/resources/print-mail/reports/samples.d.mts +7 -0
- package/resources/print-mail/reports/samples.d.mts.map +1 -1
- package/resources/print-mail/reports/samples.d.ts +7 -0
- package/resources/print-mail/reports/samples.d.ts.map +1 -1
- package/resources/print-mail/reports/samples.js +7 -0
- package/resources/print-mail/reports/samples.js.map +1 -1
- package/resources/print-mail/reports/samples.mjs +7 -0
- package/resources/print-mail/reports/samples.mjs.map +1 -1
- package/resources/print-mail/self-mailers.d.mts +52 -20
- package/resources/print-mail/self-mailers.d.mts.map +1 -1
- package/resources/print-mail/self-mailers.d.ts +52 -20
- package/resources/print-mail/self-mailers.d.ts.map +1 -1
- package/resources/print-mail/self-mailers.js +17 -0
- package/resources/print-mail/self-mailers.js.map +1 -1
- package/resources/print-mail/self-mailers.mjs +17 -0
- package/resources/print-mail/self-mailers.mjs.map +1 -1
- package/resources/print-mail/snap-packs.d.mts +1060 -0
- package/resources/print-mail/snap-packs.d.mts.map +1 -0
- package/resources/print-mail/snap-packs.d.ts +1060 -0
- package/resources/print-mail/snap-packs.d.ts.map +1 -0
- package/resources/print-mail/snap-packs.js +117 -0
- package/resources/print-mail/snap-packs.js.map +1 -0
- package/resources/print-mail/snap-packs.mjs +113 -0
- package/resources/print-mail/snap-packs.mjs.map +1 -0
- package/resources/print-mail/sub-organizations.d.mts +29 -17
- package/resources/print-mail/sub-organizations.d.mts.map +1 -1
- package/resources/print-mail/sub-organizations.d.ts +29 -17
- package/resources/print-mail/sub-organizations.d.ts.map +1 -1
- package/resources/print-mail/sub-organizations.js +26 -14
- package/resources/print-mail/sub-organizations.js.map +1 -1
- package/resources/print-mail/sub-organizations.mjs +26 -14
- package/resources/print-mail/sub-organizations.mjs.map +1 -1
- package/resources/print-mail/targeted-list-builds/filters.d.mts +92 -0
- package/resources/print-mail/targeted-list-builds/filters.d.mts.map +1 -0
- package/resources/print-mail/targeted-list-builds/filters.d.ts +92 -0
- package/resources/print-mail/targeted-list-builds/filters.d.ts.map +1 -0
- package/resources/print-mail/targeted-list-builds/filters.js +60 -0
- package/resources/print-mail/targeted-list-builds/filters.js.map +1 -0
- package/resources/print-mail/targeted-list-builds/filters.mjs +56 -0
- package/resources/print-mail/targeted-list-builds/filters.mjs.map +1 -0
- package/resources/print-mail/targeted-list-builds/index.d.mts +3 -0
- package/resources/print-mail/targeted-list-builds/index.d.mts.map +1 -0
- package/resources/print-mail/targeted-list-builds/index.d.ts +3 -0
- package/resources/print-mail/targeted-list-builds/index.d.ts.map +1 -0
- package/resources/print-mail/targeted-list-builds/index.js +9 -0
- package/resources/print-mail/targeted-list-builds/index.js.map +1 -0
- package/resources/print-mail/targeted-list-builds/index.mjs +4 -0
- package/resources/print-mail/targeted-list-builds/index.mjs.map +1 -0
- package/resources/print-mail/targeted-list-builds/targeted-list-builds.d.mts +1633 -0
- package/resources/print-mail/targeted-list-builds/targeted-list-builds.d.mts.map +1 -0
- package/resources/print-mail/targeted-list-builds/targeted-list-builds.d.ts +1633 -0
- package/resources/print-mail/targeted-list-builds/targeted-list-builds.d.ts.map +1 -0
- package/resources/print-mail/targeted-list-builds/targeted-list-builds.js +154 -0
- package/resources/print-mail/targeted-list-builds/targeted-list-builds.js.map +1 -0
- package/resources/print-mail/targeted-list-builds/targeted-list-builds.mjs +149 -0
- package/resources/print-mail/targeted-list-builds/targeted-list-builds.mjs.map +1 -0
- package/resources/print-mail/targeted-list-builds.d.mts +2 -0
- package/resources/print-mail/targeted-list-builds.d.mts.map +1 -0
- package/resources/print-mail/targeted-list-builds.d.ts +2 -0
- package/resources/print-mail/targeted-list-builds.d.ts.map +1 -0
- package/resources/print-mail/targeted-list-builds.js +6 -0
- package/resources/print-mail/targeted-list-builds.js.map +1 -0
- package/resources/print-mail/targeted-list-builds.mjs +3 -0
- package/resources/print-mail/targeted-list-builds.mjs.map +1 -0
- package/resources/print-mail/template-editor-sessions.d.mts +355 -0
- package/resources/print-mail/template-editor-sessions.d.mts.map +1 -0
- package/resources/print-mail/template-editor-sessions.d.ts +355 -0
- package/resources/print-mail/template-editor-sessions.d.ts.map +1 -0
- package/resources/print-mail/template-editor-sessions.js +78 -0
- package/resources/print-mail/template-editor-sessions.js.map +1 -0
- package/resources/print-mail/template-editor-sessions.mjs +74 -0
- package/resources/print-mail/template-editor-sessions.mjs.map +1 -0
- package/resources/print-mail/trackers.d.mts +409 -0
- package/resources/print-mail/trackers.d.mts.map +1 -0
- package/resources/print-mail/trackers.d.ts +409 -0
- package/resources/print-mail/trackers.d.ts.map +1 -0
- package/resources/print-mail/trackers.js +116 -0
- package/resources/print-mail/trackers.js.map +1 -0
- package/resources/print-mail/trackers.mjs +112 -0
- package/resources/print-mail/trackers.mjs.map +1 -0
- package/resources/print-mail/virtual-mailboxes/index.d.mts +3 -0
- package/resources/print-mail/virtual-mailboxes/index.d.mts.map +1 -0
- package/resources/print-mail/virtual-mailboxes/index.d.ts +3 -0
- package/resources/print-mail/virtual-mailboxes/index.d.ts.map +1 -0
- package/resources/print-mail/virtual-mailboxes/index.js +9 -0
- package/resources/print-mail/virtual-mailboxes/index.js.map +1 -0
- package/resources/print-mail/virtual-mailboxes/index.mjs +4 -0
- package/resources/print-mail/virtual-mailboxes/index.mjs.map +1 -0
- package/resources/print-mail/virtual-mailboxes/items.d.mts +235 -0
- package/resources/print-mail/virtual-mailboxes/items.d.mts.map +1 -0
- package/resources/print-mail/virtual-mailboxes/items.d.ts +235 -0
- package/resources/print-mail/virtual-mailboxes/items.d.ts.map +1 -0
- package/resources/print-mail/virtual-mailboxes/items.js +69 -0
- package/resources/print-mail/virtual-mailboxes/items.js.map +1 -0
- package/resources/print-mail/virtual-mailboxes/items.mjs +65 -0
- package/resources/print-mail/virtual-mailboxes/items.mjs.map +1 -0
- package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.d.mts +334 -0
- package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.d.mts.map +1 -0
- package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.d.ts +334 -0
- package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.d.ts.map +1 -0
- package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.js +92 -0
- package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.js.map +1 -0
- package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.mjs +87 -0
- package/resources/print-mail/virtual-mailboxes/virtual-mailboxes.mjs.map +1 -0
- package/resources/print-mail/virtual-mailboxes.d.mts +2 -0
- package/resources/print-mail/virtual-mailboxes.d.mts.map +1 -0
- package/resources/print-mail/virtual-mailboxes.d.ts +2 -0
- package/resources/print-mail/virtual-mailboxes.d.ts.map +1 -0
- package/resources/print-mail/{order-profiles.js → virtual-mailboxes.js} +2 -2
- package/resources/print-mail/virtual-mailboxes.js.map +1 -0
- package/resources/print-mail/virtual-mailboxes.mjs +3 -0
- package/resources/print-mail/virtual-mailboxes.mjs.map +1 -0
- package/src/client.ts +123 -33
- package/src/internal/parse.ts +6 -0
- package/src/internal/types.ts +6 -8
- package/src/internal/utils/env.ts +2 -2
- package/src/internal/utils/log.ts +2 -1
- package/src/internal/utils/query.ts +23 -0
- package/src/internal/utils.ts +1 -0
- package/src/resources/address-verification.ts +2190 -24
- package/src/resources/index.ts +24 -5
- package/src/resources/intl-address-verification.ts +1219 -43
- package/src/resources/print-mail/boxes.ts +1011 -99
- package/src/resources/print-mail/campaigns.ts +1449 -59
- package/src/resources/print-mail/cheques.ts +122 -10
- package/src/resources/print-mail/contacts.ts +167 -4
- package/src/resources/print-mail/index.ts +74 -11
- package/src/resources/print-mail/letters.ts +150 -12
- package/src/resources/print-mail/mailing-list-imports.ts +5 -1
- package/src/resources/print-mail/mailing-lists.ts +5 -1
- package/src/resources/print-mail/postcards.ts +208 -20
- package/src/resources/print-mail/print-mail.ts +239 -261
- package/src/resources/print-mail/reports/exports.ts +7 -0
- package/src/resources/print-mail/reports/reports.ts +7 -0
- package/src/resources/print-mail/reports/samples.ts +7 -0
- package/src/resources/print-mail/self-mailers.ts +162 -20
- package/src/resources/print-mail/snap-packs.ts +1484 -0
- package/src/resources/print-mail/sub-organizations.ts +35 -23
- package/src/resources/print-mail/targeted-list-builds/filters.ts +113 -0
- package/src/resources/print-mail/targeted-list-builds/index.ts +16 -0
- package/src/resources/print-mail/targeted-list-builds/targeted-list-builds.ts +2158 -0
- package/{resources/print-mail/order-profiles.mjs → src/resources/print-mail/targeted-list-builds.ts} +2 -2
- package/src/resources/print-mail/template-editor-sessions.ts +435 -0
- package/src/resources/print-mail/trackers.ts +513 -0
- package/src/resources/print-mail/virtual-mailboxes/index.ts +22 -0
- package/src/resources/print-mail/virtual-mailboxes/items.ts +296 -0
- package/src/resources/print-mail/virtual-mailboxes/virtual-mailboxes.ts +434 -0
- package/src/resources/print-mail/{order-profiles.ts → virtual-mailboxes.ts} +1 -1
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/internal/qs/formats.d.mts +0 -7
- package/internal/qs/formats.d.mts.map +0 -1
- package/internal/qs/formats.d.ts +0 -7
- package/internal/qs/formats.d.ts.map +0 -1
- package/internal/qs/formats.js +0 -13
- package/internal/qs/formats.js.map +0 -1
- package/internal/qs/formats.mjs +0 -9
- package/internal/qs/formats.mjs.map +0 -1
- package/internal/qs/index.d.mts +0 -10
- package/internal/qs/index.d.mts.map +0 -1
- package/internal/qs/index.d.ts +0 -10
- package/internal/qs/index.d.ts.map +0 -1
- package/internal/qs/index.js +0 -14
- package/internal/qs/index.js.map +0 -1
- package/internal/qs/index.mjs +0 -10
- package/internal/qs/index.mjs.map +0 -1
- package/internal/qs/stringify.d.mts +0 -3
- package/internal/qs/stringify.d.mts.map +0 -1
- package/internal/qs/stringify.d.ts +0 -3
- package/internal/qs/stringify.d.ts.map +0 -1
- package/internal/qs/stringify.js +0 -277
- package/internal/qs/stringify.js.map +0 -1
- package/internal/qs/stringify.mjs +0 -274
- package/internal/qs/stringify.mjs.map +0 -1
- package/internal/qs/types.d.mts +0 -57
- package/internal/qs/types.d.mts.map +0 -1
- package/internal/qs/types.d.ts +0 -57
- package/internal/qs/types.d.ts.map +0 -1
- package/internal/qs/types.js +0 -3
- package/internal/qs/types.js.map +0 -1
- package/internal/qs/types.mjs +0 -2
- package/internal/qs/types.mjs.map +0 -1
- package/internal/qs/utils.d.mts +0 -15
- package/internal/qs/utils.d.mts.map +0 -1
- package/internal/qs/utils.d.ts +0 -15
- package/internal/qs/utils.d.ts.map +0 -1
- package/internal/qs/utils.js +0 -230
- package/internal/qs/utils.js.map +0 -1
- package/internal/qs/utils.mjs +0 -217
- package/internal/qs/utils.mjs.map +0 -1
- package/resources/print-mail/order-profiles/cheques.d.mts +0 -388
- package/resources/print-mail/order-profiles/cheques.d.mts.map +0 -1
- package/resources/print-mail/order-profiles/cheques.d.ts +0 -388
- package/resources/print-mail/order-profiles/cheques.d.ts.map +0 -1
- package/resources/print-mail/order-profiles/cheques.js +0 -98
- package/resources/print-mail/order-profiles/cheques.js.map +0 -1
- package/resources/print-mail/order-profiles/cheques.mjs +0 -94
- package/resources/print-mail/order-profiles/cheques.mjs.map +0 -1
- package/resources/print-mail/order-profiles/index.d.mts +0 -6
- package/resources/print-mail/order-profiles/index.d.mts.map +0 -1
- package/resources/print-mail/order-profiles/index.d.ts +0 -6
- package/resources/print-mail/order-profiles/index.d.ts.map +0 -1
- package/resources/print-mail/order-profiles/index.js +0 -15
- package/resources/print-mail/order-profiles/index.js.map +0 -1
- package/resources/print-mail/order-profiles/index.mjs +0 -7
- package/resources/print-mail/order-profiles/index.mjs.map +0 -1
- package/resources/print-mail/order-profiles/letters.d.mts +0 -325
- package/resources/print-mail/order-profiles/letters.d.mts.map +0 -1
- package/resources/print-mail/order-profiles/letters.d.ts +0 -325
- package/resources/print-mail/order-profiles/letters.d.ts.map +0 -1
- package/resources/print-mail/order-profiles/letters.js +0 -105
- package/resources/print-mail/order-profiles/letters.js.map +0 -1
- package/resources/print-mail/order-profiles/letters.mjs +0 -101
- package/resources/print-mail/order-profiles/letters.mjs.map +0 -1
- package/resources/print-mail/order-profiles/order-profiles.d.mts +0 -22
- package/resources/print-mail/order-profiles/order-profiles.d.mts.map +0 -1
- package/resources/print-mail/order-profiles/order-profiles.d.ts +0 -22
- package/resources/print-mail/order-profiles/order-profiles.d.ts.map +0 -1
- package/resources/print-mail/order-profiles/order-profiles.js +0 -29
- package/resources/print-mail/order-profiles/order-profiles.js.map +0 -1
- package/resources/print-mail/order-profiles/order-profiles.mjs +0 -24
- package/resources/print-mail/order-profiles/order-profiles.mjs.map +0 -1
- package/resources/print-mail/order-profiles/postcards.d.mts +0 -255
- package/resources/print-mail/order-profiles/postcards.d.mts.map +0 -1
- package/resources/print-mail/order-profiles/postcards.d.ts +0 -255
- package/resources/print-mail/order-profiles/postcards.d.ts.map +0 -1
- package/resources/print-mail/order-profiles/postcards.js +0 -97
- package/resources/print-mail/order-profiles/postcards.js.map +0 -1
- package/resources/print-mail/order-profiles/postcards.mjs +0 -93
- package/resources/print-mail/order-profiles/postcards.mjs.map +0 -1
- package/resources/print-mail/order-profiles/self-mailers.d.mts +0 -260
- package/resources/print-mail/order-profiles/self-mailers.d.mts.map +0 -1
- package/resources/print-mail/order-profiles/self-mailers.d.ts +0 -260
- package/resources/print-mail/order-profiles/self-mailers.d.ts.map +0 -1
- package/resources/print-mail/order-profiles/self-mailers.js +0 -95
- package/resources/print-mail/order-profiles/self-mailers.js.map +0 -1
- package/resources/print-mail/order-profiles/self-mailers.mjs +0 -91
- package/resources/print-mail/order-profiles/self-mailers.mjs.map +0 -1
- package/resources/print-mail/order-profiles.d.mts +0 -2
- package/resources/print-mail/order-profiles.d.mts.map +0 -1
- package/resources/print-mail/order-profiles.d.ts +0 -2
- package/resources/print-mail/order-profiles.d.ts.map +0 -1
- package/resources/print-mail/order-profiles.js.map +0 -1
- package/resources/print-mail/order-profiles.mjs.map +0 -1
- package/src/internal/qs/LICENSE.md +0 -13
- package/src/internal/qs/README.md +0 -3
- package/src/internal/qs/formats.ts +0 -10
- package/src/internal/qs/index.ts +0 -13
- package/src/internal/qs/stringify.ts +0 -385
- package/src/internal/qs/types.ts +0 -71
- package/src/internal/qs/utils.ts +0 -265
- package/src/resources/print-mail/order-profiles/cheques.ts +0 -486
- package/src/resources/print-mail/order-profiles/index.ts +0 -47
- package/src/resources/print-mail/order-profiles/letters.ts +0 -412
- package/src/resources/print-mail/order-profiles/order-profiles.ts +0 -113
- package/src/resources/print-mail/order-profiles/postcards.ts +0 -327
- package/src/resources/print-mail/order-profiles/self-mailers.ts +0 -338
|
@@ -1,8 +1,5 @@
|
|
|
1
1
|
import { APIResource } from "../../core/resource.js";
|
|
2
|
-
import * as BoxesAPI from "./boxes.js";
|
|
3
2
|
import * as ContactsAPI from "./contacts.js";
|
|
4
|
-
import * as PrintMailAPI from "./print-mail.js";
|
|
5
|
-
import * as OrderProfilesPostcardsAPI from "./order-profiles/postcards.js";
|
|
6
3
|
import { APIPromise } from "../../core/api-promise.js";
|
|
7
4
|
import { PagePromise, SkipLimit, type SkipLimitParams } from "../../core/pagination.js";
|
|
8
5
|
import { RequestOptions } from "../../internal/request-options.js";
|
|
@@ -62,6 +59,35 @@ export declare class Postcards extends APIResource {
|
|
|
62
59
|
* ```
|
|
63
60
|
*/
|
|
64
61
|
delete(id: string, options?: RequestOptions): APIPromise<Postcard>;
|
|
62
|
+
/**
|
|
63
|
+
* Cancel a postcard by ID with a note. Note that this operation cannot be undone
|
|
64
|
+
* and that only postcards with a status of `ready` can be cancelled.
|
|
65
|
+
*
|
|
66
|
+
* @example
|
|
67
|
+
* ```ts
|
|
68
|
+
* const postcard = await client.printMail.postcards.cancel(
|
|
69
|
+
* 'id',
|
|
70
|
+
* { note: 'Cancelling this postcard' },
|
|
71
|
+
* );
|
|
72
|
+
* ```
|
|
73
|
+
*/
|
|
74
|
+
cancel(id: string, body: PostcardCancelParams, options?: RequestOptions): APIPromise<Postcard>;
|
|
75
|
+
/**
|
|
76
|
+
* Progresses a postcard's `status` to the next stage. This is only available in
|
|
77
|
+
* test mode and can be used to simulate how a live order would progress through
|
|
78
|
+
* the different statuses.
|
|
79
|
+
*
|
|
80
|
+
* Note: this will fail with an `invalid_progression_error` if the status is one of
|
|
81
|
+
* `completed` or `cancelled`.
|
|
82
|
+
*
|
|
83
|
+
* @example
|
|
84
|
+
* ```ts
|
|
85
|
+
* const postcard = await client.printMail.postcards.progress(
|
|
86
|
+
* 'id',
|
|
87
|
+
* );
|
|
88
|
+
* ```
|
|
89
|
+
*/
|
|
90
|
+
progress(id: string, options?: RequestOptions): APIPromise<Postcard>;
|
|
65
91
|
/**
|
|
66
92
|
* Retrieve a postcard preview URL.
|
|
67
93
|
*
|
|
@@ -96,7 +122,7 @@ export interface Postcard {
|
|
|
96
122
|
* The mailing class of this order. This determines the speed and cost of delivery.
|
|
97
123
|
* See `OrderMailingClass` for more details.
|
|
98
124
|
*/
|
|
99
|
-
mailingClass:
|
|
125
|
+
mailingClass: 'first_class' | 'standard_class' | 'express' | 'certified' | 'certified_return_receipt' | 'registered' | 'usps_first_class' | 'usps_standard_class' | 'usps_eddm' | 'usps_express_2_day' | 'usps_express_3_day' | 'usps_first_class_certified' | 'usps_first_class_certified_return_receipt' | 'usps_first_class_registered' | 'usps_express_3_day_signature_confirmation' | 'usps_express_3_day_certified' | 'usps_express_3_day_certified_return_receipt' | 'ca_post_lettermail' | 'ca_post_personalized' | 'ca_post_neighbourhood_mail' | 'ups_express_overnight' | 'ups_express_2_day' | 'ups_express_3_day' | 'royal_mail_first_class' | 'royal_mail_second_class' | 'au_post_second_class';
|
|
100
126
|
/**
|
|
101
127
|
* Always `postcard`.
|
|
102
128
|
*/
|
|
@@ -110,11 +136,11 @@ export interface Postcard {
|
|
|
110
136
|
/**
|
|
111
137
|
* Enum representing the supported postcard sizes.
|
|
112
138
|
*/
|
|
113
|
-
size:
|
|
139
|
+
size: '6x4' | '9x6' | '11x6';
|
|
114
140
|
/**
|
|
115
141
|
* See `OrderStatus` for more details on the status of this order.
|
|
116
142
|
*/
|
|
117
|
-
status:
|
|
143
|
+
status: 'ready' | 'printing' | 'processed_for_delivery' | 'completed' | 'cancelled';
|
|
118
144
|
/**
|
|
119
145
|
* The recipient of this order. This will be provided even if you delete the
|
|
120
146
|
* underlying contact.
|
|
@@ -128,7 +154,7 @@ export interface Postcard {
|
|
|
128
154
|
* The cancellation details of this order. Populated if the order has been
|
|
129
155
|
* cancelled.
|
|
130
156
|
*/
|
|
131
|
-
cancellation?:
|
|
157
|
+
cancellation?: Postcard.Cancellation;
|
|
132
158
|
/**
|
|
133
159
|
* An optional string describing this resource. Will be visible in the API and the
|
|
134
160
|
* dashboard.
|
|
@@ -147,7 +173,7 @@ export interface Postcard {
|
|
|
147
173
|
* US-printed and US-destined orders. This is the most detailed way to track
|
|
148
174
|
* non-express/certified orders.
|
|
149
175
|
*/
|
|
150
|
-
imbStatus?:
|
|
176
|
+
imbStatus?: 'entered_mail_stream' | 'out_for_delivery' | 'returned_to_sender';
|
|
151
177
|
/**
|
|
152
178
|
* The most recent ZIP code of the USPS facility that the order has been processed
|
|
153
179
|
* through. Only populated when an `imbStatus` is present.
|
|
@@ -168,6 +194,11 @@ export interface Postcard {
|
|
|
168
194
|
metadata?: {
|
|
169
195
|
[key: string]: unknown;
|
|
170
196
|
};
|
|
197
|
+
/**
|
|
198
|
+
* Premium paper identifier. Use "standard" for regular stock or a premium*paper*\*
|
|
199
|
+
* ID.
|
|
200
|
+
*/
|
|
201
|
+
paper?: string;
|
|
171
202
|
/**
|
|
172
203
|
* The tracking number of this order. Populated after an express/certified order
|
|
173
204
|
* has been processed for delivery.
|
|
@@ -185,6 +216,26 @@ export interface Postcard {
|
|
|
185
216
|
*/
|
|
186
217
|
url?: string;
|
|
187
218
|
}
|
|
219
|
+
export declare namespace Postcard {
|
|
220
|
+
/**
|
|
221
|
+
* The cancellation details of this order. Populated if the order has been
|
|
222
|
+
* cancelled.
|
|
223
|
+
*/
|
|
224
|
+
interface Cancellation {
|
|
225
|
+
/**
|
|
226
|
+
* The reason for the cancellation.
|
|
227
|
+
*/
|
|
228
|
+
reason: 'user_initiated' | 'invalid_content' | 'invalid_order_mailing_class';
|
|
229
|
+
/**
|
|
230
|
+
* The user ID who cancelled the order.
|
|
231
|
+
*/
|
|
232
|
+
cancelledByUser?: string;
|
|
233
|
+
/**
|
|
234
|
+
* An optional note provided by the user who cancelled the order.
|
|
235
|
+
*/
|
|
236
|
+
note?: string;
|
|
237
|
+
}
|
|
238
|
+
}
|
|
188
239
|
export interface PostcardRetrieveURLResponse {
|
|
189
240
|
/**
|
|
190
241
|
* A unique ID prefixed with postcard\_
|
|
@@ -213,14 +264,14 @@ export declare namespace PostcardCreateParams {
|
|
|
213
264
|
/**
|
|
214
265
|
* Enum representing the supported postcard sizes.
|
|
215
266
|
*/
|
|
216
|
-
size:
|
|
267
|
+
size: '6x4' | '9x6' | '11x6';
|
|
217
268
|
/**
|
|
218
269
|
* The recipient of this order. You can either supply the contact information
|
|
219
270
|
* inline here or provide a contact ID. PostGrid will automatically deduplicate
|
|
220
271
|
* contacts regardless of whether you provide the information inline here or call
|
|
221
272
|
* the contact creation endpoint.
|
|
222
273
|
*/
|
|
223
|
-
to:
|
|
274
|
+
to: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
|
|
224
275
|
/**
|
|
225
276
|
* An optional string describing this resource. Will be visible in the API and the
|
|
226
277
|
* dashboard.
|
|
@@ -231,12 +282,12 @@ export declare namespace PostcardCreateParams {
|
|
|
231
282
|
* here just like you can for the `to`. Unlike other order types, the sender
|
|
232
283
|
* address is optional for postcards.
|
|
233
284
|
*/
|
|
234
|
-
from?:
|
|
285
|
+
from?: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
|
|
235
286
|
/**
|
|
236
287
|
* The mailing class of this order. If not provided, automatically set to
|
|
237
288
|
* `first_class`.
|
|
238
289
|
*/
|
|
239
|
-
mailingClass?:
|
|
290
|
+
mailingClass?: 'first_class' | 'standard_class' | 'express' | 'certified' | 'certified_return_receipt' | 'registered' | 'usps_first_class' | 'usps_standard_class' | 'usps_eddm' | 'usps_express_2_day' | 'usps_express_3_day' | 'usps_first_class_certified' | 'usps_first_class_certified_return_receipt' | 'usps_first_class_registered' | 'usps_express_3_day_signature_confirmation' | 'usps_express_3_day_certified' | 'usps_express_3_day_certified_return_receipt' | 'ca_post_lettermail' | 'ca_post_personalized' | 'ca_post_neighbourhood_mail' | 'ups_express_overnight' | 'ups_express_2_day' | 'ups_express_3_day' | 'royal_mail_first_class' | 'royal_mail_second_class' | 'au_post_second_class';
|
|
240
291
|
/**
|
|
241
292
|
* These will be merged with the variables in the template or HTML you create this
|
|
242
293
|
* order with. The keys in this object should match the variable names in the
|
|
@@ -252,6 +303,11 @@ export declare namespace PostcardCreateParams {
|
|
|
252
303
|
metadata?: {
|
|
253
304
|
[key: string]: unknown;
|
|
254
305
|
};
|
|
306
|
+
/**
|
|
307
|
+
* Premium paper identifier. Use "standard" for regular stock or a premium*paper*\*
|
|
308
|
+
* ID.
|
|
309
|
+
*/
|
|
310
|
+
paper?: string;
|
|
255
311
|
/**
|
|
256
312
|
* This order will transition from `ready` to `printing` on the day after this
|
|
257
313
|
* date. You can use this parameter to schedule orders for a future date.
|
|
@@ -279,14 +335,14 @@ export declare namespace PostcardCreateParams {
|
|
|
279
335
|
/**
|
|
280
336
|
* Enum representing the supported postcard sizes.
|
|
281
337
|
*/
|
|
282
|
-
size:
|
|
338
|
+
size: '6x4' | '9x6' | '11x6';
|
|
283
339
|
/**
|
|
284
340
|
* The recipient of this order. You can either supply the contact information
|
|
285
341
|
* inline here or provide a contact ID. PostGrid will automatically deduplicate
|
|
286
342
|
* contacts regardless of whether you provide the information inline here or call
|
|
287
343
|
* the contact creation endpoint.
|
|
288
344
|
*/
|
|
289
|
-
to:
|
|
345
|
+
to: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
|
|
290
346
|
/**
|
|
291
347
|
* An optional string describing this resource. Will be visible in the API and the
|
|
292
348
|
* dashboard.
|
|
@@ -297,12 +353,12 @@ export declare namespace PostcardCreateParams {
|
|
|
297
353
|
* here just like you can for the `to`. Unlike other order types, the sender
|
|
298
354
|
* address is optional for postcards.
|
|
299
355
|
*/
|
|
300
|
-
from?:
|
|
356
|
+
from?: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
|
|
301
357
|
/**
|
|
302
358
|
* The mailing class of this order. If not provided, automatically set to
|
|
303
359
|
* `first_class`.
|
|
304
360
|
*/
|
|
305
|
-
mailingClass?:
|
|
361
|
+
mailingClass?: 'first_class' | 'standard_class' | 'express' | 'certified' | 'certified_return_receipt' | 'registered' | 'usps_first_class' | 'usps_standard_class' | 'usps_eddm' | 'usps_express_2_day' | 'usps_express_3_day' | 'usps_first_class_certified' | 'usps_first_class_certified_return_receipt' | 'usps_first_class_registered' | 'usps_express_3_day_signature_confirmation' | 'usps_express_3_day_certified' | 'usps_express_3_day_certified_return_receipt' | 'ca_post_lettermail' | 'ca_post_personalized' | 'ca_post_neighbourhood_mail' | 'ups_express_overnight' | 'ups_express_2_day' | 'ups_express_3_day' | 'royal_mail_first_class' | 'royal_mail_second_class' | 'au_post_second_class';
|
|
306
362
|
/**
|
|
307
363
|
* These will be merged with the variables in the template or HTML you create this
|
|
308
364
|
* order with. The keys in this object should match the variable names in the
|
|
@@ -318,6 +374,11 @@ export declare namespace PostcardCreateParams {
|
|
|
318
374
|
metadata?: {
|
|
319
375
|
[key: string]: unknown;
|
|
320
376
|
};
|
|
377
|
+
/**
|
|
378
|
+
* Premium paper identifier. Use "standard" for regular stock or a premium*paper*\*
|
|
379
|
+
* ID.
|
|
380
|
+
*/
|
|
381
|
+
paper?: string;
|
|
321
382
|
/**
|
|
322
383
|
* This order will transition from `ready` to `printing` on the day after this
|
|
323
384
|
* date. You can use this parameter to schedule orders for a future date.
|
|
@@ -333,14 +394,14 @@ export declare namespace PostcardCreateParams {
|
|
|
333
394
|
/**
|
|
334
395
|
* Enum representing the supported postcard sizes.
|
|
335
396
|
*/
|
|
336
|
-
size:
|
|
397
|
+
size: '6x4' | '9x6' | '11x6';
|
|
337
398
|
/**
|
|
338
399
|
* The recipient of this order. You can either supply the contact information
|
|
339
400
|
* inline here or provide a contact ID. PostGrid will automatically deduplicate
|
|
340
401
|
* contacts regardless of whether you provide the information inline here or call
|
|
341
402
|
* the contact creation endpoint.
|
|
342
403
|
*/
|
|
343
|
-
to:
|
|
404
|
+
to: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
|
|
344
405
|
/**
|
|
345
406
|
* An optional string describing this resource. Will be visible in the API and the
|
|
346
407
|
* dashboard.
|
|
@@ -351,12 +412,12 @@ export declare namespace PostcardCreateParams {
|
|
|
351
412
|
* here just like you can for the `to`. Unlike other order types, the sender
|
|
352
413
|
* address is optional for postcards.
|
|
353
414
|
*/
|
|
354
|
-
from?:
|
|
415
|
+
from?: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
|
|
355
416
|
/**
|
|
356
417
|
* The mailing class of this order. If not provided, automatically set to
|
|
357
418
|
* `first_class`.
|
|
358
419
|
*/
|
|
359
|
-
mailingClass?:
|
|
420
|
+
mailingClass?: 'first_class' | 'standard_class' | 'express' | 'certified' | 'certified_return_receipt' | 'registered' | 'usps_first_class' | 'usps_standard_class' | 'usps_eddm' | 'usps_express_2_day' | 'usps_express_3_day' | 'usps_first_class_certified' | 'usps_first_class_certified_return_receipt' | 'usps_first_class_registered' | 'usps_express_3_day_signature_confirmation' | 'usps_express_3_day_certified' | 'usps_express_3_day_certified_return_receipt' | 'ca_post_lettermail' | 'ca_post_personalized' | 'ca_post_neighbourhood_mail' | 'ups_express_overnight' | 'ups_express_2_day' | 'ups_express_3_day' | 'royal_mail_first_class' | 'royal_mail_second_class' | 'au_post_second_class';
|
|
360
421
|
/**
|
|
361
422
|
* These will be merged with the variables in the template or HTML you create this
|
|
362
423
|
* order with. The keys in this object should match the variable names in the
|
|
@@ -372,6 +433,11 @@ export declare namespace PostcardCreateParams {
|
|
|
372
433
|
metadata?: {
|
|
373
434
|
[key: string]: unknown;
|
|
374
435
|
};
|
|
436
|
+
/**
|
|
437
|
+
* Premium paper identifier. Use "standard" for regular stock or a premium*paper*\*
|
|
438
|
+
* ID.
|
|
439
|
+
*/
|
|
440
|
+
paper?: string;
|
|
375
441
|
/**
|
|
376
442
|
* This order will transition from `ready` to `printing` on the day after this
|
|
377
443
|
* date. You can use this parameter to schedule orders for a future date.
|
|
@@ -389,7 +455,10 @@ export interface PostcardListParams extends SkipLimitParams {
|
|
|
389
455
|
*/
|
|
390
456
|
search?: string;
|
|
391
457
|
}
|
|
458
|
+
export interface PostcardCancelParams {
|
|
459
|
+
note: string;
|
|
460
|
+
}
|
|
392
461
|
export declare namespace Postcards {
|
|
393
|
-
export { type Postcard as Postcard, type PostcardRetrieveURLResponse as PostcardRetrieveURLResponse, type PostcardsSkipLimit as PostcardsSkipLimit, type PostcardCreateParams as PostcardCreateParams, type PostcardListParams as PostcardListParams, };
|
|
462
|
+
export { type Postcard as Postcard, type PostcardRetrieveURLResponse as PostcardRetrieveURLResponse, type PostcardsSkipLimit as PostcardsSkipLimit, type PostcardCreateParams as PostcardCreateParams, type PostcardListParams as PostcardListParams, type PostcardCancelParams as PostcardCancelParams, };
|
|
394
463
|
}
|
|
395
464
|
//# sourceMappingURL=postcards.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"postcards.d.ts","sourceRoot":"","sources":["../../src/resources/print-mail/postcards.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,
|
|
1
|
+
{"version":3,"file":"postcards.d.ts","sourceRoot":"","sources":["../../src/resources/print-mail/postcards.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE;OAChD,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIlF;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIpE;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kBAAkB,EAAE,QAAQ,CAAC;IAI5C;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIlE;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAI9F;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIpE;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;CAG3F;AAED,MAAM,MAAM,kBAAkB,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;AAErD,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;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,UAAU,CAAC;IAEnB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAE7B;;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,QAAQ,CAAC,YAAY,CAAC;IAErC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;IAE3B;;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,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,QAAQ,CAAC;IACxB;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,MAAM,EAAE,gBAAgB,GAAG,iBAAiB,GAAG,6BAA6B,CAAC;QAE7E;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,MAAM,oBAAoB,GAC5B,oBAAoB,CAAC,sBAAsB,GAC3C,oBAAoB,CAAC,0BAA0B,GAC/C,oBAAoB,CAAC,wBAAwB,GAC7C,oBAAoB,CAAC,yBAAyB,CAAC;AAEnD,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,UAAiB,sBAAsB;QACrC;;;WAGG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;QAE7B;;;;;WAKG;QACH,EAAE,EAAE,WAAW,CAAC,0BAA0B,GAAG,WAAW,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAE/F;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;;WAIG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC,0BAA0B,GAAG,WAAW,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAElG;;;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,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,0BAA0B;QACzC;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,aAAa,EAAE,MAAM,CAAC;KACvB;IAED,UAAiB,wBAAwB;QACvC;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;QAE7B;;;;;WAKG;QACH,EAAE,EAAE,WAAW,CAAC,0BAA0B,GAAG,WAAW,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAE/F;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;;WAIG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC,0BAA0B,GAAG,WAAW,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAElG;;;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,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,yBAAyB;QACxC;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;QAE7B;;;;;WAKG;QACH,EAAE,EAAE,WAAW,CAAC,0BAA0B,GAAG,WAAW,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAE/F;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;;WAIG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC,0BAA0B,GAAG,WAAW,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAElG;;;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,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,kBAAmB,SAAQ,eAAe;IACzD;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
|
|
@@ -69,6 +69,39 @@ class Postcards extends resource_1.APIResource {
|
|
|
69
69
|
delete(id, options) {
|
|
70
70
|
return this._client.delete((0, path_1.path) `/print-mail/v1/postcards/${id}`, options);
|
|
71
71
|
}
|
|
72
|
+
/**
|
|
73
|
+
* Cancel a postcard by ID with a note. Note that this operation cannot be undone
|
|
74
|
+
* and that only postcards with a status of `ready` can be cancelled.
|
|
75
|
+
*
|
|
76
|
+
* @example
|
|
77
|
+
* ```ts
|
|
78
|
+
* const postcard = await client.printMail.postcards.cancel(
|
|
79
|
+
* 'id',
|
|
80
|
+
* { note: 'Cancelling this postcard' },
|
|
81
|
+
* );
|
|
82
|
+
* ```
|
|
83
|
+
*/
|
|
84
|
+
cancel(id, body, options) {
|
|
85
|
+
return this._client.post((0, path_1.path) `/print-mail/v1/postcards/${id}/cancellation`, { body, ...options });
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* Progresses a postcard's `status` to the next stage. This is only available in
|
|
89
|
+
* test mode and can be used to simulate how a live order would progress through
|
|
90
|
+
* the different statuses.
|
|
91
|
+
*
|
|
92
|
+
* Note: this will fail with an `invalid_progression_error` if the status is one of
|
|
93
|
+
* `completed` or `cancelled`.
|
|
94
|
+
*
|
|
95
|
+
* @example
|
|
96
|
+
* ```ts
|
|
97
|
+
* const postcard = await client.printMail.postcards.progress(
|
|
98
|
+
* 'id',
|
|
99
|
+
* );
|
|
100
|
+
* ```
|
|
101
|
+
*/
|
|
102
|
+
progress(id, options) {
|
|
103
|
+
return this._client.post((0, path_1.path) `/print-mail/v1/postcards/${id}/progressions`, options);
|
|
104
|
+
}
|
|
72
105
|
/**
|
|
73
106
|
* Retrieve a postcard preview URL.
|
|
74
107
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"postcards.js","sourceRoot":"","sources":["../../src/resources/print-mail/postcards.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;
|
|
1
|
+
{"version":3,"file":"postcards.js","sourceRoot":"","sources":["../../src/resources/print-mail/postcards.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,yDAAqF;AAErF,uDAAiD;AAEjD,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,0BAA0B,EAAE,CAAA,sBAAmB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAU,EAAE,IAA0B,EAAE,OAAwB;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAU,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;CACF;AA3HD,8BA2HC"}
|
|
@@ -66,6 +66,39 @@ export class Postcards extends APIResource {
|
|
|
66
66
|
delete(id, options) {
|
|
67
67
|
return this._client.delete(path `/print-mail/v1/postcards/${id}`, options);
|
|
68
68
|
}
|
|
69
|
+
/**
|
|
70
|
+
* Cancel a postcard by ID with a note. Note that this operation cannot be undone
|
|
71
|
+
* and that only postcards with a status of `ready` can be cancelled.
|
|
72
|
+
*
|
|
73
|
+
* @example
|
|
74
|
+
* ```ts
|
|
75
|
+
* const postcard = await client.printMail.postcards.cancel(
|
|
76
|
+
* 'id',
|
|
77
|
+
* { note: 'Cancelling this postcard' },
|
|
78
|
+
* );
|
|
79
|
+
* ```
|
|
80
|
+
*/
|
|
81
|
+
cancel(id, body, options) {
|
|
82
|
+
return this._client.post(path `/print-mail/v1/postcards/${id}/cancellation`, { body, ...options });
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* Progresses a postcard's `status` to the next stage. This is only available in
|
|
86
|
+
* test mode and can be used to simulate how a live order would progress through
|
|
87
|
+
* the different statuses.
|
|
88
|
+
*
|
|
89
|
+
* Note: this will fail with an `invalid_progression_error` if the status is one of
|
|
90
|
+
* `completed` or `cancelled`.
|
|
91
|
+
*
|
|
92
|
+
* @example
|
|
93
|
+
* ```ts
|
|
94
|
+
* const postcard = await client.printMail.postcards.progress(
|
|
95
|
+
* 'id',
|
|
96
|
+
* );
|
|
97
|
+
* ```
|
|
98
|
+
*/
|
|
99
|
+
progress(id, options) {
|
|
100
|
+
return this._client.post(path `/print-mail/v1/postcards/${id}/progressions`, options);
|
|
101
|
+
}
|
|
69
102
|
/**
|
|
70
103
|
* Retrieve a postcard preview URL.
|
|
71
104
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"postcards.mjs","sourceRoot":"","sources":["../../src/resources/print-mail/postcards.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;
|
|
1
|
+
{"version":3,"file":"postcards.mjs","sourceRoot":"","sources":["../../src/resources/print-mail/postcards.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAe,SAAS,EAAwB;OAEhD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,4BAA4B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,0BAA0B,EAAE,CAAA,SAAmB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,4BAA4B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAU,EAAE,IAA0B,EAAE,OAAwB;QACrE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,4BAA4B,EAAE,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,4BAA4B,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAU,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,4BAA4B,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;CACF"}
|