@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
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contracts.js","sourceRoot":"","sources":["../../../src/resources/v1/contracts/contracts.ts"],"names":[],"mappings":";AAAA,sFAAsF
|
|
1
|
+
{"version":3,"file":"contracts.js","sourceRoot":"","sources":["../../../src/resources/v1/contracts/contracts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AAErD,gFAAuD;AACvD,0DAK2B;AAC3B,mEAA0C;AAC1C,4CAgBoB;AAEpB,iFAAwD;AACxD,2DAeiC;AAEjC,4DAAkG;AAClG,0DAAyD;AAGzD,MAAa,SAAU,SAAQ,sBAAW;IAA1C;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,mBAAc,GAAqC,IAAI,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA+hBxG,CAAC;IA7hBC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyIG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,IAA4B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,IAAwB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,qBAAqB,CACnB,IAAyC,EACzC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2CAA2C,EAAE;YACpE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,IAAyB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,OAAO,CAAC,IAA2B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,wBAAwB,CACtB,IAA4C,EAC5C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wCAAwC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiDG;IACH,YAAY,CACV,IAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,qCAAqC,EACrC,CAAA,2BAA4C,CAAA,EAC5C,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,CACrC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,oBAAoB,CAClB,MAA0C,EAC1C,OAAwB;QAExB,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uCAAuC,EAAE;YAChE,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;YAC3B,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,mCAAmC,CACjC,IAAuD,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,8CAA8C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,0BAA0B,CACxB,IAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0CAA0C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,cAAc,CAAC,IAAkC,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,8BAA8B,EAAE;YACvD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,aAAa,CACX,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF;AAliBD,8BAkiBC;AA49FD,SAAS,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC9B,SAAS,CAAC,SAAS,GAAG,sBAAS,CAAC;AAChC,SAAS,CAAC,cAAc,GAAG,gCAAc,CAAC"}
|
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
-
import { APIResource } from "../../../resource.mjs";
|
|
2
|
+
import { APIResource } from "../../../core/resource.mjs";
|
|
3
3
|
import * as NamedSchedulesAPI from "./named-schedules.mjs";
|
|
4
4
|
import { NamedSchedules, } from "./named-schedules.mjs";
|
|
5
5
|
import * as ProductsAPI from "./products.mjs";
|
|
6
|
-
import {
|
|
6
|
+
import { Products, } from "./products.mjs";
|
|
7
7
|
import * as RateCardsAPI from "./rate-cards/rate-cards.mjs";
|
|
8
|
-
import {
|
|
8
|
+
import { RateCards, } from "./rate-cards/rate-cards.mjs";
|
|
9
|
+
import { BodyCursorPage } from "../../../core/pagination.mjs";
|
|
10
|
+
import { buildHeaders } from "../../../internal/headers.mjs";
|
|
9
11
|
export class Contracts extends APIResource {
|
|
10
12
|
constructor() {
|
|
11
13
|
super(...arguments);
|
|
@@ -14,7 +16,129 @@ export class Contracts extends APIResource {
|
|
|
14
16
|
this.namedSchedules = new NamedSchedulesAPI.NamedSchedules(this._client);
|
|
15
17
|
}
|
|
16
18
|
/**
|
|
17
|
-
*
|
|
19
|
+
* Contracts define a customer's products, pricing, discounts, access duration, and
|
|
20
|
+
* billing configuration. Contracts serve as the central billing agreement for both
|
|
21
|
+
* PLG and Enterprise customers, you can automatically customers access to your
|
|
22
|
+
* products and services directly from your product or CRM.
|
|
23
|
+
*
|
|
24
|
+
* ### Use this endpoint to:
|
|
25
|
+
*
|
|
26
|
+
* - PLG onboarding: Automatically provision new self-serve customers with
|
|
27
|
+
* contracts when they sign up.
|
|
28
|
+
* - Enterprise sales: Push negotiated contracts from Salesforce with custom
|
|
29
|
+
* pricing and commitments
|
|
30
|
+
* - Promotional pricing: Implement time-limited discounts and free trials through
|
|
31
|
+
* overrides
|
|
32
|
+
*
|
|
33
|
+
* ### Key components:
|
|
34
|
+
*
|
|
35
|
+
* #### Contract Term and Billing Schedule
|
|
36
|
+
*
|
|
37
|
+
* - Set contract duration using `starting_at` and `ending_before` fields. PLG
|
|
38
|
+
* contracts typically use perpetual agreements (no end date), while Enterprise
|
|
39
|
+
* contracts have fixed end dates which can be edited over time in the case of
|
|
40
|
+
* co-term upsells.
|
|
41
|
+
*
|
|
42
|
+
* #### Rate Card
|
|
43
|
+
*
|
|
44
|
+
* If you are offering usage based pricing, you can set a rate card for the
|
|
45
|
+
* contract to reference through `rate_card_id` or `rate_card_alias`. The rate card
|
|
46
|
+
* is a store of all of your usage based products and their centralized pricing.
|
|
47
|
+
* Any new products or price changes on the rate card can be set to automatically
|
|
48
|
+
* propagate to all associated contracts - this ensures consistent pricing and
|
|
49
|
+
* product launches flow to contracts without manual updates and migrations. The
|
|
50
|
+
* `usage_statement_schedule` determines the cadence on which Metronome will
|
|
51
|
+
* finalize a usage invoice for the customer. This defaults to monthly on the 1st,
|
|
52
|
+
* with options for custom dates, quarterly, or annual cadences. Note: Most usage
|
|
53
|
+
* based billing companies align usage statements to be evaluated aligned to the
|
|
54
|
+
* first of the month. Read more about
|
|
55
|
+
* [Rate Cards](https://docs.metronome.com/pricing-packaging/create-manage-rate-cards/).
|
|
56
|
+
*
|
|
57
|
+
* #### Overrides and discounts
|
|
58
|
+
*
|
|
59
|
+
* Customize pricing on the contract through time-bounded overrides that can target
|
|
60
|
+
* specific products, product families, or complex usage scenarios. Overrides
|
|
61
|
+
* enable two key capabilities:
|
|
62
|
+
*
|
|
63
|
+
* - Discounts: Apply percentage discounts, fixed rate reductions, or
|
|
64
|
+
* quantity-based pricing tiers
|
|
65
|
+
* - Entitlements: Provide special pricing or access to specific products for
|
|
66
|
+
* negotiated deals
|
|
67
|
+
*
|
|
68
|
+
* Read more about
|
|
69
|
+
* [Contract Overrides](https://docs.metronome.com/manage-product-access/add-contract-override/).
|
|
70
|
+
*
|
|
71
|
+
* #### Commits and Credits
|
|
72
|
+
*
|
|
73
|
+
* Using commits, configure prepaid or postpaid spending commitments where
|
|
74
|
+
* customers promise to spend a certain amount over the contract period paid in
|
|
75
|
+
* advance or in arrears. Use credits to provide free spending allowances. Under
|
|
76
|
+
* the hood these are the same mechanisms, however, credits are typically offered
|
|
77
|
+
* for free (SLA or promotional) or as a part of an allotment associated with a
|
|
78
|
+
* Subscription.
|
|
79
|
+
*
|
|
80
|
+
* In Metronome, you can set commits and credits to only be applicable for a subset
|
|
81
|
+
* of usage. Use `applicable_product_ids` or `applicable_product_tags` to create
|
|
82
|
+
* product or product-family specific commits or credits, or you can build complex
|
|
83
|
+
* boolean logic specifiers to target usage based on pricing and presentation group
|
|
84
|
+
* values using `override_specifiers`.
|
|
85
|
+
*
|
|
86
|
+
* These objects can also also be configured to have a recurrence schedule to
|
|
87
|
+
* easily model customer packaging which includes recurring monthly or quarterly
|
|
88
|
+
* allotments.
|
|
89
|
+
*
|
|
90
|
+
* Commits support rollover settings (`rollover_fraction`) to transfer unused
|
|
91
|
+
* balances between contract periods, either entirely or as a percentage.
|
|
92
|
+
*
|
|
93
|
+
* Read more about
|
|
94
|
+
* [Credits and Commits](https://docs.metronome.com/pricing-packaging/apply-credits-commits/).
|
|
95
|
+
*
|
|
96
|
+
* #### Subscriptions
|
|
97
|
+
*
|
|
98
|
+
* You can add a fixed recurring charge to a contract, like monthly licenses or
|
|
99
|
+
* seat-based fees, using the subscription charge. Subscription charges are defined
|
|
100
|
+
* on your rate card and you can select which subscription is applicable to add to
|
|
101
|
+
* each contract. When you add a subscription to a contract you need to:
|
|
102
|
+
*
|
|
103
|
+
* - Define whether the subscription is paid for in-advance or in-arrears
|
|
104
|
+
* (`collection_schedule`)
|
|
105
|
+
* - Define the proration behavior (`proration`)
|
|
106
|
+
* - Specify an initial quantity (`initial_quantity`)
|
|
107
|
+
* - Define which subscription rate on the rate card should be used
|
|
108
|
+
* (`subscription_rate`)
|
|
109
|
+
*
|
|
110
|
+
* Read more about
|
|
111
|
+
* [Subscriptions](https://docs.metronome.com/manage-product-access/create-subscription/).
|
|
112
|
+
*
|
|
113
|
+
* #### Scheduled Charges
|
|
114
|
+
*
|
|
115
|
+
* Set up one-time, recurring, or entirely custom charges that occur on specific
|
|
116
|
+
* dates, separate from usage-based billing or commitments. These can be used to
|
|
117
|
+
* model non-recurring platform charges or professional services.
|
|
118
|
+
*
|
|
119
|
+
* #### Threshold Billing
|
|
120
|
+
*
|
|
121
|
+
* Metronome allows you to configure automatic billing triggers when customers
|
|
122
|
+
* reach spending thresholds to prevent fraud and manage risk. You can use
|
|
123
|
+
* `spend_threshold_configuration` to trigger an invoice to cover current charges
|
|
124
|
+
* whenever the threshold is reached or you can ensure the customer maintains a
|
|
125
|
+
* minimum prepaid balance using the `prepaid_balance_configuration`.
|
|
126
|
+
*
|
|
127
|
+
* Read more about
|
|
128
|
+
* [Spend Threshold](https://docs.metronome.com/manage-product-access/spend-thresholds/)
|
|
129
|
+
* and
|
|
130
|
+
* [Prepaid Balance Thresholds](https://docs.metronome.com/manage-product-access/prepaid-balance-thresholds/).
|
|
131
|
+
*
|
|
132
|
+
* ### Usage guidelines:
|
|
133
|
+
*
|
|
134
|
+
* - You can always
|
|
135
|
+
* [Edit Contracts](https://docs.metronome.com/manage-product-access/edit-contract/)
|
|
136
|
+
* after it has been created, using the `editContract` endpoint. Metronome keeps
|
|
137
|
+
* track of all edits, both in the audit log and over the `getEditHistory`
|
|
138
|
+
* endpoint.
|
|
139
|
+
* - Customers in Metronome can have multiple concurrent contracts at one time. Use
|
|
140
|
+
* `usage_filters` to route the correct usage to each contract.
|
|
141
|
+
* [Read more about usage filters](https://docs.metronome.com/manage-product-access/provision-customer/#create-a-usage-filter).
|
|
18
142
|
*
|
|
19
143
|
* @example
|
|
20
144
|
* ```ts
|
|
@@ -48,8 +172,13 @@ export class Contracts extends APIResource {
|
|
|
48
172
|
return this._client.post('/v1/contracts/get', { body, ...options });
|
|
49
173
|
}
|
|
50
174
|
/**
|
|
51
|
-
*
|
|
52
|
-
*
|
|
175
|
+
* Retrieves all contracts for a specific customer, including pricing, terms,
|
|
176
|
+
* credits, and commitments. Use this to view a customer's contract history and
|
|
177
|
+
* current agreements for billing management. Returns contract details with
|
|
178
|
+
* optional ledgers and balance information.
|
|
179
|
+
*
|
|
180
|
+
* ⚠️ Note: This is the legacy v1 endpoint - new integrations should use the v2
|
|
181
|
+
* endpoint for enhanced features.
|
|
53
182
|
*
|
|
54
183
|
* @example
|
|
55
184
|
* ```ts
|
|
@@ -62,7 +191,24 @@ export class Contracts extends APIResource {
|
|
|
62
191
|
return this._client.post('/v1/contracts/list', { body, ...options });
|
|
63
192
|
}
|
|
64
193
|
/**
|
|
65
|
-
*
|
|
194
|
+
* Manually adjust the available balance on a commit or credit. This entry is
|
|
195
|
+
* appended to the commit ledger as a new event. Optionally include a description
|
|
196
|
+
* that provides the reasoning for the entry.
|
|
197
|
+
*
|
|
198
|
+
* ### Use this endpoint to:
|
|
199
|
+
*
|
|
200
|
+
* - Address incorrect usage burn-down caused by malformed usage or invalid config
|
|
201
|
+
* - Decrease available balance to account for outages where usage may have not
|
|
202
|
+
* been tracked or sent to Metronome
|
|
203
|
+
* - Issue credits to customers in the form of increased balance on existing commit
|
|
204
|
+
* or credit
|
|
205
|
+
*
|
|
206
|
+
* ### Usage guidelines:
|
|
207
|
+
*
|
|
208
|
+
* Manual ledger entries can be extremely useful for resolving discrepancies in
|
|
209
|
+
* Metronome. However, most corrections to inaccurate billings can be modified
|
|
210
|
+
* upstream of the commit, whether that is via contract editing, rate editing, or
|
|
211
|
+
* other actions that cause an invoice to be recalculated.
|
|
66
212
|
*
|
|
67
213
|
* @example
|
|
68
214
|
* ```ts
|
|
@@ -80,12 +226,12 @@ export class Contracts extends APIResource {
|
|
|
80
226
|
return this._client.post('/v1/contracts/addManualBalanceLedgerEntry', {
|
|
81
227
|
body,
|
|
82
228
|
...options,
|
|
83
|
-
headers: { Accept: '*/*',
|
|
229
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
84
230
|
});
|
|
85
231
|
}
|
|
86
232
|
/**
|
|
87
233
|
* Amendments will be replaced by Contract editing. New clients should implement
|
|
88
|
-
* using the editContract endpoint. Read more about the migration to contract
|
|
234
|
+
* using the `editContract` endpoint. Read more about the migration to contract
|
|
89
235
|
* editing [here](https://docs.metronome.com/migrate-amendments-to-edits/) and
|
|
90
236
|
* reach out to your Metronome representative for more details. Once contract
|
|
91
237
|
* editing is enabled, access to this endpoint will be removed.
|
|
@@ -103,7 +249,26 @@ export class Contracts extends APIResource {
|
|
|
103
249
|
return this._client.post('/v1/contracts/amend', { body, ...options });
|
|
104
250
|
}
|
|
105
251
|
/**
|
|
106
|
-
*
|
|
252
|
+
* Permanently end and archive a contract along with all its terms. Any draft
|
|
253
|
+
* invoices will be canceled, and all upcoming scheduled invoices will be
|
|
254
|
+
* voided–also all finalized invoices can optionally be voided. Use this in the
|
|
255
|
+
* event a contract was incorrectly created and needed to be removed from a
|
|
256
|
+
* customer.
|
|
257
|
+
*
|
|
258
|
+
* #### Impact on commits and credits:
|
|
259
|
+
*
|
|
260
|
+
* When archiving a contract, all associated commits and credits are also archived.
|
|
261
|
+
* For prepaid commits with active segments, Metronome automatically generates
|
|
262
|
+
* expiration ledger entries to close out any remaining balances, ensuring accurate
|
|
263
|
+
* accounting of unused prepaid amounts. These ledger entries will appear in the
|
|
264
|
+
* commit's transaction history with type `PREPAID_COMMIT_EXPIRATION`.
|
|
265
|
+
*
|
|
266
|
+
* #### Archived contract visibility:
|
|
267
|
+
*
|
|
268
|
+
* Archived contracts remain accessible for historical reporting and audit
|
|
269
|
+
* purposes. They can be retrieved using the `ListContracts` endpoint by setting
|
|
270
|
+
* the `include_archived` parameter to `true` or in the Metronome UI when the "Show
|
|
271
|
+
* archived" option is enabled.
|
|
107
272
|
*
|
|
108
273
|
* @example
|
|
109
274
|
* ```ts
|
|
@@ -118,7 +283,11 @@ export class Contracts extends APIResource {
|
|
|
118
283
|
return this._client.post('/v1/contracts/archive', { body, ...options });
|
|
119
284
|
}
|
|
120
285
|
/**
|
|
121
|
-
*
|
|
286
|
+
* Create historical usage invoices for past billing periods on specific contracts.
|
|
287
|
+
* Use this endpoint to generate retroactive invoices with custom usage line items,
|
|
288
|
+
* quantities, and date ranges. Supports preview mode to validate invoice data
|
|
289
|
+
* before creation. Ideal for billing migrations or correcting past billing
|
|
290
|
+
* periods.
|
|
122
291
|
*
|
|
123
292
|
* @example
|
|
124
293
|
* ```ts
|
|
@@ -153,22 +322,66 @@ export class Contracts extends APIResource {
|
|
|
153
322
|
return this._client.post('/v1/contracts/createHistoricalInvoices', { body, ...options });
|
|
154
323
|
}
|
|
155
324
|
/**
|
|
156
|
-
*
|
|
325
|
+
* Retrieve a comprehensive view of all available balances (commits and credits)
|
|
326
|
+
* for a customer. This endpoint provides real-time visibility into prepaid funds,
|
|
327
|
+
* postpaid commitments, promotional credits, and other balance types that can
|
|
328
|
+
* offset usage charges, helping you build transparent billing experiences.
|
|
329
|
+
*
|
|
330
|
+
* ### Use this endpoint to:
|
|
331
|
+
*
|
|
332
|
+
* - Display current available balances in customer dashboards
|
|
333
|
+
* - Verify available funds before approving high-usage operations
|
|
334
|
+
* - Generate balance reports for finance teams
|
|
335
|
+
* - Filter balances by contract or date ranges
|
|
336
|
+
*
|
|
337
|
+
* ### Key response fields:
|
|
338
|
+
*
|
|
339
|
+
* An array of balance objects (all credits and commits) containing:
|
|
340
|
+
*
|
|
341
|
+
* - Balance details: Current available amount for each commit or credit
|
|
342
|
+
* - Metadata: Product associations, priorities, applicable date ranges
|
|
343
|
+
* - Optional ledger entries: Detailed transaction history (if
|
|
344
|
+
* `include_ledgers=true`)
|
|
345
|
+
* - Balance calculations: Including pending transactions and future-dated entries
|
|
346
|
+
* - Custom fields: Any additional metadata attached to balances
|
|
347
|
+
*
|
|
348
|
+
* ### Usage guidelines:
|
|
349
|
+
*
|
|
350
|
+
* - Date filtering: Use `effective_before` to include only balances with access
|
|
351
|
+
* before a specific date (exclusive)
|
|
352
|
+
* - Set `include_balance=true` for calculated balance amounts on each commit or
|
|
353
|
+
* credit
|
|
354
|
+
* - Set `include_ledgers=true` for full transaction history
|
|
355
|
+
* - Set `include_contract_balances = true` to see contract level balances
|
|
356
|
+
* - Balance logic: Reflects currently accessible amounts, excluding expired/future
|
|
357
|
+
* segments
|
|
358
|
+
* - Manual adjustments: Includes all manual ledger entries, even future-dated ones
|
|
157
359
|
*
|
|
158
360
|
* @example
|
|
159
361
|
* ```ts
|
|
160
|
-
*
|
|
161
|
-
*
|
|
162
|
-
*
|
|
163
|
-
*
|
|
164
|
-
*
|
|
362
|
+
* // Automatically fetches more pages as needed.
|
|
363
|
+
* for await (const contractListBalancesResponse of client.v1.contracts.listBalances(
|
|
364
|
+
* {
|
|
365
|
+
* customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
|
|
366
|
+
* id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
|
|
367
|
+
* include_ledgers: true,
|
|
368
|
+
* },
|
|
369
|
+
* )) {
|
|
370
|
+
* // ...
|
|
371
|
+
* }
|
|
165
372
|
* ```
|
|
166
373
|
*/
|
|
167
374
|
listBalances(body, options) {
|
|
168
|
-
return this._client.
|
|
375
|
+
return this._client.getAPIList('/v1/contracts/customerBalances/list', (BodyCursorPage), { body, method: 'post', ...options });
|
|
169
376
|
}
|
|
170
377
|
/**
|
|
171
|
-
*
|
|
378
|
+
* For a specific customer and contract, get the rates at a specific point in time.
|
|
379
|
+
* This endpoint takes the contract's rate card into consideration, including
|
|
380
|
+
* scheduled changes. It also takes into account overrides on the contract.
|
|
381
|
+
*
|
|
382
|
+
* For example, if you want to show your customer a summary of the prices they are
|
|
383
|
+
* paying, inclusive of any negotiated discounts or promotions, use this endpoint.
|
|
384
|
+
* This endpoint only returns rates that are entitled.
|
|
172
385
|
*
|
|
173
386
|
* @example
|
|
174
387
|
* ```ts
|
|
@@ -198,8 +411,16 @@ export class Contracts extends APIResource {
|
|
|
198
411
|
});
|
|
199
412
|
}
|
|
200
413
|
/**
|
|
201
|
-
*
|
|
202
|
-
*
|
|
414
|
+
* Get the history of subscription quantities and prices over time for a given
|
|
415
|
+
* `subscription_id`. This endpoint can be used to power an in-product experience
|
|
416
|
+
* where you show a customer their historical changes to seat count. Future changes
|
|
417
|
+
* are not included in this endpoint - use the `getContract` endpoint to view the
|
|
418
|
+
* future scheduled changes to a subscription's quantity.
|
|
419
|
+
*
|
|
420
|
+
* Subscriptions are used to model fixed recurring fees as well as seat-based
|
|
421
|
+
* recurring fees. To model changes to the number of seats in Metronome, you can
|
|
422
|
+
* increment or decrement the quantity on a subscription at any point in the past
|
|
423
|
+
* or future.
|
|
203
424
|
*
|
|
204
425
|
* @example
|
|
205
426
|
* ```ts
|
|
@@ -241,7 +462,24 @@ export class Contracts extends APIResource {
|
|
|
241
462
|
return this._client.post('/v1/contracts/scheduleProServicesInvoice', { body, ...options });
|
|
242
463
|
}
|
|
243
464
|
/**
|
|
244
|
-
*
|
|
465
|
+
* If a customer has multiple contracts with overlapping rates, the usage filter
|
|
466
|
+
* routes usage to the appropriate contract based on a predefined group key.
|
|
467
|
+
*
|
|
468
|
+
* As an example, imagine you have a customer associated with two projects. Each
|
|
469
|
+
* project is associated with its own contract. You can create a usage filter with
|
|
470
|
+
* group key `project_id` on each contract, and route usage for `project_1` to the
|
|
471
|
+
* first contract and `project_2` to the second contract.
|
|
472
|
+
*
|
|
473
|
+
* ### Use this endpoint to:
|
|
474
|
+
*
|
|
475
|
+
* - Support enterprise contracting scenarios where multiple contracts are
|
|
476
|
+
* associated to the same customer with the same rates.
|
|
477
|
+
* - Update the usage filter associated with the contract over time.
|
|
478
|
+
*
|
|
479
|
+
* ### Usage guidelines:
|
|
480
|
+
*
|
|
481
|
+
* To use usage filters, the `group_key` must be defined on the billable metrics
|
|
482
|
+
* underlying the rate card on the contracts.
|
|
245
483
|
*
|
|
246
484
|
* @example
|
|
247
485
|
* ```ts
|
|
@@ -258,11 +496,16 @@ export class Contracts extends APIResource {
|
|
|
258
496
|
return this._client.post('/v1/contracts/setUsageFilter', {
|
|
259
497
|
body,
|
|
260
498
|
...options,
|
|
261
|
-
headers: { Accept: '*/*',
|
|
499
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
262
500
|
});
|
|
263
501
|
}
|
|
264
502
|
/**
|
|
265
|
-
* Update
|
|
503
|
+
* Update or add an end date to a contract. Ending a contract early will impact
|
|
504
|
+
* draft usage statements, truncate any terms, and remove upcoming scheduled
|
|
505
|
+
* invoices. Moving the date into the future will only extend the contract length.
|
|
506
|
+
* Terms and scheduled invoices are not extended. In-advance subscriptions will not
|
|
507
|
+
* be extended. Use this if a contract's end date has changed or if a perpetual
|
|
508
|
+
* contract ends.
|
|
266
509
|
*
|
|
267
510
|
* @example
|
|
268
511
|
* ```ts
|
|
@@ -278,8 +521,6 @@ export class Contracts extends APIResource {
|
|
|
278
521
|
}
|
|
279
522
|
}
|
|
280
523
|
Contracts.Products = Products;
|
|
281
|
-
Contracts.ProductListResponsesCursorPage = ProductListResponsesCursorPage;
|
|
282
524
|
Contracts.RateCards = RateCards;
|
|
283
|
-
Contracts.RateCardListResponsesCursorPage = RateCardListResponsesCursorPage;
|
|
284
525
|
Contracts.NamedSchedules = NamedSchedules;
|
|
285
526
|
//# sourceMappingURL=contracts.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contracts.mjs","sourceRoot":"","sources":["../../../src/resources/v1/contracts/contracts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;
|
|
1
|
+
{"version":3,"file":"contracts.mjs","sourceRoot":"","sources":["../../../src/resources/v1/contracts/contracts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,KAAK,iBAAiB;OACtB,EAIL,cAAc,GACf;OACM,KAAK,WAAW;OAChB,EAaL,QAAQ,GAGT;OAEM,KAAK,YAAY;OACjB,EAcL,SAAS,GACV;OAEM,EAAE,cAAc,EAA0C;OAC1D,EAAE,YAAY,EAAE;AAGvB,MAAM,OAAO,SAAU,SAAQ,WAAW;IAA1C;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,mBAAc,GAAqC,IAAI,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA+hBxG,CAAC;IA7hBC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyIG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,IAA4B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,IAAwB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,qBAAqB,CACnB,IAAyC,EACzC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2CAA2C,EAAE;YACpE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,IAAyB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,OAAO,CAAC,IAA2B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,wBAAwB,CACtB,IAA4C,EAC5C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wCAAwC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiDG;IACH,YAAY,CACV,IAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,qCAAqC,EACrC,CAAA,cAA4C,CAAA,EAC5C,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,CACrC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,oBAAoB,CAClB,MAA0C,EAC1C,OAAwB;QAExB,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uCAAuC,EAAE;YAChE,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;YAC3B,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,mCAAmC,CACjC,IAAuD,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,8CAA8C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,0BAA0B,CACxB,IAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0CAA0C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,cAAc,CAAC,IAAkC,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,8BAA8B,EAAE;YACvD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,aAAa,CACX,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF;AA49FD,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC9B,SAAS,CAAC,SAAS,GAAG,SAAS,CAAC;AAChC,SAAS,CAAC,cAAc,GAAG,cAAc,CAAC"}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
export { Contracts, type ContractCreateResponse, type ContractRetrieveResponse, type ContractListResponse, type ContractAmendResponse, type ContractArchiveResponse, type ContractCreateHistoricalInvoicesResponse, type ContractListBalancesResponse, type ContractRetrieveRateScheduleResponse, type ContractRetrieveSubscriptionQuantityHistoryResponse, type ContractScheduleProServicesInvoiceResponse, type ContractUpdateEndDateResponse, type ContractCreateParams, type ContractRetrieveParams, type ContractListParams, type ContractAddManualBalanceEntryParams, type ContractAmendParams, type ContractArchiveParams, type ContractCreateHistoricalInvoicesParams, type ContractListBalancesParams, type ContractRetrieveRateScheduleParams, type ContractRetrieveSubscriptionQuantityHistoryParams, type ContractScheduleProServicesInvoiceParams, type ContractSetUsageFilterParams, type ContractUpdateEndDateParams, type ContractListBalancesResponsesBodyCursorPage, } from "./contracts.mjs";
|
|
2
|
+
export { NamedSchedules, type NamedScheduleRetrieveResponse, type NamedScheduleRetrieveParams, type NamedScheduleUpdateParams, } from "./named-schedules.mjs";
|
|
3
|
+
export { Products, type ProductListItemState, type QuantityConversion, type QuantityRounding, type ProductCreateResponse, type ProductRetrieveResponse, type ProductUpdateResponse, type ProductListResponse, type ProductArchiveResponse, type ProductCreateParams, type ProductRetrieveParams, type ProductUpdateParams, type ProductListParams, type ProductArchiveParams, type ProductListResponsesCursorPage, } from "./products.mjs";
|
|
4
|
+
export { RateCards, type RateCardCreateResponse, type RateCardRetrieveResponse, type RateCardUpdateResponse, type RateCardListResponse, type RateCardArchiveResponse, type RateCardRetrieveRateScheduleResponse, type RateCardCreateParams, type RateCardRetrieveParams, type RateCardUpdateParams, type RateCardListParams, type RateCardArchiveParams, type RateCardRetrieveRateScheduleParams, type RateCardListResponsesCursorPage, } from "./rate-cards/index.mjs";
|
|
5
|
+
//# sourceMappingURL=index.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/contracts/index.ts"],"names":[],"mappings":"OAEO,EACL,SAAS,EACT,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,wCAAwC,EAC7C,KAAK,4BAA4B,EACjC,KAAK,oCAAoC,EACzC,KAAK,mDAAmD,EACxD,KAAK,0CAA0C,EAC/C,KAAK,6BAA6B,EAClC,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,kBAAkB,EACvB,KAAK,mCAAmC,EACxC,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,sCAAsC,EAC3C,KAAK,0BAA0B,EAC/B,KAAK,kCAAkC,EACvC,KAAK,iDAAiD,EACtD,KAAK,wCAAwC,EAC7C,KAAK,4BAA4B,EACjC,KAAK,2BAA2B,EAChC,KAAK,2CAA2C,GACjD;OACM,EACL,cAAc,EACd,KAAK,6BAA6B,EAClC,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,GAC/B;OACM,EACL,QAAQ,EACR,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EACzB,KAAK,8BAA8B,GACpC;OACM,EACL,SAAS,EACT,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,KAAK,oCAAoC,EACzC,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,kCAAkC,EACvC,KAAK,+BAA+B,GACrC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
export { Contracts, type ContractCreateResponse, type ContractRetrieveResponse, type ContractListResponse, type ContractAmendResponse, type ContractArchiveResponse, type ContractCreateHistoricalInvoicesResponse, type ContractListBalancesResponse, type ContractRetrieveRateScheduleResponse, type ContractRetrieveSubscriptionQuantityHistoryResponse, type ContractScheduleProServicesInvoiceResponse, type ContractUpdateEndDateResponse, type ContractCreateParams, type ContractRetrieveParams, type ContractListParams, type ContractAddManualBalanceEntryParams, type ContractAmendParams, type ContractArchiveParams, type ContractCreateHistoricalInvoicesParams, type ContractListBalancesParams, type ContractRetrieveRateScheduleParams, type ContractRetrieveSubscriptionQuantityHistoryParams, type ContractScheduleProServicesInvoiceParams, type ContractSetUsageFilterParams, type ContractUpdateEndDateParams, } from "./contracts.js";
|
|
1
|
+
export { Contracts, type ContractCreateResponse, type ContractRetrieveResponse, type ContractListResponse, type ContractAmendResponse, type ContractArchiveResponse, type ContractCreateHistoricalInvoicesResponse, type ContractListBalancesResponse, type ContractRetrieveRateScheduleResponse, type ContractRetrieveSubscriptionQuantityHistoryResponse, type ContractScheduleProServicesInvoiceResponse, type ContractUpdateEndDateResponse, type ContractCreateParams, type ContractRetrieveParams, type ContractListParams, type ContractAddManualBalanceEntryParams, type ContractAmendParams, type ContractArchiveParams, type ContractCreateHistoricalInvoicesParams, type ContractListBalancesParams, type ContractRetrieveRateScheduleParams, type ContractRetrieveSubscriptionQuantityHistoryParams, type ContractScheduleProServicesInvoiceParams, type ContractSetUsageFilterParams, type ContractUpdateEndDateParams, type ContractListBalancesResponsesBodyCursorPage, } from "./contracts.js";
|
|
2
2
|
export { NamedSchedules, type NamedScheduleRetrieveResponse, type NamedScheduleRetrieveParams, type NamedScheduleUpdateParams, } from "./named-schedules.js";
|
|
3
|
-
export {
|
|
4
|
-
export {
|
|
3
|
+
export { Products, type ProductListItemState, type QuantityConversion, type QuantityRounding, type ProductCreateResponse, type ProductRetrieveResponse, type ProductUpdateResponse, type ProductListResponse, type ProductArchiveResponse, type ProductCreateParams, type ProductRetrieveParams, type ProductUpdateParams, type ProductListParams, type ProductArchiveParams, type ProductListResponsesCursorPage, } from "./products.js";
|
|
4
|
+
export { RateCards, type RateCardCreateResponse, type RateCardRetrieveResponse, type RateCardUpdateResponse, type RateCardListResponse, type RateCardArchiveResponse, type RateCardRetrieveRateScheduleResponse, type RateCardCreateParams, type RateCardRetrieveParams, type RateCardUpdateParams, type RateCardListParams, type RateCardArchiveParams, type RateCardRetrieveRateScheduleParams, type RateCardListResponsesCursorPage, } from "./rate-cards/index.js";
|
|
5
5
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/contracts/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/contracts/index.ts"],"names":[],"mappings":"OAEO,EACL,SAAS,EACT,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,wCAAwC,EAC7C,KAAK,4BAA4B,EACjC,KAAK,oCAAoC,EACzC,KAAK,mDAAmD,EACxD,KAAK,0CAA0C,EAC/C,KAAK,6BAA6B,EAClC,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,kBAAkB,EACvB,KAAK,mCAAmC,EACxC,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,sCAAsC,EAC3C,KAAK,0BAA0B,EAC/B,KAAK,kCAAkC,EACvC,KAAK,iDAAiD,EACtD,KAAK,wCAAwC,EAC7C,KAAK,4BAA4B,EACjC,KAAK,2BAA2B,EAChC,KAAK,2CAA2C,GACjD;OACM,EACL,cAAc,EACd,KAAK,6BAA6B,EAClC,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,GAC/B;OACM,EACL,QAAQ,EACR,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EACzB,KAAK,8BAA8B,GACpC;OACM,EACL,SAAS,EACT,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,KAAK,oCAAoC,EACzC,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,kCAAkC,EACvC,KAAK,+BAA+B,GACrC"}
|
|
@@ -1,15 +1,13 @@
|
|
|
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.RateCards = exports.
|
|
4
|
+
exports.RateCards = exports.Products = exports.NamedSchedules = exports.Contracts = void 0;
|
|
5
5
|
var contracts_1 = require("./contracts.js");
|
|
6
6
|
Object.defineProperty(exports, "Contracts", { enumerable: true, get: function () { return contracts_1.Contracts; } });
|
|
7
7
|
var named_schedules_1 = require("./named-schedules.js");
|
|
8
8
|
Object.defineProperty(exports, "NamedSchedules", { enumerable: true, get: function () { return named_schedules_1.NamedSchedules; } });
|
|
9
9
|
var products_1 = require("./products.js");
|
|
10
|
-
Object.defineProperty(exports, "ProductListResponsesCursorPage", { enumerable: true, get: function () { return products_1.ProductListResponsesCursorPage; } });
|
|
11
10
|
Object.defineProperty(exports, "Products", { enumerable: true, get: function () { return products_1.Products; } });
|
|
12
11
|
var index_1 = require("./rate-cards/index.js");
|
|
13
|
-
Object.defineProperty(exports, "RateCardListResponsesCursorPage", { enumerable: true, get: function () { return index_1.RateCardListResponsesCursorPage; } });
|
|
14
12
|
Object.defineProperty(exports, "RateCards", { enumerable: true, get: function () { return index_1.RateCards; } });
|
|
15
13
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/v1/contracts/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/v1/contracts/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,4CA2BqB;AA1BnB,sGAAA,SAAS,OAAA;AA2BX,wDAK2B;AAJzB,iHAAA,cAAc,OAAA;AAKhB,0CAgBoB;AAflB,oGAAA,QAAQ,OAAA;AAgBV,+CAe4B;AAd1B,kGAAA,SAAS,OAAA"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
export { Contracts, } from "./contracts.mjs";
|
|
3
3
|
export { NamedSchedules, } from "./named-schedules.mjs";
|
|
4
|
-
export {
|
|
5
|
-
export {
|
|
4
|
+
export { Products, } from "./products.mjs";
|
|
5
|
+
export { RateCards, } from "./rate-cards/index.mjs";
|
|
6
6
|
//# sourceMappingURL=index.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/v1/contracts/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,SAAS,
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/v1/contracts/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,SAAS,GA0BV;OACM,EACL,cAAc,GAIf;OACM,EACL,QAAQ,GAeT;OACM,EACL,SAAS,GAcV"}
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
import { APIResource } from "../../../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../../../core/api-promise.mjs";
|
|
3
|
+
import { RequestOptions } from "../../../internal/request-options.mjs";
|
|
4
|
+
export declare class NamedSchedules extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Get a named schedule for the given rate card. This endpoint's availability is
|
|
7
|
+
* dependent on your client's configuration.
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```ts
|
|
11
|
+
* const namedSchedule =
|
|
12
|
+
* await client.v1.contracts.namedSchedules.retrieve({
|
|
13
|
+
* rate_card_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
|
|
14
|
+
* schedule_name: 'my-schedule',
|
|
15
|
+
* covering_date: '2022-02-15T00:00:00Z',
|
|
16
|
+
* });
|
|
17
|
+
* ```
|
|
18
|
+
*/
|
|
19
|
+
retrieve(body: NamedScheduleRetrieveParams, options?: RequestOptions): APIPromise<NamedScheduleRetrieveResponse>;
|
|
20
|
+
/**
|
|
21
|
+
* Update a named schedule for the given rate card. This endpoint's availability is
|
|
22
|
+
* dependent on your client's configuration.
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```ts
|
|
26
|
+
* await client.v1.contracts.namedSchedules.update({
|
|
27
|
+
* rate_card_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
|
|
28
|
+
* schedule_name: 'my-schedule',
|
|
29
|
+
* starting_at: '2022-02-01T00:00:00Z',
|
|
30
|
+
* value: { my_key: 'my_value' },
|
|
31
|
+
* ending_before: '2022-02-15T00:00:00Z',
|
|
32
|
+
* });
|
|
33
|
+
* ```
|
|
34
|
+
*/
|
|
35
|
+
update(body: NamedScheduleUpdateParams, options?: RequestOptions): APIPromise<void>;
|
|
36
|
+
}
|
|
37
|
+
export interface NamedScheduleRetrieveResponse {
|
|
38
|
+
data: Array<NamedScheduleRetrieveResponse.Data>;
|
|
39
|
+
}
|
|
40
|
+
export declare namespace NamedScheduleRetrieveResponse {
|
|
41
|
+
interface Data {
|
|
42
|
+
starting_at: string;
|
|
43
|
+
value: unknown;
|
|
44
|
+
ending_before?: string;
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
export interface NamedScheduleRetrieveParams {
|
|
48
|
+
/**
|
|
49
|
+
* ID of the rate card whose named schedule is to be retrieved
|
|
50
|
+
*/
|
|
51
|
+
rate_card_id: string;
|
|
52
|
+
/**
|
|
53
|
+
* The identifier for the schedule to be retrieved
|
|
54
|
+
*/
|
|
55
|
+
schedule_name: string;
|
|
56
|
+
/**
|
|
57
|
+
* If provided, at most one schedule segment will be returned (the one that covers
|
|
58
|
+
* this date). If not provided, all segments will be returned.
|
|
59
|
+
*/
|
|
60
|
+
covering_date?: string;
|
|
61
|
+
}
|
|
62
|
+
export interface NamedScheduleUpdateParams {
|
|
63
|
+
/**
|
|
64
|
+
* ID of the rate card whose named schedule is to be updated
|
|
65
|
+
*/
|
|
66
|
+
rate_card_id: string;
|
|
67
|
+
/**
|
|
68
|
+
* The identifier for the schedule to be updated
|
|
69
|
+
*/
|
|
70
|
+
schedule_name: string;
|
|
71
|
+
starting_at: string;
|
|
72
|
+
/**
|
|
73
|
+
* The value to set for the named schedule. The structure of this object is
|
|
74
|
+
* specific to the named schedule.
|
|
75
|
+
*/
|
|
76
|
+
value: unknown;
|
|
77
|
+
ending_before?: string;
|
|
78
|
+
}
|
|
79
|
+
export declare namespace NamedSchedules {
|
|
80
|
+
export { type NamedScheduleRetrieveResponse as NamedScheduleRetrieveResponse, type NamedScheduleRetrieveParams as NamedScheduleRetrieveParams, type NamedScheduleUpdateParams as NamedScheduleUpdateParams, };
|
|
81
|
+
}
|
|
82
|
+
//# sourceMappingURL=named-schedules.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"named-schedules.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/contracts/named-schedules.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAEzB,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAI,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAOpF;AAED,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,KAAK,CAAC,6BAA6B,CAAC,IAAI,CAAC,CAAC;CACjD;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,IAAI;QACnB,WAAW,EAAE,MAAM,CAAC;QAEpB,KAAK,EAAE,OAAO,CAAC;QAEf,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import { APIResource } from "../../../resource.js";
|
|
2
|
-
import
|
|
1
|
+
import { APIResource } from "../../../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../../../core/api-promise.js";
|
|
3
|
+
import { RequestOptions } from "../../../internal/request-options.js";
|
|
3
4
|
export declare class NamedSchedules extends APIResource {
|
|
4
5
|
/**
|
|
5
6
|
* Get a named schedule for the given rate card. This endpoint's availability is
|
|
@@ -15,7 +16,7 @@ export declare class NamedSchedules extends APIResource {
|
|
|
15
16
|
* });
|
|
16
17
|
* ```
|
|
17
18
|
*/
|
|
18
|
-
retrieve(body: NamedScheduleRetrieveParams, options?:
|
|
19
|
+
retrieve(body: NamedScheduleRetrieveParams, options?: RequestOptions): APIPromise<NamedScheduleRetrieveResponse>;
|
|
19
20
|
/**
|
|
20
21
|
* Update a named schedule for the given rate card. This endpoint's availability is
|
|
21
22
|
* dependent on your client's configuration.
|
|
@@ -31,7 +32,7 @@ export declare class NamedSchedules extends APIResource {
|
|
|
31
32
|
* });
|
|
32
33
|
* ```
|
|
33
34
|
*/
|
|
34
|
-
update(body: NamedScheduleUpdateParams, options?:
|
|
35
|
+
update(body: NamedScheduleUpdateParams, options?: RequestOptions): APIPromise<void>;
|
|
35
36
|
}
|
|
36
37
|
export interface NamedScheduleRetrieveResponse {
|
|
37
38
|
data: Array<NamedScheduleRetrieveResponse.Data>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"named-schedules.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/contracts/named-schedules.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"named-schedules.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/contracts/named-schedules.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAEzB,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAI,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAOpF;AAED,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,KAAK,CAAC,6BAA6B,CAAC,IAAI,CAAC,CAAC;CACjD;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,IAAI;QACnB,WAAW,EAAE,MAAM,CAAC;QAEpB,KAAK,EAAE,OAAO,CAAC;QAEf,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
|