@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
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
2
|
+
import * as Shared from "../shared.mjs";
|
|
3
|
+
import * as CustomersAPI from "./customers/customers.mjs";
|
|
4
|
+
import { APIPromise } from "../../core/api-promise.mjs";
|
|
5
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.mjs";
|
|
6
|
+
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
7
|
+
export declare class Plans extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* List all available plans.
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```ts
|
|
13
|
+
* // Automatically fetches more pages as needed.
|
|
14
|
+
* for await (const planListResponse of client.v1.plans.list()) {
|
|
15
|
+
* // ...
|
|
16
|
+
* }
|
|
17
|
+
* ```
|
|
18
|
+
*/
|
|
19
|
+
list(query?: PlanListParams | null | undefined, options?: RequestOptions): PagePromise<PlanListResponsesCursorPage, PlanListResponse>;
|
|
20
|
+
/**
|
|
21
|
+
* Fetch high level details of a specific plan.
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* const response = await client.v1.plans.getDetails({
|
|
26
|
+
* plan_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
|
|
27
|
+
* });
|
|
28
|
+
* ```
|
|
29
|
+
*/
|
|
30
|
+
getDetails(params: PlanGetDetailsParams, options?: RequestOptions): APIPromise<PlanGetDetailsResponse>;
|
|
31
|
+
/**
|
|
32
|
+
* Fetches a list of charges of a specific plan.
|
|
33
|
+
*
|
|
34
|
+
* @example
|
|
35
|
+
* ```ts
|
|
36
|
+
* // Automatically fetches more pages as needed.
|
|
37
|
+
* for await (const planListChargesResponse of client.v1.plans.listCharges(
|
|
38
|
+
* { plan_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc' },
|
|
39
|
+
* )) {
|
|
40
|
+
* // ...
|
|
41
|
+
* }
|
|
42
|
+
* ```
|
|
43
|
+
*/
|
|
44
|
+
listCharges(params: PlanListChargesParams, options?: RequestOptions): PagePromise<PlanListChargesResponsesCursorPage, PlanListChargesResponse>;
|
|
45
|
+
/**
|
|
46
|
+
* Fetches a list of customers on a specific plan (by default, only currently
|
|
47
|
+
* active plans are included)
|
|
48
|
+
*
|
|
49
|
+
* @example
|
|
50
|
+
* ```ts
|
|
51
|
+
* // Automatically fetches more pages as needed.
|
|
52
|
+
* for await (const planListCustomersResponse of client.v1.plans.listCustomers(
|
|
53
|
+
* { plan_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc' },
|
|
54
|
+
* )) {
|
|
55
|
+
* // ...
|
|
56
|
+
* }
|
|
57
|
+
* ```
|
|
58
|
+
*/
|
|
59
|
+
listCustomers(params: PlanListCustomersParams, options?: RequestOptions): PagePromise<PlanListCustomersResponsesCursorPage, PlanListCustomersResponse>;
|
|
60
|
+
}
|
|
61
|
+
export type PlanListResponsesCursorPage = CursorPage<PlanListResponse>;
|
|
62
|
+
export type PlanListChargesResponsesCursorPage = CursorPage<PlanListChargesResponse>;
|
|
63
|
+
export type PlanListCustomersResponsesCursorPage = CursorPage<PlanListCustomersResponse>;
|
|
64
|
+
export interface PlanDetail {
|
|
65
|
+
id: string;
|
|
66
|
+
/**
|
|
67
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
68
|
+
*/
|
|
69
|
+
custom_fields: {
|
|
70
|
+
[key: string]: string;
|
|
71
|
+
};
|
|
72
|
+
name: string;
|
|
73
|
+
credit_grants?: Array<PlanDetail.CreditGrant>;
|
|
74
|
+
description?: string;
|
|
75
|
+
minimums?: Array<PlanDetail.Minimum>;
|
|
76
|
+
overage_rates?: Array<PlanDetail.OverageRate>;
|
|
77
|
+
}
|
|
78
|
+
export declare namespace PlanDetail {
|
|
79
|
+
interface CreditGrant {
|
|
80
|
+
amount_granted: number;
|
|
81
|
+
amount_granted_credit_type: Shared.CreditTypeData;
|
|
82
|
+
amount_paid: number;
|
|
83
|
+
amount_paid_credit_type: Shared.CreditTypeData;
|
|
84
|
+
effective_duration: number;
|
|
85
|
+
name: string;
|
|
86
|
+
priority: string;
|
|
87
|
+
send_invoice: boolean;
|
|
88
|
+
reason?: string;
|
|
89
|
+
recurrence_duration?: number;
|
|
90
|
+
recurrence_interval?: number;
|
|
91
|
+
}
|
|
92
|
+
interface Minimum {
|
|
93
|
+
credit_type: Shared.CreditTypeData;
|
|
94
|
+
name: string;
|
|
95
|
+
/**
|
|
96
|
+
* Used in price ramps. Indicates how many billing periods pass before the charge
|
|
97
|
+
* applies.
|
|
98
|
+
*/
|
|
99
|
+
start_period: number;
|
|
100
|
+
value: number;
|
|
101
|
+
}
|
|
102
|
+
interface OverageRate {
|
|
103
|
+
credit_type: Shared.CreditTypeData;
|
|
104
|
+
fiat_credit_type: Shared.CreditTypeData;
|
|
105
|
+
/**
|
|
106
|
+
* Used in price ramps. Indicates how many billing periods pass before the charge
|
|
107
|
+
* applies.
|
|
108
|
+
*/
|
|
109
|
+
start_period: number;
|
|
110
|
+
to_fiat_conversion_factor: number;
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
export interface PlanListResponse {
|
|
114
|
+
id: string;
|
|
115
|
+
description: string;
|
|
116
|
+
name: string;
|
|
117
|
+
/**
|
|
118
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
119
|
+
*/
|
|
120
|
+
custom_fields?: {
|
|
121
|
+
[key: string]: string;
|
|
122
|
+
};
|
|
123
|
+
}
|
|
124
|
+
export interface PlanGetDetailsResponse {
|
|
125
|
+
data: PlanDetail;
|
|
126
|
+
}
|
|
127
|
+
export interface PlanListChargesResponse {
|
|
128
|
+
id: string;
|
|
129
|
+
charge_type: 'usage' | 'fixed' | 'composite' | 'minimum' | 'seat';
|
|
130
|
+
credit_type: Shared.CreditTypeData;
|
|
131
|
+
/**
|
|
132
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
133
|
+
*/
|
|
134
|
+
custom_fields: {
|
|
135
|
+
[key: string]: string;
|
|
136
|
+
};
|
|
137
|
+
name: string;
|
|
138
|
+
prices: Array<PlanListChargesResponse.Price>;
|
|
139
|
+
product_id: string;
|
|
140
|
+
product_name: string;
|
|
141
|
+
quantity?: number;
|
|
142
|
+
/**
|
|
143
|
+
* Used in price ramps. Indicates how many billing periods pass before the charge
|
|
144
|
+
* applies.
|
|
145
|
+
*/
|
|
146
|
+
start_period?: number;
|
|
147
|
+
/**
|
|
148
|
+
* Used in pricing tiers. Indicates how often the tier resets. Default is 1 - the
|
|
149
|
+
* tier count resets every billing period.
|
|
150
|
+
*/
|
|
151
|
+
tier_reset_frequency?: number;
|
|
152
|
+
/**
|
|
153
|
+
* Specifies how quantities for usage based charges will be converted.
|
|
154
|
+
*/
|
|
155
|
+
unit_conversion?: PlanListChargesResponse.UnitConversion;
|
|
156
|
+
}
|
|
157
|
+
export declare namespace PlanListChargesResponse {
|
|
158
|
+
interface Price {
|
|
159
|
+
/**
|
|
160
|
+
* Used in pricing tiers. Indicates at what metric value the price applies.
|
|
161
|
+
*/
|
|
162
|
+
tier: number;
|
|
163
|
+
value: number;
|
|
164
|
+
collection_interval?: number;
|
|
165
|
+
collection_schedule?: string;
|
|
166
|
+
quantity?: number;
|
|
167
|
+
}
|
|
168
|
+
/**
|
|
169
|
+
* Specifies how quantities for usage based charges will be converted.
|
|
170
|
+
*/
|
|
171
|
+
interface UnitConversion {
|
|
172
|
+
/**
|
|
173
|
+
* The conversion factor
|
|
174
|
+
*/
|
|
175
|
+
division_factor: number;
|
|
176
|
+
/**
|
|
177
|
+
* Whether usage should be rounded down or up to the nearest whole number. If null,
|
|
178
|
+
* quantity will be rounded to 20 decimal places.
|
|
179
|
+
*/
|
|
180
|
+
rounding_behavior?: 'floor' | 'ceiling';
|
|
181
|
+
}
|
|
182
|
+
}
|
|
183
|
+
export interface PlanListCustomersResponse {
|
|
184
|
+
customer_details: CustomersAPI.CustomerDetail;
|
|
185
|
+
plan_details: PlanListCustomersResponse.PlanDetails;
|
|
186
|
+
}
|
|
187
|
+
export declare namespace PlanListCustomersResponse {
|
|
188
|
+
interface PlanDetails {
|
|
189
|
+
id: string;
|
|
190
|
+
/**
|
|
191
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
192
|
+
*/
|
|
193
|
+
custom_fields: {
|
|
194
|
+
[key: string]: string;
|
|
195
|
+
};
|
|
196
|
+
customer_plan_id: string;
|
|
197
|
+
name: string;
|
|
198
|
+
/**
|
|
199
|
+
* The start date of the plan
|
|
200
|
+
*/
|
|
201
|
+
starting_on: string;
|
|
202
|
+
/**
|
|
203
|
+
* The end date of the plan
|
|
204
|
+
*/
|
|
205
|
+
ending_before?: string | null;
|
|
206
|
+
}
|
|
207
|
+
}
|
|
208
|
+
export interface PlanListParams extends CursorPageParams {
|
|
209
|
+
}
|
|
210
|
+
export interface PlanGetDetailsParams {
|
|
211
|
+
plan_id: string;
|
|
212
|
+
}
|
|
213
|
+
export interface PlanListChargesParams extends CursorPageParams {
|
|
214
|
+
/**
|
|
215
|
+
* Path param:
|
|
216
|
+
*/
|
|
217
|
+
plan_id: string;
|
|
218
|
+
}
|
|
219
|
+
export interface PlanListCustomersParams extends CursorPageParams {
|
|
220
|
+
/**
|
|
221
|
+
* Path param:
|
|
222
|
+
*/
|
|
223
|
+
plan_id: string;
|
|
224
|
+
/**
|
|
225
|
+
* Query param: Status of customers on a given plan. Defaults to `active`.
|
|
226
|
+
*
|
|
227
|
+
* - `all` - Return current, past, and upcoming customers of the plan.
|
|
228
|
+
* - `active` - Return current customers of the plan.
|
|
229
|
+
* - `ended` - Return past customers of the plan.
|
|
230
|
+
* - `upcoming` - Return upcoming customers of the plan.
|
|
231
|
+
*
|
|
232
|
+
* Multiple statuses can be OR'd together using commas, e.g. `active,ended`.
|
|
233
|
+
* **Note:** `ended,upcoming` combination is not yet supported.
|
|
234
|
+
*/
|
|
235
|
+
status?: 'all' | 'active' | 'ended' | 'upcoming';
|
|
236
|
+
}
|
|
237
|
+
export declare namespace Plans {
|
|
238
|
+
export { type PlanDetail as PlanDetail, type PlanListResponse as PlanListResponse, type PlanGetDetailsResponse as PlanGetDetailsResponse, type PlanListChargesResponse as PlanListChargesResponse, type PlanListCustomersResponse as PlanListCustomersResponse, type PlanListResponsesCursorPage as PlanListResponsesCursorPage, type PlanListChargesResponsesCursorPage as PlanListChargesResponsesCursorPage, type PlanListCustomersResponsesCursorPage as PlanListCustomersResponsesCursorPage, type PlanListParams as PlanListParams, type PlanGetDetailsParams as PlanGetDetailsParams, type PlanListChargesParams as PlanListChargesParams, type PlanListCustomersParams as PlanListCustomersParams, };
|
|
239
|
+
}
|
|
240
|
+
//# sourceMappingURL=plans.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"plans.d.mts","sourceRoot":"","sources":["../../src/resources/v1/plans.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,2BAA2B,EAAE,gBAAgB,CAAC;IAI7D;;;;;;;;;OASG;IACH,UAAU,CAAC,MAAM,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAKtG;;;;;;;;;;;;OAYG;IACH,WAAW,CACT,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kCAAkC,EAAE,uBAAuB,CAAC;IAS3E;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,yBAAyB,CAAC;CAQhF;AAED,MAAM,MAAM,2BAA2B,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAEvE,MAAM,MAAM,kCAAkC,GAAG,UAAU,CAAC,uBAAuB,CAAC,CAAC;AAErF,MAAM,MAAM,oCAAoC,GAAG,UAAU,CAAC,yBAAyB,CAAC,CAAC;AAEzF,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEzC,IAAI,EAAE,MAAM,CAAC;IAEb,aAAa,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IAE9C,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAErC,aAAa,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;CAC/C;AAED,yBAAiB,UAAU,CAAC;IAC1B,UAAiB,WAAW;QAC1B,cAAc,EAAE,MAAM,CAAC;QAEvB,0BAA0B,EAAE,MAAM,CAAC,cAAc,CAAC;QAElD,WAAW,EAAE,MAAM,CAAC;QAEpB,uBAAuB,EAAE,MAAM,CAAC,cAAc,CAAC;QAE/C,kBAAkB,EAAE,MAAM,CAAC;QAE3B,IAAI,EAAE,MAAM,CAAC;QAEb,QAAQ,EAAE,MAAM,CAAC;QAEjB,YAAY,EAAE,OAAO,CAAC;QAEtB,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;KAC9B;IAED,UAAiB,OAAO;QACtB,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;QAEnC,IAAI,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,WAAW;QAC1B,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;QAEnC,gBAAgB,EAAE,MAAM,CAAC,cAAc,CAAC;QAExC;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB,yBAAyB,EAAE,MAAM,CAAC;KACnC;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,MAAM,CAAC;IAEpB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAC3C;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,OAAO,GAAG,OAAO,GAAG,WAAW,GAAG,SAAS,GAAG,MAAM,CAAC;IAElE,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;IAEnC;;OAEG;IACH,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEzC,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,EAAE,KAAK,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC;IAE7C,UAAU,EAAE,MAAM,CAAC;IAEnB,YAAY,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,uBAAuB,CAAC,cAAc,CAAC;CAC1D;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,MAAM,CAAC;QAEd,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KACzC;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC,gBAAgB,EAAE,YAAY,CAAC,cAAc,CAAC;IAE9C,YAAY,EAAE,yBAAyB,CAAC,WAAW,CAAC;CACrD;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,WAAW;QAC1B,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,aAAa,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEzC,gBAAgB,EAAE,MAAM,CAAC;QAEzB,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC/B;CACF;AAED,MAAM,WAAW,cAAe,SAAQ,gBAAgB;CAAG;AAE3D,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,CAAC;CAClD;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
|
package/resources/v1/plans.d.ts
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
|
-
import { APIResource } from "../../resource.js";
|
|
2
|
-
import * as Core from "../../core.js";
|
|
1
|
+
import { APIResource } from "../../core/resource.js";
|
|
3
2
|
import * as Shared from "../shared.js";
|
|
4
3
|
import * as CustomersAPI from "./customers/customers.js";
|
|
5
|
-
import {
|
|
4
|
+
import { APIPromise } from "../../core/api-promise.js";
|
|
5
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.js";
|
|
6
|
+
import { RequestOptions } from "../../internal/request-options.js";
|
|
6
7
|
export declare class Plans extends APIResource {
|
|
7
8
|
/**
|
|
8
9
|
* List all available plans.
|
|
@@ -15,8 +16,7 @@ export declare class Plans extends APIResource {
|
|
|
15
16
|
* }
|
|
16
17
|
* ```
|
|
17
18
|
*/
|
|
18
|
-
list(query?: PlanListParams, options?:
|
|
19
|
-
list(options?: Core.RequestOptions): Core.PagePromise<PlanListResponsesCursorPage, PlanListResponse>;
|
|
19
|
+
list(query?: PlanListParams | null | undefined, options?: RequestOptions): PagePromise<PlanListResponsesCursorPage, PlanListResponse>;
|
|
20
20
|
/**
|
|
21
21
|
* Fetch high level details of a specific plan.
|
|
22
22
|
*
|
|
@@ -27,7 +27,7 @@ export declare class Plans extends APIResource {
|
|
|
27
27
|
* });
|
|
28
28
|
* ```
|
|
29
29
|
*/
|
|
30
|
-
getDetails(params: PlanGetDetailsParams, options?:
|
|
30
|
+
getDetails(params: PlanGetDetailsParams, options?: RequestOptions): APIPromise<PlanGetDetailsResponse>;
|
|
31
31
|
/**
|
|
32
32
|
* Fetches a list of charges of a specific plan.
|
|
33
33
|
*
|
|
@@ -41,7 +41,7 @@ export declare class Plans extends APIResource {
|
|
|
41
41
|
* }
|
|
42
42
|
* ```
|
|
43
43
|
*/
|
|
44
|
-
listCharges(params: PlanListChargesParams, options?:
|
|
44
|
+
listCharges(params: PlanListChargesParams, options?: RequestOptions): PagePromise<PlanListChargesResponsesCursorPage, PlanListChargesResponse>;
|
|
45
45
|
/**
|
|
46
46
|
* Fetches a list of customers on a specific plan (by default, only currently
|
|
47
47
|
* active plans are included)
|
|
@@ -56,16 +56,16 @@ export declare class Plans extends APIResource {
|
|
|
56
56
|
* }
|
|
57
57
|
* ```
|
|
58
58
|
*/
|
|
59
|
-
listCustomers(params: PlanListCustomersParams, options?:
|
|
60
|
-
}
|
|
61
|
-
export declare class PlanListResponsesCursorPage extends CursorPage<PlanListResponse> {
|
|
62
|
-
}
|
|
63
|
-
export declare class PlanListChargesResponsesCursorPage extends CursorPage<PlanListChargesResponse> {
|
|
64
|
-
}
|
|
65
|
-
export declare class PlanListCustomersResponsesCursorPage extends CursorPage<PlanListCustomersResponse> {
|
|
59
|
+
listCustomers(params: PlanListCustomersParams, options?: RequestOptions): PagePromise<PlanListCustomersResponsesCursorPage, PlanListCustomersResponse>;
|
|
66
60
|
}
|
|
61
|
+
export type PlanListResponsesCursorPage = CursorPage<PlanListResponse>;
|
|
62
|
+
export type PlanListChargesResponsesCursorPage = CursorPage<PlanListChargesResponse>;
|
|
63
|
+
export type PlanListCustomersResponsesCursorPage = CursorPage<PlanListCustomersResponse>;
|
|
67
64
|
export interface PlanDetail {
|
|
68
65
|
id: string;
|
|
66
|
+
/**
|
|
67
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
68
|
+
*/
|
|
69
69
|
custom_fields: {
|
|
70
70
|
[key: string]: string;
|
|
71
71
|
};
|
|
@@ -114,6 +114,9 @@ export interface PlanListResponse {
|
|
|
114
114
|
id: string;
|
|
115
115
|
description: string;
|
|
116
116
|
name: string;
|
|
117
|
+
/**
|
|
118
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
119
|
+
*/
|
|
117
120
|
custom_fields?: {
|
|
118
121
|
[key: string]: string;
|
|
119
122
|
};
|
|
@@ -125,6 +128,9 @@ export interface PlanListChargesResponse {
|
|
|
125
128
|
id: string;
|
|
126
129
|
charge_type: 'usage' | 'fixed' | 'composite' | 'minimum' | 'seat';
|
|
127
130
|
credit_type: Shared.CreditTypeData;
|
|
131
|
+
/**
|
|
132
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
133
|
+
*/
|
|
128
134
|
custom_fields: {
|
|
129
135
|
[key: string]: string;
|
|
130
136
|
};
|
|
@@ -181,6 +187,9 @@ export interface PlanListCustomersResponse {
|
|
|
181
187
|
export declare namespace PlanListCustomersResponse {
|
|
182
188
|
interface PlanDetails {
|
|
183
189
|
id: string;
|
|
190
|
+
/**
|
|
191
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
192
|
+
*/
|
|
184
193
|
custom_fields: {
|
|
185
194
|
[key: string]: string;
|
|
186
195
|
};
|
|
@@ -226,6 +235,6 @@ export interface PlanListCustomersParams extends CursorPageParams {
|
|
|
226
235
|
status?: 'all' | 'active' | 'ended' | 'upcoming';
|
|
227
236
|
}
|
|
228
237
|
export declare namespace Plans {
|
|
229
|
-
export { type PlanDetail as PlanDetail, type PlanListResponse as PlanListResponse, type PlanGetDetailsResponse as PlanGetDetailsResponse, type PlanListChargesResponse as PlanListChargesResponse, type PlanListCustomersResponse as PlanListCustomersResponse, PlanListResponsesCursorPage as PlanListResponsesCursorPage, PlanListChargesResponsesCursorPage as PlanListChargesResponsesCursorPage, PlanListCustomersResponsesCursorPage as PlanListCustomersResponsesCursorPage, type PlanListParams as PlanListParams, type PlanGetDetailsParams as PlanGetDetailsParams, type PlanListChargesParams as PlanListChargesParams, type PlanListCustomersParams as PlanListCustomersParams, };
|
|
238
|
+
export { type PlanDetail as PlanDetail, type PlanListResponse as PlanListResponse, type PlanGetDetailsResponse as PlanGetDetailsResponse, type PlanListChargesResponse as PlanListChargesResponse, type PlanListCustomersResponse as PlanListCustomersResponse, type PlanListResponsesCursorPage as PlanListResponsesCursorPage, type PlanListChargesResponsesCursorPage as PlanListChargesResponsesCursorPage, type PlanListCustomersResponsesCursorPage as PlanListCustomersResponsesCursorPage, type PlanListParams as PlanListParams, type PlanGetDetailsParams as PlanGetDetailsParams, type PlanListChargesParams as PlanListChargesParams, type PlanListCustomersParams as PlanListCustomersParams, };
|
|
230
239
|
}
|
|
231
240
|
//# sourceMappingURL=plans.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"plans.d.ts","sourceRoot":"","sources":["../../src/resources/v1/plans.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"plans.d.ts","sourceRoot":"","sources":["../../src/resources/v1/plans.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,2BAA2B,EAAE,gBAAgB,CAAC;IAI7D;;;;;;;;;OASG;IACH,UAAU,CAAC,MAAM,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAKtG;;;;;;;;;;;;OAYG;IACH,WAAW,CACT,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kCAAkC,EAAE,uBAAuB,CAAC;IAS3E;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,yBAAyB,CAAC;CAQhF;AAED,MAAM,MAAM,2BAA2B,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAEvE,MAAM,MAAM,kCAAkC,GAAG,UAAU,CAAC,uBAAuB,CAAC,CAAC;AAErF,MAAM,MAAM,oCAAoC,GAAG,UAAU,CAAC,yBAAyB,CAAC,CAAC;AAEzF,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEzC,IAAI,EAAE,MAAM,CAAC;IAEb,aAAa,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IAE9C,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAErC,aAAa,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;CAC/C;AAED,yBAAiB,UAAU,CAAC;IAC1B,UAAiB,WAAW;QAC1B,cAAc,EAAE,MAAM,CAAC;QAEvB,0BAA0B,EAAE,MAAM,CAAC,cAAc,CAAC;QAElD,WAAW,EAAE,MAAM,CAAC;QAEpB,uBAAuB,EAAE,MAAM,CAAC,cAAc,CAAC;QAE/C,kBAAkB,EAAE,MAAM,CAAC;QAE3B,IAAI,EAAE,MAAM,CAAC;QAEb,QAAQ,EAAE,MAAM,CAAC;QAEjB,YAAY,EAAE,OAAO,CAAC;QAEtB,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;KAC9B;IAED,UAAiB,OAAO;QACtB,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;QAEnC,IAAI,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,WAAW;QAC1B,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;QAEnC,gBAAgB,EAAE,MAAM,CAAC,cAAc,CAAC;QAExC;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB,yBAAyB,EAAE,MAAM,CAAC;KACnC;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,MAAM,CAAC;IAEpB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAC3C;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,OAAO,GAAG,OAAO,GAAG,WAAW,GAAG,SAAS,GAAG,MAAM,CAAC;IAElE,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;IAEnC;;OAEG;IACH,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEzC,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,EAAE,KAAK,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC;IAE7C,UAAU,EAAE,MAAM,CAAC;IAEnB,YAAY,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,uBAAuB,CAAC,cAAc,CAAC;CAC1D;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,MAAM,CAAC;QAEd,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KACzC;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC,gBAAgB,EAAE,YAAY,CAAC,cAAc,CAAC;IAE9C,YAAY,EAAE,yBAAyB,CAAC,WAAW,CAAC;CACrD;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,WAAW;QAC1B,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,aAAa,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEzC,gBAAgB,EAAE,MAAM,CAAC;QAEzB,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC/B;CACF;AAED,MAAM,WAAW,cAAe,SAAQ,gBAAgB;CAAG;AAE3D,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,CAAC;CAClD;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
|
package/resources/v1/plans.js
CHANGED
|
@@ -1,16 +1,24 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
exports.
|
|
5
|
-
const resource_1 = require("../../resource.js");
|
|
6
|
-
const
|
|
7
|
-
const
|
|
4
|
+
exports.Plans = void 0;
|
|
5
|
+
const resource_1 = require("../../core/resource.js");
|
|
6
|
+
const pagination_1 = require("../../core/pagination.js");
|
|
7
|
+
const path_1 = require("../../internal/utils/path.js");
|
|
8
8
|
class Plans extends resource_1.APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* List all available plans.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* // Automatically fetches more pages as needed.
|
|
15
|
+
* for await (const planListResponse of client.v1.plans.list()) {
|
|
16
|
+
* // ...
|
|
17
|
+
* }
|
|
18
|
+
* ```
|
|
19
|
+
*/
|
|
9
20
|
list(query = {}, options) {
|
|
10
|
-
|
|
11
|
-
return this.list({}, query);
|
|
12
|
-
}
|
|
13
|
-
return this._client.getAPIList('/v1/plans', PlanListResponsesCursorPage, { query, ...options });
|
|
21
|
+
return this._client.getAPIList('/v1/plans', (pagination_1.CursorPage), { query, ...options });
|
|
14
22
|
}
|
|
15
23
|
/**
|
|
16
24
|
* Fetch high level details of a specific plan.
|
|
@@ -24,7 +32,7 @@ class Plans extends resource_1.APIResource {
|
|
|
24
32
|
*/
|
|
25
33
|
getDetails(params, options) {
|
|
26
34
|
const { plan_id } = params;
|
|
27
|
-
return this._client.get(`/v1/planDetails/${plan_id}`, options);
|
|
35
|
+
return this._client.get((0, path_1.path) `/v1/planDetails/${plan_id}`, options);
|
|
28
36
|
}
|
|
29
37
|
/**
|
|
30
38
|
* Fetches a list of charges of a specific plan.
|
|
@@ -41,10 +49,7 @@ class Plans extends resource_1.APIResource {
|
|
|
41
49
|
*/
|
|
42
50
|
listCharges(params, options) {
|
|
43
51
|
const { plan_id, ...query } = params;
|
|
44
|
-
return this._client.getAPIList(`/v1/planDetails/${plan_id}/charges`,
|
|
45
|
-
query,
|
|
46
|
-
...options,
|
|
47
|
-
});
|
|
52
|
+
return this._client.getAPIList((0, path_1.path) `/v1/planDetails/${plan_id}/charges`, (pagination_1.CursorPage), { query, ...options });
|
|
48
53
|
}
|
|
49
54
|
/**
|
|
50
55
|
* Fetches a list of customers on a specific plan (by default, only currently
|
|
@@ -62,20 +67,8 @@ class Plans extends resource_1.APIResource {
|
|
|
62
67
|
*/
|
|
63
68
|
listCustomers(params, options) {
|
|
64
69
|
const { plan_id, ...query } = params;
|
|
65
|
-
return this._client.getAPIList(`/v1/planDetails/${plan_id}/customers`,
|
|
70
|
+
return this._client.getAPIList((0, path_1.path) `/v1/planDetails/${plan_id}/customers`, (pagination_1.CursorPage), { query, ...options });
|
|
66
71
|
}
|
|
67
72
|
}
|
|
68
73
|
exports.Plans = Plans;
|
|
69
|
-
class PlanListResponsesCursorPage extends pagination_1.CursorPage {
|
|
70
|
-
}
|
|
71
|
-
exports.PlanListResponsesCursorPage = PlanListResponsesCursorPage;
|
|
72
|
-
class PlanListChargesResponsesCursorPage extends pagination_1.CursorPage {
|
|
73
|
-
}
|
|
74
|
-
exports.PlanListChargesResponsesCursorPage = PlanListChargesResponsesCursorPage;
|
|
75
|
-
class PlanListCustomersResponsesCursorPage extends pagination_1.CursorPage {
|
|
76
|
-
}
|
|
77
|
-
exports.PlanListCustomersResponsesCursorPage = PlanListCustomersResponsesCursorPage;
|
|
78
|
-
Plans.PlanListResponsesCursorPage = PlanListResponsesCursorPage;
|
|
79
|
-
Plans.PlanListChargesResponsesCursorPage = PlanListChargesResponsesCursorPage;
|
|
80
|
-
Plans.PlanListCustomersResponsesCursorPage = PlanListCustomersResponsesCursorPage;
|
|
81
74
|
//# sourceMappingURL=plans.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"plans.js","sourceRoot":"","sources":["../../src/resources/v1/plans.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,
|
|
1
|
+
{"version":3,"file":"plans.js","sourceRoot":"","sources":["../../src/resources/v1/plans.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,yDAAuF;AAEvF,uDAAiD;AAEjD,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,uBAA4B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;OASG;IACH,UAAU,CAAC,MAA4B,EAAE,OAAwB;QAC/D,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,WAAW,CACT,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,mBAAmB,OAAO,UAAU,EACxC,CAAA,uBAAmC,CAAA,EACnC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,mBAAmB,OAAO,YAAY,EAC1C,CAAA,uBAAqC,CAAA,EACrC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AApFD,sBAoFC"}
|
package/resources/v1/plans.mjs
CHANGED
|
@@ -1,13 +1,21 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
-
import { APIResource } from "../../resource.mjs";
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
2
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
3
|
+
import { CursorPage } from "../../core/pagination.mjs";
|
|
4
|
+
import { path } from "../../internal/utils/path.mjs";
|
|
5
5
|
export class Plans extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* List all available plans.
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```ts
|
|
11
|
+
* // Automatically fetches more pages as needed.
|
|
12
|
+
* for await (const planListResponse of client.v1.plans.list()) {
|
|
13
|
+
* // ...
|
|
14
|
+
* }
|
|
15
|
+
* ```
|
|
16
|
+
*/
|
|
6
17
|
list(query = {}, options) {
|
|
7
|
-
|
|
8
|
-
return this.list({}, query);
|
|
9
|
-
}
|
|
10
|
-
return this._client.getAPIList('/v1/plans', PlanListResponsesCursorPage, { query, ...options });
|
|
18
|
+
return this._client.getAPIList('/v1/plans', (CursorPage), { query, ...options });
|
|
11
19
|
}
|
|
12
20
|
/**
|
|
13
21
|
* Fetch high level details of a specific plan.
|
|
@@ -21,7 +29,7 @@ export class Plans extends APIResource {
|
|
|
21
29
|
*/
|
|
22
30
|
getDetails(params, options) {
|
|
23
31
|
const { plan_id } = params;
|
|
24
|
-
return this._client.get(`/v1/planDetails/${plan_id}`, options);
|
|
32
|
+
return this._client.get(path `/v1/planDetails/${plan_id}`, options);
|
|
25
33
|
}
|
|
26
34
|
/**
|
|
27
35
|
* Fetches a list of charges of a specific plan.
|
|
@@ -38,10 +46,7 @@ export class Plans extends APIResource {
|
|
|
38
46
|
*/
|
|
39
47
|
listCharges(params, options) {
|
|
40
48
|
const { plan_id, ...query } = params;
|
|
41
|
-
return this._client.getAPIList(`/v1/planDetails/${plan_id}/charges`,
|
|
42
|
-
query,
|
|
43
|
-
...options,
|
|
44
|
-
});
|
|
49
|
+
return this._client.getAPIList(path `/v1/planDetails/${plan_id}/charges`, (CursorPage), { query, ...options });
|
|
45
50
|
}
|
|
46
51
|
/**
|
|
47
52
|
* Fetches a list of customers on a specific plan (by default, only currently
|
|
@@ -59,16 +64,7 @@ export class Plans extends APIResource {
|
|
|
59
64
|
*/
|
|
60
65
|
listCustomers(params, options) {
|
|
61
66
|
const { plan_id, ...query } = params;
|
|
62
|
-
return this._client.getAPIList(`/v1/planDetails/${plan_id}/customers`,
|
|
67
|
+
return this._client.getAPIList(path `/v1/planDetails/${plan_id}/customers`, (CursorPage), { query, ...options });
|
|
63
68
|
}
|
|
64
69
|
}
|
|
65
|
-
export class PlanListResponsesCursorPage extends CursorPage {
|
|
66
|
-
}
|
|
67
|
-
export class PlanListChargesResponsesCursorPage extends CursorPage {
|
|
68
|
-
}
|
|
69
|
-
export class PlanListCustomersResponsesCursorPage extends CursorPage {
|
|
70
|
-
}
|
|
71
|
-
Plans.PlanListResponsesCursorPage = PlanListResponsesCursorPage;
|
|
72
|
-
Plans.PlanListChargesResponsesCursorPage = PlanListChargesResponsesCursorPage;
|
|
73
|
-
Plans.PlanListCustomersResponsesCursorPage = PlanListCustomersResponsesCursorPage;
|
|
74
70
|
//# sourceMappingURL=plans.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"plans.mjs","sourceRoot":"","sources":["../../src/resources/v1/plans.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;
|
|
1
|
+
{"version":3,"file":"plans.mjs","sourceRoot":"","sources":["../../src/resources/v1/plans.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,UAA4B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;OASG;IACH,UAAU,CAAC,MAA4B,EAAE,OAAwB;QAC/D,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,WAAW,CACT,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,mBAAmB,OAAO,UAAU,EACxC,CAAA,UAAmC,CAAA,EACnC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,mBAAmB,OAAO,YAAY,EAC1C,CAAA,UAAqC,CAAA,EACrC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF"}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
2
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.mjs";
|
|
3
|
+
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
4
|
+
export declare class PricingUnits extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* List all pricing units. All fiat currency types (for example, USD or GBP) will
|
|
7
|
+
* be included, as well as any custom pricing units that were configured. Custom
|
|
8
|
+
* pricing units can be used to charge for usage in a non-fiat pricing unit, for
|
|
9
|
+
* example AI credits.
|
|
10
|
+
*
|
|
11
|
+
* Note: The USD (cents) pricing unit is 2714e483-4ff1-48e4-9e25-ac732e8f24f2.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* // Automatically fetches more pages as needed.
|
|
16
|
+
* for await (const pricingUnitListResponse of client.v1.pricingUnits.list()) {
|
|
17
|
+
* // ...
|
|
18
|
+
* }
|
|
19
|
+
* ```
|
|
20
|
+
*/
|
|
21
|
+
list(query?: PricingUnitListParams | null | undefined, options?: RequestOptions): PagePromise<PricingUnitListResponsesCursorPage, PricingUnitListResponse>;
|
|
22
|
+
}
|
|
23
|
+
export type PricingUnitListResponsesCursorPage = CursorPage<PricingUnitListResponse>;
|
|
24
|
+
export interface PricingUnitListResponse {
|
|
25
|
+
id?: string;
|
|
26
|
+
is_currency?: boolean;
|
|
27
|
+
name?: string;
|
|
28
|
+
}
|
|
29
|
+
export interface PricingUnitListParams extends CursorPageParams {
|
|
30
|
+
}
|
|
31
|
+
export declare namespace PricingUnits {
|
|
32
|
+
export { type PricingUnitListResponse as PricingUnitListResponse, type PricingUnitListResponsesCursorPage as PricingUnitListResponsesCursorPage, type PricingUnitListParams as PricingUnitListParams, };
|
|
33
|
+
}
|
|
34
|
+
//# sourceMappingURL=pricing-units.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pricing-units.d.mts","sourceRoot":"","sources":["../../src/resources/v1/pricing-units.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAEzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kCAAkC,EAAE,uBAAuB,CAAC;CAM5E;AAED,MAAM,MAAM,kCAAkC,GAAG,UAAU,CAAC,uBAAuB,CAAC,CAAC;AAErF,MAAM,WAAW,uBAAuB;IACtC,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;CAAG;AAElE,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
|
|
@@ -1,9 +1,14 @@
|
|
|
1
|
-
import { APIResource } from "../../resource.js";
|
|
2
|
-
import
|
|
3
|
-
import {
|
|
1
|
+
import { APIResource } from "../../core/resource.js";
|
|
2
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.js";
|
|
3
|
+
import { RequestOptions } from "../../internal/request-options.js";
|
|
4
4
|
export declare class PricingUnits extends APIResource {
|
|
5
5
|
/**
|
|
6
|
-
* List all pricing units
|
|
6
|
+
* List all pricing units. All fiat currency types (for example, USD or GBP) will
|
|
7
|
+
* be included, as well as any custom pricing units that were configured. Custom
|
|
8
|
+
* pricing units can be used to charge for usage in a non-fiat pricing unit, for
|
|
9
|
+
* example AI credits.
|
|
10
|
+
*
|
|
11
|
+
* Note: The USD (cents) pricing unit is 2714e483-4ff1-48e4-9e25-ac732e8f24f2.
|
|
7
12
|
*
|
|
8
13
|
* @example
|
|
9
14
|
* ```ts
|
|
@@ -13,11 +18,9 @@ export declare class PricingUnits extends APIResource {
|
|
|
13
18
|
* }
|
|
14
19
|
* ```
|
|
15
20
|
*/
|
|
16
|
-
list(query?: PricingUnitListParams, options?:
|
|
17
|
-
list(options?: Core.RequestOptions): Core.PagePromise<PricingUnitListResponsesCursorPage, PricingUnitListResponse>;
|
|
18
|
-
}
|
|
19
|
-
export declare class PricingUnitListResponsesCursorPage extends CursorPage<PricingUnitListResponse> {
|
|
21
|
+
list(query?: PricingUnitListParams | null | undefined, options?: RequestOptions): PagePromise<PricingUnitListResponsesCursorPage, PricingUnitListResponse>;
|
|
20
22
|
}
|
|
23
|
+
export type PricingUnitListResponsesCursorPage = CursorPage<PricingUnitListResponse>;
|
|
21
24
|
export interface PricingUnitListResponse {
|
|
22
25
|
id?: string;
|
|
23
26
|
is_currency?: boolean;
|
|
@@ -26,6 +29,6 @@ export interface PricingUnitListResponse {
|
|
|
26
29
|
export interface PricingUnitListParams extends CursorPageParams {
|
|
27
30
|
}
|
|
28
31
|
export declare namespace PricingUnits {
|
|
29
|
-
export { type PricingUnitListResponse as PricingUnitListResponse, PricingUnitListResponsesCursorPage as PricingUnitListResponsesCursorPage, type PricingUnitListParams as PricingUnitListParams, };
|
|
32
|
+
export { type PricingUnitListResponse as PricingUnitListResponse, type PricingUnitListResponsesCursorPage as PricingUnitListResponsesCursorPage, type PricingUnitListParams as PricingUnitListParams, };
|
|
30
33
|
}
|
|
31
34
|
//# sourceMappingURL=pricing-units.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pricing-units.d.ts","sourceRoot":"","sources":["../../src/resources/v1/pricing-units.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"pricing-units.d.ts","sourceRoot":"","sources":["../../src/resources/v1/pricing-units.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAEzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kCAAkC,EAAE,uBAAuB,CAAC;CAM5E;AAED,MAAM,MAAM,kCAAkC,GAAG,UAAU,CAAC,uBAAuB,CAAC,CAAC;AAErF,MAAM,WAAW,uBAAuB;IACtC,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;CAAG;AAElE,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
|