@metronome/sdk 0.3.0 → 2.0.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 +113 -28
- package/README.md +123 -51
- 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/bin/cli +46 -0
- package/bin/migration-config.json +6 -0
- package/client.d.mts +232 -0
- package/client.d.mts.map +1 -0
- package/client.d.ts +232 -0
- package/client.d.ts.map +1 -0
- package/client.js +464 -0
- package/client.js.map +1 -0
- package/client.mjs +460 -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/pagination.d.mts +137 -0
- package/core/pagination.d.mts.map +1 -0
- package/core/pagination.d.ts +137 -0
- package/core/pagination.d.ts.map +1 -0
- package/core/pagination.js +158 -0
- package/core/pagination.js.map +1 -0
- package/core/pagination.mjs +150 -0
- package/core/pagination.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 +7 -144
- package/index.d.mts.map +1 -0
- package/index.d.ts +6 -143
- package/index.d.ts.map +1 -1
- package/index.js +14 -120
- package/index.js.map +1 -1
- package/index.mjs +6 -93
- 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 +26 -0
- package/internal/headers.d.mts.map +1 -0
- package/internal/headers.d.ts +26 -0
- package/internal/headers.d.ts.map +1 -0
- package/internal/headers.js +120 -0
- package/internal/headers.js.map +1 -0
- package/internal/headers.mjs +112 -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 +85 -0
- package/internal/utils/log.js.map +1 -0
- package/internal/utils/log.mjs +79 -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 +113 -64
- package/pagination.d.mts +2 -0
- package/pagination.d.mts.map +1 -0
- package/pagination.d.ts +1 -36
- package/pagination.d.ts.map +1 -1
- package/pagination.js +3 -40
- package/pagination.js.map +1 -1
- package/pagination.mjs +1 -38
- package/pagination.mjs.map +1 -1
- 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/index.d.mts +5 -0
- package/resources/index.d.mts.map +1 -0
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +2 -15
- package/resources/index.js.map +1 -1
- package/resources/shared.d.mts +2363 -0
- package/resources/shared.d.mts.map +1 -0
- package/resources/shared.d.ts +1470 -465
- package/resources/shared.d.ts.map +1 -1
- package/resources/v1/alerts.d.mts +207 -0
- package/resources/v1/alerts.d.mts.map +1 -0
- package/resources/v1/alerts.d.ts +107 -32
- package/resources/v1/alerts.d.ts.map +1 -1
- package/resources/v1/alerts.js +74 -3
- package/resources/v1/alerts.js.map +1 -1
- package/resources/v1/alerts.mjs +74 -3
- package/resources/v1/alerts.mjs.map +1 -1
- package/resources/v1/audit-logs.d.mts +108 -0
- package/resources/v1/audit-logs.d.mts.map +1 -0
- package/resources/v1/audit-logs.d.ts +45 -12
- package/resources/v1/audit-logs.d.ts.map +1 -1
- package/resources/v1/audit-logs.js +53 -12
- package/resources/v1/audit-logs.js.map +1 -1
- package/resources/v1/audit-logs.mjs +52 -10
- package/resources/v1/audit-logs.mjs.map +1 -1
- package/resources/v1/billable-metrics.d.mts +293 -0
- package/resources/v1/billable-metrics.d.mts.map +1 -0
- package/resources/v1/billable-metrics.d.ts +70 -15
- package/resources/v1/billable-metrics.d.ts.map +1 -1
- package/resources/v1/billable-metrics.js +70 -16
- package/resources/v1/billable-metrics.js.map +1 -1
- package/resources/v1/billable-metrics.mjs +69 -14
- package/resources/v1/billable-metrics.mjs.map +1 -1
- package/resources/v1/contracts/contracts.d.mts +3006 -0
- package/resources/v1/contracts/contracts.d.mts.map +1 -0
- package/resources/v1/contracts/contracts.d.ts +428 -1299
- package/resources/v1/contracts/contracts.d.ts.map +1 -1
- package/resources/v1/contracts/contracts.js +269 -50
- package/resources/v1/contracts/contracts.js.map +1 -1
- package/resources/v1/contracts/contracts.mjs +267 -26
- package/resources/v1/contracts/contracts.mjs.map +1 -1
- package/resources/v1/contracts/index.d.mts +5 -0
- package/resources/v1/contracts/index.d.mts.map +1 -0
- package/resources/v1/contracts/index.d.ts +3 -3
- package/resources/v1/contracts/index.d.ts.map +1 -1
- package/resources/v1/contracts/index.js +1 -3
- package/resources/v1/contracts/index.js.map +1 -1
- package/resources/v1/contracts/index.mjs +2 -2
- package/resources/v1/contracts/index.mjs.map +1 -1
- package/resources/v1/contracts/named-schedules.d.mts +82 -0
- package/resources/v1/contracts/named-schedules.d.mts.map +1 -0
- package/resources/v1/contracts/named-schedules.d.ts +5 -4
- package/resources/v1/contracts/named-schedules.d.ts.map +1 -1
- package/resources/v1/contracts/named-schedules.js +3 -2
- package/resources/v1/contracts/named-schedules.js.map +1 -1
- package/resources/v1/contracts/named-schedules.mjs +3 -2
- package/resources/v1/contracts/named-schedules.mjs.map +1 -1
- package/resources/v1/contracts/products.d.mts +502 -0
- package/resources/v1/contracts/products.d.mts.map +1 -0
- package/resources/v1/contracts/products.d.ts +44 -17
- package/resources/v1/contracts/products.d.ts.map +1 -1
- package/resources/v1/contracts/products.js +41 -17
- package/resources/v1/contracts/products.js.map +1 -1
- package/resources/v1/contracts/products.mjs +40 -15
- package/resources/v1/contracts/products.mjs.map +1 -1
- package/resources/v1/contracts/rate-cards/index.d.mts +5 -0
- package/resources/v1/contracts/rate-cards/index.d.mts.map +1 -0
- package/resources/v1/contracts/rate-cards/index.d.ts +2 -2
- package/resources/v1/contracts/rate-cards/index.d.ts.map +1 -1
- package/resources/v1/contracts/rate-cards/index.js +1 -3
- package/resources/v1/contracts/rate-cards/index.js.map +1 -1
- package/resources/v1/contracts/rate-cards/index.mjs +2 -2
- package/resources/v1/contracts/rate-cards/index.mjs.map +1 -1
- package/resources/v1/contracts/rate-cards/named-schedules.d.mts +94 -0
- package/resources/v1/contracts/rate-cards/named-schedules.d.mts.map +1 -0
- package/resources/v1/contracts/rate-cards/named-schedules.d.ts +5 -4
- package/resources/v1/contracts/rate-cards/named-schedules.d.ts.map +1 -1
- package/resources/v1/contracts/rate-cards/named-schedules.js +3 -2
- package/resources/v1/contracts/rate-cards/named-schedules.js.map +1 -1
- package/resources/v1/contracts/rate-cards/named-schedules.mjs +3 -2
- package/resources/v1/contracts/rate-cards/named-schedules.mjs.map +1 -1
- package/resources/v1/contracts/rate-cards/product-orders.d.mts +85 -0
- package/resources/v1/contracts/rate-cards/product-orders.d.mts.map +1 -0
- package/resources/v1/contracts/rate-cards/product-orders.d.ts +12 -6
- package/resources/v1/contracts/rate-cards/product-orders.d.ts.map +1 -1
- package/resources/v1/contracts/rate-cards/product-orders.js +8 -3
- package/resources/v1/contracts/rate-cards/product-orders.js.map +1 -1
- package/resources/v1/contracts/rate-cards/product-orders.mjs +8 -3
- package/resources/v1/contracts/rate-cards/product-orders.mjs.map +1 -1
- package/resources/v1/contracts/rate-cards/rate-cards.d.mts +452 -0
- package/resources/v1/contracts/rate-cards/rate-cards.d.mts.map +1 -0
- package/resources/v1/contracts/rate-cards/rate-cards.d.ts +134 -41
- package/resources/v1/contracts/rate-cards/rate-cards.d.ts.map +1 -1
- package/resources/v1/contracts/rate-cards/rate-cards.js +127 -47
- package/resources/v1/contracts/rate-cards/rate-cards.js.map +1 -1
- package/resources/v1/contracts/rate-cards/rate-cards.mjs +123 -20
- package/resources/v1/contracts/rate-cards/rate-cards.mjs.map +1 -1
- package/resources/v1/contracts/rate-cards/rates.d.mts +382 -0
- package/resources/v1/contracts/rate-cards/rates.d.mts.map +1 -0
- package/resources/v1/contracts/rate-cards/rates.d.ts +25 -82
- package/resources/v1/contracts/rate-cards/rates.d.ts.map +1 -1
- package/resources/v1/contracts/rate-cards/rates.js +13 -9
- package/resources/v1/contracts/rate-cards/rates.js.map +1 -1
- package/resources/v1/contracts/rate-cards/rates.mjs +12 -7
- package/resources/v1/contracts/rate-cards/rates.mjs.map +1 -1
- package/resources/v1/contracts/rate-cards.d.mts +2 -0
- package/resources/v1/contracts/rate-cards.d.mts.map +1 -0
- package/resources/v1/contracts/rate-cards.d.ts.map +1 -1
- package/resources/v1/contracts/rate-cards.js +2 -15
- package/resources/v1/contracts/rate-cards.js.map +1 -1
- package/resources/v1/contracts.d.mts +2 -0
- package/resources/v1/contracts.d.mts.map +1 -0
- package/resources/v1/contracts.d.ts.map +1 -1
- package/resources/v1/contracts.js +2 -15
- package/resources/v1/contracts.js.map +1 -1
- package/resources/v1/credit-grants.d.mts +505 -0
- package/resources/v1/credit-grants.d.mts.map +1 -0
- package/resources/v1/credit-grants.d.ts +73 -74
- package/resources/v1/credit-grants.d.ts.map +1 -1
- package/resources/v1/credit-grants.js +52 -18
- package/resources/v1/credit-grants.js.map +1 -1
- package/resources/v1/credit-grants.mjs +51 -16
- package/resources/v1/credit-grants.mjs.map +1 -1
- package/resources/v1/custom-fields.d.mts +151 -0
- package/resources/v1/custom-fields.d.mts.map +1 -0
- package/resources/v1/custom-fields.d.ts +69 -38
- package/resources/v1/custom-fields.d.ts.map +1 -1
- package/resources/v1/custom-fields.js +66 -22
- package/resources/v1/custom-fields.js.map +1 -1
- package/resources/v1/custom-fields.mjs +66 -22
- package/resources/v1/custom-fields.mjs.map +1 -1
- package/resources/v1/customers/alerts.d.mts +309 -0
- package/resources/v1/customers/alerts.d.mts.map +1 -0
- package/resources/v1/customers/alerts.d.ts +176 -50
- package/resources/v1/customers/alerts.d.ts.map +1 -1
- package/resources/v1/customers/alerts.js +131 -10
- package/resources/v1/customers/alerts.js.map +1 -1
- package/resources/v1/customers/alerts.mjs +131 -10
- package/resources/v1/customers/alerts.mjs.map +1 -1
- package/resources/v1/customers/billing-config.d.mts +125 -0
- package/resources/v1/customers/billing-config.d.mts.map +1 -0
- package/resources/v1/customers/billing-config.d.ts +8 -7
- package/resources/v1/customers/billing-config.d.ts.map +1 -1
- package/resources/v1/customers/billing-config.js +8 -6
- package/resources/v1/customers/billing-config.js.map +1 -1
- package/resources/v1/customers/billing-config.mjs +8 -6
- package/resources/v1/customers/billing-config.mjs.map +1 -1
- package/resources/v1/customers/commits.d.mts +456 -0
- package/resources/v1/customers/commits.d.mts.map +1 -0
- package/resources/v1/customers/commits.d.ts +139 -47
- package/resources/v1/customers/commits.d.ts.map +1 -1
- package/resources/v1/customers/commits.js +131 -12
- package/resources/v1/customers/commits.js.map +1 -1
- package/resources/v1/customers/commits.mjs +131 -12
- package/resources/v1/customers/commits.mjs.map +1 -1
- package/resources/v1/customers/credits.d.mts +310 -0
- package/resources/v1/customers/credits.d.mts.map +1 -0
- package/resources/v1/customers/credits.d.ts +124 -46
- package/resources/v1/customers/credits.d.ts.map +1 -1
- package/resources/v1/customers/credits.js +116 -11
- package/resources/v1/customers/credits.js.map +1 -1
- package/resources/v1/customers/credits.mjs +116 -11
- package/resources/v1/customers/credits.mjs.map +1 -1
- package/resources/v1/customers/customers.d.mts +819 -0
- package/resources/v1/customers/customers.d.mts.map +1 -0
- package/resources/v1/customers/customers.d.ts +319 -55
- package/resources/v1/customers/customers.d.ts.map +1 -1
- package/resources/v1/customers/customers.js +220 -76
- package/resources/v1/customers/customers.js.map +1 -1
- package/resources/v1/customers/customers.mjs +213 -44
- package/resources/v1/customers/customers.mjs.map +1 -1
- package/resources/v1/customers/index.d.mts +9 -0
- package/resources/v1/customers/index.d.mts.map +1 -0
- package/resources/v1/customers/index.d.ts +6 -6
- package/resources/v1/customers/index.d.ts.map +1 -1
- package/resources/v1/customers/index.js +1 -8
- package/resources/v1/customers/index.js.map +1 -1
- package/resources/v1/customers/index.mjs +3 -3
- package/resources/v1/customers/index.mjs.map +1 -1
- package/resources/v1/customers/invoices.d.mts +825 -0
- package/resources/v1/customers/invoices.d.mts.map +1 -0
- package/resources/v1/customers/invoices.d.ts +309 -25
- package/resources/v1/customers/invoices.d.ts.map +1 -1
- package/resources/v1/customers/invoices.js +180 -22
- package/resources/v1/customers/invoices.js.map +1 -1
- package/resources/v1/customers/invoices.mjs +179 -19
- package/resources/v1/customers/invoices.mjs.map +1 -1
- package/resources/v1/customers/named-schedules.d.mts +82 -0
- package/resources/v1/customers/named-schedules.d.mts.map +1 -0
- package/resources/v1/customers/named-schedules.d.ts +5 -4
- package/resources/v1/customers/named-schedules.d.ts.map +1 -1
- package/resources/v1/customers/named-schedules.js +3 -2
- package/resources/v1/customers/named-schedules.js.map +1 -1
- package/resources/v1/customers/named-schedules.mjs +3 -2
- package/resources/v1/customers/named-schedules.mjs.map +1 -1
- package/resources/v1/customers/plans.d.mts +281 -0
- package/resources/v1/customers/plans.d.mts.map +1 -0
- package/resources/v1/customers/plans.d.ts +14 -12
- package/resources/v1/customers/plans.d.ts.map +1 -1
- package/resources/v1/customers/plans.js +8 -15
- package/resources/v1/customers/plans.js.map +1 -1
- package/resources/v1/customers/plans.mjs +7 -12
- package/resources/v1/customers/plans.mjs.map +1 -1
- package/resources/v1/customers.d.mts +2 -0
- package/resources/v1/customers.d.mts.map +1 -0
- package/resources/v1/customers.d.ts.map +1 -1
- package/resources/v1/customers.js +2 -15
- package/resources/v1/customers.js.map +1 -1
- package/resources/v1/dashboards.d.mts +133 -0
- package/resources/v1/dashboards.d.mts.map +1 -0
- package/resources/v1/dashboards.d.ts +33 -6
- package/resources/v1/dashboards.d.ts.map +1 -1
- package/resources/v1/dashboards.js +30 -4
- package/resources/v1/dashboards.js.map +1 -1
- package/resources/v1/dashboards.mjs +30 -4
- package/resources/v1/dashboards.mjs.map +1 -1
- package/resources/v1/index.d.mts +16 -0
- package/resources/v1/index.d.mts.map +1 -0
- package/resources/v1/index.d.ts +10 -9
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js +3 -12
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs +8 -7
- package/resources/v1/index.mjs.map +1 -1
- package/resources/v1/invoices.d.mts +83 -0
- package/resources/v1/invoices.d.mts.map +1 -0
- package/resources/v1/invoices.d.ts +28 -6
- package/resources/v1/invoices.d.ts.map +1 -1
- package/resources/v1/invoices.js +24 -3
- package/resources/v1/invoices.js.map +1 -1
- package/resources/v1/invoices.mjs +24 -3
- package/resources/v1/invoices.mjs.map +1 -1
- package/resources/v1/payments.d.mts +116 -0
- package/resources/v1/payments.d.mts.map +1 -0
- package/resources/v1/payments.d.ts +116 -0
- package/resources/v1/payments.d.ts.map +1 -0
- package/resources/v1/payments.js +71 -0
- package/resources/v1/payments.js.map +1 -0
- package/resources/v1/payments.mjs +67 -0
- package/resources/v1/payments.mjs.map +1 -0
- package/resources/v1/plans.d.mts +240 -0
- package/resources/v1/plans.d.mts.map +1 -0
- package/resources/v1/plans.d.ts +24 -15
- package/resources/v1/plans.d.ts.map +1 -1
- package/resources/v1/plans.js +19 -26
- package/resources/v1/plans.js.map +1 -1
- package/resources/v1/plans.mjs +18 -22
- package/resources/v1/plans.mjs.map +1 -1
- package/resources/v1/pricing-units.d.mts +34 -0
- package/resources/v1/pricing-units.d.mts.map +1 -0
- package/resources/v1/pricing-units.d.ts +12 -9
- package/resources/v1/pricing-units.d.ts.map +1 -1
- package/resources/v1/pricing-units.js +20 -12
- package/resources/v1/pricing-units.js.map +1 -1
- package/resources/v1/pricing-units.mjs +19 -10
- package/resources/v1/pricing-units.mjs.map +1 -1
- package/resources/v1/services.d.mts +33 -0
- package/resources/v1/services.d.mts.map +1 -0
- package/resources/v1/services.d.ts +10 -7
- package/resources/v1/services.d.ts.map +1 -1
- package/resources/v1/services.js +7 -5
- package/resources/v1/services.js.map +1 -1
- package/resources/v1/services.mjs +7 -5
- package/resources/v1/services.mjs.map +1 -1
- package/resources/v1/usage.d.mts +490 -0
- package/resources/v1/usage.d.mts.map +1 -0
- package/resources/v1/usage.d.ts +223 -58
- package/resources/v1/usage.d.ts.map +1 -1
- package/resources/v1/usage.js +214 -26
- package/resources/v1/usage.js.map +1 -1
- package/resources/v1/usage.mjs +213 -24
- package/resources/v1/usage.mjs.map +1 -1
- package/resources/v1/v1.d.mts +62 -0
- package/resources/v1/v1.d.mts.map +1 -0
- package/resources/v1/v1.d.ts +19 -15
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js +19 -48
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs +12 -19
- package/resources/v1/v1.mjs.map +1 -1
- package/resources/v1.d.mts +2 -0
- package/resources/v1.d.mts.map +1 -0
- package/resources/v1.d.ts.map +1 -1
- package/resources/v1.js +2 -15
- package/resources/v1.js.map +1 -1
- package/resources/v2/contracts.d.mts +2900 -0
- package/resources/v2/contracts.d.mts.map +1 -0
- package/resources/v2/contracts.d.ts +399 -3830
- package/resources/v2/contracts.d.ts.map +1 -1
- package/resources/v2/contracts.js +102 -12
- package/resources/v2/contracts.js.map +1 -1
- package/resources/v2/contracts.mjs +102 -12
- package/resources/v2/contracts.mjs.map +1 -1
- package/resources/v2/index.d.mts +3 -0
- package/resources/v2/index.d.mts.map +1 -0
- package/resources/v2/index.d.ts.map +1 -1
- package/resources/v2/v2.d.mts +10 -0
- package/resources/v2/v2.d.mts.map +1 -0
- package/resources/v2/v2.d.ts +1 -1
- package/resources/v2/v2.d.ts.map +1 -1
- package/resources/v2/v2.js +3 -25
- package/resources/v2/v2.js.map +1 -1
- package/resources/v2/v2.mjs +1 -1
- package/resources/v2.d.mts +2 -0
- package/resources/v2.d.mts.map +1 -0
- package/resources/v2.d.ts.map +1 -1
- package/resources/v2.js +2 -15
- package/resources/v2.js.map +1 -1
- package/resources/webhooks.d.mts +22 -0
- package/resources/webhooks.d.mts.map +1 -0
- package/resources/webhooks.d.ts +1 -1
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/webhooks.js +3 -3
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs +1 -1
- package/resources/webhooks.mjs.map +1 -1
- 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 +809 -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/pagination.ts +319 -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 +6 -221
- 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 +144 -0
- package/src/internal/parse.ts +50 -0
- package/src/internal/qs/formats.ts +3 -2
- package/src/internal/qs/index.ts +3 -3
- package/src/internal/qs/stringify.ts +18 -21
- package/src/internal/qs/utils.ts +16 -16
- 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 +126 -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/pagination.ts +2 -82
- package/src/resource.ts +2 -11
- package/src/resources/index.ts +4 -4
- package/src/resources/shared.ts +1921 -506
- package/src/resources/v1/alerts.ts +108 -33
- package/src/resources/v1/audit-logs.ts +48 -26
- package/src/resources/v1/billable-metrics.ts +79 -34
- package/src/resources/v1/contracts/contracts.ts +490 -1632
- package/src/resources/v1/contracts/index.ts +7 -6
- package/src/resources/v1/contracts/named-schedules.ts +8 -6
- package/src/resources/v1/contracts/products.ts +50 -38
- package/src/resources/v1/contracts/rate-cards/index.ts +6 -6
- package/src/resources/v1/contracts/rate-cards/named-schedules.ts +8 -6
- package/src/resources/v1/contracts/rate-cards/product-orders.ts +13 -10
- package/src/resources/v1/contracts/rate-cards/rate-cards.ts +145 -72
- package/src/resources/v1/contracts/rate-cards/rates.ts +28 -98
- package/src/resources/v1/contracts/rate-cards.ts +1 -1
- package/src/resources/v1/contracts.ts +1 -1
- package/src/resources/v1/credit-grants.ts +100 -112
- package/src/resources/v1/custom-fields.ts +106 -74
- package/src/resources/v1/customers/alerts.ts +195 -55
- package/src/resources/v1/customers/billing-config.ts +27 -13
- package/src/resources/v1/customers/commits.ts +146 -54
- package/src/resources/v1/customers/credits.ts +131 -53
- package/src/resources/v1/customers/customers.ts +407 -115
- package/src/resources/v1/customers/index.ts +20 -18
- package/src/resources/v1/customers/invoices.ts +343 -42
- package/src/resources/v1/customers/named-schedules.ts +8 -6
- package/src/resources/v1/customers/plans.ts +24 -22
- package/src/resources/v1/customers.ts +1 -1
- package/src/resources/v1/dashboards.ts +34 -7
- package/src/resources/v1/index.ts +43 -25
- package/src/resources/v1/invoices.ts +28 -9
- package/src/resources/v1/payments.ts +170 -0
- package/src/resources/v1/plans.ts +42 -43
- package/src/resources/v1/pricing-units.ts +15 -23
- package/src/resources/v1/services.ts +10 -7
- package/src/resources/v1/usage.ts +247 -73
- package/src/resources/v1/v1.ts +78 -49
- package/src/resources/v1.ts +1 -1
- package/src/resources/v2/contracts.ts +469 -4930
- package/src/resources/v2/index.ts +2 -2
- package/src/resources/v2/v2.ts +3 -3
- package/src/resources/v2.ts +1 -1
- package/src/resources/webhooks.ts +2 -2
- package/src/resources.ts +1 -1
- 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.js +1 -1
- package/version.mjs +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/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/shims/node.ts +0 -50
- package/src/shims/web.ts +0 -50
|
@@ -4,40 +4,35 @@ export {
|
|
|
4
4
|
Alerts,
|
|
5
5
|
type CustomerAlert,
|
|
6
6
|
type AlertRetrieveResponse,
|
|
7
|
-
type AlertListResponse,
|
|
8
7
|
type AlertRetrieveParams,
|
|
9
8
|
type AlertListParams,
|
|
10
9
|
type AlertResetParams,
|
|
11
|
-
|
|
10
|
+
type CustomerAlertsCursorPageWithoutLimit,
|
|
11
|
+
} from './alerts';
|
|
12
12
|
export {
|
|
13
13
|
BillingConfig,
|
|
14
14
|
type BillingConfigRetrieveResponse,
|
|
15
15
|
type BillingConfigCreateParams,
|
|
16
16
|
type BillingConfigRetrieveParams,
|
|
17
17
|
type BillingConfigDeleteParams,
|
|
18
|
-
} from
|
|
18
|
+
} from './billing-config';
|
|
19
19
|
export {
|
|
20
20
|
Commits,
|
|
21
21
|
type CommitCreateResponse,
|
|
22
|
-
type CommitListResponse,
|
|
23
22
|
type CommitUpdateEndDateResponse,
|
|
24
23
|
type CommitCreateParams,
|
|
25
24
|
type CommitListParams,
|
|
26
25
|
type CommitUpdateEndDateParams,
|
|
27
|
-
} from
|
|
26
|
+
} from './commits';
|
|
28
27
|
export {
|
|
29
28
|
Credits,
|
|
30
29
|
type CreditCreateResponse,
|
|
31
|
-
type CreditListResponse,
|
|
32
30
|
type CreditUpdateEndDateResponse,
|
|
33
31
|
type CreditCreateParams,
|
|
34
32
|
type CreditListParams,
|
|
35
33
|
type CreditUpdateEndDateParams,
|
|
36
|
-
} from
|
|
34
|
+
} from './credits';
|
|
37
35
|
export {
|
|
38
|
-
CustomerDetailsCursorPage,
|
|
39
|
-
CustomerListBillableMetricsResponsesCursorPage,
|
|
40
|
-
CustomerListCostsResponsesCursorPage,
|
|
41
36
|
Customers,
|
|
42
37
|
type Customer,
|
|
43
38
|
type CustomerDetail,
|
|
@@ -47,6 +42,7 @@ export {
|
|
|
47
42
|
type CustomerListBillableMetricsResponse,
|
|
48
43
|
type CustomerListCostsResponse,
|
|
49
44
|
type CustomerPreviewEventsResponse,
|
|
45
|
+
type CustomerRetrieveBillingConfigurationsResponse,
|
|
50
46
|
type CustomerSetNameResponse,
|
|
51
47
|
type CustomerCreateParams,
|
|
52
48
|
type CustomerRetrieveParams,
|
|
@@ -55,13 +51,16 @@ export {
|
|
|
55
51
|
type CustomerListBillableMetricsParams,
|
|
56
52
|
type CustomerListCostsParams,
|
|
57
53
|
type CustomerPreviewEventsParams,
|
|
54
|
+
type CustomerRetrieveBillingConfigurationsParams,
|
|
55
|
+
type CustomerSetBillingConfigurationsParams,
|
|
58
56
|
type CustomerSetIngestAliasesParams,
|
|
59
57
|
type CustomerSetNameParams,
|
|
60
58
|
type CustomerUpdateConfigParams,
|
|
61
|
-
|
|
59
|
+
type CustomerDetailsCursorPage,
|
|
60
|
+
type CustomerListBillableMetricsResponsesCursorPage,
|
|
61
|
+
type CustomerListCostsResponsesCursorPage,
|
|
62
|
+
} from './customers';
|
|
62
63
|
export {
|
|
63
|
-
InvoicesCursorPage,
|
|
64
|
-
InvoiceListBreakdownsResponsesCursorPage,
|
|
65
64
|
Invoices,
|
|
66
65
|
type Invoice,
|
|
67
66
|
type InvoiceRetrieveResponse,
|
|
@@ -71,16 +70,17 @@ export {
|
|
|
71
70
|
type InvoiceListParams,
|
|
72
71
|
type InvoiceAddChargeParams,
|
|
73
72
|
type InvoiceListBreakdownsParams,
|
|
74
|
-
|
|
73
|
+
type InvoiceRetrievePdfParams,
|
|
74
|
+
type InvoicesCursorPage,
|
|
75
|
+
type InvoiceListBreakdownsResponsesCursorPage,
|
|
76
|
+
} from './invoices';
|
|
75
77
|
export {
|
|
76
78
|
NamedSchedules,
|
|
77
79
|
type NamedScheduleRetrieveResponse,
|
|
78
80
|
type NamedScheduleRetrieveParams,
|
|
79
81
|
type NamedScheduleUpdateParams,
|
|
80
|
-
} from
|
|
82
|
+
} from './named-schedules';
|
|
81
83
|
export {
|
|
82
|
-
PlanListResponsesCursorPage,
|
|
83
|
-
PlanListPriceAdjustmentsResponsesCursorPage,
|
|
84
84
|
Plans,
|
|
85
85
|
type PlanListResponse,
|
|
86
86
|
type PlanAddResponse,
|
|
@@ -90,4 +90,6 @@ export {
|
|
|
90
90
|
type PlanAddParams,
|
|
91
91
|
type PlanEndParams,
|
|
92
92
|
type PlanListPriceAdjustmentsParams,
|
|
93
|
-
|
|
93
|
+
type PlanListResponsesCursorPage,
|
|
94
|
+
type PlanListPriceAdjustmentsResponsesCursorPage,
|
|
95
|
+
} from './plans';
|
|
@@ -1,13 +1,55 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
|
|
3
|
-
import { APIResource } from
|
|
4
|
-
import * as
|
|
5
|
-
import
|
|
6
|
-
import { CursorPage, type CursorPageParams } from
|
|
3
|
+
import { APIResource } from '../../../core/resource';
|
|
4
|
+
import * as Shared from '../../shared';
|
|
5
|
+
import { APIPromise } from '../../../core/api-promise';
|
|
6
|
+
import { CursorPage, type CursorPageParams, PagePromise } from '../../../core/pagination';
|
|
7
|
+
import { buildHeaders } from '../../../internal/headers';
|
|
8
|
+
import { RequestOptions } from '../../../internal/request-options';
|
|
9
|
+
import { path } from '../../../internal/utils/path';
|
|
7
10
|
|
|
8
11
|
export class Invoices extends APIResource {
|
|
9
12
|
/**
|
|
10
|
-
*
|
|
13
|
+
* Retrieve detailed information for a specific invoice by its unique identifier.
|
|
14
|
+
* This endpoint returns comprehensive invoice data including line items, applied
|
|
15
|
+
* credits, totals, and billing period details for both finalized and draft
|
|
16
|
+
* invoices.
|
|
17
|
+
*
|
|
18
|
+
* ### Use this endpoint to:
|
|
19
|
+
*
|
|
20
|
+
* - Display historical invoice details in customer-facing dashboards or billing
|
|
21
|
+
* portals.
|
|
22
|
+
* - Retrieve current month draft invoices to show customers their month-to-date
|
|
23
|
+
* spend.
|
|
24
|
+
* - Access finalized invoices for historical billing records and payment
|
|
25
|
+
* reconciliation.
|
|
26
|
+
* - Validate customer pricing and credit applications for customer support
|
|
27
|
+
* queries.
|
|
28
|
+
*
|
|
29
|
+
* ### Key response fields:
|
|
30
|
+
*
|
|
31
|
+
* Invoice status (DRAFT, FINALIZED, VOID) Billing period start and end dates Total
|
|
32
|
+
* amount and amount due after credits Detailed line items broken down by:
|
|
33
|
+
*
|
|
34
|
+
* - Customer and contract information
|
|
35
|
+
* - Invoice line item type
|
|
36
|
+
* - Product/service name and ID
|
|
37
|
+
* - Quantity consumed
|
|
38
|
+
* - Unit and total price
|
|
39
|
+
* - Time period for usage-based charges
|
|
40
|
+
* - Applied credits or prepaid commitments
|
|
41
|
+
*
|
|
42
|
+
* ### Usage guidelines:
|
|
43
|
+
*
|
|
44
|
+
* - Draft invoices update in real-time as usage is reported and may change before
|
|
45
|
+
* finalization
|
|
46
|
+
* - The response includes both usage-based line items (e.g., API calls, data
|
|
47
|
+
* processed) and scheduled charges (e.g., monthly subscriptions, commitment
|
|
48
|
+
* fees)
|
|
49
|
+
* - Credit and commitment applications are shown as separate line items with
|
|
50
|
+
* negative amounts
|
|
51
|
+
* - For voided invoices, the response will indicate VOID status but retain all
|
|
52
|
+
* original line item details
|
|
11
53
|
*
|
|
12
54
|
* @example
|
|
13
55
|
* ```ts
|
|
@@ -19,17 +61,58 @@ export class Invoices extends APIResource {
|
|
|
19
61
|
* );
|
|
20
62
|
* ```
|
|
21
63
|
*/
|
|
22
|
-
retrieve(
|
|
23
|
-
params: InvoiceRetrieveParams,
|
|
24
|
-
options?: Core.RequestOptions,
|
|
25
|
-
): Core.APIPromise<InvoiceRetrieveResponse> {
|
|
64
|
+
retrieve(params: InvoiceRetrieveParams, options?: RequestOptions): APIPromise<InvoiceRetrieveResponse> {
|
|
26
65
|
const { customer_id, invoice_id, ...query } = params;
|
|
27
|
-
return this._client.get(`/v1/customers/${customer_id}/invoices/${invoice_id}`, { query, ...options });
|
|
66
|
+
return this._client.get(path`/v1/customers/${customer_id}/invoices/${invoice_id}`, { query, ...options });
|
|
28
67
|
}
|
|
29
68
|
|
|
30
69
|
/**
|
|
31
|
-
*
|
|
32
|
-
* range,
|
|
70
|
+
* Retrieves a paginated list of invoices for a specific customer, with flexible
|
|
71
|
+
* filtering options to narrow results by status, date range, credit type, and
|
|
72
|
+
* more. This endpoint provides a comprehensive view of a customer's billing
|
|
73
|
+
* history and current charges, supporting both real-time billing dashboards and
|
|
74
|
+
* historical reporting needs.
|
|
75
|
+
*
|
|
76
|
+
* ### Use this endpoint to:
|
|
77
|
+
*
|
|
78
|
+
* - Display historical invoice details in customer-facing dashboards or billing
|
|
79
|
+
* portals.
|
|
80
|
+
* - Retrieve current month draft invoices to show customers their month-to-date
|
|
81
|
+
* spend.
|
|
82
|
+
* - Access finalized invoices for historical billing records and payment
|
|
83
|
+
* reconciliation.
|
|
84
|
+
* - Validate customer pricing and credit applications for customer support
|
|
85
|
+
* queries.
|
|
86
|
+
* - Generate financial reports by filtering invoices within specific date ranges
|
|
87
|
+
*
|
|
88
|
+
* ### Key response fields:
|
|
89
|
+
*
|
|
90
|
+
* Array of invoice objects containing:
|
|
91
|
+
*
|
|
92
|
+
* - Invoice ID and status (DRAFT, FINALIZED, VOID)
|
|
93
|
+
* - Invoice type (USAGE, SCHEDULED)
|
|
94
|
+
* - Billing period start and end dates
|
|
95
|
+
* - Issue date and due date
|
|
96
|
+
* - Total amount, subtotal, and amount due
|
|
97
|
+
* - Applied credits summary
|
|
98
|
+
* - Contract ID reference
|
|
99
|
+
* - External billing provider status (if integrated with Stripe, etc.)
|
|
100
|
+
* - Pagination metadata `next_page` cursor
|
|
101
|
+
*
|
|
102
|
+
* ### Usage guidelines:
|
|
103
|
+
*
|
|
104
|
+
* - The endpoint returns invoice summaries; use the Get Invoice endpoint for
|
|
105
|
+
* detailed line items
|
|
106
|
+
* - Draft invoices are continuously updated as new usage is reported and will show
|
|
107
|
+
* real-time spend
|
|
108
|
+
* - Results are ordered by creation date descending by default (newest first)
|
|
109
|
+
* - When filtering by date range, the filter applies to the billing period, not
|
|
110
|
+
* the issue date
|
|
111
|
+
* - For customers with many invoices, implement pagination to ensure all results
|
|
112
|
+
* are retrieved External billing provider statuses (like Stripe payment status)
|
|
113
|
+
* are included when applicable
|
|
114
|
+
* - Voided invoices are included in results by default unless filtered out by
|
|
115
|
+
* status
|
|
33
116
|
*
|
|
34
117
|
* @example
|
|
35
118
|
* ```ts
|
|
@@ -41,12 +124,9 @@ export class Invoices extends APIResource {
|
|
|
41
124
|
* }
|
|
42
125
|
* ```
|
|
43
126
|
*/
|
|
44
|
-
list(
|
|
45
|
-
params: InvoiceListParams,
|
|
46
|
-
options?: Core.RequestOptions,
|
|
47
|
-
): Core.PagePromise<InvoicesCursorPage, Invoice> {
|
|
127
|
+
list(params: InvoiceListParams, options?: RequestOptions): PagePromise<InvoicesCursorPage, Invoice> {
|
|
48
128
|
const { customer_id, ...query } = params;
|
|
49
|
-
return this._client.getAPIList(`/v1/customers/${customer_id}/invoices`,
|
|
129
|
+
return this._client.getAPIList(path`/v1/customers/${customer_id}/invoices`, CursorPage<Invoice>, {
|
|
50
130
|
query,
|
|
51
131
|
...options,
|
|
52
132
|
});
|
|
@@ -70,20 +150,50 @@ export class Invoices extends APIResource {
|
|
|
70
150
|
* });
|
|
71
151
|
* ```
|
|
72
152
|
*/
|
|
73
|
-
addCharge(
|
|
74
|
-
params: InvoiceAddChargeParams,
|
|
75
|
-
options?: Core.RequestOptions,
|
|
76
|
-
): Core.APIPromise<InvoiceAddChargeResponse> {
|
|
153
|
+
addCharge(params: InvoiceAddChargeParams, options?: RequestOptions): APIPromise<InvoiceAddChargeResponse> {
|
|
77
154
|
const { customer_id, ...body } = params;
|
|
78
|
-
return this._client.post(`/v1/customers/${customer_id}/addCharge`, { body, ...options });
|
|
155
|
+
return this._client.post(path`/v1/customers/${customer_id}/addCharge`, { body, ...options });
|
|
79
156
|
}
|
|
80
157
|
|
|
81
158
|
/**
|
|
82
|
-
*
|
|
83
|
-
*
|
|
159
|
+
* Retrieve granular time-series breakdowns of invoice data at hourly or daily
|
|
160
|
+
* intervals. This endpoint transforms standard invoices into detailed timelines,
|
|
161
|
+
* enabling you to track usage patterns, identify consumption spikes, and provide
|
|
162
|
+
* customers with transparency into their billing details throughout the billing
|
|
163
|
+
* period.
|
|
164
|
+
*
|
|
165
|
+
* ### Use this endpoint to:
|
|
84
166
|
*
|
|
85
|
-
* -
|
|
86
|
-
*
|
|
167
|
+
* - Build usage analytics dashboards showing daily or hourly consumption trends
|
|
168
|
+
* - Identify peak usage periods for capacity planning and cost optimization
|
|
169
|
+
* - Generate detailed billing reports for finance teams and customer success
|
|
170
|
+
* - Troubleshoot billing disputes by examining usage patterns at specific times
|
|
171
|
+
* - Power real-time cost monitoring and alerting systems
|
|
172
|
+
*
|
|
173
|
+
* ### Key response fields:
|
|
174
|
+
*
|
|
175
|
+
* An array of BreakdownInvoice objects, each containing:
|
|
176
|
+
*
|
|
177
|
+
* - All standard invoice fields (ID, customer, commit, line items, totals, status)
|
|
178
|
+
* - Line items with quantities and costs for that specific period
|
|
179
|
+
* - `breakdown_start_timestamp`: Start of the specific time window
|
|
180
|
+
* - `breakdown_end_timestamp`: End of the specific time window
|
|
181
|
+
* - `next_page`: Pagination cursor for large result sets
|
|
182
|
+
*
|
|
183
|
+
* ### Usage guidelines:
|
|
184
|
+
*
|
|
185
|
+
* - Time granularity: Set `window_size` to hour or day based on your analysis
|
|
186
|
+
* needs
|
|
187
|
+
* - Response limits: Daily breakdowns return up to 35 days; hourly breakdowns
|
|
188
|
+
* return up to 24 hours per request
|
|
189
|
+
* - Date filtering: Use `starting_on` and `ending_before` to focus on specific
|
|
190
|
+
* periods
|
|
191
|
+
* - Performance: For large date ranges, use pagination to retrieve all data
|
|
192
|
+
* efficiently
|
|
193
|
+
* - Backdated usage: If usage events arrive after invoice finalization, breakdowns
|
|
194
|
+
* will reflect the updated usage
|
|
195
|
+
* - Zero quantity filtering: Use `skip_zero_qty_line_items=true` to exclude
|
|
196
|
+
* periods with no usage
|
|
87
197
|
*
|
|
88
198
|
* @example
|
|
89
199
|
* ```ts
|
|
@@ -101,20 +211,69 @@ export class Invoices extends APIResource {
|
|
|
101
211
|
*/
|
|
102
212
|
listBreakdowns(
|
|
103
213
|
params: InvoiceListBreakdownsParams,
|
|
104
|
-
options?:
|
|
105
|
-
):
|
|
214
|
+
options?: RequestOptions,
|
|
215
|
+
): PagePromise<InvoiceListBreakdownsResponsesCursorPage, InvoiceListBreakdownsResponse> {
|
|
106
216
|
const { customer_id, ...query } = params;
|
|
107
217
|
return this._client.getAPIList(
|
|
108
|
-
`/v1/customers/${customer_id}/invoices/breakdowns`,
|
|
109
|
-
|
|
218
|
+
path`/v1/customers/${customer_id}/invoices/breakdowns`,
|
|
219
|
+
CursorPage<InvoiceListBreakdownsResponse>,
|
|
110
220
|
{ query, ...options },
|
|
111
221
|
);
|
|
112
222
|
}
|
|
223
|
+
|
|
224
|
+
/**
|
|
225
|
+
* Retrieve a PDF version of a specific invoice by its unique identifier. This
|
|
226
|
+
* endpoint generates a professionally formatted invoice document suitable for
|
|
227
|
+
* sharing with customers, accounting teams, or for record-keeping purposes.
|
|
228
|
+
*
|
|
229
|
+
* ### Use this endpoint to:
|
|
230
|
+
*
|
|
231
|
+
* - Provide customers with downloadable or emailable copies of their invoices
|
|
232
|
+
* - Support accounting and finance teams with official billing documents
|
|
233
|
+
* - Maintain accurate records of billing transactions for audits and compliance
|
|
234
|
+
*
|
|
235
|
+
* ### Key response details:
|
|
236
|
+
*
|
|
237
|
+
* - The response is a binary PDF file representing the full invoice
|
|
238
|
+
* - The PDF includes all standard invoice information such as line items, totals,
|
|
239
|
+
* billing period, and customer details
|
|
240
|
+
* - The document is formatted for clarity and professionalism, suitable for
|
|
241
|
+
* official use
|
|
242
|
+
*
|
|
243
|
+
* ### Usage guidelines:
|
|
244
|
+
*
|
|
245
|
+
* - Ensure the `invoice_id` corresponds to an existing invoice for the specified
|
|
246
|
+
* `customer_id`
|
|
247
|
+
* - The PDF is generated on-demand; frequent requests for the same invoice may
|
|
248
|
+
* impact performance
|
|
249
|
+
* - Use appropriate headers to handle the binary response in your application
|
|
250
|
+
* (e.g., setting `Content-Type: application/pdf`)
|
|
251
|
+
*
|
|
252
|
+
* @example
|
|
253
|
+
* ```ts
|
|
254
|
+
* const response =
|
|
255
|
+
* await client.v1.customers.invoices.retrievePdf({
|
|
256
|
+
* customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
|
|
257
|
+
* invoice_id: '6a37bb88-8538-48c5-b37b-a41c836328bd',
|
|
258
|
+
* });
|
|
259
|
+
*
|
|
260
|
+
* const content = await response.blob();
|
|
261
|
+
* console.log(content);
|
|
262
|
+
* ```
|
|
263
|
+
*/
|
|
264
|
+
retrievePdf(params: InvoiceRetrievePdfParams, options?: RequestOptions): APIPromise<Response> {
|
|
265
|
+
const { customer_id, invoice_id } = params;
|
|
266
|
+
return this._client.get(path`/v1/customers/${customer_id}/invoices/${invoice_id}/pdf`, {
|
|
267
|
+
...options,
|
|
268
|
+
headers: buildHeaders([{ Accept: 'application/pdf' }, options?.headers]),
|
|
269
|
+
__binaryResponse: true,
|
|
270
|
+
});
|
|
271
|
+
}
|
|
113
272
|
}
|
|
114
273
|
|
|
115
|
-
export
|
|
274
|
+
export type InvoicesCursorPage = CursorPage<Invoice>;
|
|
116
275
|
|
|
117
|
-
export
|
|
276
|
+
export type InvoiceListBreakdownsResponsesCursorPage = CursorPage<InvoiceListBreakdownsResponse>;
|
|
118
277
|
|
|
119
278
|
export interface Invoice {
|
|
120
279
|
id: string;
|
|
@@ -136,8 +295,11 @@ export interface Invoice {
|
|
|
136
295
|
/**
|
|
137
296
|
* This field's availability is dependent on your client's configuration.
|
|
138
297
|
*/
|
|
139
|
-
billable_status?:
|
|
298
|
+
billable_status?: unknown;
|
|
140
299
|
|
|
300
|
+
/**
|
|
301
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
302
|
+
*/
|
|
141
303
|
contract_custom_fields?: { [key: string]: string };
|
|
142
304
|
|
|
143
305
|
contract_id?: string;
|
|
@@ -152,6 +314,9 @@ export interface Invoice {
|
|
|
152
314
|
|
|
153
315
|
custom_fields?: { [key: string]: unknown };
|
|
154
316
|
|
|
317
|
+
/**
|
|
318
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
319
|
+
*/
|
|
155
320
|
customer_custom_fields?: { [key: string]: string };
|
|
156
321
|
|
|
157
322
|
/**
|
|
@@ -175,6 +340,9 @@ export interface Invoice {
|
|
|
175
340
|
*/
|
|
176
341
|
netsuite_sales_order_id?: string;
|
|
177
342
|
|
|
343
|
+
/**
|
|
344
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
345
|
+
*/
|
|
178
346
|
plan_custom_fields?: { [key: string]: string };
|
|
179
347
|
|
|
180
348
|
plan_id?: string;
|
|
@@ -208,11 +376,29 @@ export namespace Invoice {
|
|
|
208
376
|
total: number;
|
|
209
377
|
|
|
210
378
|
/**
|
|
211
|
-
* The type of line item.
|
|
212
|
-
*
|
|
213
|
-
*
|
|
214
|
-
*
|
|
215
|
-
*
|
|
379
|
+
* The type of line item.
|
|
380
|
+
*
|
|
381
|
+
* - `scheduled`: Line item is associated with a scheduled charge. View the
|
|
382
|
+
* scheduled_charge_id on the line item.
|
|
383
|
+
* - `commit_purchase`: Line item is associated with a payment for a prepaid
|
|
384
|
+
* commit. View the commit_id on the line item.
|
|
385
|
+
* - `usage`: Line item is associated with a usage product or composite product.
|
|
386
|
+
* View the product_id on the line item to determine which product.
|
|
387
|
+
* - `subscription`: Line item is associated with a subscription. e.g. monthly
|
|
388
|
+
* recurring payment for an in-advance subscription.
|
|
389
|
+
* - `applied_commit_or_credit`: On metronome invoices, applied commits and credits
|
|
390
|
+
* are associated with their own line items. These line items have negative
|
|
391
|
+
* totals. Use the applied_commit_or_credit object on the line item to understand
|
|
392
|
+
* the id of the applied commit or credit, and its type. Note that the
|
|
393
|
+
* application of a postpaid commit is associated with a line item, but the total
|
|
394
|
+
* on the line item is not included in the invoice's total as postpaid commits
|
|
395
|
+
* are paid in-arrears.
|
|
396
|
+
* - `cpu_conversion`: Line item converting between a custom pricing unit and fiat
|
|
397
|
+
* currency, using the conversion rate set on the rate card. This line item will
|
|
398
|
+
* appear when there are products priced in custom pricing units, and there is
|
|
399
|
+
* insufficient prepaid commit/credit in that custom pricing unit to fully cover
|
|
400
|
+
* the spend. Then, the outstanding spend in custom pricing units will be
|
|
401
|
+
* converted to fiat currency using a cpu_conversion line item.
|
|
216
402
|
*/
|
|
217
403
|
type: string;
|
|
218
404
|
|
|
@@ -223,6 +409,9 @@ export namespace Invoice {
|
|
|
223
409
|
*/
|
|
224
410
|
applied_commit_or_credit?: LineItem.AppliedCommitOrCredit;
|
|
225
411
|
|
|
412
|
+
/**
|
|
413
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
414
|
+
*/
|
|
226
415
|
commit_custom_fields?: { [key: string]: string };
|
|
227
416
|
|
|
228
417
|
/**
|
|
@@ -245,8 +434,14 @@ export namespace Invoice {
|
|
|
245
434
|
*/
|
|
246
435
|
commit_type?: string;
|
|
247
436
|
|
|
437
|
+
/**
|
|
438
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
439
|
+
*/
|
|
248
440
|
custom_fields?: { [key: string]: string };
|
|
249
441
|
|
|
442
|
+
/**
|
|
443
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
444
|
+
*/
|
|
250
445
|
discount_custom_fields?: { [key: string]: string };
|
|
251
446
|
|
|
252
447
|
/**
|
|
@@ -306,6 +501,9 @@ export namespace Invoice {
|
|
|
306
501
|
*/
|
|
307
502
|
pricing_group_values?: { [key: string]: string };
|
|
308
503
|
|
|
504
|
+
/**
|
|
505
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
506
|
+
*/
|
|
309
507
|
product_custom_fields?: { [key: string]: string };
|
|
310
508
|
|
|
311
509
|
/**
|
|
@@ -327,6 +525,9 @@ export namespace Invoice {
|
|
|
327
525
|
*/
|
|
328
526
|
product_type?: string;
|
|
329
527
|
|
|
528
|
+
/**
|
|
529
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
530
|
+
*/
|
|
330
531
|
professional_service_custom_fields?: { [key: string]: string };
|
|
331
532
|
|
|
332
533
|
professional_service_id?: string;
|
|
@@ -338,6 +539,9 @@ export namespace Invoice {
|
|
|
338
539
|
|
|
339
540
|
reseller_type?: 'AWS' | 'AWS_PRO_SERVICE' | 'GCP' | 'GCP_PRO_SERVICE';
|
|
340
541
|
|
|
542
|
+
/**
|
|
543
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
544
|
+
*/
|
|
341
545
|
scheduled_charge_custom_fields?: { [key: string]: string };
|
|
342
546
|
|
|
343
547
|
/**
|
|
@@ -352,6 +556,9 @@ export namespace Invoice {
|
|
|
352
556
|
|
|
353
557
|
sub_line_items?: Array<LineItem.SubLineItem>;
|
|
354
558
|
|
|
559
|
+
/**
|
|
560
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
561
|
+
*/
|
|
355
562
|
subscription_custom_fields?: { [key: string]: string };
|
|
356
563
|
|
|
357
564
|
/**
|
|
@@ -385,6 +592,9 @@ export namespace Invoice {
|
|
|
385
592
|
}
|
|
386
593
|
|
|
387
594
|
export interface SubLineItem {
|
|
595
|
+
/**
|
|
596
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
597
|
+
*/
|
|
388
598
|
custom_fields: { [key: string]: string };
|
|
389
599
|
|
|
390
600
|
name: string;
|
|
@@ -494,7 +704,49 @@ export namespace Invoice {
|
|
|
494
704
|
|
|
495
705
|
invoice_id?: string;
|
|
496
706
|
|
|
707
|
+
/**
|
|
708
|
+
* The subtotal amount invoiced, if available from the billing provider.
|
|
709
|
+
*/
|
|
710
|
+
invoiced_sub_total?: number;
|
|
711
|
+
|
|
712
|
+
/**
|
|
713
|
+
* The total amount invoiced, if available from the billing provider.
|
|
714
|
+
*/
|
|
715
|
+
invoiced_total?: number;
|
|
716
|
+
|
|
497
717
|
issued_at_timestamp?: string;
|
|
718
|
+
|
|
719
|
+
/**
|
|
720
|
+
* A URL to the PDF of the invoice, if available from the billing provider.
|
|
721
|
+
*/
|
|
722
|
+
pdf_url?: string;
|
|
723
|
+
|
|
724
|
+
/**
|
|
725
|
+
* Tax details for the invoice, if available from the billing provider.
|
|
726
|
+
*/
|
|
727
|
+
tax?: CorrectedExternalInvoice.Tax;
|
|
728
|
+
}
|
|
729
|
+
|
|
730
|
+
export namespace CorrectedExternalInvoice {
|
|
731
|
+
/**
|
|
732
|
+
* Tax details for the invoice, if available from the billing provider.
|
|
733
|
+
*/
|
|
734
|
+
export interface Tax {
|
|
735
|
+
/**
|
|
736
|
+
* The total tax amount applied to the invoice.
|
|
737
|
+
*/
|
|
738
|
+
total_tax_amount?: number;
|
|
739
|
+
|
|
740
|
+
/**
|
|
741
|
+
* The total taxable amount of the invoice.
|
|
742
|
+
*/
|
|
743
|
+
total_taxable_amount?: number;
|
|
744
|
+
|
|
745
|
+
/**
|
|
746
|
+
* The transaction ID associated with the tax calculation.
|
|
747
|
+
*/
|
|
748
|
+
transaction_id?: string;
|
|
749
|
+
}
|
|
498
750
|
}
|
|
499
751
|
}
|
|
500
752
|
|
|
@@ -524,7 +776,49 @@ export namespace Invoice {
|
|
|
524
776
|
|
|
525
777
|
invoice_id?: string;
|
|
526
778
|
|
|
779
|
+
/**
|
|
780
|
+
* The subtotal amount invoiced, if available from the billing provider.
|
|
781
|
+
*/
|
|
782
|
+
invoiced_sub_total?: number;
|
|
783
|
+
|
|
784
|
+
/**
|
|
785
|
+
* The total amount invoiced, if available from the billing provider.
|
|
786
|
+
*/
|
|
787
|
+
invoiced_total?: number;
|
|
788
|
+
|
|
527
789
|
issued_at_timestamp?: string;
|
|
790
|
+
|
|
791
|
+
/**
|
|
792
|
+
* A URL to the PDF of the invoice, if available from the billing provider.
|
|
793
|
+
*/
|
|
794
|
+
pdf_url?: string;
|
|
795
|
+
|
|
796
|
+
/**
|
|
797
|
+
* Tax details for the invoice, if available from the billing provider.
|
|
798
|
+
*/
|
|
799
|
+
tax?: ExternalInvoice.Tax;
|
|
800
|
+
}
|
|
801
|
+
|
|
802
|
+
export namespace ExternalInvoice {
|
|
803
|
+
/**
|
|
804
|
+
* Tax details for the invoice, if available from the billing provider.
|
|
805
|
+
*/
|
|
806
|
+
export interface Tax {
|
|
807
|
+
/**
|
|
808
|
+
* The total tax amount applied to the invoice.
|
|
809
|
+
*/
|
|
810
|
+
total_tax_amount?: number;
|
|
811
|
+
|
|
812
|
+
/**
|
|
813
|
+
* The total taxable amount of the invoice.
|
|
814
|
+
*/
|
|
815
|
+
total_taxable_amount?: number;
|
|
816
|
+
|
|
817
|
+
/**
|
|
818
|
+
* The transaction ID associated with the tax calculation.
|
|
819
|
+
*/
|
|
820
|
+
transaction_id?: string;
|
|
821
|
+
}
|
|
528
822
|
}
|
|
529
823
|
|
|
530
824
|
export interface InvoiceAdjustment {
|
|
@@ -534,6 +828,9 @@ export namespace Invoice {
|
|
|
534
828
|
|
|
535
829
|
total: number;
|
|
536
830
|
|
|
831
|
+
/**
|
|
832
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
833
|
+
*/
|
|
537
834
|
credit_grant_custom_fields?: { [key: string]: string };
|
|
538
835
|
|
|
539
836
|
credit_grant_id?: string;
|
|
@@ -728,8 +1025,11 @@ export interface InvoiceListBreakdownsParams extends CursorPageParams {
|
|
|
728
1025
|
window_size?: 'HOUR' | 'DAY';
|
|
729
1026
|
}
|
|
730
1027
|
|
|
731
|
-
|
|
732
|
-
|
|
1028
|
+
export interface InvoiceRetrievePdfParams {
|
|
1029
|
+
customer_id: string;
|
|
1030
|
+
|
|
1031
|
+
invoice_id: string;
|
|
1032
|
+
}
|
|
733
1033
|
|
|
734
1034
|
export declare namespace Invoices {
|
|
735
1035
|
export {
|
|
@@ -737,11 +1037,12 @@ export declare namespace Invoices {
|
|
|
737
1037
|
type InvoiceRetrieveResponse as InvoiceRetrieveResponse,
|
|
738
1038
|
type InvoiceAddChargeResponse as InvoiceAddChargeResponse,
|
|
739
1039
|
type InvoiceListBreakdownsResponse as InvoiceListBreakdownsResponse,
|
|
740
|
-
InvoicesCursorPage as InvoicesCursorPage,
|
|
741
|
-
InvoiceListBreakdownsResponsesCursorPage as InvoiceListBreakdownsResponsesCursorPage,
|
|
1040
|
+
type InvoicesCursorPage as InvoicesCursorPage,
|
|
1041
|
+
type InvoiceListBreakdownsResponsesCursorPage as InvoiceListBreakdownsResponsesCursorPage,
|
|
742
1042
|
type InvoiceRetrieveParams as InvoiceRetrieveParams,
|
|
743
1043
|
type InvoiceListParams as InvoiceListParams,
|
|
744
1044
|
type InvoiceAddChargeParams as InvoiceAddChargeParams,
|
|
745
1045
|
type InvoiceListBreakdownsParams as InvoiceListBreakdownsParams,
|
|
1046
|
+
type InvoiceRetrievePdfParams as InvoiceRetrievePdfParams,
|
|
746
1047
|
};
|
|
747
1048
|
}
|
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
|
|
3
|
-
import { APIResource } from
|
|
4
|
-
import
|
|
3
|
+
import { APIResource } from '../../../core/resource';
|
|
4
|
+
import { APIPromise } from '../../../core/api-promise';
|
|
5
|
+
import { buildHeaders } from '../../../internal/headers';
|
|
6
|
+
import { RequestOptions } from '../../../internal/request-options';
|
|
5
7
|
|
|
6
8
|
export class NamedSchedules extends APIResource {
|
|
7
9
|
/**
|
|
@@ -20,8 +22,8 @@ export class NamedSchedules extends APIResource {
|
|
|
20
22
|
*/
|
|
21
23
|
retrieve(
|
|
22
24
|
body: NamedScheduleRetrieveParams,
|
|
23
|
-
options?:
|
|
24
|
-
):
|
|
25
|
+
options?: RequestOptions,
|
|
26
|
+
): APIPromise<NamedScheduleRetrieveResponse> {
|
|
25
27
|
return this._client.post('/v1/customers/getNamedSchedule', { body, ...options });
|
|
26
28
|
}
|
|
27
29
|
|
|
@@ -40,11 +42,11 @@ export class NamedSchedules extends APIResource {
|
|
|
40
42
|
* });
|
|
41
43
|
* ```
|
|
42
44
|
*/
|
|
43
|
-
update(body: NamedScheduleUpdateParams, options?:
|
|
45
|
+
update(body: NamedScheduleUpdateParams, options?: RequestOptions): APIPromise<void> {
|
|
44
46
|
return this._client.post('/v1/customers/updateNamedSchedule', {
|
|
45
47
|
body,
|
|
46
48
|
...options,
|
|
47
|
-
headers: { Accept: '*/*',
|
|
49
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
48
50
|
});
|
|
49
51
|
}
|
|
50
52
|
}
|