@metronome/sdk 0.2.0 → 1.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 +62 -0
- 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 +53 -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 +116 -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 +2239 -0
- package/resources/shared.d.mts.map +1 -0
- package/resources/shared.d.ts +1409 -523
- package/resources/shared.d.ts.map +1 -1
- package/resources/v1/alerts.d.mts +203 -0
- package/resources/v1/alerts.d.mts.map +1 -0
- package/resources/v1/alerts.d.ts +78 -7
- package/resources/v1/alerts.d.ts.map +1 -1
- package/resources/v1/alerts.js +73 -3
- package/resources/v1/alerts.js.map +1 -1
- package/resources/v1/alerts.mjs +73 -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 +2984 -0
- package/resources/v1/contracts/contracts.d.mts.map +1 -0
- package/resources/v1/contracts/contracts.d.ts +450 -1285
- package/resources/v1/contracts/contracts.d.ts.map +1 -1
- package/resources/v1/contracts/contracts.js +268 -50
- package/resources/v1/contracts/contracts.js.map +1 -1
- package/resources/v1/contracts/contracts.mjs +266 -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 +47 -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 +288 -0
- package/resources/v1/customers/alerts.d.mts.map +1 -0
- package/resources/v1/customers/alerts.d.ts +128 -23
- package/resources/v1/customers/alerts.d.ts.map +1 -1
- package/resources/v1/customers/alerts.js +112 -10
- package/resources/v1/customers/alerts.js.map +1 -1
- package/resources/v1/customers/alerts.mjs +112 -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 +145 -47
- package/resources/v1/customers/commits.d.ts.map +1 -1
- package/resources/v1/customers/commits.js +132 -12
- package/resources/v1/customers/commits.js.map +1 -1
- package/resources/v1/customers/commits.mjs +132 -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 +818 -0
- package/resources/v1/customers/customers.d.mts.map +1 -0
- package/resources/v1/customers/customers.d.ts +304 -41
- package/resources/v1/customers/customers.d.ts.map +1 -1
- package/resources/v1/customers/customers.js +214 -73
- package/resources/v1/customers/customers.js.map +1 -1
- package/resources/v1/customers/customers.mjs +207 -41
- 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 +710 -0
- package/resources/v1/customers/invoices.d.mts.map +1 -0
- package/resources/v1/customers/invoices.d.ts +196 -19
- package/resources/v1/customers/invoices.d.ts.map +1 -1
- package/resources/v1/customers/invoices.js +131 -22
- package/resources/v1/customers/invoices.js.map +1 -1
- package/resources/v1/customers/invoices.mjs +130 -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 +15 -0
- package/resources/v1/index.d.mts.map +1 -0
- package/resources/v1/index.d.ts +9 -9
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js +1 -12
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs +7 -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/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 +488 -0
- package/resources/v1/usage.d.mts.map +1 -0
- package/resources/v1/usage.d.ts +220 -57
- package/resources/v1/usage.d.ts.map +1 -1
- package/resources/v1/usage.js +212 -26
- package/resources/v1/usage.js.map +1 -1
- package/resources/v1/usage.mjs +211 -24
- package/resources/v1/usage.mjs.map +1 -1
- package/resources/v1/v1.d.mts +58 -0
- package/resources/v1/v1.d.mts.map +1 -0
- package/resources/v1/v1.d.ts +15 -15
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js +15 -48
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs +8 -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 +2794 -0
- package/resources/v2/contracts.d.mts.map +1 -0
- package/resources/v2/contracts.d.ts +381 -3862
- 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 -220
- 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 +1786 -520
- package/src/resources/v1/alerts.ts +79 -8
- 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 +518 -1622
- 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 +52 -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 +147 -28
- package/src/resources/v1/customers/billing-config.ts +27 -13
- package/src/resources/v1/customers/commits.ts +153 -54
- package/src/resources/v1/customers/credits.ts +131 -53
- package/src/resources/v1/customers/customers.ts +390 -101
- package/src/resources/v1/customers/index.ts +19 -18
- package/src/resources/v1/customers/invoices.ts +206 -37
- 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 +32 -25
- package/src/resources/v1/invoices.ts +28 -9
- 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 +244 -72
- package/src/resources/v1/v1.ts +52 -49
- package/src/resources/v1.ts +1 -1
- package/src/resources/v2/contracts.ts +431 -4967
- 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,48 +1,44 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
|
|
3
|
-
import { APIResource } from
|
|
4
|
-
import
|
|
5
|
-
import * as
|
|
6
|
-
import * as Shared from "../../shared.js";
|
|
7
|
-
import * as AlertsAPI from "./alerts.js";
|
|
3
|
+
import { APIResource } from '../../../core/resource';
|
|
4
|
+
import * as Shared from '../../shared';
|
|
5
|
+
import * as AlertsAPI from './alerts';
|
|
8
6
|
import {
|
|
9
7
|
AlertListParams,
|
|
10
|
-
AlertListResponse,
|
|
11
8
|
AlertResetParams,
|
|
12
9
|
AlertRetrieveParams,
|
|
13
10
|
AlertRetrieveResponse,
|
|
14
11
|
Alerts,
|
|
15
12
|
CustomerAlert,
|
|
16
|
-
|
|
17
|
-
|
|
13
|
+
CustomerAlertsCursorPageWithoutLimit,
|
|
14
|
+
} from './alerts';
|
|
15
|
+
import * as BillingConfigAPI from './billing-config';
|
|
18
16
|
import {
|
|
19
17
|
BillingConfig as BillingConfigAPIBillingConfig,
|
|
20
18
|
BillingConfigCreateParams,
|
|
21
19
|
BillingConfigDeleteParams,
|
|
22
20
|
BillingConfigRetrieveParams,
|
|
23
21
|
BillingConfigRetrieveResponse,
|
|
24
|
-
} from
|
|
25
|
-
import * as CommitsAPI from
|
|
22
|
+
} from './billing-config';
|
|
23
|
+
import * as CommitsAPI from './commits';
|
|
26
24
|
import {
|
|
27
25
|
CommitCreateParams,
|
|
28
26
|
CommitCreateResponse,
|
|
29
27
|
CommitListParams,
|
|
30
|
-
CommitListResponse,
|
|
31
28
|
CommitUpdateEndDateParams,
|
|
32
29
|
CommitUpdateEndDateResponse,
|
|
33
30
|
Commits,
|
|
34
|
-
} from
|
|
35
|
-
import * as CreditsAPI from
|
|
31
|
+
} from './commits';
|
|
32
|
+
import * as CreditsAPI from './credits';
|
|
36
33
|
import {
|
|
37
34
|
CreditCreateParams,
|
|
38
35
|
CreditCreateResponse,
|
|
39
36
|
CreditListParams,
|
|
40
|
-
CreditListResponse,
|
|
41
37
|
CreditUpdateEndDateParams,
|
|
42
38
|
CreditUpdateEndDateResponse,
|
|
43
39
|
Credits,
|
|
44
|
-
} from
|
|
45
|
-
import * as InvoicesAPI from
|
|
40
|
+
} from './credits';
|
|
41
|
+
import * as InvoicesAPI from './invoices';
|
|
46
42
|
import {
|
|
47
43
|
Invoice,
|
|
48
44
|
InvoiceAddChargeParams,
|
|
@@ -55,15 +51,15 @@ import {
|
|
|
55
51
|
InvoiceRetrieveResponse,
|
|
56
52
|
Invoices,
|
|
57
53
|
InvoicesCursorPage,
|
|
58
|
-
} from
|
|
59
|
-
import * as NamedSchedulesAPI from
|
|
54
|
+
} from './invoices';
|
|
55
|
+
import * as NamedSchedulesAPI from './named-schedules';
|
|
60
56
|
import {
|
|
61
57
|
NamedScheduleRetrieveParams,
|
|
62
58
|
NamedScheduleRetrieveResponse,
|
|
63
59
|
NamedScheduleUpdateParams,
|
|
64
60
|
NamedSchedules,
|
|
65
|
-
} from
|
|
66
|
-
import * as PlansAPI from
|
|
61
|
+
} from './named-schedules';
|
|
62
|
+
import * as PlansAPI from './plans';
|
|
67
63
|
import {
|
|
68
64
|
PlanAddParams,
|
|
69
65
|
PlanAddResponse,
|
|
@@ -76,8 +72,12 @@ import {
|
|
|
76
72
|
PlanListResponse,
|
|
77
73
|
PlanListResponsesCursorPage,
|
|
78
74
|
Plans,
|
|
79
|
-
} from
|
|
80
|
-
import {
|
|
75
|
+
} from './plans';
|
|
76
|
+
import { APIPromise } from '../../../core/api-promise';
|
|
77
|
+
import { CursorPage, type CursorPageParams, PagePromise } from '../../../core/pagination';
|
|
78
|
+
import { buildHeaders } from '../../../internal/headers';
|
|
79
|
+
import { RequestOptions } from '../../../internal/request-options';
|
|
80
|
+
import { path } from '../../../internal/utils/path';
|
|
81
81
|
|
|
82
82
|
export class Customers extends APIResource {
|
|
83
83
|
alerts: AlertsAPI.Alerts = new AlertsAPI.Alerts(this._client);
|
|
@@ -89,7 +89,40 @@ export class Customers extends APIResource {
|
|
|
89
89
|
namedSchedules: NamedSchedulesAPI.NamedSchedules = new NamedSchedulesAPI.NamedSchedules(this._client);
|
|
90
90
|
|
|
91
91
|
/**
|
|
92
|
-
* Create a new customer
|
|
92
|
+
* Create a new customer in Metronome and optionally the billing configuration
|
|
93
|
+
* (recommended) which dictates where invoices for the customer will be sent or
|
|
94
|
+
* where payment will be collected.
|
|
95
|
+
*
|
|
96
|
+
* ### Use this endpoint to:
|
|
97
|
+
*
|
|
98
|
+
* Execute your customer provisioning workflows for either PLG motions, where
|
|
99
|
+
* customers originate in your platform, or SLG motions, where customers originate
|
|
100
|
+
* in your sales system.
|
|
101
|
+
*
|
|
102
|
+
* ### Key response fields:
|
|
103
|
+
*
|
|
104
|
+
* This end-point returns the `customer_id` created by the request. This id can be
|
|
105
|
+
* used to fetch relevant billing configurations and create contracts.
|
|
106
|
+
*
|
|
107
|
+
* ### Example workflow:
|
|
108
|
+
*
|
|
109
|
+
* - Generally, Metronome recommends first creating the customer in the downstream
|
|
110
|
+
* payment / ERP system when payment method is collected and then creating the
|
|
111
|
+
* customer in Metronome using the response (i.e. `customer_id`) from the
|
|
112
|
+
* downstream system. If you do not create a billing configuration on customer
|
|
113
|
+
* creation, you can add it later.
|
|
114
|
+
* - Once a customer is created, you can then create a contract for the customer.
|
|
115
|
+
* In the contract creation process, you will need to add the customer billing
|
|
116
|
+
* configuration to the contract to ensure Metronome invoices the customer
|
|
117
|
+
* correctly. This is because a customer can have multiple configurations.
|
|
118
|
+
* - As part of the customer creation process, set the ingest alias for the
|
|
119
|
+
* customer which will ensure usage is accurately mapped to the customer. Ingest
|
|
120
|
+
* aliases can be added or changed after the creation process as well.
|
|
121
|
+
*
|
|
122
|
+
* ### Usage guidelines:
|
|
123
|
+
*
|
|
124
|
+
* For details on different billing configurations for different systems, review
|
|
125
|
+
* the `/setCustomerBillingConfiguration` end-point.
|
|
93
126
|
*
|
|
94
127
|
* @example
|
|
95
128
|
* ```ts
|
|
@@ -109,12 +142,18 @@ export class Customers extends APIResource {
|
|
|
109
142
|
* });
|
|
110
143
|
* ```
|
|
111
144
|
*/
|
|
112
|
-
create(body: CustomerCreateParams, options?:
|
|
145
|
+
create(body: CustomerCreateParams, options?: RequestOptions): APIPromise<CustomerCreateResponse> {
|
|
113
146
|
return this._client.post('/v1/customers', { body, ...options });
|
|
114
147
|
}
|
|
115
148
|
|
|
116
149
|
/**
|
|
117
|
-
* Get a customer by Metronome ID.
|
|
150
|
+
* Get detailed information for a specific customer by their Metronome ID. Returns
|
|
151
|
+
* customer profile data including name, creation date, ingest aliases,
|
|
152
|
+
* configuration settings, and custom fields. Use this endpoint to fetch complete
|
|
153
|
+
* customer details for billing operations or account management.
|
|
154
|
+
*
|
|
155
|
+
* Note: If searching for a customer billing configuration, use the
|
|
156
|
+
* `/getCustomerBillingConfigurations` endpoint.
|
|
118
157
|
*
|
|
119
158
|
* @example
|
|
120
159
|
* ```ts
|
|
@@ -123,16 +162,17 @@ export class Customers extends APIResource {
|
|
|
123
162
|
* });
|
|
124
163
|
* ```
|
|
125
164
|
*/
|
|
126
|
-
retrieve(
|
|
127
|
-
params: CustomerRetrieveParams,
|
|
128
|
-
options?: Core.RequestOptions,
|
|
129
|
-
): Core.APIPromise<CustomerRetrieveResponse> {
|
|
165
|
+
retrieve(params: CustomerRetrieveParams, options?: RequestOptions): APIPromise<CustomerRetrieveResponse> {
|
|
130
166
|
const { customer_id } = params;
|
|
131
|
-
return this._client.get(`/v1/customers/${customer_id}`, options);
|
|
167
|
+
return this._client.get(path`/v1/customers/${customer_id}`, options);
|
|
132
168
|
}
|
|
133
169
|
|
|
134
170
|
/**
|
|
135
|
-
*
|
|
171
|
+
* Gets a paginated list of all customers in your Metronome account. Use this
|
|
172
|
+
* endpoint to browse your customer base, implement customer search functionality,
|
|
173
|
+
* or sync customer data with external systems. Returns customer details including
|
|
174
|
+
* IDs, names, and configuration settings. Supports filtering and pagination
|
|
175
|
+
* parameters for efficient data retrieval.
|
|
136
176
|
*
|
|
137
177
|
* @example
|
|
138
178
|
* ```ts
|
|
@@ -143,23 +183,27 @@ export class Customers extends APIResource {
|
|
|
143
183
|
* ```
|
|
144
184
|
*/
|
|
145
185
|
list(
|
|
146
|
-
query
|
|
147
|
-
options?:
|
|
148
|
-
):
|
|
149
|
-
|
|
150
|
-
list(
|
|
151
|
-
query: CustomerListParams | Core.RequestOptions = {},
|
|
152
|
-
options?: Core.RequestOptions,
|
|
153
|
-
): Core.PagePromise<CustomerDetailsCursorPage, CustomerDetail> {
|
|
154
|
-
if (isRequestOptions(query)) {
|
|
155
|
-
return this.list({}, query);
|
|
156
|
-
}
|
|
157
|
-
return this._client.getAPIList('/v1/customers', CustomerDetailsCursorPage, { query, ...options });
|
|
186
|
+
query: CustomerListParams | null | undefined = {},
|
|
187
|
+
options?: RequestOptions,
|
|
188
|
+
): PagePromise<CustomerDetailsCursorPage, CustomerDetail> {
|
|
189
|
+
return this._client.getAPIList('/v1/customers', CursorPage<CustomerDetail>, { query, ...options });
|
|
158
190
|
}
|
|
159
191
|
|
|
160
192
|
/**
|
|
161
|
-
*
|
|
162
|
-
*
|
|
193
|
+
* Use this endpoint to archive a customer while preserving auditability. Archiving
|
|
194
|
+
* a customer will automatically archive all contracts as of the current date and
|
|
195
|
+
* void all corresponding invoices. Use this endpoint if a customer is onboarded by
|
|
196
|
+
* mistake.
|
|
197
|
+
*
|
|
198
|
+
* ### Usage guidelines:
|
|
199
|
+
*
|
|
200
|
+
* - Once a customer is archived, it cannot be unarchived.
|
|
201
|
+
* - Archived customers can still be viewed through the API or the UI for audit
|
|
202
|
+
* purposes.
|
|
203
|
+
* - Ingest aliases remain idempotent for archived customers. In order to reuse an
|
|
204
|
+
* ingest alias, first remove the ingest alias from the customer prior to
|
|
205
|
+
* archiving.
|
|
206
|
+
* - Any alerts associated with the customer will no longer be triggered.
|
|
163
207
|
*
|
|
164
208
|
* @example
|
|
165
209
|
* ```ts
|
|
@@ -168,15 +212,15 @@ export class Customers extends APIResource {
|
|
|
168
212
|
* });
|
|
169
213
|
* ```
|
|
170
214
|
*/
|
|
171
|
-
archive(
|
|
172
|
-
body: CustomerArchiveParams,
|
|
173
|
-
options?: Core.RequestOptions,
|
|
174
|
-
): Core.APIPromise<CustomerArchiveResponse> {
|
|
215
|
+
archive(body: CustomerArchiveParams, options?: RequestOptions): APIPromise<CustomerArchiveResponse> {
|
|
175
216
|
return this._client.post('/v1/customers/archive', { body, ...options });
|
|
176
217
|
}
|
|
177
218
|
|
|
178
219
|
/**
|
|
179
|
-
* Get all billable metrics for a
|
|
220
|
+
* Get all billable metrics available for a specific customer. Supports pagination
|
|
221
|
+
* and filtering by current plan status or archived metrics. Use this endpoint to
|
|
222
|
+
* see which metrics are being tracked for billing calculations for a given
|
|
223
|
+
* customer.
|
|
180
224
|
*
|
|
181
225
|
* @example
|
|
182
226
|
* ```ts
|
|
@@ -190,12 +234,12 @@ export class Customers extends APIResource {
|
|
|
190
234
|
*/
|
|
191
235
|
listBillableMetrics(
|
|
192
236
|
params: CustomerListBillableMetricsParams,
|
|
193
|
-
options?:
|
|
194
|
-
):
|
|
237
|
+
options?: RequestOptions,
|
|
238
|
+
): PagePromise<CustomerListBillableMetricsResponsesCursorPage, CustomerListBillableMetricsResponse> {
|
|
195
239
|
const { customer_id, ...query } = params;
|
|
196
240
|
return this._client.getAPIList(
|
|
197
|
-
`/v1/customers/${customer_id}/billable-metrics`,
|
|
198
|
-
|
|
241
|
+
path`/v1/customers/${customer_id}/billable-metrics`,
|
|
242
|
+
CursorPage<CustomerListBillableMetricsResponse>,
|
|
199
243
|
{ query, ...options },
|
|
200
244
|
);
|
|
201
245
|
}
|
|
@@ -221,12 +265,12 @@ export class Customers extends APIResource {
|
|
|
221
265
|
*/
|
|
222
266
|
listCosts(
|
|
223
267
|
params: CustomerListCostsParams,
|
|
224
|
-
options?:
|
|
225
|
-
):
|
|
268
|
+
options?: RequestOptions,
|
|
269
|
+
): PagePromise<CustomerListCostsResponsesCursorPage, CustomerListCostsResponse> {
|
|
226
270
|
const { customer_id, ...query } = params;
|
|
227
271
|
return this._client.getAPIList(
|
|
228
|
-
`/v1/customers/${customer_id}/costs`,
|
|
229
|
-
|
|
272
|
+
path`/v1/customers/${customer_id}/costs`,
|
|
273
|
+
CursorPage<CustomerListCostsResponse>,
|
|
230
274
|
{ query, ...options },
|
|
231
275
|
);
|
|
232
276
|
}
|
|
@@ -253,16 +297,129 @@ export class Customers extends APIResource {
|
|
|
253
297
|
*/
|
|
254
298
|
previewEvents(
|
|
255
299
|
params: CustomerPreviewEventsParams,
|
|
256
|
-
options?:
|
|
257
|
-
):
|
|
300
|
+
options?: RequestOptions,
|
|
301
|
+
): APIPromise<CustomerPreviewEventsResponse> {
|
|
258
302
|
const { customer_id, ...body } = params;
|
|
259
|
-
return this._client.post(`/v1/customers/${customer_id}/previewEvents`, { body, ...options });
|
|
303
|
+
return this._client.post(path`/v1/customers/${customer_id}/previewEvents`, { body, ...options });
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
/**
|
|
307
|
+
* Returns all billing configurations previously set for the customer. Use during
|
|
308
|
+
* the contract provisioning process to fetch the
|
|
309
|
+
* `billing_provider_configuration_id` needed to set the contract billing
|
|
310
|
+
* configuration.
|
|
311
|
+
*
|
|
312
|
+
* @example
|
|
313
|
+
* ```ts
|
|
314
|
+
* const response =
|
|
315
|
+
* await client.v1.customers.retrieveBillingConfigurations({
|
|
316
|
+
* customer_id: '6a37bb88-8538-48c5-b37b-a41c836328bd',
|
|
317
|
+
* });
|
|
318
|
+
* ```
|
|
319
|
+
*/
|
|
320
|
+
retrieveBillingConfigurations(
|
|
321
|
+
body: CustomerRetrieveBillingConfigurationsParams,
|
|
322
|
+
options?: RequestOptions,
|
|
323
|
+
): APIPromise<CustomerRetrieveBillingConfigurationsResponse> {
|
|
324
|
+
return this._client.post('/v1/getCustomerBillingProviderConfigurations', { body, ...options });
|
|
325
|
+
}
|
|
326
|
+
|
|
327
|
+
/**
|
|
328
|
+
* Create a billing configuration for a customer. Once created, these
|
|
329
|
+
* configurations are available to associate to a contract and dictates which
|
|
330
|
+
* downstream system to collect payment in or send the invoice to. You can create
|
|
331
|
+
* multiple configurations per customer. The configuration formats are distinct for
|
|
332
|
+
* each downstream provider.
|
|
333
|
+
*
|
|
334
|
+
* ### Use this endpoint to:
|
|
335
|
+
*
|
|
336
|
+
* - Add the initial configuration to an existing customer. Once created, the
|
|
337
|
+
* billing configuration can then be associated to the customer's contract.
|
|
338
|
+
* - Add a new configuration to an existing customer. This might be used as part of
|
|
339
|
+
* an upgrade or downgrade workflow where the customer was previously billed
|
|
340
|
+
* through system A (e.g. Stripe) but will now be billed through system B (e.g.
|
|
341
|
+
* AWS). Once created, the new configuration can then be associated to the
|
|
342
|
+
* customer's contract.
|
|
343
|
+
*
|
|
344
|
+
* ### Delivery method options:
|
|
345
|
+
*
|
|
346
|
+
* - `direct_to_billing_provider`: Use when Metronome should send invoices directly
|
|
347
|
+
* to the billing provider's API (e.g., Stripe, NetSuite). This is the most
|
|
348
|
+
* common method for automated billing workflows.
|
|
349
|
+
* - `tackle`: Use specifically for AWS Marketplace transactions that require
|
|
350
|
+
* Tackle's co-selling platform for partner attribution and commission tracking.
|
|
351
|
+
* - `aws_sqs`: Use when you want invoice data delivered to an AWS SQS queue for
|
|
352
|
+
* custom processing before sending to your billing system.
|
|
353
|
+
* - `aws_sns`: Use when you want invoice notifications published to an AWS SNS
|
|
354
|
+
* topic for event-driven billing workflows.
|
|
355
|
+
*
|
|
356
|
+
* ### Key response fields:
|
|
357
|
+
*
|
|
358
|
+
* The id for the customer billing configuration. This id can be used to associate
|
|
359
|
+
* the billing configuration to a contract.
|
|
360
|
+
*
|
|
361
|
+
* ### Usage guidelines:
|
|
362
|
+
*
|
|
363
|
+
* Must use the `delivery_method_id` if you have multiple Stripe accounts connected
|
|
364
|
+
* to Metronome.
|
|
365
|
+
*
|
|
366
|
+
* @example
|
|
367
|
+
* ```ts
|
|
368
|
+
* await client.v1.customers.setBillingConfigurations({
|
|
369
|
+
* data: [
|
|
370
|
+
* {
|
|
371
|
+
* customer_id: '4db51251-61de-4bfe-b9ce-495e244f3491',
|
|
372
|
+
* billing_provider: 'stripe',
|
|
373
|
+
* configuration: { ... },
|
|
374
|
+
* delivery_method: 'direct_to_billing_provider',
|
|
375
|
+
* },
|
|
376
|
+
* {
|
|
377
|
+
* customer_id: '4db51251-61de-4bfe-b9ce-495e244f3491',
|
|
378
|
+
* billing_provider: 'aws_marketplace',
|
|
379
|
+
* configuration: { ... },
|
|
380
|
+
* delivery_method: 'direct_to_billing_provider',
|
|
381
|
+
* },
|
|
382
|
+
* {
|
|
383
|
+
* customer_id: '4db51251-61de-4bfe-b9ce-495e244f3491',
|
|
384
|
+
* billing_provider: 'azure_marketplace',
|
|
385
|
+
* configuration: { ... },
|
|
386
|
+
* delivery_method_id: '5b9e3072-415b-4842-94f0-0b6700c8b6be',
|
|
387
|
+
* },
|
|
388
|
+
* {
|
|
389
|
+
* customer_id: '4db51251-61de-4bfe-b9ce-495e244f3491',
|
|
390
|
+
* billing_provider: 'aws_marketplace',
|
|
391
|
+
* configuration: { ... },
|
|
392
|
+
* delivery_method: 'direct_to_billing_provider',
|
|
393
|
+
* },
|
|
394
|
+
* ],
|
|
395
|
+
* });
|
|
396
|
+
* ```
|
|
397
|
+
*/
|
|
398
|
+
setBillingConfigurations(
|
|
399
|
+
body: CustomerSetBillingConfigurationsParams,
|
|
400
|
+
options?: RequestOptions,
|
|
401
|
+
): APIPromise<void> {
|
|
402
|
+
return this._client.post('/v1/setCustomerBillingProviderConfigurations', {
|
|
403
|
+
body,
|
|
404
|
+
...options,
|
|
405
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
406
|
+
});
|
|
260
407
|
}
|
|
261
408
|
|
|
262
409
|
/**
|
|
263
|
-
* Sets the ingest aliases for a customer.
|
|
264
|
-
*
|
|
265
|
-
*
|
|
410
|
+
* Sets the ingest aliases for a customer. Use this endpoint to associate a
|
|
411
|
+
* Metronome customer with an internal ID for easier tracking between systems.
|
|
412
|
+
* Ingest aliases can be used in the `customer_id` field when sending usage events
|
|
413
|
+
* to Metronome.
|
|
414
|
+
*
|
|
415
|
+
* ### Usage guidelines:
|
|
416
|
+
*
|
|
417
|
+
* - This call is idempotent and fully replaces the set of ingest aliases for the
|
|
418
|
+
* given customer.
|
|
419
|
+
* - Switching an ingest alias from one customer to another will associate all
|
|
420
|
+
* corresponding usage to the new customer.
|
|
421
|
+
* - Use multiple ingest aliases to model child organizations within a single
|
|
422
|
+
* Metronome customer.
|
|
266
423
|
*
|
|
267
424
|
* @example
|
|
268
425
|
* ```ts
|
|
@@ -272,20 +429,21 @@ export class Customers extends APIResource {
|
|
|
272
429
|
* });
|
|
273
430
|
* ```
|
|
274
431
|
*/
|
|
275
|
-
setIngestAliases(
|
|
276
|
-
params: CustomerSetIngestAliasesParams,
|
|
277
|
-
options?: Core.RequestOptions,
|
|
278
|
-
): Core.APIPromise<void> {
|
|
432
|
+
setIngestAliases(params: CustomerSetIngestAliasesParams, options?: RequestOptions): APIPromise<void> {
|
|
279
433
|
const { customer_id, ...body } = params;
|
|
280
|
-
return this._client.post(`/v1/customers/${customer_id}/setIngestAliases`, {
|
|
434
|
+
return this._client.post(path`/v1/customers/${customer_id}/setIngestAliases`, {
|
|
281
435
|
body,
|
|
282
436
|
...options,
|
|
283
|
-
headers: { Accept: '*/*',
|
|
437
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
284
438
|
});
|
|
285
439
|
}
|
|
286
440
|
|
|
287
441
|
/**
|
|
288
|
-
* Updates the
|
|
442
|
+
* Updates the display name for a customer record. Use this to correct customer
|
|
443
|
+
* names, update business names after rebranding, or maintain accurate customer
|
|
444
|
+
* information for invoicing and reporting. Returns the updated customer object
|
|
445
|
+
* with the new name applied immediately across all billing documents and
|
|
446
|
+
* interfaces.
|
|
289
447
|
*
|
|
290
448
|
* @example
|
|
291
449
|
* ```ts
|
|
@@ -295,16 +453,16 @@ export class Customers extends APIResource {
|
|
|
295
453
|
* });
|
|
296
454
|
* ```
|
|
297
455
|
*/
|
|
298
|
-
setName(
|
|
299
|
-
params: CustomerSetNameParams,
|
|
300
|
-
options?: Core.RequestOptions,
|
|
301
|
-
): Core.APIPromise<CustomerSetNameResponse> {
|
|
456
|
+
setName(params: CustomerSetNameParams, options?: RequestOptions): APIPromise<CustomerSetNameResponse> {
|
|
302
457
|
const { customer_id, ...body } = params;
|
|
303
|
-
return this._client.post(`/v1/customers/${customer_id}/setName`, { body, ...options });
|
|
458
|
+
return this._client.post(path`/v1/customers/${customer_id}/setName`, { body, ...options });
|
|
304
459
|
}
|
|
305
460
|
|
|
306
461
|
/**
|
|
307
|
-
*
|
|
462
|
+
* Update configuration settings for a specific customer, such as external system
|
|
463
|
+
* integrations (e.g., Salesforce account ID) and other customer-specific billing
|
|
464
|
+
* parameters. Use this endpoint to modify customer configurations without
|
|
465
|
+
* affecting core customer data like name or ingest aliases.
|
|
308
466
|
*
|
|
309
467
|
* @example
|
|
310
468
|
* ```ts
|
|
@@ -314,21 +472,21 @@ export class Customers extends APIResource {
|
|
|
314
472
|
* });
|
|
315
473
|
* ```
|
|
316
474
|
*/
|
|
317
|
-
updateConfig(params: CustomerUpdateConfigParams, options?:
|
|
475
|
+
updateConfig(params: CustomerUpdateConfigParams, options?: RequestOptions): APIPromise<void> {
|
|
318
476
|
const { customer_id, ...body } = params;
|
|
319
|
-
return this._client.post(`/v1/customers/${customer_id}/updateConfig`, {
|
|
477
|
+
return this._client.post(path`/v1/customers/${customer_id}/updateConfig`, {
|
|
320
478
|
body,
|
|
321
479
|
...options,
|
|
322
|
-
headers: { Accept: '*/*',
|
|
480
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
323
481
|
});
|
|
324
482
|
}
|
|
325
483
|
}
|
|
326
484
|
|
|
327
|
-
export
|
|
485
|
+
export type CustomerDetailsCursorPage = CursorPage<CustomerDetail>;
|
|
328
486
|
|
|
329
|
-
export
|
|
487
|
+
export type CustomerListBillableMetricsResponsesCursorPage = CursorPage<CustomerListBillableMetricsResponse>;
|
|
330
488
|
|
|
331
|
-
export
|
|
489
|
+
export type CustomerListCostsResponsesCursorPage = CursorPage<CustomerListCostsResponse>;
|
|
332
490
|
|
|
333
491
|
export interface Customer {
|
|
334
492
|
/**
|
|
@@ -350,6 +508,9 @@ export interface Customer {
|
|
|
350
508
|
|
|
351
509
|
name: string;
|
|
352
510
|
|
|
511
|
+
/**
|
|
512
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
513
|
+
*/
|
|
353
514
|
custom_fields?: { [key: string]: string };
|
|
354
515
|
}
|
|
355
516
|
|
|
@@ -364,6 +525,9 @@ export interface CustomerDetail {
|
|
|
364
525
|
*/
|
|
365
526
|
created_at: string;
|
|
366
527
|
|
|
528
|
+
/**
|
|
529
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
530
|
+
*/
|
|
367
531
|
custom_fields: { [key: string]: string };
|
|
368
532
|
|
|
369
533
|
customer_config: CustomerDetail.CustomerConfig;
|
|
@@ -457,6 +621,9 @@ export interface CustomerListBillableMetricsResponse {
|
|
|
457
621
|
*/
|
|
458
622
|
archived_at?: string;
|
|
459
623
|
|
|
624
|
+
/**
|
|
625
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
626
|
+
*/
|
|
460
627
|
custom_fields?: { [key: string]: string };
|
|
461
628
|
|
|
462
629
|
/**
|
|
@@ -527,6 +694,59 @@ export interface CustomerPreviewEventsResponse {
|
|
|
527
694
|
data: InvoicesAPI.Invoice;
|
|
528
695
|
}
|
|
529
696
|
|
|
697
|
+
export interface CustomerRetrieveBillingConfigurationsResponse {
|
|
698
|
+
data: Array<CustomerRetrieveBillingConfigurationsResponse.Data>;
|
|
699
|
+
}
|
|
700
|
+
|
|
701
|
+
export namespace CustomerRetrieveBillingConfigurationsResponse {
|
|
702
|
+
export interface Data {
|
|
703
|
+
/**
|
|
704
|
+
* ID of this configuration; can be provided as the
|
|
705
|
+
* billing_provider_configuration_id when creating a contract.
|
|
706
|
+
*/
|
|
707
|
+
id: string;
|
|
708
|
+
|
|
709
|
+
archived_at: string | null;
|
|
710
|
+
|
|
711
|
+
/**
|
|
712
|
+
* The billing provider set for this configuration.
|
|
713
|
+
*/
|
|
714
|
+
billing_provider:
|
|
715
|
+
| 'aws_marketplace'
|
|
716
|
+
| 'stripe'
|
|
717
|
+
| 'netsuite'
|
|
718
|
+
| 'custom'
|
|
719
|
+
| 'azure_marketplace'
|
|
720
|
+
| 'quickbooks_online'
|
|
721
|
+
| 'workday'
|
|
722
|
+
| 'gcp_marketplace';
|
|
723
|
+
|
|
724
|
+
/**
|
|
725
|
+
* Configuration for the billing provider. The structure of this object is specific
|
|
726
|
+
* to the billing provider.
|
|
727
|
+
*/
|
|
728
|
+
configuration: { [key: string]: unknown };
|
|
729
|
+
|
|
730
|
+
customer_id: string;
|
|
731
|
+
|
|
732
|
+
/**
|
|
733
|
+
* The method to use for delivering invoices to this customer.
|
|
734
|
+
*/
|
|
735
|
+
delivery_method: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
|
|
736
|
+
|
|
737
|
+
/**
|
|
738
|
+
* Configuration for the delivery method. The structure of this object is specific
|
|
739
|
+
* to the delivery method.
|
|
740
|
+
*/
|
|
741
|
+
delivery_method_configuration: { [key: string]: unknown };
|
|
742
|
+
|
|
743
|
+
/**
|
|
744
|
+
* ID of the delivery method to use for this customer.
|
|
745
|
+
*/
|
|
746
|
+
delivery_method_id: string;
|
|
747
|
+
}
|
|
748
|
+
}
|
|
749
|
+
|
|
530
750
|
export interface CustomerSetNameResponse {
|
|
531
751
|
data: Customer;
|
|
532
752
|
}
|
|
@@ -539,6 +759,9 @@ export interface CustomerCreateParams {
|
|
|
539
759
|
|
|
540
760
|
billing_config?: CustomerCreateParams.BillingConfig;
|
|
541
761
|
|
|
762
|
+
/**
|
|
763
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
764
|
+
*/
|
|
542
765
|
custom_fields?: { [key: string]: string };
|
|
543
766
|
|
|
544
767
|
customer_billing_provider_configurations?: Array<CustomerCreateParams.CustomerBillingProviderConfiguration>;
|
|
@@ -603,7 +826,11 @@ export namespace CustomerCreateParams {
|
|
|
603
826
|
| 'us-west-1'
|
|
604
827
|
| 'us-west-2';
|
|
605
828
|
|
|
606
|
-
stripe_collection_method?:
|
|
829
|
+
stripe_collection_method?:
|
|
830
|
+
| 'charge_automatically'
|
|
831
|
+
| 'send_invoice'
|
|
832
|
+
| 'auto_charge_payment_intent'
|
|
833
|
+
| 'manually_charge_payment_intent';
|
|
607
834
|
}
|
|
608
835
|
|
|
609
836
|
export interface CustomerBillingProviderConfiguration {
|
|
@@ -631,6 +858,14 @@ export namespace CustomerCreateParams {
|
|
|
631
858
|
* `delivery_method` must be provided.
|
|
632
859
|
*/
|
|
633
860
|
delivery_method_id?: string;
|
|
861
|
+
|
|
862
|
+
/**
|
|
863
|
+
* Specifies which tax provider Metronome should use for tax calculation when
|
|
864
|
+
* billing through Stripe. This is only supported for Stripe billing provider
|
|
865
|
+
* configurations with auto_charge_payment_intent or manual_charge_payment_intent
|
|
866
|
+
* collection methods.
|
|
867
|
+
*/
|
|
868
|
+
tax_provider?: 'anrok' | 'avalara' | 'stripe';
|
|
634
869
|
}
|
|
635
870
|
}
|
|
636
871
|
|
|
@@ -754,6 +989,66 @@ export namespace CustomerPreviewEventsParams {
|
|
|
754
989
|
}
|
|
755
990
|
}
|
|
756
991
|
|
|
992
|
+
export interface CustomerRetrieveBillingConfigurationsParams {
|
|
993
|
+
customer_id: string;
|
|
994
|
+
|
|
995
|
+
include_archived?: boolean;
|
|
996
|
+
}
|
|
997
|
+
|
|
998
|
+
export interface CustomerSetBillingConfigurationsParams {
|
|
999
|
+
data: Array<CustomerSetBillingConfigurationsParams.Data>;
|
|
1000
|
+
}
|
|
1001
|
+
|
|
1002
|
+
export namespace CustomerSetBillingConfigurationsParams {
|
|
1003
|
+
export interface Data {
|
|
1004
|
+
/**
|
|
1005
|
+
* The billing provider set for this configuration.
|
|
1006
|
+
*/
|
|
1007
|
+
billing_provider:
|
|
1008
|
+
| 'aws_marketplace'
|
|
1009
|
+
| 'stripe'
|
|
1010
|
+
| 'netsuite'
|
|
1011
|
+
| 'custom'
|
|
1012
|
+
| 'azure_marketplace'
|
|
1013
|
+
| 'quickbooks_online'
|
|
1014
|
+
| 'workday'
|
|
1015
|
+
| 'gcp_marketplace';
|
|
1016
|
+
|
|
1017
|
+
customer_id: string;
|
|
1018
|
+
|
|
1019
|
+
/**
|
|
1020
|
+
* Configuration for the billing provider. The structure of this object is specific
|
|
1021
|
+
* to the billing provider and delivery method combination. Defaults to an empty
|
|
1022
|
+
* object, however, for most billing provider + delivery method combinations, it
|
|
1023
|
+
* will not be a valid configuration. For AWS marketplace configurations, the
|
|
1024
|
+
* aws_is_subscription_product flag can be used to indicate a product with
|
|
1025
|
+
* usage-based pricing. More information can be found
|
|
1026
|
+
* [here](https://docs.metronome.com/invoice-customers/solutions/marketplaces/invoice-aws/#provision-aws-marketplace-customers-in-metronome).
|
|
1027
|
+
*/
|
|
1028
|
+
configuration?: { [key: string]: unknown };
|
|
1029
|
+
|
|
1030
|
+
/**
|
|
1031
|
+
* The method to use for delivering invoices to this customer. If not provided, the
|
|
1032
|
+
* `delivery_method_id` must be provided.
|
|
1033
|
+
*/
|
|
1034
|
+
delivery_method?: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
|
|
1035
|
+
|
|
1036
|
+
/**
|
|
1037
|
+
* ID of the delivery method to use for this customer. If not provided, the
|
|
1038
|
+
* `delivery_method` must be provided.
|
|
1039
|
+
*/
|
|
1040
|
+
delivery_method_id?: string;
|
|
1041
|
+
|
|
1042
|
+
/**
|
|
1043
|
+
* Specifies which tax provider Metronome should use for tax calculation when
|
|
1044
|
+
* billing through Stripe. This is only supported for Stripe billing provider
|
|
1045
|
+
* configurations with auto_charge_payment_intent or manual_charge_payment_intent
|
|
1046
|
+
* collection methods.
|
|
1047
|
+
*/
|
|
1048
|
+
tax_provider?: 'anrok' | 'avalara' | 'stripe';
|
|
1049
|
+
}
|
|
1050
|
+
}
|
|
1051
|
+
|
|
757
1052
|
export interface CustomerSetIngestAliasesParams {
|
|
758
1053
|
/**
|
|
759
1054
|
* Path param:
|
|
@@ -797,16 +1092,9 @@ export interface CustomerUpdateConfigParams {
|
|
|
797
1092
|
salesforce_account_id?: string | null;
|
|
798
1093
|
}
|
|
799
1094
|
|
|
800
|
-
Customers.CustomerDetailsCursorPage = CustomerDetailsCursorPage;
|
|
801
|
-
Customers.CustomerListBillableMetricsResponsesCursorPage = CustomerListBillableMetricsResponsesCursorPage;
|
|
802
|
-
Customers.CustomerListCostsResponsesCursorPage = CustomerListCostsResponsesCursorPage;
|
|
803
1095
|
Customers.Alerts = Alerts;
|
|
804
1096
|
Customers.Plans = Plans;
|
|
805
|
-
Customers.PlanListResponsesCursorPage = PlanListResponsesCursorPage;
|
|
806
|
-
Customers.PlanListPriceAdjustmentsResponsesCursorPage = PlanListPriceAdjustmentsResponsesCursorPage;
|
|
807
1097
|
Customers.Invoices = Invoices;
|
|
808
|
-
Customers.InvoicesCursorPage = InvoicesCursorPage;
|
|
809
|
-
Customers.InvoiceListBreakdownsResponsesCursorPage = InvoiceListBreakdownsResponsesCursorPage;
|
|
810
1098
|
Customers.BillingConfig = BillingConfigAPIBillingConfig;
|
|
811
1099
|
Customers.Commits = Commits;
|
|
812
1100
|
Customers.Credits = Credits;
|
|
@@ -822,10 +1110,11 @@ export declare namespace Customers {
|
|
|
822
1110
|
type CustomerListBillableMetricsResponse as CustomerListBillableMetricsResponse,
|
|
823
1111
|
type CustomerListCostsResponse as CustomerListCostsResponse,
|
|
824
1112
|
type CustomerPreviewEventsResponse as CustomerPreviewEventsResponse,
|
|
1113
|
+
type CustomerRetrieveBillingConfigurationsResponse as CustomerRetrieveBillingConfigurationsResponse,
|
|
825
1114
|
type CustomerSetNameResponse as CustomerSetNameResponse,
|
|
826
|
-
CustomerDetailsCursorPage as CustomerDetailsCursorPage,
|
|
827
|
-
CustomerListBillableMetricsResponsesCursorPage as CustomerListBillableMetricsResponsesCursorPage,
|
|
828
|
-
CustomerListCostsResponsesCursorPage as CustomerListCostsResponsesCursorPage,
|
|
1115
|
+
type CustomerDetailsCursorPage as CustomerDetailsCursorPage,
|
|
1116
|
+
type CustomerListBillableMetricsResponsesCursorPage as CustomerListBillableMetricsResponsesCursorPage,
|
|
1117
|
+
type CustomerListCostsResponsesCursorPage as CustomerListCostsResponsesCursorPage,
|
|
829
1118
|
type CustomerCreateParams as CustomerCreateParams,
|
|
830
1119
|
type CustomerRetrieveParams as CustomerRetrieveParams,
|
|
831
1120
|
type CustomerListParams as CustomerListParams,
|
|
@@ -833,6 +1122,8 @@ export declare namespace Customers {
|
|
|
833
1122
|
type CustomerListBillableMetricsParams as CustomerListBillableMetricsParams,
|
|
834
1123
|
type CustomerListCostsParams as CustomerListCostsParams,
|
|
835
1124
|
type CustomerPreviewEventsParams as CustomerPreviewEventsParams,
|
|
1125
|
+
type CustomerRetrieveBillingConfigurationsParams as CustomerRetrieveBillingConfigurationsParams,
|
|
1126
|
+
type CustomerSetBillingConfigurationsParams as CustomerSetBillingConfigurationsParams,
|
|
836
1127
|
type CustomerSetIngestAliasesParams as CustomerSetIngestAliasesParams,
|
|
837
1128
|
type CustomerSetNameParams as CustomerSetNameParams,
|
|
838
1129
|
type CustomerUpdateConfigParams as CustomerUpdateConfigParams,
|
|
@@ -842,7 +1133,7 @@ export declare namespace Customers {
|
|
|
842
1133
|
Alerts as Alerts,
|
|
843
1134
|
type CustomerAlert as CustomerAlert,
|
|
844
1135
|
type AlertRetrieveResponse as AlertRetrieveResponse,
|
|
845
|
-
type
|
|
1136
|
+
type CustomerAlertsCursorPageWithoutLimit as CustomerAlertsCursorPageWithoutLimit,
|
|
846
1137
|
type AlertRetrieveParams as AlertRetrieveParams,
|
|
847
1138
|
type AlertListParams as AlertListParams,
|
|
848
1139
|
type AlertResetParams as AlertResetParams,
|
|
@@ -854,8 +1145,8 @@ export declare namespace Customers {
|
|
|
854
1145
|
type PlanAddResponse as PlanAddResponse,
|
|
855
1146
|
type PlanEndResponse as PlanEndResponse,
|
|
856
1147
|
type PlanListPriceAdjustmentsResponse as PlanListPriceAdjustmentsResponse,
|
|
857
|
-
PlanListResponsesCursorPage as PlanListResponsesCursorPage,
|
|
858
|
-
PlanListPriceAdjustmentsResponsesCursorPage as PlanListPriceAdjustmentsResponsesCursorPage,
|
|
1148
|
+
type PlanListResponsesCursorPage as PlanListResponsesCursorPage,
|
|
1149
|
+
type PlanListPriceAdjustmentsResponsesCursorPage as PlanListPriceAdjustmentsResponsesCursorPage,
|
|
859
1150
|
type PlanListParams as PlanListParams,
|
|
860
1151
|
type PlanAddParams as PlanAddParams,
|
|
861
1152
|
type PlanEndParams as PlanEndParams,
|
|
@@ -868,8 +1159,8 @@ export declare namespace Customers {
|
|
|
868
1159
|
type InvoiceRetrieveResponse as InvoiceRetrieveResponse,
|
|
869
1160
|
type InvoiceAddChargeResponse as InvoiceAddChargeResponse,
|
|
870
1161
|
type InvoiceListBreakdownsResponse as InvoiceListBreakdownsResponse,
|
|
871
|
-
InvoicesCursorPage as InvoicesCursorPage,
|
|
872
|
-
InvoiceListBreakdownsResponsesCursorPage as InvoiceListBreakdownsResponsesCursorPage,
|
|
1162
|
+
type InvoicesCursorPage as InvoicesCursorPage,
|
|
1163
|
+
type InvoiceListBreakdownsResponsesCursorPage as InvoiceListBreakdownsResponsesCursorPage,
|
|
873
1164
|
type InvoiceRetrieveParams as InvoiceRetrieveParams,
|
|
874
1165
|
type InvoiceListParams as InvoiceListParams,
|
|
875
1166
|
type InvoiceAddChargeParams as InvoiceAddChargeParams,
|
|
@@ -887,7 +1178,6 @@ export declare namespace Customers {
|
|
|
887
1178
|
export {
|
|
888
1179
|
Commits as Commits,
|
|
889
1180
|
type CommitCreateResponse as CommitCreateResponse,
|
|
890
|
-
type CommitListResponse as CommitListResponse,
|
|
891
1181
|
type CommitUpdateEndDateResponse as CommitUpdateEndDateResponse,
|
|
892
1182
|
type CommitCreateParams as CommitCreateParams,
|
|
893
1183
|
type CommitListParams as CommitListParams,
|
|
@@ -897,7 +1187,6 @@ export declare namespace Customers {
|
|
|
897
1187
|
export {
|
|
898
1188
|
Credits as Credits,
|
|
899
1189
|
type CreditCreateResponse as CreditCreateResponse,
|
|
900
|
-
type CreditListResponse as CreditListResponse,
|
|
901
1190
|
type CreditUpdateEndDateResponse as CreditUpdateEndDateResponse,
|
|
902
1191
|
type CreditCreateParams as CreditCreateParams,
|
|
903
1192
|
type CreditListParams as CreditListParams,
|