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,14 +1,23 @@
|
|
|
1
1
|
import { APIResource } from "../../core/resource.mjs";
|
|
2
|
+
import * as ChequesAPI from "./cheques.mjs";
|
|
3
|
+
import * as LettersAPI from "./letters.mjs";
|
|
2
4
|
import { APIPromise } from "../../core/api-promise.mjs";
|
|
3
5
|
import { PagePromise, SkipLimit, type SkipLimitParams } from "../../core/pagination.mjs";
|
|
4
6
|
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
7
|
+
/**
|
|
8
|
+
* The campaigns API enables you to send out large volumes of fully
|
|
9
|
+
* personalized mail to a mailing list.
|
|
10
|
+
*/
|
|
5
11
|
export declare class Campaigns extends APIResource {
|
|
6
12
|
/**
|
|
7
13
|
* Create a new campaign.
|
|
8
14
|
*
|
|
9
|
-
* A campaign links a mailing list with a specific mail piece
|
|
10
|
-
* postcard, cheque,
|
|
11
|
-
*
|
|
15
|
+
* A campaign links a mailing list with a specific mail piece configuration
|
|
16
|
+
* (letter, postcard, cheque, self-mailer, or snap pack) to send bulk mail. Only
|
|
17
|
+
* one collateral type can be set per campaign.
|
|
18
|
+
*
|
|
19
|
+
* Upon creation, the campaign enters the `drafting` status while assets are
|
|
20
|
+
* validated.
|
|
12
21
|
*
|
|
13
22
|
* @example
|
|
14
23
|
* ```ts
|
|
@@ -124,9 +133,10 @@ export interface Campaign {
|
|
|
124
133
|
*/
|
|
125
134
|
updatedAt: string;
|
|
126
135
|
/**
|
|
127
|
-
*
|
|
136
|
+
* Inline cheque configuration for a campaign. All fields are optional since
|
|
137
|
+
* campaigns may be in a partial state during drafting.
|
|
128
138
|
*/
|
|
129
|
-
|
|
139
|
+
cheque?: Campaign.Cheque;
|
|
130
140
|
/**
|
|
131
141
|
* The ID of the default sender contact to use for orders if not specified per
|
|
132
142
|
* recipient.
|
|
@@ -143,9 +153,10 @@ export interface Campaign {
|
|
|
143
153
|
*/
|
|
144
154
|
errors?: Array<Campaign.Error>;
|
|
145
155
|
/**
|
|
146
|
-
*
|
|
156
|
+
* Inline letter configuration for a campaign. All fields are optional since
|
|
157
|
+
* campaigns may be in a partial state during drafting.
|
|
147
158
|
*/
|
|
148
|
-
|
|
159
|
+
letter?: Campaign.Letter;
|
|
149
160
|
/**
|
|
150
161
|
* See the section on Metadata.
|
|
151
162
|
*/
|
|
@@ -158,24 +169,113 @@ export interface Campaign {
|
|
|
158
169
|
*/
|
|
159
170
|
orderPreviewURL?: string;
|
|
160
171
|
/**
|
|
161
|
-
*
|
|
172
|
+
* Inline postcard configuration for a campaign. All fields are optional since
|
|
173
|
+
* campaigns may be in a partial state during drafting.
|
|
162
174
|
*/
|
|
163
|
-
|
|
175
|
+
postcard?: Campaign.Postcard;
|
|
164
176
|
/**
|
|
165
177
|
* A temporary URL to download the processing report, available once the campaign
|
|
166
178
|
* is in the `ready` status.
|
|
167
179
|
*/
|
|
168
180
|
reportURL?: string;
|
|
169
181
|
/**
|
|
170
|
-
*
|
|
182
|
+
* Inline self-mailer configuration for a campaign. All fields are optional since
|
|
183
|
+
* campaigns may be in a partial state during drafting.
|
|
171
184
|
*/
|
|
172
|
-
|
|
185
|
+
selfMailer?: Campaign.SelfMailer;
|
|
173
186
|
/**
|
|
174
187
|
* The scheduled date and time for the campaign to be sent.
|
|
175
188
|
*/
|
|
176
189
|
sendDate?: string;
|
|
190
|
+
/**
|
|
191
|
+
* Inline snap pack configuration for a campaign. All fields are optional since
|
|
192
|
+
* campaigns may be in a partial state during drafting.
|
|
193
|
+
*/
|
|
194
|
+
snapPack?: Campaign.SnapPack;
|
|
177
195
|
}
|
|
178
196
|
export declare namespace Campaign {
|
|
197
|
+
/**
|
|
198
|
+
* Inline cheque configuration for a campaign. All fields are optional since
|
|
199
|
+
* campaigns may be in a partial state during drafting.
|
|
200
|
+
*/
|
|
201
|
+
interface Cheque {
|
|
202
|
+
/**
|
|
203
|
+
* ID of the bank account to use for the cheque.
|
|
204
|
+
*/
|
|
205
|
+
bankAccount?: string;
|
|
206
|
+
/**
|
|
207
|
+
* Enum representing the supported currency codes.
|
|
208
|
+
*/
|
|
209
|
+
currencyCode?: 'CAD' | 'USD';
|
|
210
|
+
/**
|
|
211
|
+
* An optional description.
|
|
212
|
+
*/
|
|
213
|
+
description?: string;
|
|
214
|
+
/**
|
|
215
|
+
* The custom envelope ID or `"standard"`.
|
|
216
|
+
*/
|
|
217
|
+
envelope?: string;
|
|
218
|
+
/**
|
|
219
|
+
* Settings for the attached letter (e.g., color printing).
|
|
220
|
+
*/
|
|
221
|
+
letterSettings?: Cheque.LetterSettings;
|
|
222
|
+
/**
|
|
223
|
+
* ID of a template for an optional attached letter. Cannot be used with
|
|
224
|
+
* `letterPDF`.
|
|
225
|
+
*/
|
|
226
|
+
letterTemplate?: string;
|
|
227
|
+
/**
|
|
228
|
+
* A signed URL to the attached letter PDF, if any.
|
|
229
|
+
*/
|
|
230
|
+
letterUploadedPDF?: string;
|
|
231
|
+
/**
|
|
232
|
+
* A publicly accessible URL for the logo to print on the cheque.
|
|
233
|
+
*/
|
|
234
|
+
logo?: string;
|
|
235
|
+
/**
|
|
236
|
+
* Mailing class for the cheque.
|
|
237
|
+
*/
|
|
238
|
+
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';
|
|
239
|
+
/**
|
|
240
|
+
* Memo line text for the cheque.
|
|
241
|
+
*/
|
|
242
|
+
memo?: string;
|
|
243
|
+
/**
|
|
244
|
+
* Default merge variables for the cheque.
|
|
245
|
+
*/
|
|
246
|
+
mergeVariables?: {
|
|
247
|
+
[key: string]: unknown;
|
|
248
|
+
};
|
|
249
|
+
/**
|
|
250
|
+
* Message included on the cheque stub.
|
|
251
|
+
*/
|
|
252
|
+
message?: string;
|
|
253
|
+
/**
|
|
254
|
+
* Optional key-value metadata.
|
|
255
|
+
*/
|
|
256
|
+
metadata?: {
|
|
257
|
+
[key: string]: string;
|
|
258
|
+
};
|
|
259
|
+
/**
|
|
260
|
+
* ID of a return envelope to include.
|
|
261
|
+
*/
|
|
262
|
+
returnEnvelope?: string;
|
|
263
|
+
/**
|
|
264
|
+
* Enum representing the supported cheque sizes.
|
|
265
|
+
*/
|
|
266
|
+
size?: ChequesAPI.ChequeSize;
|
|
267
|
+
}
|
|
268
|
+
namespace Cheque {
|
|
269
|
+
/**
|
|
270
|
+
* Settings for the attached letter (e.g., color printing).
|
|
271
|
+
*/
|
|
272
|
+
interface LetterSettings {
|
|
273
|
+
/**
|
|
274
|
+
* Whether to print the attached letter in color.
|
|
275
|
+
*/
|
|
276
|
+
color?: boolean;
|
|
277
|
+
}
|
|
278
|
+
}
|
|
179
279
|
/**
|
|
180
280
|
* Details of a specific error encountered during campaign processing.
|
|
181
281
|
*/
|
|
@@ -189,6 +289,207 @@ export declare namespace Campaign {
|
|
|
189
289
|
*/
|
|
190
290
|
type: 'processing_error' | 'internal_error';
|
|
191
291
|
}
|
|
292
|
+
/**
|
|
293
|
+
* Inline letter configuration for a campaign. All fields are optional since
|
|
294
|
+
* campaigns may be in a partial state during drafting.
|
|
295
|
+
*/
|
|
296
|
+
interface Letter {
|
|
297
|
+
/**
|
|
298
|
+
* Enum representing the placement of the address on the letter.
|
|
299
|
+
*/
|
|
300
|
+
addressPlacement?: LettersAPI.AddressPlacement;
|
|
301
|
+
/**
|
|
302
|
+
* Model representing an attached PDF.
|
|
303
|
+
*/
|
|
304
|
+
attachedPDF?: LettersAPI.AttachedPdf;
|
|
305
|
+
/**
|
|
306
|
+
* Whether to print in color.
|
|
307
|
+
*/
|
|
308
|
+
color?: boolean;
|
|
309
|
+
/**
|
|
310
|
+
* An optional description.
|
|
311
|
+
*/
|
|
312
|
+
description?: string;
|
|
313
|
+
/**
|
|
314
|
+
* Whether to print on both sides of the paper.
|
|
315
|
+
*/
|
|
316
|
+
doubleSided?: boolean;
|
|
317
|
+
/**
|
|
318
|
+
* The custom envelope ID or `"standard"`.
|
|
319
|
+
*/
|
|
320
|
+
envelope?: string;
|
|
321
|
+
/**
|
|
322
|
+
* The type of envelope used for the letter.
|
|
323
|
+
*/
|
|
324
|
+
envelopeType?: 'standard_double_window' | 'flat';
|
|
325
|
+
/**
|
|
326
|
+
* Mailing class for the letter.
|
|
327
|
+
*/
|
|
328
|
+
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';
|
|
329
|
+
/**
|
|
330
|
+
* Default merge variables for the letter.
|
|
331
|
+
*/
|
|
332
|
+
mergeVariables?: {
|
|
333
|
+
[key: string]: unknown;
|
|
334
|
+
};
|
|
335
|
+
/**
|
|
336
|
+
* Optional key-value metadata.
|
|
337
|
+
*/
|
|
338
|
+
metadata?: {
|
|
339
|
+
[key: string]: string;
|
|
340
|
+
};
|
|
341
|
+
/**
|
|
342
|
+
* Which page number should be perforated (if any).
|
|
343
|
+
*/
|
|
344
|
+
perforatedPage?: 1;
|
|
345
|
+
/**
|
|
346
|
+
* ID of a return envelope to include.
|
|
347
|
+
*/
|
|
348
|
+
returnEnvelope?: string;
|
|
349
|
+
/**
|
|
350
|
+
* Enum representing the supported letter sizes.
|
|
351
|
+
*/
|
|
352
|
+
size?: LettersAPI.LetterSize;
|
|
353
|
+
/**
|
|
354
|
+
* ID of a template for the letter content. Cannot be used with `pdf`.
|
|
355
|
+
*/
|
|
356
|
+
template?: string;
|
|
357
|
+
/**
|
|
358
|
+
* A signed URL to the uploaded PDF, if any.
|
|
359
|
+
*/
|
|
360
|
+
uploadedPDF?: string;
|
|
361
|
+
}
|
|
362
|
+
/**
|
|
363
|
+
* Inline postcard configuration for a campaign. All fields are optional since
|
|
364
|
+
* campaigns may be in a partial state during drafting.
|
|
365
|
+
*/
|
|
366
|
+
interface Postcard {
|
|
367
|
+
/**
|
|
368
|
+
* ID of the template for the back side. Cannot be used with `pdf`.
|
|
369
|
+
*/
|
|
370
|
+
backTemplate?: string;
|
|
371
|
+
/**
|
|
372
|
+
* An optional description.
|
|
373
|
+
*/
|
|
374
|
+
description?: string;
|
|
375
|
+
/**
|
|
376
|
+
* ID of the template for the front side. Cannot be used with `pdf`.
|
|
377
|
+
*/
|
|
378
|
+
frontTemplate?: string;
|
|
379
|
+
/**
|
|
380
|
+
* Mailing class for the postcard.
|
|
381
|
+
*/
|
|
382
|
+
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';
|
|
383
|
+
/**
|
|
384
|
+
* Default merge variables for the postcard.
|
|
385
|
+
*/
|
|
386
|
+
mergeVariables?: {
|
|
387
|
+
[key: string]: unknown;
|
|
388
|
+
};
|
|
389
|
+
/**
|
|
390
|
+
* Optional key-value metadata.
|
|
391
|
+
*/
|
|
392
|
+
metadata?: {
|
|
393
|
+
[key: string]: string;
|
|
394
|
+
};
|
|
395
|
+
/**
|
|
396
|
+
* Premium paper identifier. Use "standard" for regular stock or a premium*paper*\*
|
|
397
|
+
* ID.
|
|
398
|
+
*/
|
|
399
|
+
paper?: string;
|
|
400
|
+
/**
|
|
401
|
+
* Enum representing the supported postcard sizes.
|
|
402
|
+
*/
|
|
403
|
+
size?: '6x4' | '9x6' | '11x6';
|
|
404
|
+
/**
|
|
405
|
+
* A signed URL to the uploaded PDF, if any.
|
|
406
|
+
*/
|
|
407
|
+
uploadedPDF?: string;
|
|
408
|
+
}
|
|
409
|
+
/**
|
|
410
|
+
* Inline self-mailer configuration for a campaign. All fields are optional since
|
|
411
|
+
* campaigns may be in a partial state during drafting.
|
|
412
|
+
*/
|
|
413
|
+
interface SelfMailer {
|
|
414
|
+
/**
|
|
415
|
+
* An optional description.
|
|
416
|
+
*/
|
|
417
|
+
description?: string;
|
|
418
|
+
/**
|
|
419
|
+
* ID of the template for the inside. Cannot be used with `pdf`.
|
|
420
|
+
*/
|
|
421
|
+
insideTemplate?: string;
|
|
422
|
+
/**
|
|
423
|
+
* Mailing class for the self-mailer.
|
|
424
|
+
*/
|
|
425
|
+
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';
|
|
426
|
+
/**
|
|
427
|
+
* Default merge variables for the self-mailer.
|
|
428
|
+
*/
|
|
429
|
+
mergeVariables?: {
|
|
430
|
+
[key: string]: unknown;
|
|
431
|
+
};
|
|
432
|
+
/**
|
|
433
|
+
* Optional key-value metadata.
|
|
434
|
+
*/
|
|
435
|
+
metadata?: {
|
|
436
|
+
[key: string]: string;
|
|
437
|
+
};
|
|
438
|
+
/**
|
|
439
|
+
* ID of the template for the outside. Cannot be used with `pdf`.
|
|
440
|
+
*/
|
|
441
|
+
outsideTemplate?: string;
|
|
442
|
+
/**
|
|
443
|
+
* Enum representing the supported self-mailer sizes.
|
|
444
|
+
*/
|
|
445
|
+
size?: '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold';
|
|
446
|
+
/**
|
|
447
|
+
* A signed URL to the uploaded PDF, if any.
|
|
448
|
+
*/
|
|
449
|
+
uploadedPDF?: string;
|
|
450
|
+
}
|
|
451
|
+
/**
|
|
452
|
+
* Inline snap pack configuration for a campaign. All fields are optional since
|
|
453
|
+
* campaigns may be in a partial state during drafting.
|
|
454
|
+
*/
|
|
455
|
+
interface SnapPack {
|
|
456
|
+
/**
|
|
457
|
+
* An optional description.
|
|
458
|
+
*/
|
|
459
|
+
description?: string;
|
|
460
|
+
/**
|
|
461
|
+
* ID of the template for the inside. Cannot be used with `pdf`.
|
|
462
|
+
*/
|
|
463
|
+
insideTemplate?: string;
|
|
464
|
+
/**
|
|
465
|
+
* Mailing class for the snap pack.
|
|
466
|
+
*/
|
|
467
|
+
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';
|
|
468
|
+
/**
|
|
469
|
+
* Default merge variables for the snap pack.
|
|
470
|
+
*/
|
|
471
|
+
mergeVariables?: {
|
|
472
|
+
[key: string]: unknown;
|
|
473
|
+
};
|
|
474
|
+
/**
|
|
475
|
+
* Optional key-value metadata.
|
|
476
|
+
*/
|
|
477
|
+
metadata?: {
|
|
478
|
+
[key: string]: string;
|
|
479
|
+
};
|
|
480
|
+
/**
|
|
481
|
+
* ID of the template for the outside. Cannot be used with `pdf`.
|
|
482
|
+
*/
|
|
483
|
+
outsideTemplate?: string;
|
|
484
|
+
/**
|
|
485
|
+
* Enum representing the supported snap pack sizes.
|
|
486
|
+
*/
|
|
487
|
+
size?: '8.5x11_bifold_v';
|
|
488
|
+
/**
|
|
489
|
+
* A signed URL to the uploaded PDF, if any.
|
|
490
|
+
*/
|
|
491
|
+
uploadedPDF?: string;
|
|
492
|
+
}
|
|
192
493
|
}
|
|
193
494
|
export interface CampaignDeleteResponse {
|
|
194
495
|
/**
|
|
@@ -203,9 +504,10 @@ export interface CampaignCreateParams {
|
|
|
203
504
|
*/
|
|
204
505
|
mailingList: string;
|
|
205
506
|
/**
|
|
206
|
-
* Body param:
|
|
507
|
+
* Body param: Inline cheque configuration for a campaign. All fields are optional
|
|
508
|
+
* since campaigns may be in a partial state during drafting.
|
|
207
509
|
*/
|
|
208
|
-
|
|
510
|
+
cheque?: CampaignCreateParams.Cheque;
|
|
209
511
|
/**
|
|
210
512
|
* Body param: The ID of the default sender contact to use for orders if not
|
|
211
513
|
* specified per recipient.
|
|
@@ -217,9 +519,10 @@ export interface CampaignCreateParams {
|
|
|
217
519
|
*/
|
|
218
520
|
description?: string;
|
|
219
521
|
/**
|
|
220
|
-
* Body param:
|
|
522
|
+
* Body param: Inline letter configuration for a campaign. All fields are optional
|
|
523
|
+
* since campaigns may be in a partial state during drafting.
|
|
221
524
|
*/
|
|
222
|
-
|
|
525
|
+
letter?: CampaignCreateParams.Letter;
|
|
223
526
|
/**
|
|
224
527
|
* Body param: See the section on Metadata.
|
|
225
528
|
*/
|
|
@@ -227,30 +530,323 @@ export interface CampaignCreateParams {
|
|
|
227
530
|
[key: string]: unknown;
|
|
228
531
|
};
|
|
229
532
|
/**
|
|
230
|
-
* Body param:
|
|
231
|
-
*
|
|
533
|
+
* Body param: Inline postcard configuration for a campaign. All fields are
|
|
534
|
+
* optional since campaigns may be in a partial state during drafting.
|
|
232
535
|
*/
|
|
233
|
-
|
|
536
|
+
postcard?: CampaignCreateParams.Postcard;
|
|
234
537
|
/**
|
|
235
|
-
* Body param:
|
|
236
|
-
*
|
|
538
|
+
* Body param: Inline self-mailer configuration for a campaign. All fields are
|
|
539
|
+
* optional since campaigns may be in a partial state during drafting.
|
|
237
540
|
*/
|
|
238
|
-
|
|
541
|
+
selfMailer?: CampaignCreateParams.SelfMailer;
|
|
239
542
|
/**
|
|
240
543
|
* Body param: The scheduled date and time for the campaign to be sent.
|
|
241
544
|
*/
|
|
242
545
|
sendDate?: string;
|
|
243
546
|
/**
|
|
244
|
-
*
|
|
547
|
+
* Body param: Inline snap pack configuration for a campaign. All fields are
|
|
548
|
+
* optional since campaigns may be in a partial state during drafting.
|
|
549
|
+
*/
|
|
550
|
+
snapPack?: CampaignCreateParams.SnapPack;
|
|
551
|
+
/**
|
|
552
|
+
* Header param
|
|
245
553
|
*/
|
|
246
554
|
'idempotency-key'?: string;
|
|
247
555
|
}
|
|
556
|
+
export declare namespace CampaignCreateParams {
|
|
557
|
+
/**
|
|
558
|
+
* Inline cheque configuration for a campaign. All fields are optional since
|
|
559
|
+
* campaigns may be in a partial state during drafting.
|
|
560
|
+
*/
|
|
561
|
+
interface Cheque {
|
|
562
|
+
/**
|
|
563
|
+
* ID of the bank account to use for the cheque.
|
|
564
|
+
*/
|
|
565
|
+
bankAccount?: string;
|
|
566
|
+
/**
|
|
567
|
+
* Enum representing the supported currency codes.
|
|
568
|
+
*/
|
|
569
|
+
currencyCode?: 'CAD' | 'USD';
|
|
570
|
+
/**
|
|
571
|
+
* An optional description.
|
|
572
|
+
*/
|
|
573
|
+
description?: string;
|
|
574
|
+
/**
|
|
575
|
+
* The custom envelope ID or `"standard"`.
|
|
576
|
+
*/
|
|
577
|
+
envelope?: string;
|
|
578
|
+
/**
|
|
579
|
+
* PDF file for an optional attached letter. Cannot be used with `letterTemplate`.
|
|
580
|
+
*/
|
|
581
|
+
letterPDF?: string;
|
|
582
|
+
/**
|
|
583
|
+
* Settings for the attached letter (e.g., color printing).
|
|
584
|
+
*/
|
|
585
|
+
letterSettings?: Cheque.LetterSettings;
|
|
586
|
+
/**
|
|
587
|
+
* ID of a template for an optional attached letter. Cannot be used with
|
|
588
|
+
* `letterPDF`.
|
|
589
|
+
*/
|
|
590
|
+
letterTemplate?: string;
|
|
591
|
+
/**
|
|
592
|
+
* A publicly accessible URL for the logo to print on the cheque.
|
|
593
|
+
*/
|
|
594
|
+
logo?: string;
|
|
595
|
+
/**
|
|
596
|
+
* Mailing class for the cheque.
|
|
597
|
+
*/
|
|
598
|
+
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';
|
|
599
|
+
/**
|
|
600
|
+
* Memo line text for the cheque.
|
|
601
|
+
*/
|
|
602
|
+
memo?: string;
|
|
603
|
+
/**
|
|
604
|
+
* Default merge variables for the cheque.
|
|
605
|
+
*/
|
|
606
|
+
mergeVariables?: {
|
|
607
|
+
[key: string]: unknown;
|
|
608
|
+
};
|
|
609
|
+
/**
|
|
610
|
+
* Message included on the cheque stub.
|
|
611
|
+
*/
|
|
612
|
+
message?: string;
|
|
613
|
+
/**
|
|
614
|
+
* Optional key-value metadata.
|
|
615
|
+
*/
|
|
616
|
+
metadata?: {
|
|
617
|
+
[key: string]: string;
|
|
618
|
+
};
|
|
619
|
+
/**
|
|
620
|
+
* ID of a return envelope to include.
|
|
621
|
+
*/
|
|
622
|
+
returnEnvelope?: string;
|
|
623
|
+
/**
|
|
624
|
+
* Enum representing the supported cheque sizes.
|
|
625
|
+
*/
|
|
626
|
+
size?: ChequesAPI.ChequeSize;
|
|
627
|
+
}
|
|
628
|
+
namespace Cheque {
|
|
629
|
+
/**
|
|
630
|
+
* Settings for the attached letter (e.g., color printing).
|
|
631
|
+
*/
|
|
632
|
+
interface LetterSettings {
|
|
633
|
+
/**
|
|
634
|
+
* Whether to print the attached letter in color.
|
|
635
|
+
*/
|
|
636
|
+
color?: boolean;
|
|
637
|
+
}
|
|
638
|
+
}
|
|
639
|
+
/**
|
|
640
|
+
* Inline letter configuration for a campaign. All fields are optional since
|
|
641
|
+
* campaigns may be in a partial state during drafting.
|
|
642
|
+
*/
|
|
643
|
+
interface Letter {
|
|
644
|
+
/**
|
|
645
|
+
* Enum representing the placement of the address on the letter.
|
|
646
|
+
*/
|
|
647
|
+
addressPlacement?: LettersAPI.AddressPlacement;
|
|
648
|
+
/**
|
|
649
|
+
* Model representing an attached PDF.
|
|
650
|
+
*/
|
|
651
|
+
attachedPDF?: LettersAPI.AttachedPdf;
|
|
652
|
+
/**
|
|
653
|
+
* Whether to print in color.
|
|
654
|
+
*/
|
|
655
|
+
color?: boolean;
|
|
656
|
+
/**
|
|
657
|
+
* An optional description.
|
|
658
|
+
*/
|
|
659
|
+
description?: string;
|
|
660
|
+
/**
|
|
661
|
+
* Whether to print on both sides of the paper.
|
|
662
|
+
*/
|
|
663
|
+
doubleSided?: boolean;
|
|
664
|
+
/**
|
|
665
|
+
* The custom envelope ID or `"standard"`.
|
|
666
|
+
*/
|
|
667
|
+
envelope?: string;
|
|
668
|
+
/**
|
|
669
|
+
* The type of envelope used for the letter.
|
|
670
|
+
*/
|
|
671
|
+
envelopeType?: 'standard_double_window' | 'flat';
|
|
672
|
+
/**
|
|
673
|
+
* Mailing class for the letter.
|
|
674
|
+
*/
|
|
675
|
+
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';
|
|
676
|
+
/**
|
|
677
|
+
* Default merge variables for the letter.
|
|
678
|
+
*/
|
|
679
|
+
mergeVariables?: {
|
|
680
|
+
[key: string]: unknown;
|
|
681
|
+
};
|
|
682
|
+
/**
|
|
683
|
+
* Optional key-value metadata.
|
|
684
|
+
*/
|
|
685
|
+
metadata?: {
|
|
686
|
+
[key: string]: string;
|
|
687
|
+
};
|
|
688
|
+
/**
|
|
689
|
+
* A PDF file or URL for the letter content. Cannot be used with `template`.
|
|
690
|
+
*/
|
|
691
|
+
pdf?: string;
|
|
692
|
+
/**
|
|
693
|
+
* Which page number should be perforated (if any).
|
|
694
|
+
*/
|
|
695
|
+
perforatedPage?: 1;
|
|
696
|
+
/**
|
|
697
|
+
* ID of a return envelope to include.
|
|
698
|
+
*/
|
|
699
|
+
returnEnvelope?: string;
|
|
700
|
+
/**
|
|
701
|
+
* Enum representing the supported letter sizes.
|
|
702
|
+
*/
|
|
703
|
+
size?: LettersAPI.LetterSize;
|
|
704
|
+
/**
|
|
705
|
+
* ID of a template for the letter content. Cannot be used with `pdf`.
|
|
706
|
+
*/
|
|
707
|
+
template?: string;
|
|
708
|
+
}
|
|
709
|
+
/**
|
|
710
|
+
* Inline postcard configuration for a campaign. All fields are optional since
|
|
711
|
+
* campaigns may be in a partial state during drafting.
|
|
712
|
+
*/
|
|
713
|
+
interface Postcard {
|
|
714
|
+
/**
|
|
715
|
+
* ID of the template for the back side. Cannot be used with `pdf`.
|
|
716
|
+
*/
|
|
717
|
+
backTemplate?: string;
|
|
718
|
+
/**
|
|
719
|
+
* An optional description.
|
|
720
|
+
*/
|
|
721
|
+
description?: string;
|
|
722
|
+
/**
|
|
723
|
+
* ID of the template for the front side. Cannot be used with `pdf`.
|
|
724
|
+
*/
|
|
725
|
+
frontTemplate?: string;
|
|
726
|
+
/**
|
|
727
|
+
* Mailing class for the postcard.
|
|
728
|
+
*/
|
|
729
|
+
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';
|
|
730
|
+
/**
|
|
731
|
+
* Default merge variables for the postcard.
|
|
732
|
+
*/
|
|
733
|
+
mergeVariables?: {
|
|
734
|
+
[key: string]: unknown;
|
|
735
|
+
};
|
|
736
|
+
/**
|
|
737
|
+
* Optional key-value metadata.
|
|
738
|
+
*/
|
|
739
|
+
metadata?: {
|
|
740
|
+
[key: string]: string;
|
|
741
|
+
};
|
|
742
|
+
/**
|
|
743
|
+
* Premium paper identifier. Use "standard" for regular stock or a premium*paper*\*
|
|
744
|
+
* ID.
|
|
745
|
+
*/
|
|
746
|
+
paper?: string;
|
|
747
|
+
/**
|
|
748
|
+
* A 2-page PDF file for the postcard content (front and back). Cannot be used with
|
|
749
|
+
* `frontTemplate`/`backTemplate`.
|
|
750
|
+
*/
|
|
751
|
+
pdf?: string;
|
|
752
|
+
/**
|
|
753
|
+
* Enum representing the supported postcard sizes.
|
|
754
|
+
*/
|
|
755
|
+
size?: '6x4' | '9x6' | '11x6';
|
|
756
|
+
}
|
|
757
|
+
/**
|
|
758
|
+
* Inline self-mailer configuration for a campaign. All fields are optional since
|
|
759
|
+
* campaigns may be in a partial state during drafting.
|
|
760
|
+
*/
|
|
761
|
+
interface SelfMailer {
|
|
762
|
+
/**
|
|
763
|
+
* An optional description.
|
|
764
|
+
*/
|
|
765
|
+
description?: string;
|
|
766
|
+
/**
|
|
767
|
+
* ID of the template for the inside. Cannot be used with `pdf`.
|
|
768
|
+
*/
|
|
769
|
+
insideTemplate?: string;
|
|
770
|
+
/**
|
|
771
|
+
* Mailing class for the self-mailer.
|
|
772
|
+
*/
|
|
773
|
+
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';
|
|
774
|
+
/**
|
|
775
|
+
* Default merge variables for the self-mailer.
|
|
776
|
+
*/
|
|
777
|
+
mergeVariables?: {
|
|
778
|
+
[key: string]: unknown;
|
|
779
|
+
};
|
|
780
|
+
/**
|
|
781
|
+
* Optional key-value metadata.
|
|
782
|
+
*/
|
|
783
|
+
metadata?: {
|
|
784
|
+
[key: string]: string;
|
|
785
|
+
};
|
|
786
|
+
/**
|
|
787
|
+
* ID of the template for the outside. Cannot be used with `pdf`.
|
|
788
|
+
*/
|
|
789
|
+
outsideTemplate?: string;
|
|
790
|
+
/**
|
|
791
|
+
* A 2-page PDF file for the self-mailer content. Cannot be used with
|
|
792
|
+
* `insideTemplate`/`outsideTemplate`.
|
|
793
|
+
*/
|
|
794
|
+
pdf?: string;
|
|
795
|
+
/**
|
|
796
|
+
* Enum representing the supported self-mailer sizes.
|
|
797
|
+
*/
|
|
798
|
+
size?: '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold';
|
|
799
|
+
}
|
|
800
|
+
/**
|
|
801
|
+
* Inline snap pack configuration for a campaign. All fields are optional since
|
|
802
|
+
* campaigns may be in a partial state during drafting.
|
|
803
|
+
*/
|
|
804
|
+
interface SnapPack {
|
|
805
|
+
/**
|
|
806
|
+
* An optional description.
|
|
807
|
+
*/
|
|
808
|
+
description?: string;
|
|
809
|
+
/**
|
|
810
|
+
* ID of the template for the inside. Cannot be used with `pdf`.
|
|
811
|
+
*/
|
|
812
|
+
insideTemplate?: string;
|
|
813
|
+
/**
|
|
814
|
+
* Mailing class for the snap pack.
|
|
815
|
+
*/
|
|
816
|
+
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';
|
|
817
|
+
/**
|
|
818
|
+
* Default merge variables for the snap pack.
|
|
819
|
+
*/
|
|
820
|
+
mergeVariables?: {
|
|
821
|
+
[key: string]: unknown;
|
|
822
|
+
};
|
|
823
|
+
/**
|
|
824
|
+
* Optional key-value metadata.
|
|
825
|
+
*/
|
|
826
|
+
metadata?: {
|
|
827
|
+
[key: string]: string;
|
|
828
|
+
};
|
|
829
|
+
/**
|
|
830
|
+
* ID of the template for the outside. Cannot be used with `pdf`.
|
|
831
|
+
*/
|
|
832
|
+
outsideTemplate?: string;
|
|
833
|
+
/**
|
|
834
|
+
* A 2-page PDF file for the snap pack content. Cannot be used with
|
|
835
|
+
* `insideTemplate`/`outsideTemplate`.
|
|
836
|
+
*/
|
|
837
|
+
pdf?: string;
|
|
838
|
+
/**
|
|
839
|
+
* Enum representing the supported snap pack sizes.
|
|
840
|
+
*/
|
|
841
|
+
size?: '8.5x11_bifold_v';
|
|
842
|
+
}
|
|
843
|
+
}
|
|
248
844
|
export interface CampaignUpdateParams {
|
|
249
845
|
/**
|
|
250
|
-
*
|
|
251
|
-
*
|
|
846
|
+
* Inline cheque configuration for a campaign. All fields are optional since
|
|
847
|
+
* campaigns may be in a partial state during drafting.
|
|
252
848
|
*/
|
|
253
|
-
|
|
849
|
+
cheque?: CampaignUpdateParams.Cheque | null;
|
|
254
850
|
/**
|
|
255
851
|
* The ID of the default sender contact. Set to `null` to remove.
|
|
256
852
|
*/
|
|
@@ -261,10 +857,10 @@ export interface CampaignUpdateParams {
|
|
|
261
857
|
*/
|
|
262
858
|
description?: string | null;
|
|
263
859
|
/**
|
|
264
|
-
*
|
|
265
|
-
*
|
|
860
|
+
* Inline letter configuration for a campaign. All fields are optional since
|
|
861
|
+
* campaigns may be in a partial state during drafting.
|
|
266
862
|
*/
|
|
267
|
-
|
|
863
|
+
letter?: CampaignUpdateParams.Letter | null;
|
|
268
864
|
/**
|
|
269
865
|
* The ID of the mailing list to associate with this campaign.
|
|
270
866
|
*/
|
|
@@ -277,15 +873,308 @@ export interface CampaignUpdateParams {
|
|
|
277
873
|
[key: string]: string;
|
|
278
874
|
} | null;
|
|
279
875
|
/**
|
|
280
|
-
*
|
|
281
|
-
*
|
|
876
|
+
* Inline postcard configuration for a campaign. All fields are optional since
|
|
877
|
+
* campaigns may be in a partial state during drafting.
|
|
878
|
+
*/
|
|
879
|
+
postcard?: CampaignUpdateParams.Postcard | null;
|
|
880
|
+
/**
|
|
881
|
+
* Inline self-mailer configuration for a campaign. All fields are optional since
|
|
882
|
+
* campaigns may be in a partial state during drafting.
|
|
883
|
+
*/
|
|
884
|
+
selfMailer?: CampaignUpdateParams.SelfMailer | null;
|
|
885
|
+
/**
|
|
886
|
+
* Inline snap pack configuration for a campaign. All fields are optional since
|
|
887
|
+
* campaigns may be in a partial state during drafting.
|
|
282
888
|
*/
|
|
283
|
-
|
|
889
|
+
snapPack?: CampaignUpdateParams.SnapPack | null;
|
|
890
|
+
}
|
|
891
|
+
export declare namespace CampaignUpdateParams {
|
|
284
892
|
/**
|
|
285
|
-
*
|
|
286
|
-
*
|
|
893
|
+
* Inline cheque configuration for a campaign. All fields are optional since
|
|
894
|
+
* campaigns may be in a partial state during drafting.
|
|
287
895
|
*/
|
|
288
|
-
|
|
896
|
+
interface Cheque {
|
|
897
|
+
/**
|
|
898
|
+
* ID of the bank account to use for the cheque.
|
|
899
|
+
*/
|
|
900
|
+
bankAccount?: string;
|
|
901
|
+
/**
|
|
902
|
+
* Enum representing the supported currency codes.
|
|
903
|
+
*/
|
|
904
|
+
currencyCode?: 'CAD' | 'USD';
|
|
905
|
+
/**
|
|
906
|
+
* An optional description.
|
|
907
|
+
*/
|
|
908
|
+
description?: string;
|
|
909
|
+
/**
|
|
910
|
+
* The custom envelope ID or `"standard"`.
|
|
911
|
+
*/
|
|
912
|
+
envelope?: string;
|
|
913
|
+
/**
|
|
914
|
+
* PDF file for an optional attached letter. Cannot be used with `letterTemplate`.
|
|
915
|
+
*/
|
|
916
|
+
letterPDF?: string;
|
|
917
|
+
/**
|
|
918
|
+
* Settings for the attached letter (e.g., color printing).
|
|
919
|
+
*/
|
|
920
|
+
letterSettings?: Cheque.LetterSettings;
|
|
921
|
+
/**
|
|
922
|
+
* ID of a template for an optional attached letter. Cannot be used with
|
|
923
|
+
* `letterPDF`.
|
|
924
|
+
*/
|
|
925
|
+
letterTemplate?: string;
|
|
926
|
+
/**
|
|
927
|
+
* A publicly accessible URL for the logo to print on the cheque.
|
|
928
|
+
*/
|
|
929
|
+
logo?: string;
|
|
930
|
+
/**
|
|
931
|
+
* Mailing class for the cheque.
|
|
932
|
+
*/
|
|
933
|
+
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';
|
|
934
|
+
/**
|
|
935
|
+
* Memo line text for the cheque.
|
|
936
|
+
*/
|
|
937
|
+
memo?: string;
|
|
938
|
+
/**
|
|
939
|
+
* Default merge variables for the cheque.
|
|
940
|
+
*/
|
|
941
|
+
mergeVariables?: {
|
|
942
|
+
[key: string]: unknown;
|
|
943
|
+
};
|
|
944
|
+
/**
|
|
945
|
+
* Message included on the cheque stub.
|
|
946
|
+
*/
|
|
947
|
+
message?: string;
|
|
948
|
+
/**
|
|
949
|
+
* Optional key-value metadata.
|
|
950
|
+
*/
|
|
951
|
+
metadata?: {
|
|
952
|
+
[key: string]: string;
|
|
953
|
+
};
|
|
954
|
+
/**
|
|
955
|
+
* ID of a return envelope to include.
|
|
956
|
+
*/
|
|
957
|
+
returnEnvelope?: string;
|
|
958
|
+
/**
|
|
959
|
+
* Enum representing the supported cheque sizes.
|
|
960
|
+
*/
|
|
961
|
+
size?: ChequesAPI.ChequeSize;
|
|
962
|
+
}
|
|
963
|
+
namespace Cheque {
|
|
964
|
+
/**
|
|
965
|
+
* Settings for the attached letter (e.g., color printing).
|
|
966
|
+
*/
|
|
967
|
+
interface LetterSettings {
|
|
968
|
+
/**
|
|
969
|
+
* Whether to print the attached letter in color.
|
|
970
|
+
*/
|
|
971
|
+
color?: boolean;
|
|
972
|
+
}
|
|
973
|
+
}
|
|
974
|
+
/**
|
|
975
|
+
* Inline letter configuration for a campaign. All fields are optional since
|
|
976
|
+
* campaigns may be in a partial state during drafting.
|
|
977
|
+
*/
|
|
978
|
+
interface Letter {
|
|
979
|
+
/**
|
|
980
|
+
* Enum representing the placement of the address on the letter.
|
|
981
|
+
*/
|
|
982
|
+
addressPlacement?: LettersAPI.AddressPlacement;
|
|
983
|
+
/**
|
|
984
|
+
* Model representing an attached PDF.
|
|
985
|
+
*/
|
|
986
|
+
attachedPDF?: LettersAPI.AttachedPdf;
|
|
987
|
+
/**
|
|
988
|
+
* Whether to print in color.
|
|
989
|
+
*/
|
|
990
|
+
color?: boolean;
|
|
991
|
+
/**
|
|
992
|
+
* An optional description.
|
|
993
|
+
*/
|
|
994
|
+
description?: string;
|
|
995
|
+
/**
|
|
996
|
+
* Whether to print on both sides of the paper.
|
|
997
|
+
*/
|
|
998
|
+
doubleSided?: boolean;
|
|
999
|
+
/**
|
|
1000
|
+
* The custom envelope ID or `"standard"`.
|
|
1001
|
+
*/
|
|
1002
|
+
envelope?: string;
|
|
1003
|
+
/**
|
|
1004
|
+
* The type of envelope used for the letter.
|
|
1005
|
+
*/
|
|
1006
|
+
envelopeType?: 'standard_double_window' | 'flat';
|
|
1007
|
+
/**
|
|
1008
|
+
* Mailing class for the letter.
|
|
1009
|
+
*/
|
|
1010
|
+
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';
|
|
1011
|
+
/**
|
|
1012
|
+
* Default merge variables for the letter.
|
|
1013
|
+
*/
|
|
1014
|
+
mergeVariables?: {
|
|
1015
|
+
[key: string]: unknown;
|
|
1016
|
+
};
|
|
1017
|
+
/**
|
|
1018
|
+
* Optional key-value metadata.
|
|
1019
|
+
*/
|
|
1020
|
+
metadata?: {
|
|
1021
|
+
[key: string]: string;
|
|
1022
|
+
};
|
|
1023
|
+
/**
|
|
1024
|
+
* A PDF file or URL for the letter content. Cannot be used with `template`.
|
|
1025
|
+
*/
|
|
1026
|
+
pdf?: string;
|
|
1027
|
+
/**
|
|
1028
|
+
* Which page number should be perforated (if any).
|
|
1029
|
+
*/
|
|
1030
|
+
perforatedPage?: 1;
|
|
1031
|
+
/**
|
|
1032
|
+
* ID of a return envelope to include.
|
|
1033
|
+
*/
|
|
1034
|
+
returnEnvelope?: string;
|
|
1035
|
+
/**
|
|
1036
|
+
* Enum representing the supported letter sizes.
|
|
1037
|
+
*/
|
|
1038
|
+
size?: LettersAPI.LetterSize;
|
|
1039
|
+
/**
|
|
1040
|
+
* ID of a template for the letter content. Cannot be used with `pdf`.
|
|
1041
|
+
*/
|
|
1042
|
+
template?: string;
|
|
1043
|
+
}
|
|
1044
|
+
/**
|
|
1045
|
+
* Inline postcard configuration for a campaign. All fields are optional since
|
|
1046
|
+
* campaigns may be in a partial state during drafting.
|
|
1047
|
+
*/
|
|
1048
|
+
interface Postcard {
|
|
1049
|
+
/**
|
|
1050
|
+
* ID of the template for the back side. Cannot be used with `pdf`.
|
|
1051
|
+
*/
|
|
1052
|
+
backTemplate?: string;
|
|
1053
|
+
/**
|
|
1054
|
+
* An optional description.
|
|
1055
|
+
*/
|
|
1056
|
+
description?: string;
|
|
1057
|
+
/**
|
|
1058
|
+
* ID of the template for the front side. Cannot be used with `pdf`.
|
|
1059
|
+
*/
|
|
1060
|
+
frontTemplate?: string;
|
|
1061
|
+
/**
|
|
1062
|
+
* Mailing class for the postcard.
|
|
1063
|
+
*/
|
|
1064
|
+
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';
|
|
1065
|
+
/**
|
|
1066
|
+
* Default merge variables for the postcard.
|
|
1067
|
+
*/
|
|
1068
|
+
mergeVariables?: {
|
|
1069
|
+
[key: string]: unknown;
|
|
1070
|
+
};
|
|
1071
|
+
/**
|
|
1072
|
+
* Optional key-value metadata.
|
|
1073
|
+
*/
|
|
1074
|
+
metadata?: {
|
|
1075
|
+
[key: string]: string;
|
|
1076
|
+
};
|
|
1077
|
+
/**
|
|
1078
|
+
* Premium paper identifier. Use "standard" for regular stock or a premium*paper*\*
|
|
1079
|
+
* ID.
|
|
1080
|
+
*/
|
|
1081
|
+
paper?: string;
|
|
1082
|
+
/**
|
|
1083
|
+
* A 2-page PDF file for the postcard content (front and back). Cannot be used with
|
|
1084
|
+
* `frontTemplate`/`backTemplate`.
|
|
1085
|
+
*/
|
|
1086
|
+
pdf?: string;
|
|
1087
|
+
/**
|
|
1088
|
+
* Enum representing the supported postcard sizes.
|
|
1089
|
+
*/
|
|
1090
|
+
size?: '6x4' | '9x6' | '11x6';
|
|
1091
|
+
}
|
|
1092
|
+
/**
|
|
1093
|
+
* Inline self-mailer configuration for a campaign. All fields are optional since
|
|
1094
|
+
* campaigns may be in a partial state during drafting.
|
|
1095
|
+
*/
|
|
1096
|
+
interface SelfMailer {
|
|
1097
|
+
/**
|
|
1098
|
+
* An optional description.
|
|
1099
|
+
*/
|
|
1100
|
+
description?: string;
|
|
1101
|
+
/**
|
|
1102
|
+
* ID of the template for the inside. Cannot be used with `pdf`.
|
|
1103
|
+
*/
|
|
1104
|
+
insideTemplate?: string;
|
|
1105
|
+
/**
|
|
1106
|
+
* Mailing class for the self-mailer.
|
|
1107
|
+
*/
|
|
1108
|
+
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';
|
|
1109
|
+
/**
|
|
1110
|
+
* Default merge variables for the self-mailer.
|
|
1111
|
+
*/
|
|
1112
|
+
mergeVariables?: {
|
|
1113
|
+
[key: string]: unknown;
|
|
1114
|
+
};
|
|
1115
|
+
/**
|
|
1116
|
+
* Optional key-value metadata.
|
|
1117
|
+
*/
|
|
1118
|
+
metadata?: {
|
|
1119
|
+
[key: string]: string;
|
|
1120
|
+
};
|
|
1121
|
+
/**
|
|
1122
|
+
* ID of the template for the outside. Cannot be used with `pdf`.
|
|
1123
|
+
*/
|
|
1124
|
+
outsideTemplate?: string;
|
|
1125
|
+
/**
|
|
1126
|
+
* A 2-page PDF file for the self-mailer content. Cannot be used with
|
|
1127
|
+
* `insideTemplate`/`outsideTemplate`.
|
|
1128
|
+
*/
|
|
1129
|
+
pdf?: string;
|
|
1130
|
+
/**
|
|
1131
|
+
* Enum representing the supported self-mailer sizes.
|
|
1132
|
+
*/
|
|
1133
|
+
size?: '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold';
|
|
1134
|
+
}
|
|
1135
|
+
/**
|
|
1136
|
+
* Inline snap pack configuration for a campaign. All fields are optional since
|
|
1137
|
+
* campaigns may be in a partial state during drafting.
|
|
1138
|
+
*/
|
|
1139
|
+
interface SnapPack {
|
|
1140
|
+
/**
|
|
1141
|
+
* An optional description.
|
|
1142
|
+
*/
|
|
1143
|
+
description?: string;
|
|
1144
|
+
/**
|
|
1145
|
+
* ID of the template for the inside. Cannot be used with `pdf`.
|
|
1146
|
+
*/
|
|
1147
|
+
insideTemplate?: string;
|
|
1148
|
+
/**
|
|
1149
|
+
* Mailing class for the snap pack.
|
|
1150
|
+
*/
|
|
1151
|
+
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';
|
|
1152
|
+
/**
|
|
1153
|
+
* Default merge variables for the snap pack.
|
|
1154
|
+
*/
|
|
1155
|
+
mergeVariables?: {
|
|
1156
|
+
[key: string]: unknown;
|
|
1157
|
+
};
|
|
1158
|
+
/**
|
|
1159
|
+
* Optional key-value metadata.
|
|
1160
|
+
*/
|
|
1161
|
+
metadata?: {
|
|
1162
|
+
[key: string]: string;
|
|
1163
|
+
};
|
|
1164
|
+
/**
|
|
1165
|
+
* ID of the template for the outside. Cannot be used with `pdf`.
|
|
1166
|
+
*/
|
|
1167
|
+
outsideTemplate?: string;
|
|
1168
|
+
/**
|
|
1169
|
+
* A 2-page PDF file for the snap pack content. Cannot be used with
|
|
1170
|
+
* `insideTemplate`/`outsideTemplate`.
|
|
1171
|
+
*/
|
|
1172
|
+
pdf?: string;
|
|
1173
|
+
/**
|
|
1174
|
+
* Enum representing the supported snap pack sizes.
|
|
1175
|
+
*/
|
|
1176
|
+
size?: '8.5x11_bifold_v';
|
|
1177
|
+
}
|
|
289
1178
|
}
|
|
290
1179
|
export interface CampaignListParams extends SkipLimitParams {
|
|
291
1180
|
/**
|