postgrid-node 0.1.0-alpha.5 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +84 -0
- package/LICENSE +1 -1
- package/README.md +134 -103
- package/api-promise.d.mts +2 -0
- package/api-promise.d.mts.map +1 -0
- package/api-promise.d.ts +2 -0
- package/api-promise.d.ts.map +1 -0
- package/api-promise.js +6 -0
- package/api-promise.js.map +1 -0
- package/api-promise.mjs +2 -0
- package/api-promise.mjs.map +1 -0
- package/client.d.mts +191 -0
- package/client.d.mts.map +1 -0
- package/client.d.ts +191 -0
- package/client.d.ts.map +1 -0
- package/client.js +492 -0
- package/client.js.map +1 -0
- package/client.mjs +488 -0
- package/client.mjs.map +1 -0
- package/core/api-promise.d.mts +46 -0
- package/core/api-promise.d.mts.map +1 -0
- package/core/api-promise.d.ts +46 -0
- package/core/api-promise.d.ts.map +1 -0
- package/core/api-promise.js +74 -0
- package/core/api-promise.js.map +1 -0
- package/core/api-promise.mjs +70 -0
- package/core/api-promise.mjs.map +1 -0
- package/core/error.d.mts +46 -0
- package/core/error.d.mts.map +1 -0
- package/core/error.d.ts +46 -0
- package/core/error.d.ts.map +1 -0
- package/core/error.js +113 -0
- package/core/error.js.map +1 -0
- package/core/error.mjs +97 -0
- package/core/error.mjs.map +1 -0
- package/core/resource.d.mts +6 -0
- package/core/resource.d.mts.map +1 -0
- package/core/resource.d.ts +6 -0
- package/core/resource.d.ts.map +1 -0
- package/core/resource.js +11 -0
- package/core/resource.js.map +1 -0
- package/core/resource.mjs +7 -0
- package/core/resource.mjs.map +1 -0
- package/core/uploads.d.mts +3 -0
- package/core/uploads.d.mts.map +1 -0
- package/core/uploads.d.ts +3 -0
- package/core/uploads.d.ts.map +1 -0
- package/core/uploads.js +6 -0
- package/core/uploads.js.map +1 -0
- package/core/uploads.mjs +2 -0
- package/core/uploads.mjs.map +1 -0
- package/error.d.mts +2 -0
- package/error.d.mts.map +1 -0
- package/error.d.ts +1 -46
- package/error.d.ts.map +1 -1
- package/error.js +3 -110
- package/error.js.map +1 -1
- package/error.mjs +1 -96
- package/error.mjs.map +1 -1
- package/index.d.mts +6 -157
- package/index.d.mts.map +1 -0
- package/index.d.ts +5 -156
- package/index.d.ts.map +1 -1
- package/index.js +12 -166
- package/index.js.map +1 -1
- package/index.mjs +5 -139
- package/index.mjs.map +1 -1
- package/internal/builtin-types.d.mts +73 -0
- package/internal/builtin-types.d.mts.map +1 -0
- package/internal/builtin-types.d.ts +73 -0
- package/internal/builtin-types.d.ts.map +1 -0
- package/internal/builtin-types.js +4 -0
- package/internal/builtin-types.js.map +1 -0
- package/internal/builtin-types.mjs +3 -0
- package/internal/builtin-types.mjs.map +1 -0
- package/internal/detect-platform.d.mts +15 -0
- package/internal/detect-platform.d.mts.map +1 -0
- package/internal/detect-platform.d.ts +15 -0
- package/internal/detect-platform.d.ts.map +1 -0
- package/internal/detect-platform.js +162 -0
- package/internal/detect-platform.js.map +1 -0
- package/internal/detect-platform.mjs +157 -0
- package/internal/detect-platform.mjs.map +1 -0
- package/internal/errors.d.mts +3 -0
- package/internal/errors.d.mts.map +1 -0
- package/internal/errors.d.ts +3 -0
- package/internal/errors.d.ts.map +1 -0
- package/internal/errors.js +41 -0
- package/internal/errors.js.map +1 -0
- package/internal/errors.mjs +36 -0
- package/internal/errors.mjs.map +1 -0
- package/internal/headers.d.mts +20 -0
- package/internal/headers.d.mts.map +1 -0
- package/internal/headers.d.ts +20 -0
- package/internal/headers.d.ts.map +1 -0
- package/internal/headers.js +79 -0
- package/internal/headers.js.map +1 -0
- package/internal/headers.mjs +74 -0
- package/internal/headers.mjs.map +1 -0
- package/internal/parse.d.mts +12 -0
- package/internal/parse.d.mts.map +1 -0
- package/internal/parse.d.ts +12 -0
- package/internal/parse.d.ts.map +1 -0
- package/internal/parse.js +35 -0
- package/internal/parse.js.map +1 -0
- package/internal/parse.mjs +32 -0
- package/internal/parse.mjs.map +1 -0
- package/internal/qs/formats.d.mts +7 -0
- package/internal/qs/formats.d.mts.map +1 -0
- package/internal/qs/formats.d.ts +1 -0
- package/internal/qs/formats.d.ts.map +1 -1
- package/internal/qs/formats.js +4 -2
- package/internal/qs/formats.js.map +1 -1
- package/internal/qs/formats.mjs +2 -1
- package/internal/qs/formats.mjs.map +1 -1
- package/internal/qs/index.d.mts +10 -0
- package/internal/qs/index.d.mts.map +1 -0
- package/internal/qs/index.d.ts.map +1 -1
- package/internal/qs/stringify.d.mts +3 -0
- package/internal/qs/stringify.d.mts.map +1 -0
- package/internal/qs/stringify.d.ts.map +1 -1
- package/internal/qs/stringify.js +16 -19
- package/internal/qs/stringify.js.map +1 -1
- package/internal/qs/stringify.mjs +17 -19
- package/internal/qs/stringify.mjs.map +1 -1
- package/internal/qs/types.d.mts +57 -0
- package/internal/qs/types.d.mts.map +1 -0
- package/internal/qs/utils.d.mts +15 -0
- package/internal/qs/utils.d.mts.map +1 -0
- package/internal/qs/utils.d.ts +1 -0
- package/internal/qs/utils.d.ts.map +1 -1
- package/internal/qs/utils.js +22 -21
- package/internal/qs/utils.js.map +1 -1
- package/internal/qs/utils.mjs +12 -12
- package/internal/qs/utils.mjs.map +1 -1
- package/internal/request-options.d.mts +75 -0
- package/internal/request-options.d.mts.map +1 -0
- package/internal/request-options.d.ts +75 -0
- package/internal/request-options.d.ts.map +1 -0
- package/internal/request-options.js +14 -0
- package/internal/request-options.js.map +1 -0
- package/internal/request-options.mjs +10 -0
- package/internal/request-options.mjs.map +1 -0
- package/internal/shim-types.d.mts +17 -0
- package/internal/shim-types.d.mts.map +1 -0
- package/internal/shim-types.d.ts +17 -0
- package/internal/shim-types.d.ts.map +1 -0
- package/internal/shim-types.js +4 -0
- package/internal/shim-types.js.map +1 -0
- package/internal/shim-types.mjs +3 -0
- package/internal/shim-types.mjs.map +1 -0
- package/internal/shims.d.mts +20 -0
- package/internal/shims.d.mts.map +1 -0
- package/internal/shims.d.ts +20 -0
- package/internal/shims.d.ts.map +1 -0
- package/internal/shims.js +92 -0
- package/internal/shims.js.map +1 -0
- package/internal/shims.mjs +85 -0
- package/internal/shims.mjs.map +1 -0
- package/internal/to-file.d.mts +45 -0
- package/internal/to-file.d.mts.map +1 -0
- package/internal/to-file.d.ts +45 -0
- package/internal/to-file.d.ts.map +1 -0
- package/internal/to-file.js +91 -0
- package/internal/to-file.js.map +1 -0
- package/internal/to-file.mjs +88 -0
- package/internal/to-file.mjs.map +1 -0
- package/internal/tslib.js +81 -0
- package/internal/tslib.mjs +17 -0
- package/internal/types.d.mts +69 -0
- package/internal/types.d.mts.map +1 -0
- package/internal/types.d.ts +69 -0
- package/internal/types.d.ts.map +1 -0
- package/internal/types.js +4 -0
- package/internal/types.js.map +1 -0
- package/internal/types.mjs +3 -0
- package/internal/types.mjs.map +1 -0
- package/internal/uploads.d.mts +42 -0
- package/internal/uploads.d.mts.map +1 -0
- package/internal/uploads.d.ts +42 -0
- package/internal/uploads.d.ts.map +1 -0
- package/internal/uploads.js +141 -0
- package/internal/uploads.js.map +1 -0
- package/internal/uploads.mjs +131 -0
- package/internal/uploads.mjs.map +1 -0
- package/internal/utils/base64.d.mts +3 -0
- package/internal/utils/base64.d.mts.map +1 -0
- package/internal/utils/base64.d.ts +3 -0
- package/internal/utils/base64.d.ts.map +1 -0
- package/internal/utils/base64.js +38 -0
- package/internal/utils/base64.js.map +1 -0
- package/internal/utils/base64.mjs +33 -0
- package/internal/utils/base64.mjs.map +1 -0
- package/internal/utils/bytes.d.mts +4 -0
- package/internal/utils/bytes.d.mts.map +1 -0
- package/internal/utils/bytes.d.ts +4 -0
- package/internal/utils/bytes.d.ts.map +1 -0
- package/internal/utils/bytes.js +31 -0
- package/internal/utils/bytes.js.map +1 -0
- package/internal/utils/bytes.mjs +26 -0
- package/internal/utils/bytes.mjs.map +1 -0
- package/internal/utils/env.d.mts +9 -0
- package/internal/utils/env.d.mts.map +1 -0
- package/internal/utils/env.d.ts +9 -0
- package/internal/utils/env.d.ts.map +1 -0
- package/internal/utils/env.js +22 -0
- package/internal/utils/env.js.map +1 -0
- package/internal/utils/env.mjs +18 -0
- package/internal/utils/env.mjs.map +1 -0
- package/internal/utils/log.d.mts +37 -0
- package/internal/utils/log.d.mts.map +1 -0
- package/internal/utils/log.d.ts +37 -0
- package/internal/utils/log.d.ts.map +1 -0
- package/internal/utils/log.js +86 -0
- package/internal/utils/log.js.map +1 -0
- package/internal/utils/log.mjs +80 -0
- package/internal/utils/log.mjs.map +1 -0
- package/internal/utils/path.d.mts +15 -0
- package/internal/utils/path.d.mts.map +1 -0
- package/internal/utils/path.d.ts +15 -0
- package/internal/utils/path.d.ts.map +1 -0
- package/internal/utils/path.js +79 -0
- package/internal/utils/path.js.map +1 -0
- package/internal/utils/path.mjs +74 -0
- package/internal/utils/path.mjs.map +1 -0
- package/internal/utils/sleep.d.mts +2 -0
- package/internal/utils/sleep.d.mts.map +1 -0
- package/internal/utils/sleep.d.ts +2 -0
- package/internal/utils/sleep.d.ts.map +1 -0
- package/internal/utils/sleep.js +7 -0
- package/internal/utils/sleep.js.map +1 -0
- package/internal/utils/sleep.mjs +3 -0
- package/internal/utils/sleep.mjs.map +1 -0
- package/internal/utils/uuid.d.mts +5 -0
- package/internal/utils/uuid.d.mts.map +1 -0
- package/internal/utils/uuid.d.ts +5 -0
- package/internal/utils/uuid.d.ts.map +1 -0
- package/internal/utils/uuid.js +19 -0
- package/internal/utils/uuid.js.map +1 -0
- package/internal/utils/uuid.mjs +15 -0
- package/internal/utils/uuid.mjs.map +1 -0
- package/internal/utils/values.d.mts +18 -0
- package/internal/utils/values.d.mts.map +1 -0
- package/internal/utils/values.d.ts +18 -0
- package/internal/utils/values.d.ts.map +1 -0
- package/internal/utils/values.js +112 -0
- package/internal/utils/values.js.map +1 -0
- package/internal/utils/values.mjs +94 -0
- package/internal/utils/values.mjs.map +1 -0
- package/internal/utils.d.mts +7 -0
- package/internal/utils.d.mts.map +1 -0
- package/internal/utils.d.ts +7 -0
- package/internal/utils.d.ts.map +1 -0
- package/internal/utils.js +11 -0
- package/internal/utils.js.map +1 -0
- package/internal/utils.mjs +8 -0
- package/internal/utils.mjs.map +1 -0
- package/package.json +110 -75
- package/resource.d.mts +2 -0
- package/resource.d.mts.map +1 -0
- package/resource.d.ts +1 -5
- package/resource.d.ts.map +1 -1
- package/resource.js +3 -8
- package/resource.js.map +1 -1
- package/resource.mjs +1 -6
- package/resource.mjs.map +1 -1
- package/resources/address-verification.d.mts +425 -0
- package/resources/address-verification.d.mts.map +1 -0
- package/resources/address-verification.d.ts +425 -0
- package/resources/address-verification.d.ts.map +1 -0
- package/resources/address-verification.js +36 -0
- package/resources/address-verification.js.map +1 -0
- package/resources/address-verification.mjs +32 -0
- package/resources/address-verification.mjs.map +1 -0
- package/resources/index.d.mts +4 -0
- package/resources/index.d.mts.map +1 -0
- package/resources/index.d.ts +3 -15
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +7 -57
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +3 -15
- package/resources/index.mjs.map +1 -1
- package/resources/intl-address-verification.d.mts +406 -0
- package/resources/intl-address-verification.d.mts.map +1 -0
- package/resources/intl-address-verification.d.ts +406 -0
- package/resources/intl-address-verification.d.ts.map +1 -0
- package/resources/intl-address-verification.js +59 -0
- package/resources/intl-address-verification.js.map +1 -0
- package/resources/intl-address-verification.mjs +55 -0
- package/resources/intl-address-verification.mjs.map +1 -0
- package/resources/print-mail/bank-accounts.d.mts +345 -0
- package/resources/print-mail/bank-accounts.d.mts.map +1 -0
- package/resources/print-mail/bank-accounts.d.ts +345 -0
- package/resources/print-mail/bank-accounts.d.ts.map +1 -0
- package/resources/print-mail/bank-accounts.js +72 -0
- package/resources/print-mail/bank-accounts.js.map +1 -0
- package/resources/print-mail/bank-accounts.mjs +68 -0
- package/resources/print-mail/bank-accounts.mjs.map +1 -0
- package/resources/print-mail/boxes.d.mts +873 -0
- package/resources/print-mail/boxes.d.mts.map +1 -0
- package/resources/print-mail/boxes.d.ts +873 -0
- package/resources/print-mail/boxes.d.ts.map +1 -0
- package/resources/print-mail/boxes.js +81 -0
- package/resources/print-mail/boxes.js.map +1 -0
- package/resources/print-mail/boxes.mjs +77 -0
- package/resources/print-mail/boxes.mjs.map +1 -0
- package/resources/print-mail/campaigns.d.mts +317 -0
- package/resources/print-mail/campaigns.d.mts.map +1 -0
- package/resources/print-mail/campaigns.d.ts +317 -0
- package/resources/print-mail/campaigns.d.ts.map +1 -0
- package/resources/print-mail/campaigns.js +114 -0
- package/resources/print-mail/campaigns.js.map +1 -0
- package/resources/print-mail/campaigns.mjs +110 -0
- package/resources/print-mail/campaigns.mjs.map +1 -0
- package/resources/print-mail/cheques.d.mts +817 -0
- package/resources/print-mail/cheques.d.mts.map +1 -0
- package/resources/print-mail/cheques.d.ts +817 -0
- package/resources/print-mail/cheques.d.ts.map +1 -0
- package/resources/print-mail/cheques.js +121 -0
- package/resources/print-mail/cheques.js.map +1 -0
- package/resources/print-mail/cheques.mjs +117 -0
- package/resources/print-mail/cheques.mjs.map +1 -0
- package/resources/print-mail/contacts.d.mts +475 -0
- package/resources/print-mail/contacts.d.mts.map +1 -0
- package/resources/print-mail/contacts.d.ts +475 -0
- package/resources/print-mail/contacts.d.ts.map +1 -0
- package/resources/print-mail/contacts.js +76 -0
- package/resources/print-mail/contacts.js.map +1 -0
- package/resources/print-mail/contacts.mjs +72 -0
- package/resources/print-mail/contacts.mjs.map +1 -0
- package/resources/print-mail/index.d.mts +16 -0
- package/resources/print-mail/index.d.mts.map +1 -0
- package/resources/print-mail/index.d.ts +16 -0
- package/resources/print-mail/index.d.ts.map +1 -0
- package/resources/print-mail/index.js +35 -0
- package/resources/print-mail/index.js.map +1 -0
- package/resources/print-mail/index.mjs +17 -0
- package/resources/print-mail/index.mjs.map +1 -0
- package/resources/print-mail/letters.d.mts +1079 -0
- package/resources/print-mail/letters.d.mts.map +1 -0
- package/resources/print-mail/letters.d.ts +1079 -0
- package/resources/print-mail/letters.d.ts.map +1 -0
- package/resources/print-mail/letters.js +83 -0
- package/resources/print-mail/letters.js.map +1 -0
- package/resources/print-mail/letters.mjs +79 -0
- package/resources/print-mail/letters.mjs.map +1 -0
- package/resources/print-mail/mailing-list-imports.d.mts +354 -0
- package/resources/print-mail/mailing-list-imports.d.mts.map +1 -0
- package/resources/print-mail/mailing-list-imports.d.ts +354 -0
- package/resources/print-mail/mailing-list-imports.d.ts.map +1 -0
- package/resources/print-mail/mailing-list-imports.js +105 -0
- package/resources/print-mail/mailing-list-imports.js.map +1 -0
- package/resources/print-mail/mailing-list-imports.mjs +101 -0
- package/resources/print-mail/mailing-list-imports.mjs.map +1 -0
- package/resources/print-mail/mailing-lists.d.mts +247 -0
- package/resources/print-mail/mailing-lists.d.mts.map +1 -0
- package/resources/print-mail/mailing-lists.d.ts +247 -0
- package/resources/print-mail/mailing-lists.d.ts.map +1 -0
- package/resources/print-mail/mailing-lists.js +117 -0
- package/resources/print-mail/mailing-lists.js.map +1 -0
- package/resources/print-mail/mailing-lists.mjs +113 -0
- package/resources/print-mail/mailing-lists.mjs.map +1 -0
- package/resources/print-mail/order-profiles/cheques.d.mts +398 -0
- package/resources/print-mail/order-profiles/cheques.d.mts.map +1 -0
- package/resources/print-mail/order-profiles/cheques.d.ts +398 -0
- package/resources/print-mail/order-profiles/cheques.d.ts.map +1 -0
- package/resources/print-mail/order-profiles/cheques.js +92 -0
- package/resources/print-mail/order-profiles/cheques.js.map +1 -0
- package/resources/print-mail/order-profiles/cheques.mjs +88 -0
- package/resources/print-mail/order-profiles/cheques.mjs.map +1 -0
- package/resources/print-mail/order-profiles/index.d.mts +6 -0
- package/resources/print-mail/order-profiles/index.d.mts.map +1 -0
- package/resources/print-mail/order-profiles/index.d.ts +6 -0
- package/resources/print-mail/order-profiles/index.d.ts.map +1 -0
- package/resources/print-mail/order-profiles/index.js +15 -0
- package/resources/print-mail/order-profiles/index.js.map +1 -0
- package/resources/print-mail/order-profiles/index.mjs +7 -0
- package/resources/print-mail/order-profiles/index.mjs.map +1 -0
- package/resources/print-mail/order-profiles/letters.d.mts +333 -0
- package/resources/print-mail/order-profiles/letters.d.mts.map +1 -0
- package/resources/print-mail/order-profiles/letters.d.ts +333 -0
- package/resources/print-mail/order-profiles/letters.d.ts.map +1 -0
- package/resources/print-mail/order-profiles/letters.js +99 -0
- package/resources/print-mail/order-profiles/letters.js.map +1 -0
- package/resources/print-mail/order-profiles/letters.mjs +95 -0
- package/resources/print-mail/order-profiles/letters.mjs.map +1 -0
- package/resources/print-mail/order-profiles/order-profiles.d.mts +22 -0
- package/resources/print-mail/order-profiles/order-profiles.d.mts.map +1 -0
- package/resources/print-mail/order-profiles/order-profiles.d.ts +22 -0
- package/resources/print-mail/order-profiles/order-profiles.d.ts.map +1 -0
- package/resources/print-mail/order-profiles/order-profiles.js +29 -0
- package/resources/print-mail/order-profiles/order-profiles.js.map +1 -0
- package/resources/print-mail/order-profiles/order-profiles.mjs +24 -0
- package/resources/print-mail/order-profiles/order-profiles.mjs.map +1 -0
- package/resources/print-mail/order-profiles/postcards.d.mts +263 -0
- package/resources/print-mail/order-profiles/postcards.d.mts.map +1 -0
- package/resources/print-mail/order-profiles/postcards.d.ts +263 -0
- package/resources/print-mail/order-profiles/postcards.d.ts.map +1 -0
- package/resources/print-mail/order-profiles/postcards.js +91 -0
- package/resources/print-mail/order-profiles/postcards.js.map +1 -0
- package/resources/print-mail/order-profiles/postcards.mjs +87 -0
- package/resources/print-mail/order-profiles/postcards.mjs.map +1 -0
- package/resources/print-mail/order-profiles/self-mailers.d.mts +268 -0
- package/resources/print-mail/order-profiles/self-mailers.d.mts.map +1 -0
- package/resources/print-mail/order-profiles/self-mailers.d.ts +268 -0
- package/resources/print-mail/order-profiles/self-mailers.d.ts.map +1 -0
- package/resources/print-mail/order-profiles/self-mailers.js +92 -0
- package/resources/print-mail/order-profiles/self-mailers.js.map +1 -0
- package/resources/print-mail/order-profiles/self-mailers.mjs +88 -0
- package/resources/print-mail/order-profiles/self-mailers.mjs.map +1 -0
- package/resources/print-mail/order-profiles.d.mts +2 -0
- package/resources/print-mail/order-profiles.d.mts.map +1 -0
- package/resources/print-mail/order-profiles.d.ts.map +1 -0
- package/resources/print-mail/order-profiles.js +6 -0
- package/resources/print-mail/order-profiles.js.map +1 -0
- package/resources/print-mail/order-profiles.mjs.map +1 -0
- package/resources/print-mail/postcards.d.mts +1220 -0
- package/resources/print-mail/postcards.d.mts.map +1 -0
- package/resources/print-mail/postcards.d.ts +1220 -0
- package/resources/print-mail/postcards.d.ts.map +1 -0
- package/resources/print-mail/postcards.js +87 -0
- package/resources/print-mail/postcards.js.map +1 -0
- package/resources/print-mail/postcards.mjs +83 -0
- package/resources/print-mail/postcards.mjs.map +1 -0
- package/resources/print-mail/print-mail.d.mts +62 -0
- package/resources/print-mail/print-mail.d.mts.map +1 -0
- package/resources/print-mail/print-mail.d.ts +62 -0
- package/resources/print-mail/print-mail.d.ts.map +1 -0
- package/resources/print-mail/print-mail.js +69 -0
- package/resources/print-mail/print-mail.js.map +1 -0
- package/resources/print-mail/print-mail.mjs +64 -0
- package/resources/print-mail/print-mail.mjs.map +1 -0
- package/resources/print-mail/reports/exports.d.mts +165 -0
- package/resources/print-mail/reports/exports.d.mts.map +1 -0
- package/resources/print-mail/reports/exports.d.ts +165 -0
- package/resources/print-mail/reports/exports.d.ts.map +1 -0
- package/resources/print-mail/reports/exports.js +66 -0
- package/resources/print-mail/reports/exports.js.map +1 -0
- package/resources/print-mail/reports/exports.mjs +62 -0
- package/resources/print-mail/reports/exports.mjs.map +1 -0
- package/resources/print-mail/reports/index.d.mts +4 -0
- package/resources/print-mail/reports/index.d.mts.map +1 -0
- package/resources/print-mail/reports/index.d.ts +4 -0
- package/resources/print-mail/reports/index.d.ts.map +1 -0
- package/resources/print-mail/reports/index.js +11 -0
- package/resources/print-mail/reports/index.js.map +1 -0
- package/resources/print-mail/reports/index.mjs +5 -0
- package/resources/print-mail/reports/index.mjs.map +1 -0
- package/resources/print-mail/reports/reports.d.mts +214 -0
- package/resources/print-mail/reports/reports.d.mts.map +1 -0
- package/resources/print-mail/reports/reports.d.ts +214 -0
- package/resources/print-mail/reports/reports.d.ts.map +1 -0
- package/resources/print-mail/reports/reports.js +110 -0
- package/resources/print-mail/reports/reports.js.map +1 -0
- package/resources/print-mail/reports/reports.mjs +105 -0
- package/resources/print-mail/reports/reports.mjs.map +1 -0
- package/resources/print-mail/reports/samples.d.mts +69 -0
- package/resources/print-mail/reports/samples.d.mts.map +1 -0
- package/resources/print-mail/reports/samples.d.ts +69 -0
- package/resources/print-mail/reports/samples.d.ts.map +1 -0
- package/resources/print-mail/reports/samples.js +28 -0
- package/resources/print-mail/reports/samples.js.map +1 -0
- package/resources/print-mail/reports/samples.mjs +24 -0
- package/resources/print-mail/reports/samples.mjs.map +1 -0
- package/resources/print-mail/reports.d.mts +2 -0
- package/resources/print-mail/reports.d.mts.map +1 -0
- package/resources/print-mail/reports.d.ts.map +1 -0
- package/resources/print-mail/reports.js +6 -0
- package/resources/print-mail/reports.js.map +1 -0
- package/resources/print-mail/reports.mjs.map +1 -0
- package/resources/print-mail/self-mailers.d.mts +1218 -0
- package/resources/print-mail/self-mailers.d.mts.map +1 -0
- package/resources/print-mail/self-mailers.d.ts +1218 -0
- package/resources/print-mail/self-mailers.d.ts.map +1 -0
- package/resources/print-mail/self-mailers.js +87 -0
- package/resources/print-mail/self-mailers.js.map +1 -0
- package/resources/print-mail/self-mailers.mjs +83 -0
- package/resources/print-mail/self-mailers.mjs.map +1 -0
- package/resources/print-mail/sub-organizations.d.mts +304 -0
- package/resources/print-mail/sub-organizations.d.mts.map +1 -0
- package/resources/print-mail/sub-organizations.d.ts +304 -0
- package/resources/print-mail/sub-organizations.d.ts.map +1 -0
- package/resources/print-mail/sub-organizations.js +69 -0
- package/resources/print-mail/sub-organizations.js.map +1 -0
- package/resources/print-mail/sub-organizations.mjs +65 -0
- package/resources/print-mail/sub-organizations.mjs.map +1 -0
- package/resources/print-mail/templates.d.mts +169 -0
- package/resources/print-mail/templates.d.mts.map +1 -0
- package/resources/print-mail/templates.d.ts +169 -0
- package/resources/print-mail/templates.d.ts.map +1 -0
- package/resources/print-mail/templates.js +79 -0
- package/resources/print-mail/templates.js.map +1 -0
- package/resources/print-mail/templates.mjs +75 -0
- package/resources/print-mail/templates.mjs.map +1 -0
- package/resources/print-mail.d.mts +2 -0
- package/resources/print-mail.d.mts.map +1 -0
- package/resources/print-mail.d.ts +2 -0
- package/resources/print-mail.d.ts.map +1 -0
- package/resources/print-mail.js +6 -0
- package/resources/print-mail.js.map +1 -0
- package/resources/print-mail.mjs +3 -0
- package/resources/print-mail.mjs.map +1 -0
- package/resources.d.mts +2 -0
- package/resources.d.mts.map +1 -0
- package/resources.d.ts.map +1 -1
- package/resources.js +2 -15
- package/resources.js.map +1 -1
- package/src/api-promise.ts +2 -0
- package/src/client.ts +793 -0
- package/src/core/README.md +3 -0
- package/src/core/api-promise.ts +92 -0
- package/src/core/error.ts +130 -0
- package/src/core/resource.ts +11 -0
- package/src/core/uploads.ts +2 -0
- package/src/error.ts +2 -130
- package/src/index.ts +5 -520
- package/src/internal/README.md +3 -0
- package/src/internal/builtin-types.ts +93 -0
- package/src/internal/detect-platform.ts +196 -0
- package/src/internal/errors.ts +33 -0
- package/src/internal/headers.ts +97 -0
- package/src/internal/parse.ts +50 -0
- package/src/internal/qs/formats.ts +2 -1
- package/src/internal/qs/stringify.ts +17 -20
- package/src/internal/qs/utils.ts +14 -14
- package/src/internal/request-options.ts +91 -0
- package/src/internal/shim-types.ts +26 -0
- package/src/internal/shims.ts +107 -0
- package/src/internal/to-file.ts +154 -0
- package/src/internal/types.ts +95 -0
- package/src/internal/uploads.ts +187 -0
- package/src/internal/utils/base64.ts +40 -0
- package/src/internal/utils/bytes.ts +32 -0
- package/src/internal/utils/env.ts +18 -0
- package/src/internal/utils/log.ts +127 -0
- package/src/internal/utils/path.ts +88 -0
- package/src/internal/utils/sleep.ts +3 -0
- package/src/internal/utils/uuid.ts +17 -0
- package/src/internal/utils/values.ts +105 -0
- package/src/internal/utils.ts +8 -0
- package/src/resource.ts +2 -11
- package/src/resources/address-verification.ts +542 -0
- package/src/resources/index.ts +12 -142
- package/src/resources/intl-address-verification.ts +505 -0
- package/src/resources/print-mail/bank-accounts.ts +432 -0
- package/src/resources/print-mail/boxes.ts +1079 -0
- package/src/resources/print-mail/campaigns.ts +408 -0
- package/src/resources/print-mail/cheques.ts +995 -0
- package/src/resources/print-mail/contacts.ts +594 -0
- package/src/resources/print-mail/index.ts +134 -0
- package/src/resources/print-mail/letters.ts +1319 -0
- package/src/resources/print-mail/mailing-list-imports.ts +433 -0
- package/src/resources/print-mail/mailing-lists.ts +316 -0
- package/src/resources/print-mail/order-profiles/cheques.ts +498 -0
- package/src/resources/print-mail/order-profiles/index.ts +46 -0
- package/src/resources/print-mail/order-profiles/letters.ts +423 -0
- package/src/resources/print-mail/order-profiles/order-profiles.ts +111 -0
- package/src/resources/print-mail/order-profiles/postcards.ts +338 -0
- package/src/resources/print-mail/order-profiles/self-mailers.ts +348 -0
- package/src/resources/print-mail/postcards.ts +1483 -0
- package/src/resources/print-mail/print-mail.ts +331 -0
- package/src/resources/print-mail/reports/exports.ts +209 -0
- package/src/resources/print-mail/reports/index.ts +20 -0
- package/src/resources/print-mail/reports/reports.ts +290 -0
- package/src/resources/print-mail/reports/samples.ts +84 -0
- package/src/resources/print-mail/self-mailers.ts +1481 -0
- package/src/resources/print-mail/sub-organizations.ts +394 -0
- package/src/resources/print-mail/templates.ts +216 -0
- package/src/resources/print-mail.ts +3 -0
- package/src/tsconfig.json +2 -2
- package/src/uploads.ts +2 -255
- package/src/version.ts +1 -1
- package/uploads.d.mts +2 -0
- package/uploads.d.mts.map +1 -0
- package/uploads.d.ts +1 -74
- package/uploads.d.ts.map +1 -1
- package/uploads.js +3 -168
- package/uploads.js.map +1 -1
- package/uploads.mjs +1 -157
- package/uploads.mjs.map +1 -1
- package/version.d.mts +2 -0
- package/version.d.mts.map +1 -0
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
- package/_shims/MultipartBody.d.ts +0 -9
- package/_shims/MultipartBody.d.ts.map +0 -1
- package/_shims/MultipartBody.js +0 -16
- package/_shims/MultipartBody.js.map +0 -1
- package/_shims/MultipartBody.mjs +0 -12
- package/_shims/MultipartBody.mjs.map +0 -1
- package/_shims/README.md +0 -46
- package/_shims/auto/runtime-bun.d.ts +0 -5
- package/_shims/auto/runtime-bun.d.ts.map +0 -1
- package/_shims/auto/runtime-bun.js +0 -21
- package/_shims/auto/runtime-bun.js.map +0 -1
- package/_shims/auto/runtime-bun.mjs +0 -2
- package/_shims/auto/runtime-bun.mjs.map +0 -1
- package/_shims/auto/runtime-node.d.ts +0 -5
- package/_shims/auto/runtime-node.d.ts.map +0 -1
- package/_shims/auto/runtime-node.js +0 -21
- package/_shims/auto/runtime-node.js.map +0 -1
- package/_shims/auto/runtime-node.mjs +0 -2
- package/_shims/auto/runtime-node.mjs.map +0 -1
- package/_shims/auto/runtime.d.ts +0 -5
- package/_shims/auto/runtime.d.ts.map +0 -1
- package/_shims/auto/runtime.js +0 -21
- package/_shims/auto/runtime.js.map +0 -1
- package/_shims/auto/runtime.mjs +0 -2
- package/_shims/auto/runtime.mjs.map +0 -1
- package/_shims/auto/types-node.d.ts +0 -5
- package/_shims/auto/types-node.d.ts.map +0 -1
- package/_shims/auto/types-node.js +0 -21
- package/_shims/auto/types-node.js.map +0 -1
- package/_shims/auto/types-node.mjs +0 -2
- package/_shims/auto/types-node.mjs.map +0 -1
- package/_shims/auto/types.d.ts +0 -101
- package/_shims/auto/types.js +0 -3
- package/_shims/auto/types.mjs +0 -3
- package/_shims/bun-runtime.d.ts +0 -6
- package/_shims/bun-runtime.d.ts.map +0 -1
- package/_shims/bun-runtime.js +0 -14
- package/_shims/bun-runtime.js.map +0 -1
- package/_shims/bun-runtime.mjs +0 -10
- package/_shims/bun-runtime.mjs.map +0 -1
- package/_shims/index.d.ts +0 -83
- package/_shims/index.js +0 -17
- package/_shims/index.mjs +0 -11
- package/_shims/manual-types.d.ts +0 -12
- package/_shims/manual-types.js +0 -3
- package/_shims/manual-types.mjs +0 -3
- package/_shims/node-runtime.d.ts +0 -3
- package/_shims/node-runtime.d.ts.map +0 -1
- package/_shims/node-runtime.js +0 -89
- package/_shims/node-runtime.js.map +0 -1
- package/_shims/node-runtime.mjs +0 -56
- package/_shims/node-runtime.mjs.map +0 -1
- package/_shims/node-types.d.ts +0 -42
- package/_shims/node-types.js +0 -3
- package/_shims/node-types.mjs +0 -3
- package/_shims/registry.d.ts +0 -37
- package/_shims/registry.d.ts.map +0 -1
- package/_shims/registry.js +0 -41
- package/_shims/registry.js.map +0 -1
- package/_shims/registry.mjs +0 -37
- package/_shims/registry.mjs.map +0 -1
- package/_shims/web-runtime.d.ts +0 -5
- package/_shims/web-runtime.d.ts.map +0 -1
- package/_shims/web-runtime.js +0 -78
- package/_shims/web-runtime.js.map +0 -1
- package/_shims/web-runtime.mjs +0 -71
- package/_shims/web-runtime.mjs.map +0 -1
- package/_shims/web-types.d.ts +0 -83
- package/_shims/web-types.js +0 -3
- package/_shims/web-types.mjs +0 -3
- package/core.d.ts +0 -255
- package/core.d.ts.map +0 -1
- package/core.js +0 -924
- package/core.js.map +0 -1
- package/core.mjs +0 -892
- package/core.mjs.map +0 -1
- package/pagination.d.ts +0 -26
- package/pagination.d.ts.map +0 -1
- package/pagination.js +0 -46
- package/pagination.js.map +0 -1
- package/pagination.mjs +0 -42
- package/pagination.mjs.map +0 -1
- package/resources/bank-accounts.d.ts +0 -342
- package/resources/bank-accounts.d.ts.map +0 -1
- package/resources/bank-accounts.js +0 -70
- package/resources/bank-accounts.js.map +0 -1
- package/resources/bank-accounts.mjs +0 -65
- package/resources/bank-accounts.mjs.map +0 -1
- package/resources/boxes.d.ts +0 -748
- package/resources/boxes.d.ts.map +0 -1
- package/resources/boxes.js +0 -81
- package/resources/boxes.js.map +0 -1
- package/resources/boxes.mjs +0 -76
- package/resources/boxes.mjs.map +0 -1
- package/resources/campaigns.d.ts +0 -658
- package/resources/campaigns.d.ts.map +0 -1
- package/resources/campaigns.js +0 -67
- package/resources/campaigns.js.map +0 -1
- package/resources/campaigns.mjs +0 -62
- package/resources/campaigns.mjs.map +0 -1
- package/resources/cheques/cheques.d.ts +0 -388
- package/resources/cheques/cheques.d.ts.map +0 -1
- package/resources/cheques/cheques.js +0 -118
- package/resources/cheques/cheques.js.map +0 -1
- package/resources/cheques/cheques.mjs +0 -90
- package/resources/cheques/cheques.mjs.map +0 -1
- package/resources/cheques/index.d.ts +0 -4
- package/resources/cheques/index.d.ts.map +0 -1
- package/resources/cheques/index.js +0 -12
- package/resources/cheques/index.js.map +0 -1
- package/resources/cheques/index.mjs +0 -5
- package/resources/cheques/index.mjs.map +0 -1
- package/resources/cheques/url.d.ts +0 -34
- package/resources/cheques/url.d.ts.map +0 -1
- package/resources/cheques/url.js +0 -25
- package/resources/cheques/url.js.map +0 -1
- package/resources/cheques/url.mjs +0 -21
- package/resources/cheques/url.mjs.map +0 -1
- package/resources/cheques/with-deposit-ready-pdf.d.ts +0 -19
- package/resources/cheques/with-deposit-ready-pdf.d.ts.map +0 -1
- package/resources/cheques/with-deposit-ready-pdf.js +0 -24
- package/resources/cheques/with-deposit-ready-pdf.js.map +0 -1
- package/resources/cheques/with-deposit-ready-pdf.mjs +0 -20
- package/resources/cheques/with-deposit-ready-pdf.mjs.map +0 -1
- package/resources/cheques.d.ts +0 -2
- package/resources/cheques.d.ts.map +0 -1
- package/resources/cheques.js +0 -19
- package/resources/cheques.js.map +0 -1
- package/resources/cheques.mjs +0 -3
- package/resources/cheques.mjs.map +0 -1
- package/resources/contacts.d.ts +0 -329
- package/resources/contacts.d.ts.map +0 -1
- package/resources/contacts.js +0 -72
- package/resources/contacts.js.map +0 -1
- package/resources/contacts.mjs +0 -67
- package/resources/contacts.mjs.map +0 -1
- package/resources/letters.d.ts +0 -683
- package/resources/letters.d.ts.map +0 -1
- package/resources/letters.js +0 -79
- package/resources/letters.js.map +0 -1
- package/resources/letters.mjs +0 -74
- package/resources/letters.mjs.map +0 -1
- package/resources/mailing-list-imports.d.ts +0 -919
- package/resources/mailing-list-imports.d.ts.map +0 -1
- package/resources/mailing-list-imports.js +0 -95
- package/resources/mailing-list-imports.js.map +0 -1
- package/resources/mailing-list-imports.mjs +0 -90
- package/resources/mailing-list-imports.mjs.map +0 -1
- package/resources/mailing-lists.d.ts +0 -398
- package/resources/mailing-lists.d.ts.map +0 -1
- package/resources/mailing-lists.js +0 -101
- package/resources/mailing-lists.js.map +0 -1
- package/resources/mailing-lists.mjs +0 -96
- package/resources/mailing-lists.mjs.map +0 -1
- package/resources/order-profiles/cheques.d.ts +0 -588
- package/resources/order-profiles/cheques.d.ts.map +0 -1
- package/resources/order-profiles/cheques.js +0 -74
- package/resources/order-profiles/cheques.js.map +0 -1
- package/resources/order-profiles/cheques.mjs +0 -69
- package/resources/order-profiles/cheques.mjs.map +0 -1
- package/resources/order-profiles/index.d.ts +0 -6
- package/resources/order-profiles/index.d.ts.map +0 -1
- package/resources/order-profiles/index.js +0 -19
- package/resources/order-profiles/index.js.map +0 -1
- package/resources/order-profiles/index.mjs +0 -7
- package/resources/order-profiles/index.mjs.map +0 -1
- package/resources/order-profiles/letters.d.ts +0 -647
- package/resources/order-profiles/letters.d.ts.map +0 -1
- package/resources/order-profiles/letters.js +0 -80
- package/resources/order-profiles/letters.js.map +0 -1
- package/resources/order-profiles/letters.mjs +0 -75
- package/resources/order-profiles/letters.mjs.map +0 -1
- package/resources/order-profiles/order-profiles.d.ts +0 -22
- package/resources/order-profiles/order-profiles.d.ts.map +0 -1
- package/resources/order-profiles/order-profiles.js +0 -55
- package/resources/order-profiles/order-profiles.js.map +0 -1
- package/resources/order-profiles/order-profiles.mjs +0 -28
- package/resources/order-profiles/order-profiles.mjs.map +0 -1
- package/resources/order-profiles/postcards.d.ts +0 -423
- package/resources/order-profiles/postcards.d.ts.map +0 -1
- package/resources/order-profiles/postcards.js +0 -73
- package/resources/order-profiles/postcards.js.map +0 -1
- package/resources/order-profiles/postcards.mjs +0 -68
- package/resources/order-profiles/postcards.mjs.map +0 -1
- package/resources/order-profiles/self-mailers.d.ts +0 -435
- package/resources/order-profiles/self-mailers.d.ts.map +0 -1
- package/resources/order-profiles/self-mailers.js +0 -75
- package/resources/order-profiles/self-mailers.js.map +0 -1
- package/resources/order-profiles/self-mailers.mjs +0 -70
- package/resources/order-profiles/self-mailers.mjs.map +0 -1
- package/resources/order-profiles.d.ts.map +0 -1
- package/resources/order-profiles.js +0 -19
- package/resources/order-profiles.js.map +0 -1
- package/resources/order-profiles.mjs.map +0 -1
- package/resources/postcards.d.ts +0 -396
- package/resources/postcards.d.ts.map +0 -1
- package/resources/postcards.js +0 -82
- package/resources/postcards.js.map +0 -1
- package/resources/postcards.mjs +0 -77
- package/resources/postcards.mjs.map +0 -1
- package/resources/reports/exports.d.ts +0 -240
- package/resources/reports/exports.d.ts.map +0 -1
- package/resources/reports/exports.js +0 -60
- package/resources/reports/exports.js.map +0 -1
- package/resources/reports/exports.mjs +0 -56
- package/resources/reports/exports.mjs.map +0 -1
- package/resources/reports/index.d.ts +0 -3
- package/resources/reports/index.d.ts.map +0 -1
- package/resources/reports/index.js +0 -10
- package/resources/reports/index.js.map +0 -1
- package/resources/reports/index.mjs +0 -4
- package/resources/reports/index.mjs.map +0 -1
- package/resources/reports/reports.d.ts +0 -382
- package/resources/reports/reports.d.ts.map +0 -1
- package/resources/reports/reports.js +0 -142
- package/resources/reports/reports.js.map +0 -1
- package/resources/reports/reports.mjs +0 -114
- package/resources/reports/reports.mjs.map +0 -1
- package/resources/reports.d.ts.map +0 -1
- package/resources/reports.js +0 -19
- package/resources/reports.js.map +0 -1
- package/resources/reports.mjs.map +0 -1
- package/resources/self-mailers.d.ts +0 -706
- package/resources/self-mailers.d.ts.map +0 -1
- package/resources/self-mailers.js +0 -83
- package/resources/self-mailers.js.map +0 -1
- package/resources/self-mailers.mjs +0 -78
- package/resources/self-mailers.mjs.map +0 -1
- package/resources/shared.d.ts +0 -151
- package/resources/shared.d.ts.map +0 -1
- package/resources/shared.js +0 -4
- package/resources/shared.js.map +0 -1
- package/resources/shared.mjs +0 -3
- package/resources/shared.mjs.map +0 -1
- package/resources/sub-organizations.d.ts +0 -394
- package/resources/sub-organizations.d.ts.map +0 -1
- package/resources/sub-organizations.js +0 -63
- package/resources/sub-organizations.js.map +0 -1
- package/resources/sub-organizations.mjs +0 -58
- package/resources/sub-organizations.mjs.map +0 -1
- package/resources/templates.d.ts +0 -166
- package/resources/templates.d.ts.map +0 -1
- package/resources/templates.js +0 -72
- package/resources/templates.js.map +0 -1
- package/resources/templates.mjs +0 -67
- package/resources/templates.mjs.map +0 -1
- package/shims/node.d.ts +0 -30
- package/shims/node.d.ts.map +0 -1
- package/shims/node.js +0 -31
- package/shims/node.js.map +0 -1
- package/shims/node.mjs +0 -5
- package/shims/node.mjs.map +0 -1
- package/shims/web.d.ts +0 -26
- package/shims/web.d.ts.map +0 -1
- package/shims/web.js +0 -31
- package/shims/web.js.map +0 -1
- package/shims/web.mjs +0 -5
- package/shims/web.mjs.map +0 -1
- package/src/_shims/MultipartBody.ts +0 -9
- package/src/_shims/README.md +0 -46
- package/src/_shims/auto/runtime-bun.ts +0 -4
- package/src/_shims/auto/runtime-node.ts +0 -4
- package/src/_shims/auto/runtime.ts +0 -4
- package/src/_shims/auto/types-node.ts +0 -4
- package/src/_shims/auto/types.d.ts +0 -101
- package/src/_shims/auto/types.js +0 -3
- package/src/_shims/auto/types.mjs +0 -3
- package/src/_shims/bun-runtime.ts +0 -14
- package/src/_shims/index.d.ts +0 -83
- package/src/_shims/index.js +0 -17
- package/src/_shims/index.mjs +0 -11
- package/src/_shims/manual-types.d.ts +0 -12
- package/src/_shims/manual-types.js +0 -3
- package/src/_shims/manual-types.mjs +0 -3
- package/src/_shims/node-runtime.ts +0 -81
- package/src/_shims/node-types.d.ts +0 -42
- package/src/_shims/node-types.js +0 -3
- package/src/_shims/node-types.mjs +0 -3
- package/src/_shims/registry.ts +0 -67
- package/src/_shims/web-runtime.ts +0 -103
- package/src/_shims/web-types.d.ts +0 -83
- package/src/_shims/web-types.js +0 -3
- package/src/_shims/web-types.mjs +0 -3
- package/src/core.ts +0 -1236
- package/src/pagination.ts +0 -74
- package/src/resources/bank-accounts.ts +0 -435
- package/src/resources/boxes.ts +0 -1017
- package/src/resources/campaigns.ts +0 -853
- package/src/resources/cheques/cheques.ts +0 -524
- package/src/resources/cheques/index.ts +0 -12
- package/src/resources/cheques/url.ts +0 -42
- package/src/resources/cheques/with-deposit-ready-pdf.ts +0 -23
- package/src/resources/cheques.ts +0 -3
- package/src/resources/contacts.ts +0 -415
- package/src/resources/letters.ts +0 -902
- package/src/resources/mailing-list-imports.ts +0 -1076
- package/src/resources/mailing-lists.ts +0 -511
- package/src/resources/order-profiles/cheques.ts +0 -888
- package/src/resources/order-profiles/index.ts +0 -55
- package/src/resources/order-profiles/letters.ts +0 -956
- package/src/resources/order-profiles/order-profiles.ts +0 -133
- package/src/resources/order-profiles/postcards.ts +0 -694
- package/src/resources/order-profiles/self-mailers.ts +0 -707
- package/src/resources/postcards.ts +0 -582
- package/src/resources/reports/exports.ts +0 -299
- package/src/resources/reports/index.ts +0 -25
- package/src/resources/reports/reports.ts +0 -494
- package/src/resources/self-mailers.ts +0 -1024
- package/src/resources/shared.ts +0 -182
- package/src/resources/sub-organizations.ts +0 -518
- package/src/resources/templates.ts +0 -218
- package/src/shims/node.ts +0 -50
- package/src/shims/web.ts +0 -50
- /package/resources/{order-profiles.d.ts → print-mail/order-profiles.d.ts} +0 -0
- /package/resources/{order-profiles.mjs → print-mail/order-profiles.mjs} +0 -0
- /package/resources/{reports.d.ts → print-mail/reports.d.ts} +0 -0
- /package/resources/{reports.mjs → print-mail/reports.mjs} +0 -0
- /package/src/resources/{order-profiles.ts → print-mail/order-profiles.ts} +0 -0
- /package/src/resources/{reports.ts → print-mail/reports.ts} +0 -0
|
@@ -0,0 +1,214 @@
|
|
|
1
|
+
import { APIResource } from "../../../core/resource.mjs";
|
|
2
|
+
import * as ExportsAPI from "./exports.mjs";
|
|
3
|
+
import { ExportCreateParams, ExportDeleteParams, ExportRetrieveParams, Exports, ReportExport } from "./exports.mjs";
|
|
4
|
+
import * as SamplesAPI from "./samples.mjs";
|
|
5
|
+
import { ReportSample, ReportSampleCreateBase, SampleCreateParams, Samples } from "./samples.mjs";
|
|
6
|
+
import { APIPromise } from "../../../core/api-promise.mjs";
|
|
7
|
+
import { RequestOptions } from "../../../internal/request-options.mjs";
|
|
8
|
+
export declare class Reports extends APIResource {
|
|
9
|
+
samples: SamplesAPI.Samples;
|
|
10
|
+
exports: ExportsAPI.Exports;
|
|
11
|
+
/**
|
|
12
|
+
* Create a new saved report definition. Saved reports are SQL queries that can be
|
|
13
|
+
* executed later to generate full exports or samples.
|
|
14
|
+
*
|
|
15
|
+
* If you just want to do ad-hoc queries, you should use the `/reports/samples`
|
|
16
|
+
* endpoint.
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* ```ts
|
|
20
|
+
* const report = await client.printMail.reports.create({
|
|
21
|
+
* sqlQuery:
|
|
22
|
+
* 'SELECT id, status FROM orders WHERE created_at > ?',
|
|
23
|
+
* description: 'Recent Orders',
|
|
24
|
+
* metadata: { team: 'Sales' },
|
|
25
|
+
* });
|
|
26
|
+
* ```
|
|
27
|
+
*/
|
|
28
|
+
create(body: ReportCreateParams, options?: RequestOptions): APIPromise<Report>;
|
|
29
|
+
/**
|
|
30
|
+
* Retrieve the details of a specific saved report by its ID.
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* ```ts
|
|
34
|
+
* const report = await client.printMail.reports.retrieve(
|
|
35
|
+
* 'id',
|
|
36
|
+
* );
|
|
37
|
+
* ```
|
|
38
|
+
*/
|
|
39
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<Report>;
|
|
40
|
+
/**
|
|
41
|
+
* Update an existing saved report definition. You can change the query,
|
|
42
|
+
* description, or metadata.
|
|
43
|
+
*
|
|
44
|
+
* @example
|
|
45
|
+
* ```ts
|
|
46
|
+
* const report = await client.printMail.reports.update('id', {
|
|
47
|
+
* description: 'Recent Orders (Updated)',
|
|
48
|
+
* });
|
|
49
|
+
* ```
|
|
50
|
+
*/
|
|
51
|
+
update(id: string, body: ReportUpdateParams, options?: RequestOptions): APIPromise<Report>;
|
|
52
|
+
/**
|
|
53
|
+
* Retrieve a list of saved reports for your organization.
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* ```ts
|
|
57
|
+
* const reports = await client.printMail.reports.list();
|
|
58
|
+
* ```
|
|
59
|
+
*/
|
|
60
|
+
list(query?: ReportListParams | null | undefined, options?: RequestOptions): APIPromise<ReportListResponse>;
|
|
61
|
+
/**
|
|
62
|
+
* Delete a saved report definition. This action cannot be undone. Associated
|
|
63
|
+
* exports are not automatically deleted.
|
|
64
|
+
*
|
|
65
|
+
* @example
|
|
66
|
+
* ```ts
|
|
67
|
+
* const deletedResponse =
|
|
68
|
+
* await client.printMail.reports.delete('id');
|
|
69
|
+
* ```
|
|
70
|
+
*/
|
|
71
|
+
delete(id: string, options?: RequestOptions): APIPromise<DeletedResponse>;
|
|
72
|
+
/**
|
|
73
|
+
* Run an ad-hoc SQL query against your data lake and get a sample of the results.
|
|
74
|
+
* This is useful for quickly testing queries without saving them as a report. The
|
|
75
|
+
* query execution time and result size are limited.
|
|
76
|
+
*
|
|
77
|
+
* @example
|
|
78
|
+
* ```ts
|
|
79
|
+
* const reportSample = await client.printMail.reports.sample({
|
|
80
|
+
* sqlQuery: 'SELECT id FROM contacts LIMIT 5',
|
|
81
|
+
* limit: 5,
|
|
82
|
+
* params: [],
|
|
83
|
+
* });
|
|
84
|
+
* ```
|
|
85
|
+
*/
|
|
86
|
+
sample(body: ReportSampleParams, options?: RequestOptions): APIPromise<SamplesAPI.ReportSample>;
|
|
87
|
+
}
|
|
88
|
+
/**
|
|
89
|
+
* Generic response for delete operations.
|
|
90
|
+
*/
|
|
91
|
+
export interface DeletedResponse {
|
|
92
|
+
/**
|
|
93
|
+
* The ID of the deleted resource.
|
|
94
|
+
*/
|
|
95
|
+
id: string;
|
|
96
|
+
/**
|
|
97
|
+
* Indicates the resource was successfully deleted.
|
|
98
|
+
*/
|
|
99
|
+
deleted: true;
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* Represents a saved Report definition.
|
|
103
|
+
*/
|
|
104
|
+
export interface Report {
|
|
105
|
+
/**
|
|
106
|
+
* Unique identifier for the report.
|
|
107
|
+
*/
|
|
108
|
+
id: string;
|
|
109
|
+
/**
|
|
110
|
+
* Timestamp when the report was created.
|
|
111
|
+
*/
|
|
112
|
+
createdAt: string;
|
|
113
|
+
/**
|
|
114
|
+
* Indicates if the report is associated with the live or test environment.
|
|
115
|
+
*/
|
|
116
|
+
live: boolean;
|
|
117
|
+
/**
|
|
118
|
+
* Always `report`.
|
|
119
|
+
*/
|
|
120
|
+
object: 'report';
|
|
121
|
+
/**
|
|
122
|
+
* The SQL query defining the report.
|
|
123
|
+
*/
|
|
124
|
+
sqlQuery: string;
|
|
125
|
+
/**
|
|
126
|
+
* Timestamp when the report was last updated.
|
|
127
|
+
*/
|
|
128
|
+
updatedAt: string;
|
|
129
|
+
/**
|
|
130
|
+
* An optional user-friendly description for the report.
|
|
131
|
+
*/
|
|
132
|
+
description?: string;
|
|
133
|
+
/**
|
|
134
|
+
* Optional key-value metadata associated with the report.
|
|
135
|
+
*/
|
|
136
|
+
metadata?: {
|
|
137
|
+
[key: string]: string;
|
|
138
|
+
};
|
|
139
|
+
}
|
|
140
|
+
/**
|
|
141
|
+
* Represents a list of Reports.
|
|
142
|
+
*/
|
|
143
|
+
export interface ReportListResponse {
|
|
144
|
+
data: Array<Report>;
|
|
145
|
+
limit: number;
|
|
146
|
+
object: 'list';
|
|
147
|
+
skip: number;
|
|
148
|
+
totalCount: number;
|
|
149
|
+
}
|
|
150
|
+
export interface ReportCreateParams {
|
|
151
|
+
/**
|
|
152
|
+
* The SQL query defining the report.
|
|
153
|
+
*/
|
|
154
|
+
sqlQuery: string;
|
|
155
|
+
/**
|
|
156
|
+
* An optional user-friendly description for the report.
|
|
157
|
+
*/
|
|
158
|
+
description?: string;
|
|
159
|
+
/**
|
|
160
|
+
* Optional key-value metadata associated with the report.
|
|
161
|
+
*/
|
|
162
|
+
metadata?: {
|
|
163
|
+
[key: string]: string;
|
|
164
|
+
};
|
|
165
|
+
}
|
|
166
|
+
export interface ReportUpdateParams {
|
|
167
|
+
/**
|
|
168
|
+
* An optional user-friendly description for the report. Set to null to remove.
|
|
169
|
+
*/
|
|
170
|
+
description?: string | null;
|
|
171
|
+
/**
|
|
172
|
+
* Optional key-value metadata associated with the report. Set to null to remove.
|
|
173
|
+
*/
|
|
174
|
+
metadata?: {
|
|
175
|
+
[key: string]: string;
|
|
176
|
+
} | null;
|
|
177
|
+
/**
|
|
178
|
+
* The SQL query defining the report.
|
|
179
|
+
*/
|
|
180
|
+
sqlQuery?: string;
|
|
181
|
+
}
|
|
182
|
+
export interface ReportListParams {
|
|
183
|
+
limit?: number;
|
|
184
|
+
/**
|
|
185
|
+
* You can supply any string to help narrow down the list of resources. For
|
|
186
|
+
* example, if you pass `"New York"` (quoted), it will return resources that have
|
|
187
|
+
* that string present somewhere in their response. Alternatively, you can supply a
|
|
188
|
+
* structured search query. See the documentation on `StructuredSearchQuery` for
|
|
189
|
+
* more details.
|
|
190
|
+
*/
|
|
191
|
+
search?: string;
|
|
192
|
+
skip?: number;
|
|
193
|
+
}
|
|
194
|
+
export interface ReportSampleParams {
|
|
195
|
+
/**
|
|
196
|
+
* The SQL query to execute for the sample.
|
|
197
|
+
*/
|
|
198
|
+
sqlQuery: string;
|
|
199
|
+
/**
|
|
200
|
+
* Maximum number of rows to return in the sample.
|
|
201
|
+
*/
|
|
202
|
+
limit?: number;
|
|
203
|
+
/**
|
|
204
|
+
* Optional parameters to bind to the SQL query (e.g., for placeholders like ? or
|
|
205
|
+
* $1).
|
|
206
|
+
*/
|
|
207
|
+
params?: Array<string>;
|
|
208
|
+
}
|
|
209
|
+
export declare namespace Reports {
|
|
210
|
+
export { type DeletedResponse as DeletedResponse, type Report as Report, type ReportListResponse as ReportListResponse, type ReportCreateParams as ReportCreateParams, type ReportUpdateParams as ReportUpdateParams, type ReportListParams as ReportListParams, type ReportSampleParams as ReportSampleParams, };
|
|
211
|
+
export { Samples as Samples, type ReportSample as ReportSample, type ReportSampleCreateBase as ReportSampleCreateBase, type SampleCreateParams as SampleCreateParams, };
|
|
212
|
+
export { Exports as Exports, type ReportExport as ReportExport, type ExportCreateParams as ExportCreateParams, type ExportRetrieveParams as ExportRetrieveParams, type ExportDeleteParams as ExportDeleteParams, };
|
|
213
|
+
}
|
|
214
|
+
//# sourceMappingURL=reports.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"reports.d.mts","sourceRoot":"","sources":["../../../src/resources/print-mail/reports/reports.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EACL,kBAAkB,EAClB,kBAAkB,EAClB,oBAAoB,EACpB,OAAO,EACP,YAAY,EACb;OACM,KAAK,UAAU;OACf,EAAE,YAAY,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,OAAO,EAAE;OACrE,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI9E;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIlE;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI1F;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kBAAkB,CAAC;IAIjC;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAIzE;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC,YAAY,CAAC;CAGhG;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACtC;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAKD,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
|
|
@@ -0,0 +1,214 @@
|
|
|
1
|
+
import { APIResource } from "../../../core/resource.js";
|
|
2
|
+
import * as ExportsAPI from "./exports.js";
|
|
3
|
+
import { ExportCreateParams, ExportDeleteParams, ExportRetrieveParams, Exports, ReportExport } from "./exports.js";
|
|
4
|
+
import * as SamplesAPI from "./samples.js";
|
|
5
|
+
import { ReportSample, ReportSampleCreateBase, SampleCreateParams, Samples } from "./samples.js";
|
|
6
|
+
import { APIPromise } from "../../../core/api-promise.js";
|
|
7
|
+
import { RequestOptions } from "../../../internal/request-options.js";
|
|
8
|
+
export declare class Reports extends APIResource {
|
|
9
|
+
samples: SamplesAPI.Samples;
|
|
10
|
+
exports: ExportsAPI.Exports;
|
|
11
|
+
/**
|
|
12
|
+
* Create a new saved report definition. Saved reports are SQL queries that can be
|
|
13
|
+
* executed later to generate full exports or samples.
|
|
14
|
+
*
|
|
15
|
+
* If you just want to do ad-hoc queries, you should use the `/reports/samples`
|
|
16
|
+
* endpoint.
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* ```ts
|
|
20
|
+
* const report = await client.printMail.reports.create({
|
|
21
|
+
* sqlQuery:
|
|
22
|
+
* 'SELECT id, status FROM orders WHERE created_at > ?',
|
|
23
|
+
* description: 'Recent Orders',
|
|
24
|
+
* metadata: { team: 'Sales' },
|
|
25
|
+
* });
|
|
26
|
+
* ```
|
|
27
|
+
*/
|
|
28
|
+
create(body: ReportCreateParams, options?: RequestOptions): APIPromise<Report>;
|
|
29
|
+
/**
|
|
30
|
+
* Retrieve the details of a specific saved report by its ID.
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* ```ts
|
|
34
|
+
* const report = await client.printMail.reports.retrieve(
|
|
35
|
+
* 'id',
|
|
36
|
+
* );
|
|
37
|
+
* ```
|
|
38
|
+
*/
|
|
39
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<Report>;
|
|
40
|
+
/**
|
|
41
|
+
* Update an existing saved report definition. You can change the query,
|
|
42
|
+
* description, or metadata.
|
|
43
|
+
*
|
|
44
|
+
* @example
|
|
45
|
+
* ```ts
|
|
46
|
+
* const report = await client.printMail.reports.update('id', {
|
|
47
|
+
* description: 'Recent Orders (Updated)',
|
|
48
|
+
* });
|
|
49
|
+
* ```
|
|
50
|
+
*/
|
|
51
|
+
update(id: string, body: ReportUpdateParams, options?: RequestOptions): APIPromise<Report>;
|
|
52
|
+
/**
|
|
53
|
+
* Retrieve a list of saved reports for your organization.
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* ```ts
|
|
57
|
+
* const reports = await client.printMail.reports.list();
|
|
58
|
+
* ```
|
|
59
|
+
*/
|
|
60
|
+
list(query?: ReportListParams | null | undefined, options?: RequestOptions): APIPromise<ReportListResponse>;
|
|
61
|
+
/**
|
|
62
|
+
* Delete a saved report definition. This action cannot be undone. Associated
|
|
63
|
+
* exports are not automatically deleted.
|
|
64
|
+
*
|
|
65
|
+
* @example
|
|
66
|
+
* ```ts
|
|
67
|
+
* const deletedResponse =
|
|
68
|
+
* await client.printMail.reports.delete('id');
|
|
69
|
+
* ```
|
|
70
|
+
*/
|
|
71
|
+
delete(id: string, options?: RequestOptions): APIPromise<DeletedResponse>;
|
|
72
|
+
/**
|
|
73
|
+
* Run an ad-hoc SQL query against your data lake and get a sample of the results.
|
|
74
|
+
* This is useful for quickly testing queries without saving them as a report. The
|
|
75
|
+
* query execution time and result size are limited.
|
|
76
|
+
*
|
|
77
|
+
* @example
|
|
78
|
+
* ```ts
|
|
79
|
+
* const reportSample = await client.printMail.reports.sample({
|
|
80
|
+
* sqlQuery: 'SELECT id FROM contacts LIMIT 5',
|
|
81
|
+
* limit: 5,
|
|
82
|
+
* params: [],
|
|
83
|
+
* });
|
|
84
|
+
* ```
|
|
85
|
+
*/
|
|
86
|
+
sample(body: ReportSampleParams, options?: RequestOptions): APIPromise<SamplesAPI.ReportSample>;
|
|
87
|
+
}
|
|
88
|
+
/**
|
|
89
|
+
* Generic response for delete operations.
|
|
90
|
+
*/
|
|
91
|
+
export interface DeletedResponse {
|
|
92
|
+
/**
|
|
93
|
+
* The ID of the deleted resource.
|
|
94
|
+
*/
|
|
95
|
+
id: string;
|
|
96
|
+
/**
|
|
97
|
+
* Indicates the resource was successfully deleted.
|
|
98
|
+
*/
|
|
99
|
+
deleted: true;
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* Represents a saved Report definition.
|
|
103
|
+
*/
|
|
104
|
+
export interface Report {
|
|
105
|
+
/**
|
|
106
|
+
* Unique identifier for the report.
|
|
107
|
+
*/
|
|
108
|
+
id: string;
|
|
109
|
+
/**
|
|
110
|
+
* Timestamp when the report was created.
|
|
111
|
+
*/
|
|
112
|
+
createdAt: string;
|
|
113
|
+
/**
|
|
114
|
+
* Indicates if the report is associated with the live or test environment.
|
|
115
|
+
*/
|
|
116
|
+
live: boolean;
|
|
117
|
+
/**
|
|
118
|
+
* Always `report`.
|
|
119
|
+
*/
|
|
120
|
+
object: 'report';
|
|
121
|
+
/**
|
|
122
|
+
* The SQL query defining the report.
|
|
123
|
+
*/
|
|
124
|
+
sqlQuery: string;
|
|
125
|
+
/**
|
|
126
|
+
* Timestamp when the report was last updated.
|
|
127
|
+
*/
|
|
128
|
+
updatedAt: string;
|
|
129
|
+
/**
|
|
130
|
+
* An optional user-friendly description for the report.
|
|
131
|
+
*/
|
|
132
|
+
description?: string;
|
|
133
|
+
/**
|
|
134
|
+
* Optional key-value metadata associated with the report.
|
|
135
|
+
*/
|
|
136
|
+
metadata?: {
|
|
137
|
+
[key: string]: string;
|
|
138
|
+
};
|
|
139
|
+
}
|
|
140
|
+
/**
|
|
141
|
+
* Represents a list of Reports.
|
|
142
|
+
*/
|
|
143
|
+
export interface ReportListResponse {
|
|
144
|
+
data: Array<Report>;
|
|
145
|
+
limit: number;
|
|
146
|
+
object: 'list';
|
|
147
|
+
skip: number;
|
|
148
|
+
totalCount: number;
|
|
149
|
+
}
|
|
150
|
+
export interface ReportCreateParams {
|
|
151
|
+
/**
|
|
152
|
+
* The SQL query defining the report.
|
|
153
|
+
*/
|
|
154
|
+
sqlQuery: string;
|
|
155
|
+
/**
|
|
156
|
+
* An optional user-friendly description for the report.
|
|
157
|
+
*/
|
|
158
|
+
description?: string;
|
|
159
|
+
/**
|
|
160
|
+
* Optional key-value metadata associated with the report.
|
|
161
|
+
*/
|
|
162
|
+
metadata?: {
|
|
163
|
+
[key: string]: string;
|
|
164
|
+
};
|
|
165
|
+
}
|
|
166
|
+
export interface ReportUpdateParams {
|
|
167
|
+
/**
|
|
168
|
+
* An optional user-friendly description for the report. Set to null to remove.
|
|
169
|
+
*/
|
|
170
|
+
description?: string | null;
|
|
171
|
+
/**
|
|
172
|
+
* Optional key-value metadata associated with the report. Set to null to remove.
|
|
173
|
+
*/
|
|
174
|
+
metadata?: {
|
|
175
|
+
[key: string]: string;
|
|
176
|
+
} | null;
|
|
177
|
+
/**
|
|
178
|
+
* The SQL query defining the report.
|
|
179
|
+
*/
|
|
180
|
+
sqlQuery?: string;
|
|
181
|
+
}
|
|
182
|
+
export interface ReportListParams {
|
|
183
|
+
limit?: number;
|
|
184
|
+
/**
|
|
185
|
+
* You can supply any string to help narrow down the list of resources. For
|
|
186
|
+
* example, if you pass `"New York"` (quoted), it will return resources that have
|
|
187
|
+
* that string present somewhere in their response. Alternatively, you can supply a
|
|
188
|
+
* structured search query. See the documentation on `StructuredSearchQuery` for
|
|
189
|
+
* more details.
|
|
190
|
+
*/
|
|
191
|
+
search?: string;
|
|
192
|
+
skip?: number;
|
|
193
|
+
}
|
|
194
|
+
export interface ReportSampleParams {
|
|
195
|
+
/**
|
|
196
|
+
* The SQL query to execute for the sample.
|
|
197
|
+
*/
|
|
198
|
+
sqlQuery: string;
|
|
199
|
+
/**
|
|
200
|
+
* Maximum number of rows to return in the sample.
|
|
201
|
+
*/
|
|
202
|
+
limit?: number;
|
|
203
|
+
/**
|
|
204
|
+
* Optional parameters to bind to the SQL query (e.g., for placeholders like ? or
|
|
205
|
+
* $1).
|
|
206
|
+
*/
|
|
207
|
+
params?: Array<string>;
|
|
208
|
+
}
|
|
209
|
+
export declare namespace Reports {
|
|
210
|
+
export { type DeletedResponse as DeletedResponse, type Report as Report, type ReportListResponse as ReportListResponse, type ReportCreateParams as ReportCreateParams, type ReportUpdateParams as ReportUpdateParams, type ReportListParams as ReportListParams, type ReportSampleParams as ReportSampleParams, };
|
|
211
|
+
export { Samples as Samples, type ReportSample as ReportSample, type ReportSampleCreateBase as ReportSampleCreateBase, type SampleCreateParams as SampleCreateParams, };
|
|
212
|
+
export { Exports as Exports, type ReportExport as ReportExport, type ExportCreateParams as ExportCreateParams, type ExportRetrieveParams as ExportRetrieveParams, type ExportDeleteParams as ExportDeleteParams, };
|
|
213
|
+
}
|
|
214
|
+
//# sourceMappingURL=reports.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"reports.d.ts","sourceRoot":"","sources":["../../../src/resources/print-mail/reports/reports.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EACL,kBAAkB,EAClB,kBAAkB,EAClB,oBAAoB,EACpB,OAAO,EACP,YAAY,EACb;OACM,KAAK,UAAU;OACf,EAAE,YAAY,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,OAAO,EAAE;OACrE,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI9E;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIlE;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI1F;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kBAAkB,CAAC;IAIjC;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAIzE;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC,YAAY,CAAC;CAGhG;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACtC;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAKD,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.Reports = void 0;
|
|
5
|
+
const tslib_1 = require("../../../internal/tslib.js");
|
|
6
|
+
const resource_1 = require("../../../core/resource.js");
|
|
7
|
+
const ExportsAPI = tslib_1.__importStar(require("./exports.js"));
|
|
8
|
+
const exports_1 = require("./exports.js");
|
|
9
|
+
const SamplesAPI = tslib_1.__importStar(require("./samples.js"));
|
|
10
|
+
const samples_1 = require("./samples.js");
|
|
11
|
+
const path_1 = require("../../../internal/utils/path.js");
|
|
12
|
+
class Reports extends resource_1.APIResource {
|
|
13
|
+
constructor() {
|
|
14
|
+
super(...arguments);
|
|
15
|
+
this.samples = new SamplesAPI.Samples(this._client);
|
|
16
|
+
this.exports = new ExportsAPI.Exports(this._client);
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Create a new saved report definition. Saved reports are SQL queries that can be
|
|
20
|
+
* executed later to generate full exports or samples.
|
|
21
|
+
*
|
|
22
|
+
* If you just want to do ad-hoc queries, you should use the `/reports/samples`
|
|
23
|
+
* endpoint.
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* ```ts
|
|
27
|
+
* const report = await client.printMail.reports.create({
|
|
28
|
+
* sqlQuery:
|
|
29
|
+
* 'SELECT id, status FROM orders WHERE created_at > ?',
|
|
30
|
+
* description: 'Recent Orders',
|
|
31
|
+
* metadata: { team: 'Sales' },
|
|
32
|
+
* });
|
|
33
|
+
* ```
|
|
34
|
+
*/
|
|
35
|
+
create(body, options) {
|
|
36
|
+
return this._client.post('/print-mail/v1/reports', { body, ...options });
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Retrieve the details of a specific saved report by its ID.
|
|
40
|
+
*
|
|
41
|
+
* @example
|
|
42
|
+
* ```ts
|
|
43
|
+
* const report = await client.printMail.reports.retrieve(
|
|
44
|
+
* 'id',
|
|
45
|
+
* );
|
|
46
|
+
* ```
|
|
47
|
+
*/
|
|
48
|
+
retrieve(id, options) {
|
|
49
|
+
return this._client.get((0, path_1.path) `/print-mail/v1/reports/${id}`, options);
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Update an existing saved report definition. You can change the query,
|
|
53
|
+
* description, or metadata.
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* ```ts
|
|
57
|
+
* const report = await client.printMail.reports.update('id', {
|
|
58
|
+
* description: 'Recent Orders (Updated)',
|
|
59
|
+
* });
|
|
60
|
+
* ```
|
|
61
|
+
*/
|
|
62
|
+
update(id, body, options) {
|
|
63
|
+
return this._client.post((0, path_1.path) `/print-mail/v1/reports/${id}`, { body, ...options });
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Retrieve a list of saved reports for your organization.
|
|
67
|
+
*
|
|
68
|
+
* @example
|
|
69
|
+
* ```ts
|
|
70
|
+
* const reports = await client.printMail.reports.list();
|
|
71
|
+
* ```
|
|
72
|
+
*/
|
|
73
|
+
list(query = {}, options) {
|
|
74
|
+
return this._client.get('/print-mail/v1/reports', { query, ...options });
|
|
75
|
+
}
|
|
76
|
+
/**
|
|
77
|
+
* Delete a saved report definition. This action cannot be undone. Associated
|
|
78
|
+
* exports are not automatically deleted.
|
|
79
|
+
*
|
|
80
|
+
* @example
|
|
81
|
+
* ```ts
|
|
82
|
+
* const deletedResponse =
|
|
83
|
+
* await client.printMail.reports.delete('id');
|
|
84
|
+
* ```
|
|
85
|
+
*/
|
|
86
|
+
delete(id, options) {
|
|
87
|
+
return this._client.delete((0, path_1.path) `/print-mail/v1/reports/${id}`, options);
|
|
88
|
+
}
|
|
89
|
+
/**
|
|
90
|
+
* Run an ad-hoc SQL query against your data lake and get a sample of the results.
|
|
91
|
+
* This is useful for quickly testing queries without saving them as a report. The
|
|
92
|
+
* query execution time and result size are limited.
|
|
93
|
+
*
|
|
94
|
+
* @example
|
|
95
|
+
* ```ts
|
|
96
|
+
* const reportSample = await client.printMail.reports.sample({
|
|
97
|
+
* sqlQuery: 'SELECT id FROM contacts LIMIT 5',
|
|
98
|
+
* limit: 5,
|
|
99
|
+
* params: [],
|
|
100
|
+
* });
|
|
101
|
+
* ```
|
|
102
|
+
*/
|
|
103
|
+
sample(body, options) {
|
|
104
|
+
return this._client.post('/print-mail/v1/reports/samples', { body, ...options });
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
exports.Reports = Reports;
|
|
108
|
+
Reports.Samples = samples_1.Samples;
|
|
109
|
+
Reports.Exports = exports_1.Exports;
|
|
110
|
+
//# sourceMappingURL=reports.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"reports.js","sourceRoot":"","sources":["../../../src/resources/print-mail/reports/reports.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AACrD,iEAAwC;AACxC,0CAMmB;AACnB,iEAAwC;AACxC,0CAA8F;AAG9F,0DAAoD;AAEpD,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkGrE,CAAC;IAhGC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,IAAwB,EAAE,OAAwB;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;CACF;AApGD,0BAoGC;AAgJD,OAAO,CAAC,OAAO,GAAG,iBAAO,CAAC;AAC1B,OAAO,CAAC,OAAO,GAAG,iBAAO,CAAC"}
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../../../core/resource.mjs";
|
|
3
|
+
import * as ExportsAPI from "./exports.mjs";
|
|
4
|
+
import { Exports, } from "./exports.mjs";
|
|
5
|
+
import * as SamplesAPI from "./samples.mjs";
|
|
6
|
+
import { Samples } from "./samples.mjs";
|
|
7
|
+
import { path } from "../../../internal/utils/path.mjs";
|
|
8
|
+
export class Reports extends APIResource {
|
|
9
|
+
constructor() {
|
|
10
|
+
super(...arguments);
|
|
11
|
+
this.samples = new SamplesAPI.Samples(this._client);
|
|
12
|
+
this.exports = new ExportsAPI.Exports(this._client);
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Create a new saved report definition. Saved reports are SQL queries that can be
|
|
16
|
+
* executed later to generate full exports or samples.
|
|
17
|
+
*
|
|
18
|
+
* If you just want to do ad-hoc queries, you should use the `/reports/samples`
|
|
19
|
+
* endpoint.
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* ```ts
|
|
23
|
+
* const report = await client.printMail.reports.create({
|
|
24
|
+
* sqlQuery:
|
|
25
|
+
* 'SELECT id, status FROM orders WHERE created_at > ?',
|
|
26
|
+
* description: 'Recent Orders',
|
|
27
|
+
* metadata: { team: 'Sales' },
|
|
28
|
+
* });
|
|
29
|
+
* ```
|
|
30
|
+
*/
|
|
31
|
+
create(body, options) {
|
|
32
|
+
return this._client.post('/print-mail/v1/reports', { body, ...options });
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Retrieve the details of a specific saved report by its ID.
|
|
36
|
+
*
|
|
37
|
+
* @example
|
|
38
|
+
* ```ts
|
|
39
|
+
* const report = await client.printMail.reports.retrieve(
|
|
40
|
+
* 'id',
|
|
41
|
+
* );
|
|
42
|
+
* ```
|
|
43
|
+
*/
|
|
44
|
+
retrieve(id, options) {
|
|
45
|
+
return this._client.get(path `/print-mail/v1/reports/${id}`, options);
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Update an existing saved report definition. You can change the query,
|
|
49
|
+
* description, or metadata.
|
|
50
|
+
*
|
|
51
|
+
* @example
|
|
52
|
+
* ```ts
|
|
53
|
+
* const report = await client.printMail.reports.update('id', {
|
|
54
|
+
* description: 'Recent Orders (Updated)',
|
|
55
|
+
* });
|
|
56
|
+
* ```
|
|
57
|
+
*/
|
|
58
|
+
update(id, body, options) {
|
|
59
|
+
return this._client.post(path `/print-mail/v1/reports/${id}`, { body, ...options });
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Retrieve a list of saved reports for your organization.
|
|
63
|
+
*
|
|
64
|
+
* @example
|
|
65
|
+
* ```ts
|
|
66
|
+
* const reports = await client.printMail.reports.list();
|
|
67
|
+
* ```
|
|
68
|
+
*/
|
|
69
|
+
list(query = {}, options) {
|
|
70
|
+
return this._client.get('/print-mail/v1/reports', { query, ...options });
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Delete a saved report definition. This action cannot be undone. Associated
|
|
74
|
+
* exports are not automatically deleted.
|
|
75
|
+
*
|
|
76
|
+
* @example
|
|
77
|
+
* ```ts
|
|
78
|
+
* const deletedResponse =
|
|
79
|
+
* await client.printMail.reports.delete('id');
|
|
80
|
+
* ```
|
|
81
|
+
*/
|
|
82
|
+
delete(id, options) {
|
|
83
|
+
return this._client.delete(path `/print-mail/v1/reports/${id}`, options);
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* Run an ad-hoc SQL query against your data lake and get a sample of the results.
|
|
87
|
+
* This is useful for quickly testing queries without saving them as a report. The
|
|
88
|
+
* query execution time and result size are limited.
|
|
89
|
+
*
|
|
90
|
+
* @example
|
|
91
|
+
* ```ts
|
|
92
|
+
* const reportSample = await client.printMail.reports.sample({
|
|
93
|
+
* sqlQuery: 'SELECT id FROM contacts LIMIT 5',
|
|
94
|
+
* limit: 5,
|
|
95
|
+
* params: [],
|
|
96
|
+
* });
|
|
97
|
+
* ```
|
|
98
|
+
*/
|
|
99
|
+
sample(body, options) {
|
|
100
|
+
return this._client.post('/print-mail/v1/reports/samples', { body, ...options });
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
Reports.Samples = Samples;
|
|
104
|
+
Reports.Exports = Exports;
|
|
105
|
+
//# sourceMappingURL=reports.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"reports.mjs","sourceRoot":"","sources":["../../../src/resources/print-mail/reports/reports.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAIL,OAAO,GAER;OACM,KAAK,UAAU;OACf,EAA4D,OAAO,EAAE;OAGrE,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkGrE,CAAC;IAhGC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,IAAwB,EAAE,OAAwB;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,0BAA0B,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,0BAA0B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;CACF;AAgJD,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;AAC1B,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC"}
|