postgrid-node 0.1.0-alpha.4 → 0.2.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 +85 -0
- package/LICENSE +1 -1
- package/README.md +124 -85
- 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 +112 -78
- 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/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,90 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.2.0 (2025-11-06)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.1.0-alpha.7...v0.2.0](https://github.com/postgrid/postgrid-node/compare/v0.1.0-alpha.7...v0.2.0)
|
|
6
|
+
|
|
7
|
+
### Chores
|
|
8
|
+
|
|
9
|
+
* update SDK settings ([b77eaca](https://github.com/postgrid/postgrid-node/commit/b77eacae34e549dec20cbaabf417bac4a26d4bfe))
|
|
10
|
+
|
|
11
|
+
## 0.1.0-alpha.7 (2025-11-05)
|
|
12
|
+
|
|
13
|
+
Full Changelog: [v0.1.0-alpha.6...v0.1.0-alpha.7](https://github.com/postgrid/postgrid-node/compare/v0.1.0-alpha.6...v0.1.0-alpha.7)
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
|
|
17
|
+
* **api:** manual updates ([d5bec88](https://github.com/postgrid/postgrid-node/commit/d5bec887542cd3fc6075f77c110d1a30510d8c8a))
|
|
18
|
+
|
|
19
|
+
## 0.1.0-alpha.6 (2025-11-04)
|
|
20
|
+
|
|
21
|
+
Full Changelog: [v0.1.0-alpha.5...v0.1.0-alpha.6](https://github.com/postgrid/postgrid-node/compare/v0.1.0-alpha.5...v0.1.0-alpha.6)
|
|
22
|
+
|
|
23
|
+
### Features
|
|
24
|
+
|
|
25
|
+
* **api:** manual updates ([0e2cb4a](https://github.com/postgrid/postgrid-node/commit/0e2cb4a4eba86345e95e9f65b097e580a1f9504d))
|
|
26
|
+
* **api:** manual updates ([f6cda5b](https://github.com/postgrid/postgrid-node/commit/f6cda5b4c5b65b7553a728072da1a75a9297d7e8))
|
|
27
|
+
* **api:** manual updates ([2292eba](https://github.com/postgrid/postgrid-node/commit/2292ebacebbe33cb6506791f298f0a1cadc90bc1))
|
|
28
|
+
* **api:** manual updates ([cb905a8](https://github.com/postgrid/postgrid-node/commit/cb905a8fe663a31c71a9fcecffb8dc191f7b5502))
|
|
29
|
+
* **api:** manual updates ([5e28201](https://github.com/postgrid/postgrid-node/commit/5e2820166ebf3ed1d44c81a747cc6eaee07ba25f))
|
|
30
|
+
* **api:** manual updates ([0d9444a](https://github.com/postgrid/postgrid-node/commit/0d9444af25deee78035a553a7cf0c4e3e0fee2b8))
|
|
31
|
+
* **api:** manual updates ([4ba55b4](https://github.com/postgrid/postgrid-node/commit/4ba55b4f14fcfb7e30989256798af7c17ad12b7d))
|
|
32
|
+
* **api:** manual updates ([5c99f89](https://github.com/postgrid/postgrid-node/commit/5c99f89c149535a95457e1dad589442f6929e057))
|
|
33
|
+
* **api:** manual updates ([8a8263b](https://github.com/postgrid/postgrid-node/commit/8a8263b3486dfaff379eed4c0de05f2edb0c3f46))
|
|
34
|
+
* **api:** manual updates ([6bfa765](https://github.com/postgrid/postgrid-node/commit/6bfa765001e8e1388aaa2cfa89dd586269a72cc3))
|
|
35
|
+
* **api:** manual updates ([6c6f765](https://github.com/postgrid/postgrid-node/commit/6c6f765a5344da461466d54eff27f7be2b3f66cf))
|
|
36
|
+
* **api:** manual updates ([b4e2f75](https://github.com/postgrid/postgrid-node/commit/b4e2f754489d343477e3aacf7f58622b2fb00f40))
|
|
37
|
+
* **api:** manual updates ([0b3222d](https://github.com/postgrid/postgrid-node/commit/0b3222d1182fa3e1a42d81607e0f18bb70369178))
|
|
38
|
+
* **api:** manual updates ([af5db50](https://github.com/postgrid/postgrid-node/commit/af5db50eb9fd8733cbbed0430cdebadd794241a1))
|
|
39
|
+
* **api:** manual updates ([7affe60](https://github.com/postgrid/postgrid-node/commit/7affe6098d10d0fcf531f30de6f511e3759cbacf))
|
|
40
|
+
* **api:** manual updates to merge PM and AV ([9692120](https://github.com/postgrid/postgrid-node/commit/9692120e792062a8a9d05456a19cc6036e707045))
|
|
41
|
+
* **api:** Select API key based on URL ([a4ef8c0](https://github.com/postgrid/postgrid-node/commit/a4ef8c01bf57319a3b44a8dca5620fb65a6e9907))
|
|
42
|
+
* **api:** support both API auth schemes ([8dc1bf5](https://github.com/postgrid/postgrid-node/commit/8dc1bf5d1b5ebfe51a3e525d3787606e49369f54))
|
|
43
|
+
* **api:** Update OpenAPI spec ([5e33ca6](https://github.com/postgrid/postgrid-node/commit/5e33ca64240823dd689ed70bbf413bccf1c78e3b))
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
### Bug Fixes
|
|
47
|
+
|
|
48
|
+
* **api:** Examples for AV ([2e0d345](https://github.com/postgrid/postgrid-node/commit/2e0d34544da280ab9dca98c305f12bc1f80e28a7))
|
|
49
|
+
* **api:** header assignment in prepareRequest method ([39ea7ed](https://github.com/postgrid/postgrid-node/commit/39ea7edb8a15adf25bdb0e6df001c713b93a4e94))
|
|
50
|
+
* **api:** restructuring under printMail and addver ([c576dbe](https://github.com/postgrid/postgrid-node/commit/c576dbe5df4d59a84c55f36cc9d33ade25a045dc))
|
|
51
|
+
* coerce nullable values to undefined ([16b5f52](https://github.com/postgrid/postgrid-node/commit/16b5f52b376752133d92213fcdc48001c3d723b5))
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
### Performance Improvements
|
|
55
|
+
|
|
56
|
+
* faster formatting ([669e461](https://github.com/postgrid/postgrid-node/commit/669e4618266377faf093b575d65a1e06db6fb957))
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
### Chores
|
|
60
|
+
|
|
61
|
+
* **api:** more docs ([9f44e29](https://github.com/postgrid/postgrid-node/commit/9f44e29c300d7df16f65e2dfef7c3ba73afc46d5))
|
|
62
|
+
* **api:** rename API endpoints for AV ([548d9e3](https://github.com/postgrid/postgrid-node/commit/548d9e3085ecb23b038da86ad74284545494f101))
|
|
63
|
+
* **api:** Update OpenAPI schema ([2a29dbc](https://github.com/postgrid/postgrid-node/commit/2a29dbc33aea71d4348e295c203c5c6166b07531))
|
|
64
|
+
* **deps:** update dependency node-fetch to v2.6.13 ([9d18c47](https://github.com/postgrid/postgrid-node/commit/9d18c477e6993a11e5e99a5f1767ccb6f5ca5cd7))
|
|
65
|
+
* do not install brew dependencies in ./scripts/bootstrap by default ([92cd0ec](https://github.com/postgrid/postgrid-node/commit/92cd0ec15019dc755fd2c5d25000dc79a26e9200))
|
|
66
|
+
* **internal:** codegen related update ([b00d3ff](https://github.com/postgrid/postgrid-node/commit/b00d3ffeb99b8a74d7d372bd066e8a8b808cd519))
|
|
67
|
+
* **internal:** codegen related update ([a8ec314](https://github.com/postgrid/postgrid-node/commit/a8ec314e8edbe03fab399e323b9b73912749172b))
|
|
68
|
+
* **internal:** fix incremental formatting in some cases ([2e13552](https://github.com/postgrid/postgrid-node/commit/2e135520c1c15d414dec4ee05377644613a2be20))
|
|
69
|
+
* **internal:** formatting change ([36db802](https://github.com/postgrid/postgrid-node/commit/36db802aa9e9c4eccf281ab0f846fb039ea4152d))
|
|
70
|
+
* **internal:** ignore .eslintcache ([a0a4bd3](https://github.com/postgrid/postgrid-node/commit/a0a4bd3b359f8e1f97b8010ef70aade58c3b701f))
|
|
71
|
+
* **internal:** remove .eslintcache ([c2a1b69](https://github.com/postgrid/postgrid-node/commit/c2a1b697036a5d99876e5c14a748a004f45d581b))
|
|
72
|
+
* **internal:** remove deprecated `compilerOptions.baseUrl` from tsconfig.json ([867309f](https://github.com/postgrid/postgrid-node/commit/867309fd42d75fdca870c4dbc532769626408428))
|
|
73
|
+
* **internal:** update comment in script ([0f4e66e](https://github.com/postgrid/postgrid-node/commit/0f4e66ee5aaf00c64d332c1924062f024ae1df13))
|
|
74
|
+
* **internal:** use npm pack for build uploads ([db5fba9](https://github.com/postgrid/postgrid-node/commit/db5fba95b07d3e51da3e54005a46d186f2755c40))
|
|
75
|
+
* update @stainless-api/prism-cli to v5.15.0 ([4640767](https://github.com/postgrid/postgrid-node/commit/46407677b2142f0a99834bd5a626a119f36fe463))
|
|
76
|
+
* update CI script ([1adf9d4](https://github.com/postgrid/postgrid-node/commit/1adf9d4dc106b6c31f99e709017b1b85070ac8a5))
|
|
77
|
+
* update SDK settings ([45e20aa](https://github.com/postgrid/postgrid-node/commit/45e20aab8340be7c79151e52ca8fb503a6aa57c7))
|
|
78
|
+
|
|
79
|
+
## 0.1.0-alpha.5 (2025-08-07)
|
|
80
|
+
|
|
81
|
+
Full Changelog: [v0.1.0-alpha.4...v0.1.0-alpha.5](https://github.com/postgrid/postgrid-node/compare/v0.1.0-alpha.4...v0.1.0-alpha.5)
|
|
82
|
+
|
|
83
|
+
### Chores
|
|
84
|
+
|
|
85
|
+
* **internal:** move publish config ([d54ef96](https://github.com/postgrid/postgrid-node/commit/d54ef96aaead49055df7ec142379824f6e6d98c3))
|
|
86
|
+
* **internal:** remove redundant imports config ([744c409](https://github.com/postgrid/postgrid-node/commit/744c409582f6af93168e3d75d9b2f53ee367e182))
|
|
87
|
+
|
|
3
88
|
## 0.1.0-alpha.4 (2025-07-24)
|
|
4
89
|
|
|
5
90
|
Full Changelog: [v0.1.0-alpha.3...v0.1.0-alpha.4](https://github.com/postgrid/postgrid-node/compare/v0.1.0-alpha.3...v0.1.0-alpha.4)
|
package/LICENSE
CHANGED
|
@@ -186,7 +186,7 @@
|
|
|
186
186
|
same "printed page" as the copyright notice for easier
|
|
187
187
|
identification within third-party archives.
|
|
188
188
|
|
|
189
|
-
Copyright 2025
|
|
189
|
+
Copyright 2025 Post Grid
|
|
190
190
|
|
|
191
191
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
192
|
you may not use this file except in compliance with the License.
|
package/README.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
# PostGrid
|
|
1
|
+
# PostGrid API Library
|
|
2
2
|
|
|
3
|
-
[](https://npmjs.org/package/postgrid-node) 
|
|
3
|
+
[>)](https://npmjs.org/package/postgrid-node) 
|
|
4
4
|
|
|
5
|
-
This library provides convenient access to the
|
|
5
|
+
This library provides convenient access to the Post Grid REST API from server-side TypeScript or JavaScript.
|
|
6
6
|
|
|
7
|
-
The
|
|
7
|
+
The full API of this library can be found in [api.md](api.md).
|
|
8
8
|
|
|
9
9
|
## Installation
|
|
10
10
|
|
|
@@ -21,10 +21,10 @@ The full API of this library can be found in [api.md](api.md).
|
|
|
21
21
|
import PostGrid from 'postgrid-node';
|
|
22
22
|
|
|
23
23
|
const client = new PostGrid({
|
|
24
|
-
|
|
24
|
+
printMailAPIKey: process.env['POSTGRID_PRINT_MAIL_API_KEY'], // This is the default and can be omitted
|
|
25
25
|
});
|
|
26
26
|
|
|
27
|
-
const contact = await client.contacts.create({
|
|
27
|
+
const contact = await client.printMail.contacts.create({
|
|
28
28
|
addressLine1: 'addressLine1',
|
|
29
29
|
countryCode: 'countryCode',
|
|
30
30
|
firstName: 'firstName',
|
|
@@ -42,15 +42,15 @@ This library includes TypeScript definitions for all request params and response
|
|
|
42
42
|
import PostGrid from 'postgrid-node';
|
|
43
43
|
|
|
44
44
|
const client = new PostGrid({
|
|
45
|
-
|
|
45
|
+
printMailAPIKey: process.env['POSTGRID_PRINT_MAIL_API_KEY'], // This is the default and can be omitted
|
|
46
46
|
});
|
|
47
47
|
|
|
48
|
-
const params: PostGrid.ContactCreateParams = {
|
|
48
|
+
const params: PostGrid.PrintMail.ContactCreateParams = {
|
|
49
49
|
addressLine1: 'addressLine1',
|
|
50
50
|
countryCode: 'countryCode',
|
|
51
51
|
firstName: 'firstName',
|
|
52
52
|
};
|
|
53
|
-
const contact: PostGrid.Contact = await client.contacts.create(params);
|
|
53
|
+
const contact: PostGrid.PrintMail.Contact = await client.printMail.contacts.create(params);
|
|
54
54
|
```
|
|
55
55
|
|
|
56
56
|
Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
|
|
@@ -63,7 +63,7 @@ a subclass of `APIError` will be thrown:
|
|
|
63
63
|
|
|
64
64
|
<!-- prettier-ignore -->
|
|
65
65
|
```ts
|
|
66
|
-
const contact = await client.contacts
|
|
66
|
+
const contact = await client.printMail.contacts
|
|
67
67
|
.create({ addressLine1: 'addressLine1', countryCode: 'countryCode', firstName: 'firstName' })
|
|
68
68
|
.catch(async (err) => {
|
|
69
69
|
if (err instanceof PostGrid.APIError) {
|
|
@@ -105,7 +105,7 @@ const client = new PostGrid({
|
|
|
105
105
|
});
|
|
106
106
|
|
|
107
107
|
// Or, configure per-request:
|
|
108
|
-
await client.contacts.create({ addressLine1: 'addressLine1', countryCode: 'countryCode', firstName: 'firstName' }, {
|
|
108
|
+
await client.printMail.contacts.create({ addressLine1: 'addressLine1', countryCode: 'countryCode', firstName: 'firstName' }, {
|
|
109
109
|
maxRetries: 5,
|
|
110
110
|
});
|
|
111
111
|
```
|
|
@@ -122,7 +122,7 @@ const client = new PostGrid({
|
|
|
122
122
|
});
|
|
123
123
|
|
|
124
124
|
// Override per-request:
|
|
125
|
-
await client.contacts.create({ addressLine1: 'addressLine1', countryCode: 'countryCode', firstName: 'firstName' }, {
|
|
125
|
+
await client.printMail.contacts.create({ addressLine1: 'addressLine1', countryCode: 'countryCode', firstName: 'firstName' }, {
|
|
126
126
|
timeout: 5 * 1000,
|
|
127
127
|
});
|
|
128
128
|
```
|
|
@@ -131,62 +131,86 @@ On timeout, an `APIConnectionTimeoutError` is thrown.
|
|
|
131
131
|
|
|
132
132
|
Note that requests which time out will be [retried twice by default](#retries).
|
|
133
133
|
|
|
134
|
-
## Auto-pagination
|
|
135
|
-
|
|
136
|
-
List methods in the PostGrid API are paginated.
|
|
137
|
-
You can use the `for await … of` syntax to iterate through items across all pages:
|
|
138
|
-
|
|
139
|
-
```ts
|
|
140
|
-
async function fetchAllContacts(params) {
|
|
141
|
-
const allContacts = [];
|
|
142
|
-
// Automatically fetches more pages as needed.
|
|
143
|
-
for await (const contact of client.contacts.list()) {
|
|
144
|
-
allContacts.push(contact);
|
|
145
|
-
}
|
|
146
|
-
return allContacts;
|
|
147
|
-
}
|
|
148
|
-
```
|
|
149
|
-
|
|
150
|
-
Alternatively, you can request a single page at a time:
|
|
151
|
-
|
|
152
|
-
```ts
|
|
153
|
-
let page = await client.contacts.list();
|
|
154
|
-
for (const contact of page.data) {
|
|
155
|
-
console.log(contact);
|
|
156
|
-
}
|
|
157
|
-
|
|
158
|
-
// Convenience methods are provided for manually paginating:
|
|
159
|
-
while (page.hasNextPage()) {
|
|
160
|
-
page = await page.getNextPage();
|
|
161
|
-
// ...
|
|
162
|
-
}
|
|
163
|
-
```
|
|
164
|
-
|
|
165
134
|
## Advanced Usage
|
|
166
135
|
|
|
167
136
|
### Accessing raw Response data (e.g., headers)
|
|
168
137
|
|
|
169
138
|
The "raw" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.
|
|
139
|
+
This method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.
|
|
170
140
|
|
|
171
141
|
You can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.
|
|
142
|
+
Unlike `.asResponse()` this method consumes the body, returning once it is parsed.
|
|
172
143
|
|
|
173
144
|
<!-- prettier-ignore -->
|
|
174
145
|
```ts
|
|
175
146
|
const client = new PostGrid();
|
|
176
147
|
|
|
177
|
-
const response = await client.contacts
|
|
148
|
+
const response = await client.printMail.contacts
|
|
178
149
|
.create({ addressLine1: 'addressLine1', countryCode: 'countryCode', firstName: 'firstName' })
|
|
179
150
|
.asResponse();
|
|
180
151
|
console.log(response.headers.get('X-My-Header'));
|
|
181
152
|
console.log(response.statusText); // access the underlying Response object
|
|
182
153
|
|
|
183
|
-
const { data: contact, response: raw } = await client.contacts
|
|
154
|
+
const { data: contact, response: raw } = await client.printMail.contacts
|
|
184
155
|
.create({ addressLine1: 'addressLine1', countryCode: 'countryCode', firstName: 'firstName' })
|
|
185
156
|
.withResponse();
|
|
186
157
|
console.log(raw.headers.get('X-My-Header'));
|
|
187
158
|
console.log(contact.id);
|
|
188
159
|
```
|
|
189
160
|
|
|
161
|
+
### Logging
|
|
162
|
+
|
|
163
|
+
> [!IMPORTANT]
|
|
164
|
+
> All log messages are intended for debugging only. The format and content of log messages
|
|
165
|
+
> may change between releases.
|
|
166
|
+
|
|
167
|
+
#### Log levels
|
|
168
|
+
|
|
169
|
+
The log level can be configured in two ways:
|
|
170
|
+
|
|
171
|
+
1. Via the `POST_GRID_LOG` environment variable
|
|
172
|
+
2. Using the `logLevel` client option (overrides the environment variable if set)
|
|
173
|
+
|
|
174
|
+
```ts
|
|
175
|
+
import PostGrid from 'postgrid-node';
|
|
176
|
+
|
|
177
|
+
const client = new PostGrid({
|
|
178
|
+
logLevel: 'debug', // Show all log messages
|
|
179
|
+
});
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
Available log levels, from most to least verbose:
|
|
183
|
+
|
|
184
|
+
- `'debug'` - Show debug messages, info, warnings, and errors
|
|
185
|
+
- `'info'` - Show info messages, warnings, and errors
|
|
186
|
+
- `'warn'` - Show warnings and errors (default)
|
|
187
|
+
- `'error'` - Show only errors
|
|
188
|
+
- `'off'` - Disable all logging
|
|
189
|
+
|
|
190
|
+
At the `'debug'` level, all HTTP requests and responses are logged, including headers and bodies.
|
|
191
|
+
Some authentication-related headers are redacted, but sensitive data in request and response bodies
|
|
192
|
+
may still be visible.
|
|
193
|
+
|
|
194
|
+
#### Custom logger
|
|
195
|
+
|
|
196
|
+
By default, this library logs to `globalThis.console`. You can also provide a custom logger.
|
|
197
|
+
Most logging libraries are supported, including [pino](https://www.npmjs.com/package/pino), [winston](https://www.npmjs.com/package/winston), [bunyan](https://www.npmjs.com/package/bunyan), [consola](https://www.npmjs.com/package/consola), [signale](https://www.npmjs.com/package/signale), and [@std/log](https://jsr.io/@std/log). If your logger doesn't work, please open an issue.
|
|
198
|
+
|
|
199
|
+
When providing a custom logger, the `logLevel` option still controls which messages are emitted, messages
|
|
200
|
+
below the configured level will not be sent to your logger.
|
|
201
|
+
|
|
202
|
+
```ts
|
|
203
|
+
import PostGrid from 'postgrid-node';
|
|
204
|
+
import pino from 'pino';
|
|
205
|
+
|
|
206
|
+
const logger = pino();
|
|
207
|
+
|
|
208
|
+
const client = new PostGrid({
|
|
209
|
+
logger: logger.child({ name: 'PostGrid' }),
|
|
210
|
+
logLevel: 'debug', // Send all messages to pino, allowing it to filter
|
|
211
|
+
});
|
|
212
|
+
```
|
|
213
|
+
|
|
190
214
|
### Making custom/undocumented requests
|
|
191
215
|
|
|
192
216
|
This library is typed for convenient access to the documented API. If you need to access undocumented
|
|
@@ -211,9 +235,8 @@ parameter. This library doesn't validate at runtime that the request matches the
|
|
|
211
235
|
send will be sent as-is.
|
|
212
236
|
|
|
213
237
|
```ts
|
|
214
|
-
client.
|
|
215
|
-
|
|
216
|
-
bar: 12,
|
|
238
|
+
client.printMail.contacts.create({
|
|
239
|
+
// ...
|
|
217
240
|
// @ts-expect-error baz is not yet public
|
|
218
241
|
baz: 'undocumented option',
|
|
219
242
|
});
|
|
@@ -233,69 +256,85 @@ validate or strip extra properties from the response from the API.
|
|
|
233
256
|
|
|
234
257
|
### Customizing the fetch client
|
|
235
258
|
|
|
236
|
-
By default, this library
|
|
259
|
+
By default, this library expects a global `fetch` function is defined.
|
|
237
260
|
|
|
238
|
-
If you
|
|
239
|
-
(for example, if you are running Node with `--experimental-fetch` or using NextJS which polyfills with `undici`),
|
|
240
|
-
add the following import before your first import `from "PostGrid"`:
|
|
261
|
+
If you want to use a different `fetch` function, you can either polyfill the global:
|
|
241
262
|
|
|
242
263
|
```ts
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
import PostGrid from 'postgrid-node';
|
|
264
|
+
import fetch from 'my-fetch';
|
|
265
|
+
|
|
266
|
+
globalThis.fetch = fetch;
|
|
247
267
|
```
|
|
248
268
|
|
|
249
|
-
|
|
250
|
-
|
|
269
|
+
Or pass it to the client:
|
|
270
|
+
|
|
271
|
+
```ts
|
|
272
|
+
import PostGrid from 'postgrid-node';
|
|
273
|
+
import fetch from 'my-fetch';
|
|
274
|
+
|
|
275
|
+
const client = new PostGrid({ fetch });
|
|
276
|
+
```
|
|
251
277
|
|
|
252
|
-
###
|
|
278
|
+
### Fetch options
|
|
253
279
|
|
|
254
|
-
|
|
255
|
-
which can be used to inspect or alter the `Request` or `Response` before/after each request:
|
|
280
|
+
If you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)
|
|
256
281
|
|
|
257
282
|
```ts
|
|
258
|
-
import { fetch } from 'undici'; // as one example
|
|
259
283
|
import PostGrid from 'postgrid-node';
|
|
260
284
|
|
|
261
285
|
const client = new PostGrid({
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
const response = await fetch(url, init);
|
|
265
|
-
console.log('Got response', response);
|
|
266
|
-
return response;
|
|
286
|
+
fetchOptions: {
|
|
287
|
+
// `RequestInit` options
|
|
267
288
|
},
|
|
268
289
|
});
|
|
269
290
|
```
|
|
270
291
|
|
|
271
|
-
|
|
272
|
-
This is intended for debugging purposes only and may change in the future without notice.
|
|
292
|
+
#### Configuring proxies
|
|
273
293
|
|
|
274
|
-
|
|
294
|
+
To modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy
|
|
295
|
+
options to requests:
|
|
275
296
|
|
|
276
|
-
|
|
297
|
+
<img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/node.svg" align="top" width="18" height="21"> **Node** <sup>[[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]</sup>
|
|
277
298
|
|
|
278
|
-
|
|
299
|
+
```ts
|
|
300
|
+
import PostGrid from 'postgrid-node';
|
|
301
|
+
import * as undici from 'undici';
|
|
302
|
+
|
|
303
|
+
const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
|
|
304
|
+
const client = new PostGrid({
|
|
305
|
+
fetchOptions: {
|
|
306
|
+
dispatcher: proxyAgent,
|
|
307
|
+
},
|
|
308
|
+
});
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
<img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/bun.svg" align="top" width="18" height="21"> **Bun** <sup>[[docs](https://bun.sh/guides/http/proxy)]</sup>
|
|
279
312
|
|
|
280
|
-
<!-- prettier-ignore -->
|
|
281
313
|
```ts
|
|
282
|
-
import
|
|
283
|
-
import { HttpsProxyAgent } from 'https-proxy-agent';
|
|
314
|
+
import PostGrid from 'postgrid-node';
|
|
284
315
|
|
|
285
|
-
// Configure the default for all requests:
|
|
286
316
|
const client = new PostGrid({
|
|
287
|
-
|
|
317
|
+
fetchOptions: {
|
|
318
|
+
proxy: 'http://localhost:8888',
|
|
319
|
+
},
|
|
288
320
|
});
|
|
321
|
+
```
|
|
289
322
|
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
323
|
+
<img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/deno.svg" align="top" width="18" height="21"> **Deno** <sup>[[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]</sup>
|
|
324
|
+
|
|
325
|
+
```ts
|
|
326
|
+
import PostGrid from 'npm:postgrid-node';
|
|
327
|
+
|
|
328
|
+
const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
|
|
329
|
+
const client = new PostGrid({
|
|
330
|
+
fetchOptions: {
|
|
331
|
+
client: httpClient,
|
|
295
332
|
},
|
|
296
|
-
);
|
|
333
|
+
});
|
|
297
334
|
```
|
|
298
335
|
|
|
336
|
+
## Frequently Asked Questions
|
|
337
|
+
|
|
299
338
|
## Semantic versioning
|
|
300
339
|
|
|
301
340
|
This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
|
|
@@ -310,12 +349,12 @@ We are keen for your feedback; please open an [issue](https://www.github.com/pos
|
|
|
310
349
|
|
|
311
350
|
## Requirements
|
|
312
351
|
|
|
313
|
-
TypeScript >= 4.
|
|
352
|
+
TypeScript >= 4.9 is supported.
|
|
314
353
|
|
|
315
354
|
The following runtimes are supported:
|
|
316
355
|
|
|
317
356
|
- Web browsers (Up-to-date Chrome, Firefox, Safari, Edge, and more)
|
|
318
|
-
- Node.js
|
|
357
|
+
- Node.js 20 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.
|
|
319
358
|
- Deno v1.28.0 or higher.
|
|
320
359
|
- Bun 1.0 or later.
|
|
321
360
|
- Cloudflare Workers.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-promise.d.mts","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":""}
|
package/api-promise.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-promise.d.ts","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":""}
|
package/api-promise.js
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const tslib_1 = require("./internal/tslib.js");
|
|
4
|
+
/** @deprecated Import from ./core/api-promise instead */
|
|
5
|
+
tslib_1.__exportStar(require("./core/api-promise.js"), exports);
|
|
6
|
+
//# sourceMappingURL=api-promise.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-promise.js","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":";;;AAAA,yDAAyD;AACzD,gEAAmC"}
|
package/api-promise.mjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-promise.mjs","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":""}
|