postgrid-node 0.1.0-alpha.5 → 0.3.0
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 +84 -0
- package/LICENSE +1 -1
- package/README.md +134 -103
- package/api-promise.d.mts +2 -0
- package/api-promise.d.mts.map +1 -0
- package/api-promise.d.ts +2 -0
- package/api-promise.d.ts.map +1 -0
- package/api-promise.js +6 -0
- package/api-promise.js.map +1 -0
- package/api-promise.mjs +2 -0
- package/api-promise.mjs.map +1 -0
- package/client.d.mts +191 -0
- package/client.d.mts.map +1 -0
- package/client.d.ts +191 -0
- package/client.d.ts.map +1 -0
- package/client.js +492 -0
- package/client.js.map +1 -0
- package/client.mjs +488 -0
- package/client.mjs.map +1 -0
- package/core/api-promise.d.mts +46 -0
- package/core/api-promise.d.mts.map +1 -0
- package/core/api-promise.d.ts +46 -0
- package/core/api-promise.d.ts.map +1 -0
- package/core/api-promise.js +74 -0
- package/core/api-promise.js.map +1 -0
- package/core/api-promise.mjs +70 -0
- package/core/api-promise.mjs.map +1 -0
- package/core/error.d.mts +46 -0
- package/core/error.d.mts.map +1 -0
- package/core/error.d.ts +46 -0
- package/core/error.d.ts.map +1 -0
- package/core/error.js +113 -0
- package/core/error.js.map +1 -0
- package/core/error.mjs +97 -0
- package/core/error.mjs.map +1 -0
- package/core/resource.d.mts +6 -0
- package/core/resource.d.mts.map +1 -0
- package/core/resource.d.ts +6 -0
- package/core/resource.d.ts.map +1 -0
- package/core/resource.js +11 -0
- package/core/resource.js.map +1 -0
- package/core/resource.mjs +7 -0
- package/core/resource.mjs.map +1 -0
- package/core/uploads.d.mts +3 -0
- package/core/uploads.d.mts.map +1 -0
- package/core/uploads.d.ts +3 -0
- package/core/uploads.d.ts.map +1 -0
- package/core/uploads.js +6 -0
- package/core/uploads.js.map +1 -0
- package/core/uploads.mjs +2 -0
- package/core/uploads.mjs.map +1 -0
- package/error.d.mts +2 -0
- package/error.d.mts.map +1 -0
- package/error.d.ts +1 -46
- package/error.d.ts.map +1 -1
- package/error.js +3 -110
- package/error.js.map +1 -1
- package/error.mjs +1 -96
- package/error.mjs.map +1 -1
- package/index.d.mts +6 -157
- package/index.d.mts.map +1 -0
- package/index.d.ts +5 -156
- package/index.d.ts.map +1 -1
- package/index.js +12 -166
- package/index.js.map +1 -1
- package/index.mjs +5 -139
- package/index.mjs.map +1 -1
- package/internal/builtin-types.d.mts +73 -0
- package/internal/builtin-types.d.mts.map +1 -0
- package/internal/builtin-types.d.ts +73 -0
- package/internal/builtin-types.d.ts.map +1 -0
- package/internal/builtin-types.js +4 -0
- package/internal/builtin-types.js.map +1 -0
- package/internal/builtin-types.mjs +3 -0
- package/internal/builtin-types.mjs.map +1 -0
- package/internal/detect-platform.d.mts +15 -0
- package/internal/detect-platform.d.mts.map +1 -0
- package/internal/detect-platform.d.ts +15 -0
- package/internal/detect-platform.d.ts.map +1 -0
- package/internal/detect-platform.js +162 -0
- package/internal/detect-platform.js.map +1 -0
- package/internal/detect-platform.mjs +157 -0
- package/internal/detect-platform.mjs.map +1 -0
- package/internal/errors.d.mts +3 -0
- package/internal/errors.d.mts.map +1 -0
- package/internal/errors.d.ts +3 -0
- package/internal/errors.d.ts.map +1 -0
- package/internal/errors.js +41 -0
- package/internal/errors.js.map +1 -0
- package/internal/errors.mjs +36 -0
- package/internal/errors.mjs.map +1 -0
- package/internal/headers.d.mts +20 -0
- package/internal/headers.d.mts.map +1 -0
- package/internal/headers.d.ts +20 -0
- package/internal/headers.d.ts.map +1 -0
- package/internal/headers.js +79 -0
- package/internal/headers.js.map +1 -0
- package/internal/headers.mjs +74 -0
- package/internal/headers.mjs.map +1 -0
- package/internal/parse.d.mts +12 -0
- package/internal/parse.d.mts.map +1 -0
- package/internal/parse.d.ts +12 -0
- package/internal/parse.d.ts.map +1 -0
- package/internal/parse.js +35 -0
- package/internal/parse.js.map +1 -0
- package/internal/parse.mjs +32 -0
- package/internal/parse.mjs.map +1 -0
- package/internal/qs/formats.d.mts +7 -0
- package/internal/qs/formats.d.mts.map +1 -0
- package/internal/qs/formats.d.ts +1 -0
- package/internal/qs/formats.d.ts.map +1 -1
- package/internal/qs/formats.js +4 -2
- package/internal/qs/formats.js.map +1 -1
- package/internal/qs/formats.mjs +2 -1
- package/internal/qs/formats.mjs.map +1 -1
- package/internal/qs/index.d.mts +10 -0
- package/internal/qs/index.d.mts.map +1 -0
- package/internal/qs/index.d.ts.map +1 -1
- package/internal/qs/stringify.d.mts +3 -0
- package/internal/qs/stringify.d.mts.map +1 -0
- package/internal/qs/stringify.d.ts.map +1 -1
- package/internal/qs/stringify.js +16 -19
- package/internal/qs/stringify.js.map +1 -1
- package/internal/qs/stringify.mjs +17 -19
- package/internal/qs/stringify.mjs.map +1 -1
- package/internal/qs/types.d.mts +57 -0
- package/internal/qs/types.d.mts.map +1 -0
- package/internal/qs/utils.d.mts +15 -0
- package/internal/qs/utils.d.mts.map +1 -0
- package/internal/qs/utils.d.ts +1 -0
- package/internal/qs/utils.d.ts.map +1 -1
- package/internal/qs/utils.js +22 -21
- package/internal/qs/utils.js.map +1 -1
- package/internal/qs/utils.mjs +12 -12
- package/internal/qs/utils.mjs.map +1 -1
- package/internal/request-options.d.mts +75 -0
- package/internal/request-options.d.mts.map +1 -0
- package/internal/request-options.d.ts +75 -0
- package/internal/request-options.d.ts.map +1 -0
- package/internal/request-options.js +14 -0
- package/internal/request-options.js.map +1 -0
- package/internal/request-options.mjs +10 -0
- package/internal/request-options.mjs.map +1 -0
- package/internal/shim-types.d.mts +17 -0
- package/internal/shim-types.d.mts.map +1 -0
- package/internal/shim-types.d.ts +17 -0
- package/internal/shim-types.d.ts.map +1 -0
- package/internal/shim-types.js +4 -0
- package/internal/shim-types.js.map +1 -0
- package/internal/shim-types.mjs +3 -0
- package/internal/shim-types.mjs.map +1 -0
- package/internal/shims.d.mts +20 -0
- package/internal/shims.d.mts.map +1 -0
- package/internal/shims.d.ts +20 -0
- package/internal/shims.d.ts.map +1 -0
- package/internal/shims.js +92 -0
- package/internal/shims.js.map +1 -0
- package/internal/shims.mjs +85 -0
- package/internal/shims.mjs.map +1 -0
- package/internal/to-file.d.mts +45 -0
- package/internal/to-file.d.mts.map +1 -0
- package/internal/to-file.d.ts +45 -0
- package/internal/to-file.d.ts.map +1 -0
- package/internal/to-file.js +91 -0
- package/internal/to-file.js.map +1 -0
- package/internal/to-file.mjs +88 -0
- package/internal/to-file.mjs.map +1 -0
- package/internal/tslib.js +81 -0
- package/internal/tslib.mjs +17 -0
- package/internal/types.d.mts +69 -0
- package/internal/types.d.mts.map +1 -0
- package/internal/types.d.ts +69 -0
- package/internal/types.d.ts.map +1 -0
- package/internal/types.js +4 -0
- package/internal/types.js.map +1 -0
- package/internal/types.mjs +3 -0
- package/internal/types.mjs.map +1 -0
- package/internal/uploads.d.mts +42 -0
- package/internal/uploads.d.mts.map +1 -0
- package/internal/uploads.d.ts +42 -0
- package/internal/uploads.d.ts.map +1 -0
- package/internal/uploads.js +141 -0
- package/internal/uploads.js.map +1 -0
- package/internal/uploads.mjs +131 -0
- package/internal/uploads.mjs.map +1 -0
- package/internal/utils/base64.d.mts +3 -0
- package/internal/utils/base64.d.mts.map +1 -0
- package/internal/utils/base64.d.ts +3 -0
- package/internal/utils/base64.d.ts.map +1 -0
- package/internal/utils/base64.js +38 -0
- package/internal/utils/base64.js.map +1 -0
- package/internal/utils/base64.mjs +33 -0
- package/internal/utils/base64.mjs.map +1 -0
- package/internal/utils/bytes.d.mts +4 -0
- package/internal/utils/bytes.d.mts.map +1 -0
- package/internal/utils/bytes.d.ts +4 -0
- package/internal/utils/bytes.d.ts.map +1 -0
- package/internal/utils/bytes.js +31 -0
- package/internal/utils/bytes.js.map +1 -0
- package/internal/utils/bytes.mjs +26 -0
- package/internal/utils/bytes.mjs.map +1 -0
- package/internal/utils/env.d.mts +9 -0
- package/internal/utils/env.d.mts.map +1 -0
- package/internal/utils/env.d.ts +9 -0
- package/internal/utils/env.d.ts.map +1 -0
- package/internal/utils/env.js +22 -0
- package/internal/utils/env.js.map +1 -0
- package/internal/utils/env.mjs +18 -0
- package/internal/utils/env.mjs.map +1 -0
- package/internal/utils/log.d.mts +37 -0
- package/internal/utils/log.d.mts.map +1 -0
- package/internal/utils/log.d.ts +37 -0
- package/internal/utils/log.d.ts.map +1 -0
- package/internal/utils/log.js +86 -0
- package/internal/utils/log.js.map +1 -0
- package/internal/utils/log.mjs +80 -0
- package/internal/utils/log.mjs.map +1 -0
- package/internal/utils/path.d.mts +15 -0
- package/internal/utils/path.d.mts.map +1 -0
- package/internal/utils/path.d.ts +15 -0
- package/internal/utils/path.d.ts.map +1 -0
- package/internal/utils/path.js +79 -0
- package/internal/utils/path.js.map +1 -0
- package/internal/utils/path.mjs +74 -0
- package/internal/utils/path.mjs.map +1 -0
- package/internal/utils/sleep.d.mts +2 -0
- package/internal/utils/sleep.d.mts.map +1 -0
- package/internal/utils/sleep.d.ts +2 -0
- package/internal/utils/sleep.d.ts.map +1 -0
- package/internal/utils/sleep.js +7 -0
- package/internal/utils/sleep.js.map +1 -0
- package/internal/utils/sleep.mjs +3 -0
- package/internal/utils/sleep.mjs.map +1 -0
- package/internal/utils/uuid.d.mts +5 -0
- package/internal/utils/uuid.d.mts.map +1 -0
- package/internal/utils/uuid.d.ts +5 -0
- package/internal/utils/uuid.d.ts.map +1 -0
- package/internal/utils/uuid.js +19 -0
- package/internal/utils/uuid.js.map +1 -0
- package/internal/utils/uuid.mjs +15 -0
- package/internal/utils/uuid.mjs.map +1 -0
- package/internal/utils/values.d.mts +18 -0
- package/internal/utils/values.d.mts.map +1 -0
- package/internal/utils/values.d.ts +18 -0
- package/internal/utils/values.d.ts.map +1 -0
- package/internal/utils/values.js +112 -0
- package/internal/utils/values.js.map +1 -0
- package/internal/utils/values.mjs +94 -0
- package/internal/utils/values.mjs.map +1 -0
- package/internal/utils.d.mts +7 -0
- package/internal/utils.d.mts.map +1 -0
- package/internal/utils.d.ts +7 -0
- package/internal/utils.d.ts.map +1 -0
- package/internal/utils.js +11 -0
- package/internal/utils.js.map +1 -0
- package/internal/utils.mjs +8 -0
- package/internal/utils.mjs.map +1 -0
- package/package.json +110 -75
- package/resource.d.mts +2 -0
- package/resource.d.mts.map +1 -0
- package/resource.d.ts +1 -5
- package/resource.d.ts.map +1 -1
- package/resource.js +3 -8
- package/resource.js.map +1 -1
- package/resource.mjs +1 -6
- package/resource.mjs.map +1 -1
- package/resources/address-verification.d.mts +425 -0
- package/resources/address-verification.d.mts.map +1 -0
- package/resources/address-verification.d.ts +425 -0
- package/resources/address-verification.d.ts.map +1 -0
- package/resources/address-verification.js +36 -0
- package/resources/address-verification.js.map +1 -0
- package/resources/address-verification.mjs +32 -0
- package/resources/address-verification.mjs.map +1 -0
- package/resources/index.d.mts +4 -0
- package/resources/index.d.mts.map +1 -0
- package/resources/index.d.ts +3 -15
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +7 -57
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +3 -15
- package/resources/index.mjs.map +1 -1
- package/resources/intl-address-verification.d.mts +406 -0
- package/resources/intl-address-verification.d.mts.map +1 -0
- package/resources/intl-address-verification.d.ts +406 -0
- package/resources/intl-address-verification.d.ts.map +1 -0
- package/resources/intl-address-verification.js +59 -0
- package/resources/intl-address-verification.js.map +1 -0
- package/resources/intl-address-verification.mjs +55 -0
- package/resources/intl-address-verification.mjs.map +1 -0
- package/resources/print-mail/bank-accounts.d.mts +345 -0
- package/resources/print-mail/bank-accounts.d.mts.map +1 -0
- package/resources/print-mail/bank-accounts.d.ts +345 -0
- package/resources/print-mail/bank-accounts.d.ts.map +1 -0
- package/resources/print-mail/bank-accounts.js +72 -0
- package/resources/print-mail/bank-accounts.js.map +1 -0
- package/resources/print-mail/bank-accounts.mjs +68 -0
- package/resources/print-mail/bank-accounts.mjs.map +1 -0
- package/resources/print-mail/boxes.d.mts +873 -0
- package/resources/print-mail/boxes.d.mts.map +1 -0
- package/resources/print-mail/boxes.d.ts +873 -0
- package/resources/print-mail/boxes.d.ts.map +1 -0
- package/resources/print-mail/boxes.js +81 -0
- package/resources/print-mail/boxes.js.map +1 -0
- package/resources/print-mail/boxes.mjs +77 -0
- package/resources/print-mail/boxes.mjs.map +1 -0
- package/resources/print-mail/campaigns.d.mts +317 -0
- package/resources/print-mail/campaigns.d.mts.map +1 -0
- package/resources/print-mail/campaigns.d.ts +317 -0
- package/resources/print-mail/campaigns.d.ts.map +1 -0
- package/resources/print-mail/campaigns.js +114 -0
- package/resources/print-mail/campaigns.js.map +1 -0
- package/resources/print-mail/campaigns.mjs +110 -0
- package/resources/print-mail/campaigns.mjs.map +1 -0
- package/resources/print-mail/cheques.d.mts +817 -0
- package/resources/print-mail/cheques.d.mts.map +1 -0
- package/resources/print-mail/cheques.d.ts +817 -0
- package/resources/print-mail/cheques.d.ts.map +1 -0
- package/resources/print-mail/cheques.js +121 -0
- package/resources/print-mail/cheques.js.map +1 -0
- package/resources/print-mail/cheques.mjs +117 -0
- package/resources/print-mail/cheques.mjs.map +1 -0
- package/resources/print-mail/contacts.d.mts +475 -0
- package/resources/print-mail/contacts.d.mts.map +1 -0
- package/resources/print-mail/contacts.d.ts +475 -0
- package/resources/print-mail/contacts.d.ts.map +1 -0
- package/resources/print-mail/contacts.js +76 -0
- package/resources/print-mail/contacts.js.map +1 -0
- package/resources/print-mail/contacts.mjs +72 -0
- package/resources/print-mail/contacts.mjs.map +1 -0
- package/resources/print-mail/index.d.mts +16 -0
- package/resources/print-mail/index.d.mts.map +1 -0
- package/resources/print-mail/index.d.ts +16 -0
- package/resources/print-mail/index.d.ts.map +1 -0
- package/resources/print-mail/index.js +35 -0
- package/resources/print-mail/index.js.map +1 -0
- package/resources/print-mail/index.mjs +17 -0
- package/resources/print-mail/index.mjs.map +1 -0
- package/resources/print-mail/letters.d.mts +1079 -0
- package/resources/print-mail/letters.d.mts.map +1 -0
- package/resources/print-mail/letters.d.ts +1079 -0
- package/resources/print-mail/letters.d.ts.map +1 -0
- package/resources/print-mail/letters.js +83 -0
- package/resources/print-mail/letters.js.map +1 -0
- package/resources/print-mail/letters.mjs +79 -0
- package/resources/print-mail/letters.mjs.map +1 -0
- package/resources/print-mail/mailing-list-imports.d.mts +354 -0
- package/resources/print-mail/mailing-list-imports.d.mts.map +1 -0
- package/resources/print-mail/mailing-list-imports.d.ts +354 -0
- package/resources/print-mail/mailing-list-imports.d.ts.map +1 -0
- package/resources/print-mail/mailing-list-imports.js +105 -0
- package/resources/print-mail/mailing-list-imports.js.map +1 -0
- package/resources/print-mail/mailing-list-imports.mjs +101 -0
- package/resources/print-mail/mailing-list-imports.mjs.map +1 -0
- package/resources/print-mail/mailing-lists.d.mts +247 -0
- package/resources/print-mail/mailing-lists.d.mts.map +1 -0
- package/resources/print-mail/mailing-lists.d.ts +247 -0
- package/resources/print-mail/mailing-lists.d.ts.map +1 -0
- package/resources/print-mail/mailing-lists.js +117 -0
- package/resources/print-mail/mailing-lists.js.map +1 -0
- package/resources/print-mail/mailing-lists.mjs +113 -0
- package/resources/print-mail/mailing-lists.mjs.map +1 -0
- package/resources/print-mail/order-profiles/cheques.d.mts +398 -0
- package/resources/print-mail/order-profiles/cheques.d.mts.map +1 -0
- package/resources/print-mail/order-profiles/cheques.d.ts +398 -0
- package/resources/print-mail/order-profiles/cheques.d.ts.map +1 -0
- package/resources/print-mail/order-profiles/cheques.js +92 -0
- package/resources/print-mail/order-profiles/cheques.js.map +1 -0
- package/resources/print-mail/order-profiles/cheques.mjs +88 -0
- package/resources/print-mail/order-profiles/cheques.mjs.map +1 -0
- package/resources/print-mail/order-profiles/index.d.mts +6 -0
- package/resources/print-mail/order-profiles/index.d.mts.map +1 -0
- package/resources/print-mail/order-profiles/index.d.ts +6 -0
- package/resources/print-mail/order-profiles/index.d.ts.map +1 -0
- package/resources/print-mail/order-profiles/index.js +15 -0
- package/resources/print-mail/order-profiles/index.js.map +1 -0
- package/resources/print-mail/order-profiles/index.mjs +7 -0
- package/resources/print-mail/order-profiles/index.mjs.map +1 -0
- package/resources/print-mail/order-profiles/letters.d.mts +333 -0
- package/resources/print-mail/order-profiles/letters.d.mts.map +1 -0
- package/resources/print-mail/order-profiles/letters.d.ts +333 -0
- package/resources/print-mail/order-profiles/letters.d.ts.map +1 -0
- package/resources/print-mail/order-profiles/letters.js +99 -0
- package/resources/print-mail/order-profiles/letters.js.map +1 -0
- package/resources/print-mail/order-profiles/letters.mjs +95 -0
- package/resources/print-mail/order-profiles/letters.mjs.map +1 -0
- package/resources/print-mail/order-profiles/order-profiles.d.mts +22 -0
- package/resources/print-mail/order-profiles/order-profiles.d.mts.map +1 -0
- package/resources/print-mail/order-profiles/order-profiles.d.ts +22 -0
- package/resources/print-mail/order-profiles/order-profiles.d.ts.map +1 -0
- package/resources/print-mail/order-profiles/order-profiles.js +29 -0
- package/resources/print-mail/order-profiles/order-profiles.js.map +1 -0
- package/resources/print-mail/order-profiles/order-profiles.mjs +24 -0
- package/resources/print-mail/order-profiles/order-profiles.mjs.map +1 -0
- package/resources/print-mail/order-profiles/postcards.d.mts +263 -0
- package/resources/print-mail/order-profiles/postcards.d.mts.map +1 -0
- package/resources/print-mail/order-profiles/postcards.d.ts +263 -0
- package/resources/print-mail/order-profiles/postcards.d.ts.map +1 -0
- package/resources/print-mail/order-profiles/postcards.js +91 -0
- package/resources/print-mail/order-profiles/postcards.js.map +1 -0
- package/resources/print-mail/order-profiles/postcards.mjs +87 -0
- package/resources/print-mail/order-profiles/postcards.mjs.map +1 -0
- package/resources/print-mail/order-profiles/self-mailers.d.mts +268 -0
- package/resources/print-mail/order-profiles/self-mailers.d.mts.map +1 -0
- package/resources/print-mail/order-profiles/self-mailers.d.ts +268 -0
- package/resources/print-mail/order-profiles/self-mailers.d.ts.map +1 -0
- package/resources/print-mail/order-profiles/self-mailers.js +92 -0
- package/resources/print-mail/order-profiles/self-mailers.js.map +1 -0
- package/resources/print-mail/order-profiles/self-mailers.mjs +88 -0
- package/resources/print-mail/order-profiles/self-mailers.mjs.map +1 -0
- package/resources/print-mail/order-profiles.d.mts +2 -0
- package/resources/print-mail/order-profiles.d.mts.map +1 -0
- package/resources/print-mail/order-profiles.d.ts.map +1 -0
- package/resources/print-mail/order-profiles.js +6 -0
- package/resources/print-mail/order-profiles.js.map +1 -0
- package/resources/print-mail/order-profiles.mjs.map +1 -0
- package/resources/print-mail/postcards.d.mts +1220 -0
- package/resources/print-mail/postcards.d.mts.map +1 -0
- package/resources/print-mail/postcards.d.ts +1220 -0
- package/resources/print-mail/postcards.d.ts.map +1 -0
- package/resources/print-mail/postcards.js +87 -0
- package/resources/print-mail/postcards.js.map +1 -0
- package/resources/print-mail/postcards.mjs +83 -0
- package/resources/print-mail/postcards.mjs.map +1 -0
- package/resources/print-mail/print-mail.d.mts +62 -0
- package/resources/print-mail/print-mail.d.mts.map +1 -0
- package/resources/print-mail/print-mail.d.ts +62 -0
- package/resources/print-mail/print-mail.d.ts.map +1 -0
- package/resources/print-mail/print-mail.js +69 -0
- package/resources/print-mail/print-mail.js.map +1 -0
- package/resources/print-mail/print-mail.mjs +64 -0
- package/resources/print-mail/print-mail.mjs.map +1 -0
- package/resources/print-mail/reports/exports.d.mts +165 -0
- package/resources/print-mail/reports/exports.d.mts.map +1 -0
- package/resources/print-mail/reports/exports.d.ts +165 -0
- package/resources/print-mail/reports/exports.d.ts.map +1 -0
- package/resources/print-mail/reports/exports.js +66 -0
- package/resources/print-mail/reports/exports.js.map +1 -0
- package/resources/print-mail/reports/exports.mjs +62 -0
- package/resources/print-mail/reports/exports.mjs.map +1 -0
- package/resources/print-mail/reports/index.d.mts +4 -0
- package/resources/print-mail/reports/index.d.mts.map +1 -0
- package/resources/print-mail/reports/index.d.ts +4 -0
- package/resources/print-mail/reports/index.d.ts.map +1 -0
- package/resources/print-mail/reports/index.js +11 -0
- package/resources/print-mail/reports/index.js.map +1 -0
- package/resources/print-mail/reports/index.mjs +5 -0
- package/resources/print-mail/reports/index.mjs.map +1 -0
- package/resources/print-mail/reports/reports.d.mts +214 -0
- package/resources/print-mail/reports/reports.d.mts.map +1 -0
- package/resources/print-mail/reports/reports.d.ts +214 -0
- package/resources/print-mail/reports/reports.d.ts.map +1 -0
- package/resources/print-mail/reports/reports.js +110 -0
- package/resources/print-mail/reports/reports.js.map +1 -0
- package/resources/print-mail/reports/reports.mjs +105 -0
- package/resources/print-mail/reports/reports.mjs.map +1 -0
- package/resources/print-mail/reports/samples.d.mts +69 -0
- package/resources/print-mail/reports/samples.d.mts.map +1 -0
- package/resources/print-mail/reports/samples.d.ts +69 -0
- package/resources/print-mail/reports/samples.d.ts.map +1 -0
- package/resources/print-mail/reports/samples.js +28 -0
- package/resources/print-mail/reports/samples.js.map +1 -0
- package/resources/print-mail/reports/samples.mjs +24 -0
- package/resources/print-mail/reports/samples.mjs.map +1 -0
- package/resources/print-mail/reports.d.mts +2 -0
- package/resources/print-mail/reports.d.mts.map +1 -0
- package/resources/print-mail/reports.d.ts.map +1 -0
- package/resources/print-mail/reports.js +6 -0
- package/resources/print-mail/reports.js.map +1 -0
- package/resources/print-mail/reports.mjs.map +1 -0
- package/resources/print-mail/self-mailers.d.mts +1218 -0
- package/resources/print-mail/self-mailers.d.mts.map +1 -0
- package/resources/print-mail/self-mailers.d.ts +1218 -0
- package/resources/print-mail/self-mailers.d.ts.map +1 -0
- package/resources/print-mail/self-mailers.js +87 -0
- package/resources/print-mail/self-mailers.js.map +1 -0
- package/resources/print-mail/self-mailers.mjs +83 -0
- package/resources/print-mail/self-mailers.mjs.map +1 -0
- package/resources/print-mail/sub-organizations.d.mts +304 -0
- package/resources/print-mail/sub-organizations.d.mts.map +1 -0
- package/resources/print-mail/sub-organizations.d.ts +304 -0
- package/resources/print-mail/sub-organizations.d.ts.map +1 -0
- package/resources/print-mail/sub-organizations.js +69 -0
- package/resources/print-mail/sub-organizations.js.map +1 -0
- package/resources/print-mail/sub-organizations.mjs +65 -0
- package/resources/print-mail/sub-organizations.mjs.map +1 -0
- package/resources/print-mail/templates.d.mts +169 -0
- package/resources/print-mail/templates.d.mts.map +1 -0
- package/resources/print-mail/templates.d.ts +169 -0
- package/resources/print-mail/templates.d.ts.map +1 -0
- package/resources/print-mail/templates.js +79 -0
- package/resources/print-mail/templates.js.map +1 -0
- package/resources/print-mail/templates.mjs +75 -0
- package/resources/print-mail/templates.mjs.map +1 -0
- package/resources/print-mail.d.mts +2 -0
- package/resources/print-mail.d.mts.map +1 -0
- package/resources/print-mail.d.ts +2 -0
- package/resources/print-mail.d.ts.map +1 -0
- package/resources/print-mail.js +6 -0
- package/resources/print-mail.js.map +1 -0
- package/resources/print-mail.mjs +3 -0
- package/resources/print-mail.mjs.map +1 -0
- package/resources.d.mts +2 -0
- package/resources.d.mts.map +1 -0
- package/resources.d.ts.map +1 -1
- package/resources.js +2 -15
- package/resources.js.map +1 -1
- package/src/api-promise.ts +2 -0
- package/src/client.ts +793 -0
- package/src/core/README.md +3 -0
- package/src/core/api-promise.ts +92 -0
- package/src/core/error.ts +130 -0
- package/src/core/resource.ts +11 -0
- package/src/core/uploads.ts +2 -0
- package/src/error.ts +2 -130
- package/src/index.ts +5 -520
- package/src/internal/README.md +3 -0
- package/src/internal/builtin-types.ts +93 -0
- package/src/internal/detect-platform.ts +196 -0
- package/src/internal/errors.ts +33 -0
- package/src/internal/headers.ts +97 -0
- package/src/internal/parse.ts +50 -0
- package/src/internal/qs/formats.ts +2 -1
- package/src/internal/qs/stringify.ts +17 -20
- package/src/internal/qs/utils.ts +14 -14
- package/src/internal/request-options.ts +91 -0
- package/src/internal/shim-types.ts +26 -0
- package/src/internal/shims.ts +107 -0
- package/src/internal/to-file.ts +154 -0
- package/src/internal/types.ts +95 -0
- package/src/internal/uploads.ts +187 -0
- package/src/internal/utils/base64.ts +40 -0
- package/src/internal/utils/bytes.ts +32 -0
- package/src/internal/utils/env.ts +18 -0
- package/src/internal/utils/log.ts +127 -0
- package/src/internal/utils/path.ts +88 -0
- package/src/internal/utils/sleep.ts +3 -0
- package/src/internal/utils/uuid.ts +17 -0
- package/src/internal/utils/values.ts +105 -0
- package/src/internal/utils.ts +8 -0
- package/src/resource.ts +2 -11
- package/src/resources/address-verification.ts +542 -0
- package/src/resources/index.ts +12 -142
- package/src/resources/intl-address-verification.ts +505 -0
- package/src/resources/print-mail/bank-accounts.ts +432 -0
- package/src/resources/print-mail/boxes.ts +1079 -0
- package/src/resources/print-mail/campaigns.ts +408 -0
- package/src/resources/print-mail/cheques.ts +995 -0
- package/src/resources/print-mail/contacts.ts +594 -0
- package/src/resources/print-mail/index.ts +134 -0
- package/src/resources/print-mail/letters.ts +1319 -0
- package/src/resources/print-mail/mailing-list-imports.ts +433 -0
- package/src/resources/print-mail/mailing-lists.ts +316 -0
- package/src/resources/print-mail/order-profiles/cheques.ts +498 -0
- package/src/resources/print-mail/order-profiles/index.ts +46 -0
- package/src/resources/print-mail/order-profiles/letters.ts +423 -0
- package/src/resources/print-mail/order-profiles/order-profiles.ts +111 -0
- package/src/resources/print-mail/order-profiles/postcards.ts +338 -0
- package/src/resources/print-mail/order-profiles/self-mailers.ts +348 -0
- package/src/resources/print-mail/postcards.ts +1483 -0
- package/src/resources/print-mail/print-mail.ts +331 -0
- package/src/resources/print-mail/reports/exports.ts +209 -0
- package/src/resources/print-mail/reports/index.ts +20 -0
- package/src/resources/print-mail/reports/reports.ts +290 -0
- package/src/resources/print-mail/reports/samples.ts +84 -0
- package/src/resources/print-mail/self-mailers.ts +1481 -0
- package/src/resources/print-mail/sub-organizations.ts +394 -0
- package/src/resources/print-mail/templates.ts +216 -0
- package/src/resources/print-mail.ts +3 -0
- package/src/tsconfig.json +2 -2
- package/src/uploads.ts +2 -255
- package/src/version.ts +1 -1
- package/uploads.d.mts +2 -0
- package/uploads.d.mts.map +1 -0
- package/uploads.d.ts +1 -74
- package/uploads.d.ts.map +1 -1
- package/uploads.js +3 -168
- package/uploads.js.map +1 -1
- package/uploads.mjs +1 -157
- package/uploads.mjs.map +1 -1
- package/version.d.mts +2 -0
- package/version.d.mts.map +1 -0
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
- package/_shims/MultipartBody.d.ts +0 -9
- package/_shims/MultipartBody.d.ts.map +0 -1
- package/_shims/MultipartBody.js +0 -16
- package/_shims/MultipartBody.js.map +0 -1
- package/_shims/MultipartBody.mjs +0 -12
- package/_shims/MultipartBody.mjs.map +0 -1
- package/_shims/README.md +0 -46
- package/_shims/auto/runtime-bun.d.ts +0 -5
- package/_shims/auto/runtime-bun.d.ts.map +0 -1
- package/_shims/auto/runtime-bun.js +0 -21
- package/_shims/auto/runtime-bun.js.map +0 -1
- package/_shims/auto/runtime-bun.mjs +0 -2
- package/_shims/auto/runtime-bun.mjs.map +0 -1
- package/_shims/auto/runtime-node.d.ts +0 -5
- package/_shims/auto/runtime-node.d.ts.map +0 -1
- package/_shims/auto/runtime-node.js +0 -21
- package/_shims/auto/runtime-node.js.map +0 -1
- package/_shims/auto/runtime-node.mjs +0 -2
- package/_shims/auto/runtime-node.mjs.map +0 -1
- package/_shims/auto/runtime.d.ts +0 -5
- package/_shims/auto/runtime.d.ts.map +0 -1
- package/_shims/auto/runtime.js +0 -21
- package/_shims/auto/runtime.js.map +0 -1
- package/_shims/auto/runtime.mjs +0 -2
- package/_shims/auto/runtime.mjs.map +0 -1
- package/_shims/auto/types-node.d.ts +0 -5
- package/_shims/auto/types-node.d.ts.map +0 -1
- package/_shims/auto/types-node.js +0 -21
- package/_shims/auto/types-node.js.map +0 -1
- package/_shims/auto/types-node.mjs +0 -2
- package/_shims/auto/types-node.mjs.map +0 -1
- package/_shims/auto/types.d.ts +0 -101
- package/_shims/auto/types.js +0 -3
- package/_shims/auto/types.mjs +0 -3
- package/_shims/bun-runtime.d.ts +0 -6
- package/_shims/bun-runtime.d.ts.map +0 -1
- package/_shims/bun-runtime.js +0 -14
- package/_shims/bun-runtime.js.map +0 -1
- package/_shims/bun-runtime.mjs +0 -10
- package/_shims/bun-runtime.mjs.map +0 -1
- package/_shims/index.d.ts +0 -83
- package/_shims/index.js +0 -17
- package/_shims/index.mjs +0 -11
- package/_shims/manual-types.d.ts +0 -12
- package/_shims/manual-types.js +0 -3
- package/_shims/manual-types.mjs +0 -3
- package/_shims/node-runtime.d.ts +0 -3
- package/_shims/node-runtime.d.ts.map +0 -1
- package/_shims/node-runtime.js +0 -89
- package/_shims/node-runtime.js.map +0 -1
- package/_shims/node-runtime.mjs +0 -56
- package/_shims/node-runtime.mjs.map +0 -1
- package/_shims/node-types.d.ts +0 -42
- package/_shims/node-types.js +0 -3
- package/_shims/node-types.mjs +0 -3
- package/_shims/registry.d.ts +0 -37
- package/_shims/registry.d.ts.map +0 -1
- package/_shims/registry.js +0 -41
- package/_shims/registry.js.map +0 -1
- package/_shims/registry.mjs +0 -37
- package/_shims/registry.mjs.map +0 -1
- package/_shims/web-runtime.d.ts +0 -5
- package/_shims/web-runtime.d.ts.map +0 -1
- package/_shims/web-runtime.js +0 -78
- package/_shims/web-runtime.js.map +0 -1
- package/_shims/web-runtime.mjs +0 -71
- package/_shims/web-runtime.mjs.map +0 -1
- package/_shims/web-types.d.ts +0 -83
- package/_shims/web-types.js +0 -3
- package/_shims/web-types.mjs +0 -3
- package/core.d.ts +0 -255
- package/core.d.ts.map +0 -1
- package/core.js +0 -924
- package/core.js.map +0 -1
- package/core.mjs +0 -892
- package/core.mjs.map +0 -1
- package/pagination.d.ts +0 -26
- package/pagination.d.ts.map +0 -1
- package/pagination.js +0 -46
- package/pagination.js.map +0 -1
- package/pagination.mjs +0 -42
- package/pagination.mjs.map +0 -1
- package/resources/bank-accounts.d.ts +0 -342
- package/resources/bank-accounts.d.ts.map +0 -1
- package/resources/bank-accounts.js +0 -70
- package/resources/bank-accounts.js.map +0 -1
- package/resources/bank-accounts.mjs +0 -65
- package/resources/bank-accounts.mjs.map +0 -1
- package/resources/boxes.d.ts +0 -748
- package/resources/boxes.d.ts.map +0 -1
- package/resources/boxes.js +0 -81
- package/resources/boxes.js.map +0 -1
- package/resources/boxes.mjs +0 -76
- package/resources/boxes.mjs.map +0 -1
- package/resources/campaigns.d.ts +0 -658
- package/resources/campaigns.d.ts.map +0 -1
- package/resources/campaigns.js +0 -67
- package/resources/campaigns.js.map +0 -1
- package/resources/campaigns.mjs +0 -62
- package/resources/campaigns.mjs.map +0 -1
- package/resources/cheques/cheques.d.ts +0 -388
- package/resources/cheques/cheques.d.ts.map +0 -1
- package/resources/cheques/cheques.js +0 -118
- package/resources/cheques/cheques.js.map +0 -1
- package/resources/cheques/cheques.mjs +0 -90
- package/resources/cheques/cheques.mjs.map +0 -1
- package/resources/cheques/index.d.ts +0 -4
- package/resources/cheques/index.d.ts.map +0 -1
- package/resources/cheques/index.js +0 -12
- package/resources/cheques/index.js.map +0 -1
- package/resources/cheques/index.mjs +0 -5
- package/resources/cheques/index.mjs.map +0 -1
- package/resources/cheques/url.d.ts +0 -34
- package/resources/cheques/url.d.ts.map +0 -1
- package/resources/cheques/url.js +0 -25
- package/resources/cheques/url.js.map +0 -1
- package/resources/cheques/url.mjs +0 -21
- package/resources/cheques/url.mjs.map +0 -1
- package/resources/cheques/with-deposit-ready-pdf.d.ts +0 -19
- package/resources/cheques/with-deposit-ready-pdf.d.ts.map +0 -1
- package/resources/cheques/with-deposit-ready-pdf.js +0 -24
- package/resources/cheques/with-deposit-ready-pdf.js.map +0 -1
- package/resources/cheques/with-deposit-ready-pdf.mjs +0 -20
- package/resources/cheques/with-deposit-ready-pdf.mjs.map +0 -1
- package/resources/cheques.d.ts +0 -2
- package/resources/cheques.d.ts.map +0 -1
- package/resources/cheques.js +0 -19
- package/resources/cheques.js.map +0 -1
- package/resources/cheques.mjs +0 -3
- package/resources/cheques.mjs.map +0 -1
- package/resources/contacts.d.ts +0 -329
- package/resources/contacts.d.ts.map +0 -1
- package/resources/contacts.js +0 -72
- package/resources/contacts.js.map +0 -1
- package/resources/contacts.mjs +0 -67
- package/resources/contacts.mjs.map +0 -1
- package/resources/letters.d.ts +0 -683
- package/resources/letters.d.ts.map +0 -1
- package/resources/letters.js +0 -79
- package/resources/letters.js.map +0 -1
- package/resources/letters.mjs +0 -74
- package/resources/letters.mjs.map +0 -1
- package/resources/mailing-list-imports.d.ts +0 -919
- package/resources/mailing-list-imports.d.ts.map +0 -1
- package/resources/mailing-list-imports.js +0 -95
- package/resources/mailing-list-imports.js.map +0 -1
- package/resources/mailing-list-imports.mjs +0 -90
- package/resources/mailing-list-imports.mjs.map +0 -1
- package/resources/mailing-lists.d.ts +0 -398
- package/resources/mailing-lists.d.ts.map +0 -1
- package/resources/mailing-lists.js +0 -101
- package/resources/mailing-lists.js.map +0 -1
- package/resources/mailing-lists.mjs +0 -96
- package/resources/mailing-lists.mjs.map +0 -1
- package/resources/order-profiles/cheques.d.ts +0 -588
- package/resources/order-profiles/cheques.d.ts.map +0 -1
- package/resources/order-profiles/cheques.js +0 -74
- package/resources/order-profiles/cheques.js.map +0 -1
- package/resources/order-profiles/cheques.mjs +0 -69
- package/resources/order-profiles/cheques.mjs.map +0 -1
- package/resources/order-profiles/index.d.ts +0 -6
- package/resources/order-profiles/index.d.ts.map +0 -1
- package/resources/order-profiles/index.js +0 -19
- package/resources/order-profiles/index.js.map +0 -1
- package/resources/order-profiles/index.mjs +0 -7
- package/resources/order-profiles/index.mjs.map +0 -1
- package/resources/order-profiles/letters.d.ts +0 -647
- package/resources/order-profiles/letters.d.ts.map +0 -1
- package/resources/order-profiles/letters.js +0 -80
- package/resources/order-profiles/letters.js.map +0 -1
- package/resources/order-profiles/letters.mjs +0 -75
- package/resources/order-profiles/letters.mjs.map +0 -1
- package/resources/order-profiles/order-profiles.d.ts +0 -22
- package/resources/order-profiles/order-profiles.d.ts.map +0 -1
- package/resources/order-profiles/order-profiles.js +0 -55
- package/resources/order-profiles/order-profiles.js.map +0 -1
- package/resources/order-profiles/order-profiles.mjs +0 -28
- package/resources/order-profiles/order-profiles.mjs.map +0 -1
- package/resources/order-profiles/postcards.d.ts +0 -423
- package/resources/order-profiles/postcards.d.ts.map +0 -1
- package/resources/order-profiles/postcards.js +0 -73
- package/resources/order-profiles/postcards.js.map +0 -1
- package/resources/order-profiles/postcards.mjs +0 -68
- package/resources/order-profiles/postcards.mjs.map +0 -1
- package/resources/order-profiles/self-mailers.d.ts +0 -435
- package/resources/order-profiles/self-mailers.d.ts.map +0 -1
- package/resources/order-profiles/self-mailers.js +0 -75
- package/resources/order-profiles/self-mailers.js.map +0 -1
- package/resources/order-profiles/self-mailers.mjs +0 -70
- package/resources/order-profiles/self-mailers.mjs.map +0 -1
- package/resources/order-profiles.d.ts.map +0 -1
- package/resources/order-profiles.js +0 -19
- package/resources/order-profiles.js.map +0 -1
- package/resources/order-profiles.mjs.map +0 -1
- package/resources/postcards.d.ts +0 -396
- package/resources/postcards.d.ts.map +0 -1
- package/resources/postcards.js +0 -82
- package/resources/postcards.js.map +0 -1
- package/resources/postcards.mjs +0 -77
- package/resources/postcards.mjs.map +0 -1
- package/resources/reports/exports.d.ts +0 -240
- package/resources/reports/exports.d.ts.map +0 -1
- package/resources/reports/exports.js +0 -60
- package/resources/reports/exports.js.map +0 -1
- package/resources/reports/exports.mjs +0 -56
- package/resources/reports/exports.mjs.map +0 -1
- package/resources/reports/index.d.ts +0 -3
- package/resources/reports/index.d.ts.map +0 -1
- package/resources/reports/index.js +0 -10
- package/resources/reports/index.js.map +0 -1
- package/resources/reports/index.mjs +0 -4
- package/resources/reports/index.mjs.map +0 -1
- package/resources/reports/reports.d.ts +0 -382
- package/resources/reports/reports.d.ts.map +0 -1
- package/resources/reports/reports.js +0 -142
- package/resources/reports/reports.js.map +0 -1
- package/resources/reports/reports.mjs +0 -114
- package/resources/reports/reports.mjs.map +0 -1
- package/resources/reports.d.ts.map +0 -1
- package/resources/reports.js +0 -19
- package/resources/reports.js.map +0 -1
- package/resources/reports.mjs.map +0 -1
- package/resources/self-mailers.d.ts +0 -706
- package/resources/self-mailers.d.ts.map +0 -1
- package/resources/self-mailers.js +0 -83
- package/resources/self-mailers.js.map +0 -1
- package/resources/self-mailers.mjs +0 -78
- package/resources/self-mailers.mjs.map +0 -1
- package/resources/shared.d.ts +0 -151
- package/resources/shared.d.ts.map +0 -1
- package/resources/shared.js +0 -4
- package/resources/shared.js.map +0 -1
- package/resources/shared.mjs +0 -3
- package/resources/shared.mjs.map +0 -1
- package/resources/sub-organizations.d.ts +0 -394
- package/resources/sub-organizations.d.ts.map +0 -1
- package/resources/sub-organizations.js +0 -63
- package/resources/sub-organizations.js.map +0 -1
- package/resources/sub-organizations.mjs +0 -58
- package/resources/sub-organizations.mjs.map +0 -1
- package/resources/templates.d.ts +0 -166
- package/resources/templates.d.ts.map +0 -1
- package/resources/templates.js +0 -72
- package/resources/templates.js.map +0 -1
- package/resources/templates.mjs +0 -67
- package/resources/templates.mjs.map +0 -1
- package/shims/node.d.ts +0 -30
- package/shims/node.d.ts.map +0 -1
- package/shims/node.js +0 -31
- package/shims/node.js.map +0 -1
- package/shims/node.mjs +0 -5
- package/shims/node.mjs.map +0 -1
- package/shims/web.d.ts +0 -26
- package/shims/web.d.ts.map +0 -1
- package/shims/web.js +0 -31
- package/shims/web.js.map +0 -1
- package/shims/web.mjs +0 -5
- package/shims/web.mjs.map +0 -1
- package/src/_shims/MultipartBody.ts +0 -9
- package/src/_shims/README.md +0 -46
- package/src/_shims/auto/runtime-bun.ts +0 -4
- package/src/_shims/auto/runtime-node.ts +0 -4
- package/src/_shims/auto/runtime.ts +0 -4
- package/src/_shims/auto/types-node.ts +0 -4
- package/src/_shims/auto/types.d.ts +0 -101
- package/src/_shims/auto/types.js +0 -3
- package/src/_shims/auto/types.mjs +0 -3
- package/src/_shims/bun-runtime.ts +0 -14
- package/src/_shims/index.d.ts +0 -83
- package/src/_shims/index.js +0 -17
- package/src/_shims/index.mjs +0 -11
- package/src/_shims/manual-types.d.ts +0 -12
- package/src/_shims/manual-types.js +0 -3
- package/src/_shims/manual-types.mjs +0 -3
- package/src/_shims/node-runtime.ts +0 -81
- package/src/_shims/node-types.d.ts +0 -42
- package/src/_shims/node-types.js +0 -3
- package/src/_shims/node-types.mjs +0 -3
- package/src/_shims/registry.ts +0 -67
- package/src/_shims/web-runtime.ts +0 -103
- package/src/_shims/web-types.d.ts +0 -83
- package/src/_shims/web-types.js +0 -3
- package/src/_shims/web-types.mjs +0 -3
- package/src/core.ts +0 -1236
- package/src/pagination.ts +0 -74
- package/src/resources/bank-accounts.ts +0 -435
- package/src/resources/boxes.ts +0 -1017
- package/src/resources/campaigns.ts +0 -853
- package/src/resources/cheques/cheques.ts +0 -524
- package/src/resources/cheques/index.ts +0 -12
- package/src/resources/cheques/url.ts +0 -42
- package/src/resources/cheques/with-deposit-ready-pdf.ts +0 -23
- package/src/resources/cheques.ts +0 -3
- package/src/resources/contacts.ts +0 -415
- package/src/resources/letters.ts +0 -902
- package/src/resources/mailing-list-imports.ts +0 -1076
- package/src/resources/mailing-lists.ts +0 -511
- package/src/resources/order-profiles/cheques.ts +0 -888
- package/src/resources/order-profiles/index.ts +0 -55
- package/src/resources/order-profiles/letters.ts +0 -956
- package/src/resources/order-profiles/order-profiles.ts +0 -133
- package/src/resources/order-profiles/postcards.ts +0 -694
- package/src/resources/order-profiles/self-mailers.ts +0 -707
- package/src/resources/postcards.ts +0 -582
- package/src/resources/reports/exports.ts +0 -299
- package/src/resources/reports/index.ts +0 -25
- package/src/resources/reports/reports.ts +0 -494
- package/src/resources/self-mailers.ts +0 -1024
- package/src/resources/shared.ts +0 -182
- package/src/resources/sub-organizations.ts +0 -518
- package/src/resources/templates.ts +0 -218
- package/src/shims/node.ts +0 -50
- package/src/shims/web.ts +0 -50
- /package/resources/{order-profiles.d.ts → print-mail/order-profiles.d.ts} +0 -0
- /package/resources/{order-profiles.mjs → print-mail/order-profiles.mjs} +0 -0
- /package/resources/{reports.d.ts → print-mail/reports.d.ts} +0 -0
- /package/resources/{reports.mjs → print-mail/reports.mjs} +0 -0
- /package/src/resources/{order-profiles.ts → print-mail/order-profiles.ts} +0 -0
- /package/src/resources/{reports.ts → print-mail/reports.ts} +0 -0
|
@@ -1,888 +0,0 @@
|
|
|
1
|
-
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
-
|
|
3
|
-
import { APIResource } from '../../resource';
|
|
4
|
-
import { isRequestOptions } from '../../core';
|
|
5
|
-
import * as Core from '../../core';
|
|
6
|
-
import * as ContactsAPI from '../contacts';
|
|
7
|
-
import { List, type ListParams } from '../../pagination';
|
|
8
|
-
|
|
9
|
-
export class Cheques extends APIResource {
|
|
10
|
-
/**
|
|
11
|
-
* Creates a new Cheque Profile. Requires a `bankAccount` ID. Can optionally
|
|
12
|
-
* include an attached letter via `letterHTML`, `letterTemplate`, or `letterPDF`.
|
|
13
|
-
* If providing `letterPDF` or `logo` (if logo needs upload, though schema suggests
|
|
14
|
-
* URL), use `multipart/form-data`.
|
|
15
|
-
*
|
|
16
|
-
* @example
|
|
17
|
-
* ```ts
|
|
18
|
-
* const cheque = await client.orderProfiles.cheques.create({
|
|
19
|
-
* bankAccount: 'bankAccount',
|
|
20
|
-
* size: 'us_letter',
|
|
21
|
-
* });
|
|
22
|
-
* ```
|
|
23
|
-
*/
|
|
24
|
-
create(params: ChequeCreateParams, options?: Core.RequestOptions): Core.APIPromise<ChequeCreateResponse> {
|
|
25
|
-
const { expand, ...body } = params;
|
|
26
|
-
return this._client.post('/order_profiles/cheques', { query: { expand }, body, ...options });
|
|
27
|
-
}
|
|
28
|
-
|
|
29
|
-
/**
|
|
30
|
-
* Retrieves the details of a specific Cheque Profile.
|
|
31
|
-
*
|
|
32
|
-
* @example
|
|
33
|
-
* ```ts
|
|
34
|
-
* const cheque = await client.orderProfiles.cheques.retrieve(
|
|
35
|
-
* 'id',
|
|
36
|
-
* );
|
|
37
|
-
* ```
|
|
38
|
-
*/
|
|
39
|
-
retrieve(
|
|
40
|
-
id: string,
|
|
41
|
-
query?: ChequeRetrieveParams,
|
|
42
|
-
options?: Core.RequestOptions,
|
|
43
|
-
): Core.APIPromise<ChequeRetrieveResponse>;
|
|
44
|
-
retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<ChequeRetrieveResponse>;
|
|
45
|
-
retrieve(
|
|
46
|
-
id: string,
|
|
47
|
-
query: ChequeRetrieveParams | Core.RequestOptions = {},
|
|
48
|
-
options?: Core.RequestOptions,
|
|
49
|
-
): Core.APIPromise<ChequeRetrieveResponse> {
|
|
50
|
-
if (isRequestOptions(query)) {
|
|
51
|
-
return this.retrieve(id, {}, query);
|
|
52
|
-
}
|
|
53
|
-
return this._client.get(`/order_profiles/cheques/${id}`, { query, ...options });
|
|
54
|
-
}
|
|
55
|
-
|
|
56
|
-
/**
|
|
57
|
-
* Updates specific fields of an existing Cheque Profile. If providing `letterPDF`
|
|
58
|
-
* or `logo`, use `multipart/form-data`.
|
|
59
|
-
*
|
|
60
|
-
* @example
|
|
61
|
-
* ```ts
|
|
62
|
-
* const cheque = await client.orderProfiles.cheques.update(
|
|
63
|
-
* 'id',
|
|
64
|
-
* { bankAccount: 'bankAccount', size: 'us_letter' },
|
|
65
|
-
* );
|
|
66
|
-
* ```
|
|
67
|
-
*/
|
|
68
|
-
update(
|
|
69
|
-
id: string,
|
|
70
|
-
params: ChequeUpdateParams,
|
|
71
|
-
options?: Core.RequestOptions,
|
|
72
|
-
): Core.APIPromise<ChequeUpdateResponse> {
|
|
73
|
-
const { expand, ...body } = params;
|
|
74
|
-
return this._client.post(`/order_profiles/cheques/${id}`, { query: { expand }, body, ...options });
|
|
75
|
-
}
|
|
76
|
-
|
|
77
|
-
/**
|
|
78
|
-
* Retrieves a list of Cheque Profiles.
|
|
79
|
-
*
|
|
80
|
-
* @example
|
|
81
|
-
* ```ts
|
|
82
|
-
* // Automatically fetches more pages as needed.
|
|
83
|
-
* for await (const chequeListResponse of client.orderProfiles.cheques.list()) {
|
|
84
|
-
* // ...
|
|
85
|
-
* }
|
|
86
|
-
* ```
|
|
87
|
-
*/
|
|
88
|
-
list(
|
|
89
|
-
query?: ChequeListParams,
|
|
90
|
-
options?: Core.RequestOptions,
|
|
91
|
-
): Core.PagePromise<ChequeListResponsesList, ChequeListResponse>;
|
|
92
|
-
list(options?: Core.RequestOptions): Core.PagePromise<ChequeListResponsesList, ChequeListResponse>;
|
|
93
|
-
list(
|
|
94
|
-
query: ChequeListParams | Core.RequestOptions = {},
|
|
95
|
-
options?: Core.RequestOptions,
|
|
96
|
-
): Core.PagePromise<ChequeListResponsesList, ChequeListResponse> {
|
|
97
|
-
if (isRequestOptions(query)) {
|
|
98
|
-
return this.list({}, query);
|
|
99
|
-
}
|
|
100
|
-
return this._client.getAPIList('/order_profiles/cheques', ChequeListResponsesList, { query, ...options });
|
|
101
|
-
}
|
|
102
|
-
|
|
103
|
-
/**
|
|
104
|
-
* Deletes a Cheque Profile.
|
|
105
|
-
*
|
|
106
|
-
* @example
|
|
107
|
-
* ```ts
|
|
108
|
-
* const cheque = await client.orderProfiles.cheques.delete(
|
|
109
|
-
* 'id',
|
|
110
|
-
* );
|
|
111
|
-
* ```
|
|
112
|
-
*/
|
|
113
|
-
delete(id: string, options?: Core.RequestOptions): Core.APIPromise<ChequeDeleteResponse> {
|
|
114
|
-
return this._client.delete(`/order_profiles/cheques/${id}`, options);
|
|
115
|
-
}
|
|
116
|
-
}
|
|
117
|
-
|
|
118
|
-
export class ChequeListResponsesList extends List<ChequeListResponse> {}
|
|
119
|
-
|
|
120
|
-
export interface ChequeCreateResponse {
|
|
121
|
-
/**
|
|
122
|
-
* Unique identifier for the order profile.
|
|
123
|
-
*/
|
|
124
|
-
id: string;
|
|
125
|
-
|
|
126
|
-
/**
|
|
127
|
-
* ID of the bank account to use for the cheque. Required for creation.
|
|
128
|
-
*/
|
|
129
|
-
bankAccount: string;
|
|
130
|
-
|
|
131
|
-
/**
|
|
132
|
-
* Timestamp when the profile was created.
|
|
133
|
-
*/
|
|
134
|
-
createdAt: string;
|
|
135
|
-
|
|
136
|
-
/**
|
|
137
|
-
* Enum representing the supported currency codes.
|
|
138
|
-
*/
|
|
139
|
-
currencyCode: 'CAD' | 'USD';
|
|
140
|
-
|
|
141
|
-
/**
|
|
142
|
-
* Indicates if the profile is associated with the live or test environment.
|
|
143
|
-
*/
|
|
144
|
-
live: boolean;
|
|
145
|
-
|
|
146
|
-
/**
|
|
147
|
-
* Always `cheque_profile`.
|
|
148
|
-
*/
|
|
149
|
-
object: 'cheque_profile';
|
|
150
|
-
|
|
151
|
-
/**
|
|
152
|
-
* Enum representing the supported cheque sizes.
|
|
153
|
-
*/
|
|
154
|
-
size: 'us_letter' | 'us_legal';
|
|
155
|
-
|
|
156
|
-
/**
|
|
157
|
-
* Timestamp when the profile was last updated.
|
|
158
|
-
*/
|
|
159
|
-
updatedAt: string;
|
|
160
|
-
|
|
161
|
-
/**
|
|
162
|
-
* An optional description for the profile. Set to `null` to remove during update.
|
|
163
|
-
*/
|
|
164
|
-
description?: string | null;
|
|
165
|
-
|
|
166
|
-
/**
|
|
167
|
-
* HTML content for an optional attached letter. Cannot be used with
|
|
168
|
-
* `letterTemplate` or `letterPDF`.
|
|
169
|
-
*/
|
|
170
|
-
letterHTML?: string;
|
|
171
|
-
|
|
172
|
-
/**
|
|
173
|
-
* ID of a template for an optional attached letter. Cannot be used with
|
|
174
|
-
* `letterHTML` or `letterPDF`.
|
|
175
|
-
*/
|
|
176
|
-
letterTemplate?: string;
|
|
177
|
-
|
|
178
|
-
/**
|
|
179
|
-
* A temporary, signed URL to view the attached letter PDF, if any. Output only.
|
|
180
|
-
*/
|
|
181
|
-
letterUploadedPDF?: string;
|
|
182
|
-
|
|
183
|
-
/**
|
|
184
|
-
* A publicly accessible URL for the logo to print on the cheque. Set to `null` to
|
|
185
|
-
* remove during update.
|
|
186
|
-
*/
|
|
187
|
-
logo?: string | null;
|
|
188
|
-
|
|
189
|
-
/**
|
|
190
|
-
* Mailing class. Generally must be first class (or equivalent for destination
|
|
191
|
-
* country) for cheques.
|
|
192
|
-
*/
|
|
193
|
-
mailingClass?:
|
|
194
|
-
| 'first_class'
|
|
195
|
-
| 'standard_class'
|
|
196
|
-
| 'express'
|
|
197
|
-
| 'certified'
|
|
198
|
-
| 'certified_return_receipt'
|
|
199
|
-
| 'registered'
|
|
200
|
-
| 'usps_first_class'
|
|
201
|
-
| 'usps_standard_class'
|
|
202
|
-
| 'usps_eddm'
|
|
203
|
-
| 'usps_express_2_day'
|
|
204
|
-
| 'usps_express_3_day'
|
|
205
|
-
| 'usps_first_class_certified'
|
|
206
|
-
| 'usps_first_class_certified_return_receipt'
|
|
207
|
-
| 'usps_first_class_registered'
|
|
208
|
-
| 'usps_express_3_day_signature_confirmation'
|
|
209
|
-
| 'usps_express_3_day_certified'
|
|
210
|
-
| 'usps_express_3_day_certified_return_receipt'
|
|
211
|
-
| 'ca_post_lettermail'
|
|
212
|
-
| 'ca_post_personalized'
|
|
213
|
-
| 'ca_post_neighbourhood_mail'
|
|
214
|
-
| 'ups_express_overnight'
|
|
215
|
-
| 'ups_express_2_day'
|
|
216
|
-
| 'ups_express_3_day'
|
|
217
|
-
| 'royal_mail_first_class'
|
|
218
|
-
| 'royal_mail_second_class'
|
|
219
|
-
| 'au_post_second_class';
|
|
220
|
-
|
|
221
|
-
/**
|
|
222
|
-
* Memo line text for the cheque. Set to `null` to remove during update.
|
|
223
|
-
*/
|
|
224
|
-
memo?: string | null;
|
|
225
|
-
|
|
226
|
-
/**
|
|
227
|
-
* Default merge variables for orders created using this profile.
|
|
228
|
-
*/
|
|
229
|
-
mergeVariables?: { [key: string]: unknown } | null;
|
|
230
|
-
|
|
231
|
-
/**
|
|
232
|
-
* Message included on the cheque stub. Set to `null` to remove during update.
|
|
233
|
-
*/
|
|
234
|
-
message?: string | null;
|
|
235
|
-
|
|
236
|
-
/**
|
|
237
|
-
* Optional key-value metadata.
|
|
238
|
-
*/
|
|
239
|
-
metadata?: { [key: string]: string } | null;
|
|
240
|
-
|
|
241
|
-
/**
|
|
242
|
-
* Contact details for redirection (output).
|
|
243
|
-
*/
|
|
244
|
-
redirectTo?: ContactsAPI.Contact;
|
|
245
|
-
}
|
|
246
|
-
|
|
247
|
-
export interface ChequeRetrieveResponse {
|
|
248
|
-
/**
|
|
249
|
-
* Unique identifier for the order profile.
|
|
250
|
-
*/
|
|
251
|
-
id: string;
|
|
252
|
-
|
|
253
|
-
/**
|
|
254
|
-
* ID of the bank account to use for the cheque. Required for creation.
|
|
255
|
-
*/
|
|
256
|
-
bankAccount: string;
|
|
257
|
-
|
|
258
|
-
/**
|
|
259
|
-
* Timestamp when the profile was created.
|
|
260
|
-
*/
|
|
261
|
-
createdAt: string;
|
|
262
|
-
|
|
263
|
-
/**
|
|
264
|
-
* Enum representing the supported currency codes.
|
|
265
|
-
*/
|
|
266
|
-
currencyCode: 'CAD' | 'USD';
|
|
267
|
-
|
|
268
|
-
/**
|
|
269
|
-
* Indicates if the profile is associated with the live or test environment.
|
|
270
|
-
*/
|
|
271
|
-
live: boolean;
|
|
272
|
-
|
|
273
|
-
/**
|
|
274
|
-
* Always `cheque_profile`.
|
|
275
|
-
*/
|
|
276
|
-
object: 'cheque_profile';
|
|
277
|
-
|
|
278
|
-
/**
|
|
279
|
-
* Enum representing the supported cheque sizes.
|
|
280
|
-
*/
|
|
281
|
-
size: 'us_letter' | 'us_legal';
|
|
282
|
-
|
|
283
|
-
/**
|
|
284
|
-
* Timestamp when the profile was last updated.
|
|
285
|
-
*/
|
|
286
|
-
updatedAt: string;
|
|
287
|
-
|
|
288
|
-
/**
|
|
289
|
-
* An optional description for the profile. Set to `null` to remove during update.
|
|
290
|
-
*/
|
|
291
|
-
description?: string | null;
|
|
292
|
-
|
|
293
|
-
/**
|
|
294
|
-
* HTML content for an optional attached letter. Cannot be used with
|
|
295
|
-
* `letterTemplate` or `letterPDF`.
|
|
296
|
-
*/
|
|
297
|
-
letterHTML?: string;
|
|
298
|
-
|
|
299
|
-
/**
|
|
300
|
-
* ID of a template for an optional attached letter. Cannot be used with
|
|
301
|
-
* `letterHTML` or `letterPDF`.
|
|
302
|
-
*/
|
|
303
|
-
letterTemplate?: string;
|
|
304
|
-
|
|
305
|
-
/**
|
|
306
|
-
* A temporary, signed URL to view the attached letter PDF, if any. Output only.
|
|
307
|
-
*/
|
|
308
|
-
letterUploadedPDF?: string;
|
|
309
|
-
|
|
310
|
-
/**
|
|
311
|
-
* A publicly accessible URL for the logo to print on the cheque. Set to `null` to
|
|
312
|
-
* remove during update.
|
|
313
|
-
*/
|
|
314
|
-
logo?: string | null;
|
|
315
|
-
|
|
316
|
-
/**
|
|
317
|
-
* Mailing class. Generally must be first class (or equivalent for destination
|
|
318
|
-
* country) for cheques.
|
|
319
|
-
*/
|
|
320
|
-
mailingClass?:
|
|
321
|
-
| 'first_class'
|
|
322
|
-
| 'standard_class'
|
|
323
|
-
| 'express'
|
|
324
|
-
| 'certified'
|
|
325
|
-
| 'certified_return_receipt'
|
|
326
|
-
| 'registered'
|
|
327
|
-
| 'usps_first_class'
|
|
328
|
-
| 'usps_standard_class'
|
|
329
|
-
| 'usps_eddm'
|
|
330
|
-
| 'usps_express_2_day'
|
|
331
|
-
| 'usps_express_3_day'
|
|
332
|
-
| 'usps_first_class_certified'
|
|
333
|
-
| 'usps_first_class_certified_return_receipt'
|
|
334
|
-
| 'usps_first_class_registered'
|
|
335
|
-
| 'usps_express_3_day_signature_confirmation'
|
|
336
|
-
| 'usps_express_3_day_certified'
|
|
337
|
-
| 'usps_express_3_day_certified_return_receipt'
|
|
338
|
-
| 'ca_post_lettermail'
|
|
339
|
-
| 'ca_post_personalized'
|
|
340
|
-
| 'ca_post_neighbourhood_mail'
|
|
341
|
-
| 'ups_express_overnight'
|
|
342
|
-
| 'ups_express_2_day'
|
|
343
|
-
| 'ups_express_3_day'
|
|
344
|
-
| 'royal_mail_first_class'
|
|
345
|
-
| 'royal_mail_second_class'
|
|
346
|
-
| 'au_post_second_class';
|
|
347
|
-
|
|
348
|
-
/**
|
|
349
|
-
* Memo line text for the cheque. Set to `null` to remove during update.
|
|
350
|
-
*/
|
|
351
|
-
memo?: string | null;
|
|
352
|
-
|
|
353
|
-
/**
|
|
354
|
-
* Default merge variables for orders created using this profile.
|
|
355
|
-
*/
|
|
356
|
-
mergeVariables?: { [key: string]: unknown } | null;
|
|
357
|
-
|
|
358
|
-
/**
|
|
359
|
-
* Message included on the cheque stub. Set to `null` to remove during update.
|
|
360
|
-
*/
|
|
361
|
-
message?: string | null;
|
|
362
|
-
|
|
363
|
-
/**
|
|
364
|
-
* Optional key-value metadata.
|
|
365
|
-
*/
|
|
366
|
-
metadata?: { [key: string]: string } | null;
|
|
367
|
-
|
|
368
|
-
/**
|
|
369
|
-
* Contact details for redirection (output).
|
|
370
|
-
*/
|
|
371
|
-
redirectTo?: ContactsAPI.Contact;
|
|
372
|
-
}
|
|
373
|
-
|
|
374
|
-
export interface ChequeUpdateResponse {
|
|
375
|
-
/**
|
|
376
|
-
* Unique identifier for the order profile.
|
|
377
|
-
*/
|
|
378
|
-
id: string;
|
|
379
|
-
|
|
380
|
-
/**
|
|
381
|
-
* ID of the bank account to use for the cheque. Required for creation.
|
|
382
|
-
*/
|
|
383
|
-
bankAccount: string;
|
|
384
|
-
|
|
385
|
-
/**
|
|
386
|
-
* Timestamp when the profile was created.
|
|
387
|
-
*/
|
|
388
|
-
createdAt: string;
|
|
389
|
-
|
|
390
|
-
/**
|
|
391
|
-
* Enum representing the supported currency codes.
|
|
392
|
-
*/
|
|
393
|
-
currencyCode: 'CAD' | 'USD';
|
|
394
|
-
|
|
395
|
-
/**
|
|
396
|
-
* Indicates if the profile is associated with the live or test environment.
|
|
397
|
-
*/
|
|
398
|
-
live: boolean;
|
|
399
|
-
|
|
400
|
-
/**
|
|
401
|
-
* Always `cheque_profile`.
|
|
402
|
-
*/
|
|
403
|
-
object: 'cheque_profile';
|
|
404
|
-
|
|
405
|
-
/**
|
|
406
|
-
* Enum representing the supported cheque sizes.
|
|
407
|
-
*/
|
|
408
|
-
size: 'us_letter' | 'us_legal';
|
|
409
|
-
|
|
410
|
-
/**
|
|
411
|
-
* Timestamp when the profile was last updated.
|
|
412
|
-
*/
|
|
413
|
-
updatedAt: string;
|
|
414
|
-
|
|
415
|
-
/**
|
|
416
|
-
* An optional description for the profile. Set to `null` to remove during update.
|
|
417
|
-
*/
|
|
418
|
-
description?: string | null;
|
|
419
|
-
|
|
420
|
-
/**
|
|
421
|
-
* HTML content for an optional attached letter. Cannot be used with
|
|
422
|
-
* `letterTemplate` or `letterPDF`.
|
|
423
|
-
*/
|
|
424
|
-
letterHTML?: string;
|
|
425
|
-
|
|
426
|
-
/**
|
|
427
|
-
* ID of a template for an optional attached letter. Cannot be used with
|
|
428
|
-
* `letterHTML` or `letterPDF`.
|
|
429
|
-
*/
|
|
430
|
-
letterTemplate?: string;
|
|
431
|
-
|
|
432
|
-
/**
|
|
433
|
-
* A temporary, signed URL to view the attached letter PDF, if any. Output only.
|
|
434
|
-
*/
|
|
435
|
-
letterUploadedPDF?: string;
|
|
436
|
-
|
|
437
|
-
/**
|
|
438
|
-
* A publicly accessible URL for the logo to print on the cheque. Set to `null` to
|
|
439
|
-
* remove during update.
|
|
440
|
-
*/
|
|
441
|
-
logo?: string | null;
|
|
442
|
-
|
|
443
|
-
/**
|
|
444
|
-
* Mailing class. Generally must be first class (or equivalent for destination
|
|
445
|
-
* country) for cheques.
|
|
446
|
-
*/
|
|
447
|
-
mailingClass?:
|
|
448
|
-
| 'first_class'
|
|
449
|
-
| 'standard_class'
|
|
450
|
-
| 'express'
|
|
451
|
-
| 'certified'
|
|
452
|
-
| 'certified_return_receipt'
|
|
453
|
-
| 'registered'
|
|
454
|
-
| 'usps_first_class'
|
|
455
|
-
| 'usps_standard_class'
|
|
456
|
-
| 'usps_eddm'
|
|
457
|
-
| 'usps_express_2_day'
|
|
458
|
-
| 'usps_express_3_day'
|
|
459
|
-
| 'usps_first_class_certified'
|
|
460
|
-
| 'usps_first_class_certified_return_receipt'
|
|
461
|
-
| 'usps_first_class_registered'
|
|
462
|
-
| 'usps_express_3_day_signature_confirmation'
|
|
463
|
-
| 'usps_express_3_day_certified'
|
|
464
|
-
| 'usps_express_3_day_certified_return_receipt'
|
|
465
|
-
| 'ca_post_lettermail'
|
|
466
|
-
| 'ca_post_personalized'
|
|
467
|
-
| 'ca_post_neighbourhood_mail'
|
|
468
|
-
| 'ups_express_overnight'
|
|
469
|
-
| 'ups_express_2_day'
|
|
470
|
-
| 'ups_express_3_day'
|
|
471
|
-
| 'royal_mail_first_class'
|
|
472
|
-
| 'royal_mail_second_class'
|
|
473
|
-
| 'au_post_second_class';
|
|
474
|
-
|
|
475
|
-
/**
|
|
476
|
-
* Memo line text for the cheque. Set to `null` to remove during update.
|
|
477
|
-
*/
|
|
478
|
-
memo?: string | null;
|
|
479
|
-
|
|
480
|
-
/**
|
|
481
|
-
* Default merge variables for orders created using this profile.
|
|
482
|
-
*/
|
|
483
|
-
mergeVariables?: { [key: string]: unknown } | null;
|
|
484
|
-
|
|
485
|
-
/**
|
|
486
|
-
* Message included on the cheque stub. Set to `null` to remove during update.
|
|
487
|
-
*/
|
|
488
|
-
message?: string | null;
|
|
489
|
-
|
|
490
|
-
/**
|
|
491
|
-
* Optional key-value metadata.
|
|
492
|
-
*/
|
|
493
|
-
metadata?: { [key: string]: string } | null;
|
|
494
|
-
|
|
495
|
-
/**
|
|
496
|
-
* Contact details for redirection (output).
|
|
497
|
-
*/
|
|
498
|
-
redirectTo?: ContactsAPI.Contact;
|
|
499
|
-
}
|
|
500
|
-
|
|
501
|
-
export interface ChequeListResponse {
|
|
502
|
-
/**
|
|
503
|
-
* Unique identifier for the order profile.
|
|
504
|
-
*/
|
|
505
|
-
id: string;
|
|
506
|
-
|
|
507
|
-
/**
|
|
508
|
-
* ID of the bank account to use for the cheque. Required for creation.
|
|
509
|
-
*/
|
|
510
|
-
bankAccount: string;
|
|
511
|
-
|
|
512
|
-
/**
|
|
513
|
-
* Timestamp when the profile was created.
|
|
514
|
-
*/
|
|
515
|
-
createdAt: string;
|
|
516
|
-
|
|
517
|
-
/**
|
|
518
|
-
* Indicates if the profile is associated with the live or test environment.
|
|
519
|
-
*/
|
|
520
|
-
live: boolean;
|
|
521
|
-
|
|
522
|
-
/**
|
|
523
|
-
* Always `cheque_profile`.
|
|
524
|
-
*/
|
|
525
|
-
object: 'cheque_profile';
|
|
526
|
-
|
|
527
|
-
/**
|
|
528
|
-
* Enum representing the supported cheque sizes.
|
|
529
|
-
*/
|
|
530
|
-
size: 'us_letter' | 'us_legal';
|
|
531
|
-
|
|
532
|
-
/**
|
|
533
|
-
* Timestamp when the profile was last updated.
|
|
534
|
-
*/
|
|
535
|
-
updatedAt: string;
|
|
536
|
-
|
|
537
|
-
/**
|
|
538
|
-
* An optional description for the profile. Set to `null` to remove during update.
|
|
539
|
-
*/
|
|
540
|
-
description?: string | null;
|
|
541
|
-
|
|
542
|
-
/**
|
|
543
|
-
* HTML content for an optional attached letter. Cannot be used with
|
|
544
|
-
* `letterTemplate` or `letterPDF`.
|
|
545
|
-
*/
|
|
546
|
-
letterHTML?: string;
|
|
547
|
-
|
|
548
|
-
/**
|
|
549
|
-
* ID of a template for an optional attached letter. Cannot be used with
|
|
550
|
-
* `letterHTML` or `letterPDF`.
|
|
551
|
-
*/
|
|
552
|
-
letterTemplate?: string;
|
|
553
|
-
|
|
554
|
-
/**
|
|
555
|
-
* A temporary, signed URL to view the attached letter PDF, if any. Output only.
|
|
556
|
-
*/
|
|
557
|
-
letterUploadedPDF?: string;
|
|
558
|
-
|
|
559
|
-
/**
|
|
560
|
-
* A publicly accessible URL for the logo to print on the cheque. Set to `null` to
|
|
561
|
-
* remove during update.
|
|
562
|
-
*/
|
|
563
|
-
logo?: string | null;
|
|
564
|
-
|
|
565
|
-
/**
|
|
566
|
-
* Mailing class. Generally must be first class (or equivalent for destination
|
|
567
|
-
* country) for cheques.
|
|
568
|
-
*/
|
|
569
|
-
mailingClass?:
|
|
570
|
-
| 'first_class'
|
|
571
|
-
| 'standard_class'
|
|
572
|
-
| 'express'
|
|
573
|
-
| 'certified'
|
|
574
|
-
| 'certified_return_receipt'
|
|
575
|
-
| 'registered'
|
|
576
|
-
| 'usps_first_class'
|
|
577
|
-
| 'usps_standard_class'
|
|
578
|
-
| 'usps_eddm'
|
|
579
|
-
| 'usps_express_2_day'
|
|
580
|
-
| 'usps_express_3_day'
|
|
581
|
-
| 'usps_first_class_certified'
|
|
582
|
-
| 'usps_first_class_certified_return_receipt'
|
|
583
|
-
| 'usps_first_class_registered'
|
|
584
|
-
| 'usps_express_3_day_signature_confirmation'
|
|
585
|
-
| 'usps_express_3_day_certified'
|
|
586
|
-
| 'usps_express_3_day_certified_return_receipt'
|
|
587
|
-
| 'ca_post_lettermail'
|
|
588
|
-
| 'ca_post_personalized'
|
|
589
|
-
| 'ca_post_neighbourhood_mail'
|
|
590
|
-
| 'ups_express_overnight'
|
|
591
|
-
| 'ups_express_2_day'
|
|
592
|
-
| 'ups_express_3_day'
|
|
593
|
-
| 'royal_mail_first_class'
|
|
594
|
-
| 'royal_mail_second_class'
|
|
595
|
-
| 'au_post_second_class';
|
|
596
|
-
|
|
597
|
-
/**
|
|
598
|
-
* Memo line text for the cheque. Set to `null` to remove during update.
|
|
599
|
-
*/
|
|
600
|
-
memo?: string | null;
|
|
601
|
-
|
|
602
|
-
/**
|
|
603
|
-
* Default merge variables for orders created using this profile.
|
|
604
|
-
*/
|
|
605
|
-
mergeVariables?: { [key: string]: unknown } | null;
|
|
606
|
-
|
|
607
|
-
/**
|
|
608
|
-
* Message included on the cheque stub. Set to `null` to remove during update.
|
|
609
|
-
*/
|
|
610
|
-
message?: string | null;
|
|
611
|
-
|
|
612
|
-
/**
|
|
613
|
-
* Optional key-value metadata.
|
|
614
|
-
*/
|
|
615
|
-
metadata?: { [key: string]: string } | null;
|
|
616
|
-
|
|
617
|
-
/**
|
|
618
|
-
* Contact details for redirection (output).
|
|
619
|
-
*/
|
|
620
|
-
redirectTo?: ContactsAPI.Contact;
|
|
621
|
-
}
|
|
622
|
-
|
|
623
|
-
export interface ChequeDeleteResponse {
|
|
624
|
-
/**
|
|
625
|
-
* Unique identifier for the order profile.
|
|
626
|
-
*/
|
|
627
|
-
id: string;
|
|
628
|
-
|
|
629
|
-
deleted: true;
|
|
630
|
-
|
|
631
|
-
/**
|
|
632
|
-
* Always `cheque_profile`.
|
|
633
|
-
*/
|
|
634
|
-
object: 'cheque_profile';
|
|
635
|
-
}
|
|
636
|
-
|
|
637
|
-
export interface ChequeCreateParams {
|
|
638
|
-
/**
|
|
639
|
-
* Body param: ID of the bank account to use for the cheque. Required for creation.
|
|
640
|
-
*/
|
|
641
|
-
bankAccount: string;
|
|
642
|
-
|
|
643
|
-
/**
|
|
644
|
-
* Body param: Enum representing the supported cheque sizes.
|
|
645
|
-
*/
|
|
646
|
-
size: 'us_letter' | 'us_legal';
|
|
647
|
-
|
|
648
|
-
/**
|
|
649
|
-
* Query param: Optional list of related resources to expand in the response.
|
|
650
|
-
*/
|
|
651
|
-
expand?: Array<string>;
|
|
652
|
-
|
|
653
|
-
/**
|
|
654
|
-
* Body param: Enum representing the supported currency codes.
|
|
655
|
-
*/
|
|
656
|
-
currencyCode?: 'CAD' | 'USD';
|
|
657
|
-
|
|
658
|
-
/**
|
|
659
|
-
* Body param: An optional description for the profile. Set to `null` to remove
|
|
660
|
-
* during update.
|
|
661
|
-
*/
|
|
662
|
-
description?: string | null;
|
|
663
|
-
|
|
664
|
-
/**
|
|
665
|
-
* Body param: HTML content for an optional attached letter. Cannot be used with
|
|
666
|
-
* `letterTemplate` or `letterPDF`.
|
|
667
|
-
*/
|
|
668
|
-
letterHTML?: string;
|
|
669
|
-
|
|
670
|
-
/**
|
|
671
|
-
* Body param: PDF file for an optional attached letter. Cannot be used with
|
|
672
|
-
* `letterHTML` or `letterTemplate`. Input only.
|
|
673
|
-
*/
|
|
674
|
-
letterPDF?: string;
|
|
675
|
-
|
|
676
|
-
/**
|
|
677
|
-
* Body param: ID of a template for an optional attached letter. Cannot be used
|
|
678
|
-
* with `letterHTML` or `letterPDF`.
|
|
679
|
-
*/
|
|
680
|
-
letterTemplate?: string;
|
|
681
|
-
|
|
682
|
-
/**
|
|
683
|
-
* Body param: A publicly accessible URL for the logo to print on the cheque. Set
|
|
684
|
-
* to `null` to remove during update.
|
|
685
|
-
*/
|
|
686
|
-
logo?: string | null;
|
|
687
|
-
|
|
688
|
-
/**
|
|
689
|
-
* Body param: Mailing class. Generally must be first class (or equivalent for
|
|
690
|
-
* destination country) for cheques.
|
|
691
|
-
*/
|
|
692
|
-
mailingClass?:
|
|
693
|
-
| 'first_class'
|
|
694
|
-
| 'standard_class'
|
|
695
|
-
| 'express'
|
|
696
|
-
| 'certified'
|
|
697
|
-
| 'certified_return_receipt'
|
|
698
|
-
| 'registered'
|
|
699
|
-
| 'usps_first_class'
|
|
700
|
-
| 'usps_standard_class'
|
|
701
|
-
| 'usps_eddm'
|
|
702
|
-
| 'usps_express_2_day'
|
|
703
|
-
| 'usps_express_3_day'
|
|
704
|
-
| 'usps_first_class_certified'
|
|
705
|
-
| 'usps_first_class_certified_return_receipt'
|
|
706
|
-
| 'usps_first_class_registered'
|
|
707
|
-
| 'usps_express_3_day_signature_confirmation'
|
|
708
|
-
| 'usps_express_3_day_certified'
|
|
709
|
-
| 'usps_express_3_day_certified_return_receipt'
|
|
710
|
-
| 'ca_post_lettermail'
|
|
711
|
-
| 'ca_post_personalized'
|
|
712
|
-
| 'ca_post_neighbourhood_mail'
|
|
713
|
-
| 'ups_express_overnight'
|
|
714
|
-
| 'ups_express_2_day'
|
|
715
|
-
| 'ups_express_3_day'
|
|
716
|
-
| 'royal_mail_first_class'
|
|
717
|
-
| 'royal_mail_second_class'
|
|
718
|
-
| 'au_post_second_class';
|
|
719
|
-
|
|
720
|
-
/**
|
|
721
|
-
* Body param: Memo line text for the cheque. Set to `null` to remove during
|
|
722
|
-
* update.
|
|
723
|
-
*/
|
|
724
|
-
memo?: string | null;
|
|
725
|
-
|
|
726
|
-
/**
|
|
727
|
-
* Body param: Default merge variables for orders created using this profile.
|
|
728
|
-
*/
|
|
729
|
-
mergeVariables?: { [key: string]: unknown } | null;
|
|
730
|
-
|
|
731
|
-
/**
|
|
732
|
-
* Body param: Message included on the cheque stub. Set to `null` to remove during
|
|
733
|
-
* update.
|
|
734
|
-
*/
|
|
735
|
-
message?: string | null;
|
|
736
|
-
|
|
737
|
-
/**
|
|
738
|
-
* Body param: Optional key-value metadata.
|
|
739
|
-
*/
|
|
740
|
-
metadata?: { [key: string]: string } | null;
|
|
741
|
-
}
|
|
742
|
-
|
|
743
|
-
export interface ChequeRetrieveParams {
|
|
744
|
-
/**
|
|
745
|
-
* Optional list of related resources to expand in the response.
|
|
746
|
-
*/
|
|
747
|
-
expand?: Array<string>;
|
|
748
|
-
}
|
|
749
|
-
|
|
750
|
-
export interface ChequeUpdateParams {
|
|
751
|
-
/**
|
|
752
|
-
* Body param: ID of the bank account to use for the cheque. Required for creation.
|
|
753
|
-
*/
|
|
754
|
-
bankAccount: string;
|
|
755
|
-
|
|
756
|
-
/**
|
|
757
|
-
* Body param: Enum representing the supported cheque sizes.
|
|
758
|
-
*/
|
|
759
|
-
size: 'us_letter' | 'us_legal';
|
|
760
|
-
|
|
761
|
-
/**
|
|
762
|
-
* Query param: Optional list of related resources to expand in the response.
|
|
763
|
-
*/
|
|
764
|
-
expand?: Array<string>;
|
|
765
|
-
|
|
766
|
-
/**
|
|
767
|
-
* Body param: Enum representing the supported currency codes.
|
|
768
|
-
*/
|
|
769
|
-
currencyCode?: 'CAD' | 'USD';
|
|
770
|
-
|
|
771
|
-
/**
|
|
772
|
-
* Body param: An optional description for the profile. Set to `null` to remove
|
|
773
|
-
* during update.
|
|
774
|
-
*/
|
|
775
|
-
description?: string | null;
|
|
776
|
-
|
|
777
|
-
/**
|
|
778
|
-
* Body param: Set explicitly to `null` during an update operation to remove the
|
|
779
|
-
* attached letter.
|
|
780
|
-
*/
|
|
781
|
-
letter?: unknown;
|
|
782
|
-
|
|
783
|
-
/**
|
|
784
|
-
* Body param: HTML content for an optional attached letter. Cannot be used with
|
|
785
|
-
* `letterTemplate` or `letterPDF`.
|
|
786
|
-
*/
|
|
787
|
-
letterHTML?: string;
|
|
788
|
-
|
|
789
|
-
/**
|
|
790
|
-
* Body param: PDF file for an optional attached letter. Cannot be used with
|
|
791
|
-
* `letterHTML` or `letterTemplate`. Input only.
|
|
792
|
-
*/
|
|
793
|
-
letterPDF?: string;
|
|
794
|
-
|
|
795
|
-
/**
|
|
796
|
-
* Body param: ID of a template for an optional attached letter. Cannot be used
|
|
797
|
-
* with `letterHTML` or `letterPDF`.
|
|
798
|
-
*/
|
|
799
|
-
letterTemplate?: string;
|
|
800
|
-
|
|
801
|
-
/**
|
|
802
|
-
* Body param: A publicly accessible URL for the logo to print on the cheque. Set
|
|
803
|
-
* to `null` to remove during update.
|
|
804
|
-
*/
|
|
805
|
-
logo?: string | null;
|
|
806
|
-
|
|
807
|
-
/**
|
|
808
|
-
* Body param: Mailing class. Generally must be first class (or equivalent for
|
|
809
|
-
* destination country) for cheques.
|
|
810
|
-
*/
|
|
811
|
-
mailingClass?:
|
|
812
|
-
| 'first_class'
|
|
813
|
-
| 'standard_class'
|
|
814
|
-
| 'express'
|
|
815
|
-
| 'certified'
|
|
816
|
-
| 'certified_return_receipt'
|
|
817
|
-
| 'registered'
|
|
818
|
-
| 'usps_first_class'
|
|
819
|
-
| 'usps_standard_class'
|
|
820
|
-
| 'usps_eddm'
|
|
821
|
-
| 'usps_express_2_day'
|
|
822
|
-
| 'usps_express_3_day'
|
|
823
|
-
| 'usps_first_class_certified'
|
|
824
|
-
| 'usps_first_class_certified_return_receipt'
|
|
825
|
-
| 'usps_first_class_registered'
|
|
826
|
-
| 'usps_express_3_day_signature_confirmation'
|
|
827
|
-
| 'usps_express_3_day_certified'
|
|
828
|
-
| 'usps_express_3_day_certified_return_receipt'
|
|
829
|
-
| 'ca_post_lettermail'
|
|
830
|
-
| 'ca_post_personalized'
|
|
831
|
-
| 'ca_post_neighbourhood_mail'
|
|
832
|
-
| 'ups_express_overnight'
|
|
833
|
-
| 'ups_express_2_day'
|
|
834
|
-
| 'ups_express_3_day'
|
|
835
|
-
| 'royal_mail_first_class'
|
|
836
|
-
| 'royal_mail_second_class'
|
|
837
|
-
| 'au_post_second_class';
|
|
838
|
-
|
|
839
|
-
/**
|
|
840
|
-
* Body param: Memo line text for the cheque. Set to `null` to remove during
|
|
841
|
-
* update.
|
|
842
|
-
*/
|
|
843
|
-
memo?: string | null;
|
|
844
|
-
|
|
845
|
-
/**
|
|
846
|
-
* Body param: Default merge variables for orders created using this profile.
|
|
847
|
-
*/
|
|
848
|
-
mergeVariables?: { [key: string]: unknown } | null;
|
|
849
|
-
|
|
850
|
-
/**
|
|
851
|
-
* Body param: Message included on the cheque stub. Set to `null` to remove during
|
|
852
|
-
* update.
|
|
853
|
-
*/
|
|
854
|
-
message?: string | null;
|
|
855
|
-
|
|
856
|
-
/**
|
|
857
|
-
* Body param: Optional key-value metadata.
|
|
858
|
-
*/
|
|
859
|
-
metadata?: { [key: string]: string } | null;
|
|
860
|
-
}
|
|
861
|
-
|
|
862
|
-
export interface ChequeListParams extends ListParams {
|
|
863
|
-
/**
|
|
864
|
-
* You can supply any string to help narrow down the list of resources. For
|
|
865
|
-
* example, if you pass `"New York"` (quoted), it will return resources that have
|
|
866
|
-
* that string present somewhere in their response. Alternatively, you can supply a
|
|
867
|
-
* structured search query. See the documentation on `StructuredSearchQuery` for
|
|
868
|
-
* more details.
|
|
869
|
-
*/
|
|
870
|
-
search?: string;
|
|
871
|
-
}
|
|
872
|
-
|
|
873
|
-
Cheques.ChequeListResponsesList = ChequeListResponsesList;
|
|
874
|
-
|
|
875
|
-
export declare namespace Cheques {
|
|
876
|
-
export {
|
|
877
|
-
type ChequeCreateResponse as ChequeCreateResponse,
|
|
878
|
-
type ChequeRetrieveResponse as ChequeRetrieveResponse,
|
|
879
|
-
type ChequeUpdateResponse as ChequeUpdateResponse,
|
|
880
|
-
type ChequeListResponse as ChequeListResponse,
|
|
881
|
-
type ChequeDeleteResponse as ChequeDeleteResponse,
|
|
882
|
-
ChequeListResponsesList as ChequeListResponsesList,
|
|
883
|
-
type ChequeCreateParams as ChequeCreateParams,
|
|
884
|
-
type ChequeRetrieveParams as ChequeRetrieveParams,
|
|
885
|
-
type ChequeUpdateParams as ChequeUpdateParams,
|
|
886
|
-
type ChequeListParams as ChequeListParams,
|
|
887
|
-
};
|
|
888
|
-
}
|