npm - postgrid-node - Versions diffs - 0.1.0-alpha.5 → 0.3.0 - Mend

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.

Files changed (907) hide show

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

package/resources/print-mail/letters.d.ts ADDED Viewed

@@ -0,0 +1,1079 @@
+import { APIResource } from "../../core/resource.js";
+import * as BoxesAPI from "./boxes.js";
+import * as ContactsAPI from "./contacts.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Letters extends APIResource {
+    /**
+     * Create a letter. Note that you can supply one of the following:
+     *
+     * - HTML content for the letter
+     * - A template ID for the letter
+     * - A URL or file for a PDF for the letter
+     * - Upload the aforementioned PDF file via a multipart form upload request
+     *
+     * @example
+     * ```ts
+     * const letter = await client.printMail.letters.create({
+     *   from: 'contact_123',
+     *   html: '<html>Content</html>',
+     *   to: 'contact_123',
+     * });
+     * ```
+     */
+    create(body: LetterCreateParams, options?: RequestOptions): APIPromise<Letter>;
+    /**
+     * Retrieve a letter by ID.
+     *
+     * @example
+     * ```ts
+     * const letter = await client.printMail.letters.retrieve(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<Letter>;
+    /**
+     * Get a list of letters.
+     *
+     * @example
+     * ```ts
+     * const letters = await client.printMail.letters.list();
+     * ```
+     */
+    list(query?: LetterListParams | null | undefined, options?: RequestOptions): APIPromise<LetterListResponse>;
+    /**
+     * Cancel a letter by ID. Note that this operation cannot be undone.
+     *
+     * @example
+     * ```ts
+     * const letter = await client.printMail.letters.delete('id');
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<Letter>;
+    /**
+     * Retrieve a letter preview URL.
+     *
+     * This is only available for customers with our document management addon, which
+     * offers document generation and hosting capabilities. This endpoint has a much
+     * higher rate limit than the regular order retrieval endpoint, so it is suitable
+     * for customer-facing use-cases.
+     *
+     * @example
+     * ```ts
+     * const response = await client.printMail.letters.retrieveURL(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieveURL(id: string, options?: RequestOptions): APIPromise<LetterRetrieveURLResponse>;
+}
+/**
+ * Enum representing the placement of the address on the letter.
+ */
+export type AddressPlacement = 'top_first_page' | 'insert_blank_page';
+/**
+ * Model representing an attached PDF.
+ */
+export interface AttachedPdf {
+    /**
+     * The file (multipart form upload) or URL pointing to a PDF for the attached PDF.
+     */
+    file: string;
+    /**
+     * Enum representing the placement of the attached PDF.
+     */
+    placement: 'before_template' | 'after_template';
+}
+export interface Letter {
+    /**
+     * A unique ID prefixed with letter\_
+     */
+    id: string;
+    /**
+     * Enum representing the placement of the address on the letter.
+     */
+    addressPlacement: AddressPlacement;
+    /**
+     * Indicates if the letter is in color.
+     */
+    color: boolean;
+    /**
+     * The UTC time at which this resource was created.
+     */
+    createdAt: string;
+    /**
+     * Indicates if the letter is double-sided.
+     */
+    doubleSided: boolean;
+    /**
+     * The envelope (ID) for the letter or the default `standard` envelope.
+     */
+    envelope: string;
+    /**
+     * The contact information of the sender.
+     */
+    from: ContactsAPI.Contact;
+    /**
+     * `true` if this is a live mode resource else `false`.
+     */
+    live: boolean;
+    /**
+     * The mailing class of this order. This determines the speed and cost of delivery.
+     * See `OrderMailingClass` for more details.
+     */
+    mailingClass: BoxesAPI.OrderMailingClass;
+    /**
+     * Always `letter`.
+     */
+    object: 'letter';
+    /**
+     * This order will transition from `ready` to `printing` on the day after this
+     * date. For example, if this is a date on Tuesday, the order will transition to
+     * `printing` on Wednesday at midnight eastern time.
+     */
+    sendDate: string;
+    /**
+     * Enum representing the supported letter sizes.
+     */
+    size: LetterSize;
+    /**
+     * See `OrderStatus` for more details on the status of this order.
+     */
+    status: BoxesAPI.OrderStatus;
+    /**
+     * The recipient of this order. This will be provided even if you delete the
+     * underlying contact.
+     */
+    to: ContactsAPI.Contact;
+    /**
+     * The UTC time at which this resource was last updated.
+     */
+    updatedAt: string;
+    /**
+     * Model representing an attached PDF.
+     */
+    attachedPDF?: AttachedPdf;
+    /**
+     * The cancellation details of this order. Populated if the order has been
+     * cancelled.
+     */
+    cancellation?: BoxesAPI.Cancellation;
+    /**
+     * An optional string describing this resource. Will be visible in the API and the
+     * dashboard.
+     */
+    description?: string;
+    /**
+     * The HTML content for the letter. You can supply _either_ this or `template` but
+     * not both.
+     */
+    html?: string;
+    /**
+     * The last date that the IMB status was updated. See `imbStatus` for more details.
+     */
+    imbDate?: string;
+    /**
+     * The Intelligent Mail Barcode (IMB) status of this order. Only populated for
+     * US-printed and US-destined orders. This is the most detailed way to track
+     * non-express/certified orders.
+     */
+    imbStatus?: BoxesAPI.OrderImbStatus;
+    /**
+     * The most recent ZIP code of the USPS facility that the order has been processed
+     * through. Only populated when an `imbStatus` is present.
+     */
+    imbZIPCode?: string;
+    /**
+     * These will be merged with the variables in the template or HTML you create this
+     * order with. The keys in this object should match the variable names in the
+     * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
+     * PDFs uploaded with the order.
+     */
+    mergeVariables?: {
+        [key: string]: unknown;
+    };
+    /**
+     * See the section on Metadata.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * The ID of the PDF workflow run that created the letter, if any.
+     */
+    pdfWorkflowRun?: string;
+    /**
+     * If specified, indicates which letter page is perforated. Currently, only the
+     * first page can be perforated.
+     */
+    perforatedPage?: 1;
+    /**
+     * Model representing a plastic card.
+     */
+    plasticCard?: PlasticCard;
+    /**
+     * The return envelope (ID) sent out with the letter, if any.
+     */
+    returnEnvelope?: string;
+    /**
+     * The template ID used for the letter. You can supply _either_ this or `html` but
+     * not both.
+     */
+    template?: string;
+    /**
+     * The tracking number of this order. Populated after an express/certified order
+     * has been processed for delivery.
+     */
+    trackingNumber?: string;
+    /**
+     * If a PDF was uploaded for the letter, this will contain the signed link to the
+     * uploaded PDF.
+     */
+    uploadedPDF?: string;
+    /**
+     * PostGrid renders a PDF preview for all orders. This should be inspected to
+     * ensure that the order is correct before it is sent out because it shows what
+     * will be printed and mailed to the recipient. Once the PDF preview is generated,
+     * this field will be returned by all `GET` endpoints which produce this order.
+     *
+     * This URL is a signed link to the PDF preview. It will expire after a short
+     * period of time. If you need to access this URL after it has expired, you can
+     * regenerate it by calling the `GET` endpoint again.
+     */
+    url?: string;
+}
+/**
+ * Enum representing the supported letter sizes.
+ */
+export type LetterSize = 'us_letter' | 'a4';
+/**
+ * Model representing a plastic card.
+ */
+export interface PlasticCard {
+    /**
+     * Enum representing the size of the plastic card.
+     */
+    size: 'standard';
+    /**
+     * Model representing a double-sided plastic card.
+     */
+    doubleSided?: PlasticCard.DoubleSided;
+    /**
+     * Model representing a single-sided plastic card.
+     */
+    singleSided?: PlasticCard.SingleSided;
+}
+export declare namespace PlasticCard {
+    /**
+     * Model representing a double-sided plastic card.
+     */
+    interface DoubleSided {
+        /**
+         * The HTML content for the back side of the double-sided plastic card.
+         */
+        backHTML?: string;
+        /**
+         * The template ID for the back side of the double-sided plastic card.
+         */
+        backTemplate?: string;
+        /**
+         * The HTML content for the front side of the double-sided plastic card.
+         */
+        frontHTML?: string;
+        /**
+         * The template ID for the front side of the double-sided plastic card.
+         */
+        frontTemplate?: string;
+        /**
+         * A URL pointing to a PDF file for the double-sided plastic card or the file
+         * itself.
+         */
+        pdf?: string;
+    }
+    /**
+     * Model representing a single-sided plastic card.
+     */
+    interface SingleSided {
+        /**
+         * The HTML content for the single-sided plastic card. Can specify one of this,
+         * `template`, or `pdf`.
+         */
+        html?: string;
+        /**
+         * A URL pointing to a PDF file for the single-sided plastic card or the PDF file
+         * itself.
+         */
+        pdf?: string;
+        /**
+         * The template ID for the single-sided plastic card.
+         */
+        template?: string;
+    }
+}
+export interface LetterListResponse {
+    data: Array<Letter>;
+    limit: number;
+    object: 'list';
+    skip: number;
+    totalCount: number;
+}
+export interface LetterRetrieveURLResponse {
+    /**
+     * A unique ID prefixed with letter\_
+     */
+    id: string;
+    object: string;
+    /**
+     * A signed URL linking to the order preview PDF. The link remains valid for 15
+     * minutes from the time of the API call.
+     */
+    url: string;
+}
+export type LetterCreateParams = LetterCreateParams.LetterCreateWithHTML | LetterCreateParams.LetterCreateWithTemplate | LetterCreateParams.LetterCreateWithPdf;
+export declare namespace LetterCreateParams {
+    interface LetterCreateWithHTML {
+        /**
+         * The contact information of the sender. You can pass contact information inline
+         * here just like you can for the `to`.
+         */
+        from: LetterCreateWithHTML.ContactCreateWithFirstName | LetterCreateWithHTML.ContactCreateWithCompanyName | string;
+        /**
+         * The HTML content for the letter. You can supply _either_ this or `template` but
+         * not both.
+         */
+        html: string;
+        /**
+         * The recipient of this order. You can either supply the contact information
+         * inline here or provide a contact ID. PostGrid will automatically deduplicate
+         * contacts regardless of whether you provide the information inline here or call
+         * the contact creation endpoint.
+         */
+        to: LetterCreateWithHTML.ContactCreateWithFirstName | LetterCreateWithHTML.ContactCreateWithCompanyName | string;
+        /**
+         * Enum representing the placement of the address on the letter.
+         */
+        addressPlacement?: AddressPlacement;
+        /**
+         * Model representing an attached PDF.
+         */
+        attachedPDF?: AttachedPdf;
+        /**
+         * Indicates if the letter is in color.
+         */
+        color?: boolean;
+        /**
+         * An optional string describing this resource. Will be visible in the API and the
+         * dashboard.
+         */
+        description?: string;
+        /**
+         * Indicates if the letter is double-sided.
+         */
+        doubleSided?: boolean;
+        /**
+         * The envelope (ID) for the letter. You can either specify a custom envelope ID or
+         * use the default `standard` envelope.
+         */
+        envelope?: string;
+        /**
+         * The mailing class of this order. If not provided, automatically set to
+         * `first_class`.
+         */
+        mailingClass?: BoxesAPI.OrderMailingClass;
+        /**
+         * These will be merged with the variables in the template or HTML you create this
+         * order with. The keys in this object should match the variable names in the
+         * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
+         * PDFs uploaded with the order.
+         */
+        mergeVariables?: {
+            [key: string]: unknown;
+        };
+        /**
+         * See the section on Metadata.
+         */
+        metadata?: {
+            [key: string]: unknown;
+        };
+        /**
+         * If specified, indicates which letter page is perforated. Currently, only the
+         * first page can be perforated.
+         */
+        perforatedPage?: 1;
+        /**
+         * Model representing a plastic card.
+         */
+        plasticCard?: PlasticCard;
+        /**
+         * The return envelope (ID) sent out with the letter, if any.
+         */
+        returnEnvelope?: string;
+        /**
+         * This order will transition from `ready` to `printing` on the day after this
+         * date. You can use this parameter to schedule orders for a future date.
+         */
+        sendDate?: string;
+        /**
+         * Enum representing the supported letter sizes.
+         */
+        size?: LetterSize;
+    }
+    namespace LetterCreateWithHTML {
+        interface ContactCreateWithFirstName {
+            /**
+             * The first line of the contact's address.
+             */
+            addressLine1: string;
+            /**
+             * The ISO 3611-1 country code of the contact's address.
+             */
+            countryCode: string;
+            firstName: string;
+            /**
+             * Second line of the contact's address, if applicable.
+             */
+            addressLine2?: string;
+            /**
+             * The city of the contact's address.
+             */
+            city?: string;
+            /**
+             * Company name of the contact.
+             */
+            companyName?: string;
+            /**
+             * An optional string describing this resource. Will be visible in the API and the
+             * dashboard.
+             */
+            description?: string;
+            /**
+             * Email of the contact.
+             */
+            email?: string;
+            /**
+             * If `true`, PostGrid will force this contact to have an `addressStatus` of
+             * `verified` even if our address verification system says otherwise.
+             */
+            forceVerifiedStatus?: boolean;
+            /**
+             * Job title of the contact.
+             */
+            jobTitle?: string;
+            /**
+             * Last name of the contact.
+             */
+            lastName?: string;
+            /**
+             * See the section on Metadata.
+             */
+            metadata?: {
+                [key: string]: unknown;
+            };
+            /**
+             * Phone number of the contact.
+             */
+            phoneNumber?: string;
+            /**
+             * The postal or ZIP code of the contact's address.
+             */
+            postalOrZip?: string;
+            /**
+             * Province or state of the contact's address.
+             */
+            provinceOrState?: string;
+            /**
+             * If `true`, PostGrid will skip running this contact's address through our address
+             * verification system.
+             */
+            skipVerification?: boolean;
+        }
+        interface ContactCreateWithCompanyName {
+            /**
+             * The first line of the contact's address.
+             */
+            addressLine1: string;
+            companyName: string;
+            /**
+             * The ISO 3611-1 country code of the contact's address.
+             */
+            countryCode: string;
+            /**
+             * Second line of the contact's address, if applicable.
+             */
+            addressLine2?: string;
+            /**
+             * The city of the contact's address.
+             */
+            city?: string;
+            /**
+             * An optional string describing this resource. Will be visible in the API and the
+             * dashboard.
+             */
+            description?: string;
+            /**
+             * Email of the contact.
+             */
+            email?: string;
+            /**
+             * First name of the contact.
+             */
+            firstName?: string;
+            /**
+             * If `true`, PostGrid will force this contact to have an `addressStatus` of
+             * `verified` even if our address verification system says otherwise.
+             */
+            forceVerifiedStatus?: boolean;
+            /**
+             * Job title of the contact.
+             */
+            jobTitle?: string;
+            /**
+             * Last name of the contact.
+             */
+            lastName?: string;
+            /**
+             * See the section on Metadata.
+             */
+            metadata?: {
+                [key: string]: unknown;
+            };
+            /**
+             * Phone number of the contact.
+             */
+            phoneNumber?: string;
+            /**
+             * The postal or ZIP code of the contact's address.
+             */
+            postalOrZip?: string;
+            /**
+             * Province or state of the contact's address.
+             */
+            provinceOrState?: string;
+            /**
+             * If `true`, PostGrid will skip running this contact's address through our address
+             * verification system.
+             */
+            skipVerification?: boolean;
+        }
+        interface ContactCreateWithFirstName {
+            /**
+             * The first line of the contact's address.
+             */
+            addressLine1: string;
+            /**
+             * The ISO 3611-1 country code of the contact's address.
+             */
+            countryCode: string;
+            firstName: string;
+            /**
+             * Second line of the contact's address, if applicable.
+             */
+            addressLine2?: string;
+            /**
+             * The city of the contact's address.
+             */
+            city?: string;
+            /**
+             * Company name of the contact.
+             */
+            companyName?: string;
+            /**
+             * An optional string describing this resource. Will be visible in the API and the
+             * dashboard.
+             */
+            description?: string;
+            /**
+             * Email of the contact.
+             */
+            email?: string;
+            /**
+             * If `true`, PostGrid will force this contact to have an `addressStatus` of
+             * `verified` even if our address verification system says otherwise.
+             */
+            forceVerifiedStatus?: boolean;
+            /**
+             * Job title of the contact.
+             */
+            jobTitle?: string;
+            /**
+             * Last name of the contact.
+             */
+            lastName?: string;
+            /**
+             * See the section on Metadata.
+             */
+            metadata?: {
+                [key: string]: unknown;
+            };
+            /**
+             * Phone number of the contact.
+             */
+            phoneNumber?: string;
+            /**
+             * The postal or ZIP code of the contact's address.
+             */
+            postalOrZip?: string;
+            /**
+             * Province or state of the contact's address.
+             */
+            provinceOrState?: string;
+            /**
+             * If `true`, PostGrid will skip running this contact's address through our address
+             * verification system.
+             */
+            skipVerification?: boolean;
+        }
+        interface ContactCreateWithCompanyName {
+            /**
+             * The first line of the contact's address.
+             */
+            addressLine1: string;
+            companyName: string;
+            /**
+             * The ISO 3611-1 country code of the contact's address.
+             */
+            countryCode: string;
+            /**
+             * Second line of the contact's address, if applicable.
+             */
+            addressLine2?: string;
+            /**
+             * The city of the contact's address.
+             */
+            city?: string;
+            /**
+             * An optional string describing this resource. Will be visible in the API and the
+             * dashboard.
+             */
+            description?: string;
+            /**
+             * Email of the contact.
+             */
+            email?: string;
+            /**
+             * First name of the contact.
+             */
+            firstName?: string;
+            /**
+             * If `true`, PostGrid will force this contact to have an `addressStatus` of
+             * `verified` even if our address verification system says otherwise.
+             */
+            forceVerifiedStatus?: boolean;
+            /**
+             * Job title of the contact.
+             */
+            jobTitle?: string;
+            /**
+             * Last name of the contact.
+             */
+            lastName?: string;
+            /**
+             * See the section on Metadata.
+             */
+            metadata?: {
+                [key: string]: unknown;
+            };
+            /**
+             * Phone number of the contact.
+             */
+            phoneNumber?: string;
+            /**
+             * The postal or ZIP code of the contact's address.
+             */
+            postalOrZip?: string;
+            /**
+             * Province or state of the contact's address.
+             */
+            provinceOrState?: string;
+            /**
+             * If `true`, PostGrid will skip running this contact's address through our address
+             * verification system.
+             */
+            skipVerification?: boolean;
+        }
+    }
+    interface LetterCreateWithTemplate {
+        /**
+         * The template ID for the letter. You can supply _either_ this or `html` but not
+         * both.
+         */
+        template: string;
+    }
+    interface LetterCreateWithPdf {
+        /**
+         * The contact information of the sender. You can pass contact information inline
+         * here just like you can for the `to`.
+         */
+        from: LetterCreateWithPdf.ContactCreateWithFirstName | LetterCreateWithPdf.ContactCreateWithCompanyName | string;
+        /**
+         * A URL pointing to a PDF file for the letter or the PDF file itself.
+         */
+        pdf: string;
+        /**
+         * The recipient of this order. You can either supply the contact information
+         * inline here or provide a contact ID. PostGrid will automatically deduplicate
+         * contacts regardless of whether you provide the information inline here or call
+         * the contact creation endpoint.
+         */
+        to: LetterCreateWithPdf.ContactCreateWithFirstName | LetterCreateWithPdf.ContactCreateWithCompanyName | string;
+        /**
+         * Enum representing the placement of the address on the letter.
+         */
+        addressPlacement?: AddressPlacement;
+        /**
+         * Model representing an attached PDF.
+         */
+        attachedPDF?: AttachedPdf;
+        /**
+         * Indicates if the letter is in color.
+         */
+        color?: boolean;
+        /**
+         * An optional string describing this resource. Will be visible in the API and the
+         * dashboard.
+         */
+        description?: string;
+        /**
+         * Indicates if the letter is double-sided.
+         */
+        doubleSided?: boolean;
+        /**
+         * The envelope (ID) for the letter. You can either specify a custom envelope ID or
+         * use the default `standard` envelope.
+         */
+        envelope?: string;
+        /**
+         * The mailing class of this order. If not provided, automatically set to
+         * `first_class`.
+         */
+        mailingClass?: BoxesAPI.OrderMailingClass;
+        /**
+         * These will be merged with the variables in the template or HTML you create this
+         * order with. The keys in this object should match the variable names in the
+         * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
+         * PDFs uploaded with the order.
+         */
+        mergeVariables?: {
+            [key: string]: unknown;
+        };
+        /**
+         * See the section on Metadata.
+         */
+        metadata?: {
+            [key: string]: unknown;
+        };
+        /**
+         * If specified, indicates which letter page is perforated. Currently, only the
+         * first page can be perforated.
+         */
+        perforatedPage?: 1;
+        /**
+         * Model representing a plastic card.
+         */
+        plasticCard?: PlasticCard;
+        /**
+         * The return envelope (ID) sent out with the letter, if any.
+         */
+        returnEnvelope?: string;
+        /**
+         * This order will transition from `ready` to `printing` on the day after this
+         * date. You can use this parameter to schedule orders for a future date.
+         */
+        sendDate?: string;
+        /**
+         * Enum representing the supported letter sizes.
+         */
+        size?: LetterSize;
+    }
+    namespace LetterCreateWithPdf {
+        interface ContactCreateWithFirstName {
+            /**
+             * The first line of the contact's address.
+             */
+            addressLine1: string;
+            /**
+             * The ISO 3611-1 country code of the contact's address.
+             */
+            countryCode: string;
+            firstName: string;
+            /**
+             * Second line of the contact's address, if applicable.
+             */
+            addressLine2?: string;
+            /**
+             * The city of the contact's address.
+             */
+            city?: string;
+            /**
+             * Company name of the contact.
+             */
+            companyName?: string;
+            /**
+             * An optional string describing this resource. Will be visible in the API and the
+             * dashboard.
+             */
+            description?: string;
+            /**
+             * Email of the contact.
+             */
+            email?: string;
+            /**
+             * If `true`, PostGrid will force this contact to have an `addressStatus` of
+             * `verified` even if our address verification system says otherwise.
+             */
+            forceVerifiedStatus?: boolean;
+            /**
+             * Job title of the contact.
+             */
+            jobTitle?: string;
+            /**
+             * Last name of the contact.
+             */
+            lastName?: string;
+            /**
+             * See the section on Metadata.
+             */
+            metadata?: {
+                [key: string]: unknown;
+            };
+            /**
+             * Phone number of the contact.
+             */
+            phoneNumber?: string;
+            /**
+             * The postal or ZIP code of the contact's address.
+             */
+            postalOrZip?: string;
+            /**
+             * Province or state of the contact's address.
+             */
+            provinceOrState?: string;
+            /**
+             * If `true`, PostGrid will skip running this contact's address through our address
+             * verification system.
+             */
+            skipVerification?: boolean;
+        }
+        interface ContactCreateWithCompanyName {
+            /**
+             * The first line of the contact's address.
+             */
+            addressLine1: string;
+            companyName: string;
+            /**
+             * The ISO 3611-1 country code of the contact's address.
+             */
+            countryCode: string;
+            /**
+             * Second line of the contact's address, if applicable.
+             */
+            addressLine2?: string;
+            /**
+             * The city of the contact's address.
+             */
+            city?: string;
+            /**
+             * An optional string describing this resource. Will be visible in the API and the
+             * dashboard.
+             */
+            description?: string;
+            /**
+             * Email of the contact.
+             */
+            email?: string;
+            /**
+             * First name of the contact.
+             */
+            firstName?: string;
+            /**
+             * If `true`, PostGrid will force this contact to have an `addressStatus` of
+             * `verified` even if our address verification system says otherwise.
+             */
+            forceVerifiedStatus?: boolean;
+            /**
+             * Job title of the contact.
+             */
+            jobTitle?: string;
+            /**
+             * Last name of the contact.
+             */
+            lastName?: string;
+            /**
+             * See the section on Metadata.
+             */
+            metadata?: {
+                [key: string]: unknown;
+            };
+            /**
+             * Phone number of the contact.
+             */
+            phoneNumber?: string;
+            /**
+             * The postal or ZIP code of the contact's address.
+             */
+            postalOrZip?: string;
+            /**
+             * Province or state of the contact's address.
+             */
+            provinceOrState?: string;
+            /**
+             * If `true`, PostGrid will skip running this contact's address through our address
+             * verification system.
+             */
+            skipVerification?: boolean;
+        }
+        interface ContactCreateWithFirstName {
+            /**
+             * The first line of the contact's address.
+             */
+            addressLine1: string;
+            /**
+             * The ISO 3611-1 country code of the contact's address.
+             */
+            countryCode: string;
+            firstName: string;
+            /**
+             * Second line of the contact's address, if applicable.
+             */
+            addressLine2?: string;
+            /**
+             * The city of the contact's address.
+             */
+            city?: string;
+            /**
+             * Company name of the contact.
+             */
+            companyName?: string;
+            /**
+             * An optional string describing this resource. Will be visible in the API and the
+             * dashboard.
+             */
+            description?: string;
+            /**
+             * Email of the contact.
+             */
+            email?: string;
+            /**
+             * If `true`, PostGrid will force this contact to have an `addressStatus` of
+             * `verified` even if our address verification system says otherwise.
+             */
+            forceVerifiedStatus?: boolean;
+            /**
+             * Job title of the contact.
+             */
+            jobTitle?: string;
+            /**
+             * Last name of the contact.
+             */
+            lastName?: string;
+            /**
+             * See the section on Metadata.
+             */
+            metadata?: {
+                [key: string]: unknown;
+            };
+            /**
+             * Phone number of the contact.
+             */
+            phoneNumber?: string;
+            /**
+             * The postal or ZIP code of the contact's address.
+             */
+            postalOrZip?: string;
+            /**
+             * Province or state of the contact's address.
+             */
+            provinceOrState?: string;
+            /**
+             * If `true`, PostGrid will skip running this contact's address through our address
+             * verification system.
+             */
+            skipVerification?: boolean;
+        }
+        interface ContactCreateWithCompanyName {
+            /**
+             * The first line of the contact's address.
+             */
+            addressLine1: string;
+            companyName: string;
+            /**
+             * The ISO 3611-1 country code of the contact's address.
+             */
+            countryCode: string;
+            /**
+             * Second line of the contact's address, if applicable.
+             */
+            addressLine2?: string;
+            /**
+             * The city of the contact's address.
+             */
+            city?: string;
+            /**
+             * An optional string describing this resource. Will be visible in the API and the
+             * dashboard.
+             */
+            description?: string;
+            /**
+             * Email of the contact.
+             */
+            email?: string;
+            /**
+             * First name of the contact.
+             */
+            firstName?: string;
+            /**
+             * If `true`, PostGrid will force this contact to have an `addressStatus` of
+             * `verified` even if our address verification system says otherwise.
+             */
+            forceVerifiedStatus?: boolean;
+            /**
+             * Job title of the contact.
+             */
+            jobTitle?: string;
+            /**
+             * Last name of the contact.
+             */
+            lastName?: string;
+            /**
+             * See the section on Metadata.
+             */
+            metadata?: {
+                [key: string]: unknown;
+            };
+            /**
+             * Phone number of the contact.
+             */
+            phoneNumber?: string;
+            /**
+             * The postal or ZIP code of the contact's address.
+             */
+            postalOrZip?: string;
+            /**
+             * Province or state of the contact's address.
+             */
+            provinceOrState?: string;
+            /**
+             * If `true`, PostGrid will skip running this contact's address through our address
+             * verification system.
+             */
+            skipVerification?: boolean;
+        }
+    }
+}
+export interface LetterListParams {
+    limit?: number;
+    /**
+     * You can supply any string to help narrow down the list of resources. For
+     * example, if you pass `"New York"` (quoted), it will return resources that have
+     * that string present somewhere in their response. Alternatively, you can supply a
+     * structured search query. See the documentation on `StructuredSearchQuery` for
+     * more details.
+     */
+    search?: string;
+    skip?: number;
+}
+export declare namespace Letters {
+    export { type AddressPlacement as AddressPlacement, type AttachedPdf as AttachedPdf, type Letter as Letter, type LetterSize as LetterSize, type PlasticCard as PlasticCard, type LetterListResponse as LetterListResponse, type LetterRetrieveURLResponse as LetterRetrieveURLResponse, type LetterCreateParams as LetterCreateParams, type LetterListParams as LetterListParams, };
+}
+//# sourceMappingURL=letters.d.ts.map