@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,8 +1,9 @@
|
|
|
1
|
-
import { APIResource } from "../../resource.js";
|
|
2
|
-
import * as Core from "../../core.js";
|
|
1
|
+
import { APIResource } from "../../core/resource.js";
|
|
3
2
|
import * as CreditGrantsAPI from "./credit-grants.js";
|
|
4
3
|
import * as Shared from "../shared.js";
|
|
5
|
-
import {
|
|
4
|
+
import { APIPromise } from "../../core/api-promise.js";
|
|
5
|
+
import { CursorPage, type CursorPageParams, CursorPageWithoutLimit, type CursorPageWithoutLimitParams, PagePromise } from "../../core/pagination.js";
|
|
6
|
+
import { RequestOptions } from "../../internal/request-options.js";
|
|
6
7
|
export declare class CreditGrants extends APIResource {
|
|
7
8
|
/**
|
|
8
9
|
* Create a new credit grant
|
|
@@ -28,7 +29,7 @@ export declare class CreditGrants extends APIResource {
|
|
|
28
29
|
* });
|
|
29
30
|
* ```
|
|
30
31
|
*/
|
|
31
|
-
create(body: CreditGrantCreateParams, options?:
|
|
32
|
+
create(body: CreditGrantCreateParams, options?: RequestOptions): APIPromise<CreditGrantCreateResponse>;
|
|
32
33
|
/**
|
|
33
34
|
* List credit grants. This list does not included voided grants.
|
|
34
35
|
*
|
|
@@ -52,8 +53,7 @@ export declare class CreditGrants extends APIResource {
|
|
|
52
53
|
* }
|
|
53
54
|
* ```
|
|
54
55
|
*/
|
|
55
|
-
list(params?: CreditGrantListParams, options?:
|
|
56
|
-
list(options?: Core.RequestOptions): Core.PagePromise<CreditGrantListResponsesCursorPage, CreditGrantListResponse>;
|
|
56
|
+
list(params?: CreditGrantListParams | null | undefined, options?: RequestOptions): PagePromise<CreditGrantListResponsesCursorPage, CreditGrantListResponse>;
|
|
57
57
|
/**
|
|
58
58
|
* Edit an existing credit grant
|
|
59
59
|
*
|
|
@@ -66,7 +66,7 @@ export declare class CreditGrants extends APIResource {
|
|
|
66
66
|
* });
|
|
67
67
|
* ```
|
|
68
68
|
*/
|
|
69
|
-
edit(body: CreditGrantEditParams, options?:
|
|
69
|
+
edit(body: CreditGrantEditParams, options?: RequestOptions): APIPromise<CreditGrantEditResponse>;
|
|
70
70
|
/**
|
|
71
71
|
* Fetches a list of credit ledger entries. Returns lists of ledgers per customer.
|
|
72
72
|
* Ledger entries are returned in chronological order. Ledger entries associated
|
|
@@ -74,16 +74,22 @@ export declare class CreditGrants extends APIResource {
|
|
|
74
74
|
*
|
|
75
75
|
* @example
|
|
76
76
|
* ```ts
|
|
77
|
-
*
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
*
|
|
81
|
-
*
|
|
82
|
-
*
|
|
77
|
+
* // Automatically fetches more pages as needed.
|
|
78
|
+
* for await (const creditGrantListEntriesResponse of client.v1.creditGrants.listEntries(
|
|
79
|
+
* {
|
|
80
|
+
* credit_type_ids: [
|
|
81
|
+
* '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
|
|
82
|
+
* ],
|
|
83
|
+
* customer_ids: ['6a37bb88-8538-48c5-b37b-a41c836328bd'],
|
|
84
|
+
* ending_before: '2021-02-01T00:00:00Z',
|
|
85
|
+
* starting_on: '2021-01-01T00:00:00Z',
|
|
86
|
+
* },
|
|
87
|
+
* )) {
|
|
88
|
+
* // ...
|
|
89
|
+
* }
|
|
83
90
|
* ```
|
|
84
91
|
*/
|
|
85
|
-
listEntries(params?: CreditGrantListEntriesParams, options?:
|
|
86
|
-
listEntries(options?: Core.RequestOptions): Core.APIPromise<CreditGrantListEntriesResponse>;
|
|
92
|
+
listEntries(params?: CreditGrantListEntriesParams | null | undefined, options?: RequestOptions): PagePromise<CreditGrantListEntriesResponsesCursorPageWithoutLimit, CreditGrantListEntriesResponse>;
|
|
87
93
|
/**
|
|
88
94
|
* Void a credit grant
|
|
89
95
|
*
|
|
@@ -94,10 +100,10 @@ export declare class CreditGrants extends APIResource {
|
|
|
94
100
|
* });
|
|
95
101
|
* ```
|
|
96
102
|
*/
|
|
97
|
-
void(body: CreditGrantVoidParams, options?:
|
|
98
|
-
}
|
|
99
|
-
export declare class CreditGrantListResponsesCursorPage extends CursorPage<CreditGrantListResponse> {
|
|
103
|
+
void(body: CreditGrantVoidParams, options?: RequestOptions): APIPromise<CreditGrantVoidResponse>;
|
|
100
104
|
}
|
|
105
|
+
export type CreditGrantListResponsesCursorPage = CursorPage<CreditGrantListResponse>;
|
|
106
|
+
export type CreditGrantListEntriesResponsesCursorPageWithoutLimit = CursorPageWithoutLimit<CreditGrantListEntriesResponse>;
|
|
101
107
|
export interface CreditLedgerEntry {
|
|
102
108
|
/**
|
|
103
109
|
* an amount representing the change to the customer's credit balance
|
|
@@ -156,6 +162,9 @@ export interface CreditGrantListResponse {
|
|
|
156
162
|
* before the end of the current billing period.
|
|
157
163
|
*/
|
|
158
164
|
balance: CreditGrantListResponse.Balance;
|
|
165
|
+
/**
|
|
166
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
167
|
+
*/
|
|
159
168
|
custom_fields: {
|
|
160
169
|
[key: string]: string;
|
|
161
170
|
};
|
|
@@ -248,64 +257,58 @@ export interface CreditGrantEditResponse {
|
|
|
248
257
|
data: Shared.ID;
|
|
249
258
|
}
|
|
250
259
|
export interface CreditGrantListEntriesResponse {
|
|
251
|
-
|
|
252
|
-
|
|
260
|
+
customer_id: string;
|
|
261
|
+
ledgers: Array<CreditGrantListEntriesResponse.Ledger>;
|
|
253
262
|
}
|
|
254
263
|
export declare namespace CreditGrantListEntriesResponse {
|
|
255
|
-
interface
|
|
256
|
-
|
|
257
|
-
|
|
264
|
+
interface Ledger {
|
|
265
|
+
credit_type: Shared.CreditTypeData;
|
|
266
|
+
/**
|
|
267
|
+
* the effective balances at the end of the specified time window
|
|
268
|
+
*/
|
|
269
|
+
ending_balance: Ledger.EndingBalance;
|
|
270
|
+
entries: Array<CreditGrantsAPI.CreditLedgerEntry>;
|
|
271
|
+
pending_entries: Array<CreditGrantsAPI.CreditLedgerEntry>;
|
|
272
|
+
starting_balance: Ledger.StartingBalance;
|
|
258
273
|
}
|
|
259
|
-
namespace
|
|
260
|
-
|
|
261
|
-
|
|
274
|
+
namespace Ledger {
|
|
275
|
+
/**
|
|
276
|
+
* the effective balances at the end of the specified time window
|
|
277
|
+
*/
|
|
278
|
+
interface EndingBalance {
|
|
279
|
+
/**
|
|
280
|
+
* the ending_before request parameter (if supplied) or the current billing
|
|
281
|
+
* period's end date
|
|
282
|
+
*/
|
|
283
|
+
effective_at: string;
|
|
284
|
+
/**
|
|
285
|
+
* the ending balance, including the balance of all grants that have not expired
|
|
286
|
+
* before the effective_at date and deductions that happened before the
|
|
287
|
+
* effective_at date
|
|
288
|
+
*/
|
|
289
|
+
excluding_pending: number;
|
|
262
290
|
/**
|
|
263
|
-
* the
|
|
291
|
+
* the excluding_pending balance plus any pending invoice deductions and
|
|
292
|
+
* expirations that will happen by the effective_at date
|
|
264
293
|
*/
|
|
265
|
-
|
|
266
|
-
entries: Array<CreditGrantsAPI.CreditLedgerEntry>;
|
|
267
|
-
pending_entries: Array<CreditGrantsAPI.CreditLedgerEntry>;
|
|
268
|
-
starting_balance: Ledger.StartingBalance;
|
|
294
|
+
including_pending: number;
|
|
269
295
|
}
|
|
270
|
-
|
|
296
|
+
interface StartingBalance {
|
|
297
|
+
/**
|
|
298
|
+
* the starting_on request parameter (if supplied) or the first credit grant's
|
|
299
|
+
* effective_at date
|
|
300
|
+
*/
|
|
301
|
+
effective_at: string;
|
|
271
302
|
/**
|
|
272
|
-
* the
|
|
303
|
+
* the starting balance, including all posted grants, deductions, and expirations
|
|
304
|
+
* that happened at or before the effective_at timestamp
|
|
273
305
|
*/
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
/**
|
|
281
|
-
* the ending balance, including the balance of all grants that have not expired
|
|
282
|
-
* before the effective_at date and deductions that happened before the
|
|
283
|
-
* effective_at date
|
|
284
|
-
*/
|
|
285
|
-
excluding_pending: number;
|
|
286
|
-
/**
|
|
287
|
-
* the excluding_pending balance plus any pending invoice deductions and
|
|
288
|
-
* expirations that will happen by the effective_at date
|
|
289
|
-
*/
|
|
290
|
-
including_pending: number;
|
|
291
|
-
}
|
|
292
|
-
interface StartingBalance {
|
|
293
|
-
/**
|
|
294
|
-
* the starting_on request parameter (if supplied) or the first credit grant's
|
|
295
|
-
* effective_at date
|
|
296
|
-
*/
|
|
297
|
-
effective_at: string;
|
|
298
|
-
/**
|
|
299
|
-
* the starting balance, including all posted grants, deductions, and expirations
|
|
300
|
-
* that happened at or before the effective_at timestamp
|
|
301
|
-
*/
|
|
302
|
-
excluding_pending: number;
|
|
303
|
-
/**
|
|
304
|
-
* the excluding_pending balance plus any pending activity that has not been posted
|
|
305
|
-
* at the time of the query
|
|
306
|
-
*/
|
|
307
|
-
including_pending: number;
|
|
308
|
-
}
|
|
306
|
+
excluding_pending: number;
|
|
307
|
+
/**
|
|
308
|
+
* the excluding_pending balance plus any pending activity that has not been posted
|
|
309
|
+
* at the time of the query
|
|
310
|
+
*/
|
|
311
|
+
including_pending: number;
|
|
309
312
|
}
|
|
310
313
|
}
|
|
311
314
|
}
|
|
@@ -457,11 +460,7 @@ export interface CreditGrantEditParams {
|
|
|
457
460
|
*/
|
|
458
461
|
name?: string;
|
|
459
462
|
}
|
|
460
|
-
export interface CreditGrantListEntriesParams {
|
|
461
|
-
/**
|
|
462
|
-
* Query param: Cursor that indicates where the next page of results should start.
|
|
463
|
-
*/
|
|
464
|
-
next_page?: string;
|
|
463
|
+
export interface CreditGrantListEntriesParams extends CursorPageWithoutLimitParams {
|
|
465
464
|
/**
|
|
466
465
|
* Query param: Ledgers sort order by date, asc or desc. Defaults to asc.
|
|
467
466
|
*/
|
|
@@ -501,6 +500,6 @@ export interface CreditGrantVoidParams {
|
|
|
501
500
|
void_credit_purchase_invoice?: boolean;
|
|
502
501
|
}
|
|
503
502
|
export declare namespace CreditGrants {
|
|
504
|
-
export { type CreditLedgerEntry as CreditLedgerEntry, type RolloverAmountMaxAmount as RolloverAmountMaxAmount, type RolloverAmountMaxPercentage as RolloverAmountMaxPercentage, type CreditGrantCreateResponse as CreditGrantCreateResponse, type CreditGrantListResponse as CreditGrantListResponse, type CreditGrantEditResponse as CreditGrantEditResponse, type CreditGrantListEntriesResponse as CreditGrantListEntriesResponse, type CreditGrantVoidResponse as CreditGrantVoidResponse, CreditGrantListResponsesCursorPage as CreditGrantListResponsesCursorPage, type CreditGrantCreateParams as CreditGrantCreateParams, type CreditGrantListParams as CreditGrantListParams, type CreditGrantEditParams as CreditGrantEditParams, type CreditGrantListEntriesParams as CreditGrantListEntriesParams, type CreditGrantVoidParams as CreditGrantVoidParams, };
|
|
503
|
+
export { type CreditLedgerEntry as CreditLedgerEntry, type RolloverAmountMaxAmount as RolloverAmountMaxAmount, type RolloverAmountMaxPercentage as RolloverAmountMaxPercentage, type CreditGrantCreateResponse as CreditGrantCreateResponse, type CreditGrantListResponse as CreditGrantListResponse, type CreditGrantEditResponse as CreditGrantEditResponse, type CreditGrantListEntriesResponse as CreditGrantListEntriesResponse, type CreditGrantVoidResponse as CreditGrantVoidResponse, type CreditGrantListResponsesCursorPage as CreditGrantListResponsesCursorPage, type CreditGrantListEntriesResponsesCursorPageWithoutLimit as CreditGrantListEntriesResponsesCursorPageWithoutLimit, type CreditGrantCreateParams as CreditGrantCreateParams, type CreditGrantListParams as CreditGrantListParams, type CreditGrantEditParams as CreditGrantEditParams, type CreditGrantListEntriesParams as CreditGrantListEntriesParams, type CreditGrantVoidParams as CreditGrantVoidParams, };
|
|
505
504
|
}
|
|
506
505
|
//# sourceMappingURL=credit-grants.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"credit-grants.d.ts","sourceRoot":"","sources":["../../src/resources/v1/credit-grants.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"credit-grants.d.ts","sourceRoot":"","sources":["../../src/resources/v1/credit-grants.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,eAAe;OACpB,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EACL,UAAU,EACV,KAAK,gBAAgB,EACrB,sBAAsB,EACtB,KAAK,4BAA4B,EACjC,WAAW,EACZ;OACM,EAAE,cAAc,EAAE;AAEzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAItG;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,IAAI,CACF,MAAM,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kCAAkC,EAAE,uBAAuB,CAAC;IAU3E;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIhG;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,WAAW,CACT,MAAM,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qDAAqD,EAAE,8BAA8B,CAAC;IASrG;;;;;;;;;OASG;IACH,IAAI,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAGjG;AAED,MAAM,MAAM,kCAAkC,GAAG,UAAU,CAAC,uBAAuB,CAAC,CAAC;AAErF,MAAM,MAAM,qDAAqD,GAC/D,sBAAsB,CAAC,8BAA8B,CAAC,CAAC;AAEzD,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB,YAAY,EAAE,MAAM,CAAC;IAErB,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,YAAY,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,IAAI,EAAE,gBAAgB,CAAC;IAEvB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,OAAO,EAAE,uBAAuB,CAAC,OAAO,CAAC;IAEzC;;OAEG;IACH,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEzC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAErC,YAAY,EAAE,MAAM,CAAC;IAErB,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,uBAAuB,CAAC,WAAW,CAAC;IAElD,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,uBAAuB,CAAC,UAAU,CAAC;IAEhD,kBAAkB,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAE7C,QAAQ,EAAE,MAAM,CAAC;IAEjB,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAElD,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;;;OAIG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;;;WAIG;QACH,iBAAiB,EAAE,MAAM,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,WAAW;QAC1B,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;KACpC;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;KACpC;IAED,UAAiB,OAAO;QACtB,EAAE,EAAE,MAAM,CAAC;QAEX,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,8BAA8B;IAC7C,WAAW,EAAE,MAAM,CAAC;IAEpB,OAAO,EAAE,KAAK,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC;CACvD;AAED,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,MAAM;QACrB,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;QAEnC;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC,aAAa,CAAC;QAErC,OAAO,EAAE,KAAK,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC;QAElD,eAAe,EAAE,KAAK,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC;QAE1D,gBAAgB,EAAE,MAAM,CAAC,eAAe,CAAC;KAC1C;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,aAAa;YAC5B;;;eAGG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;;;eAIG;YACH,iBAAiB,EAAE,MAAM,CAAC;YAE1B;;;eAGG;YACH,iBAAiB,EAAE,MAAM,CAAC;SAC3B;QAED,UAAiB,eAAe;YAC9B;;;eAGG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;;eAGG;YACH,iBAAiB,EAAE,MAAM,CAAC;YAE1B;;;eAGG;YACH,iBAAiB,EAAE,MAAM,CAAC;SAC3B;KACF;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,uBAAuB,CAAC,WAAW,CAAC;IAElD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,uBAAuB,CAAC,UAAU,CAAC;IAEhD,QAAQ,EAAE,MAAM,CAAC;IAEjB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAE1C;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,uBAAuB,CAAC,gBAAgB,CAAC;IAE7D;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,WAAW;QAC1B,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;KACxB;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;KACxB;IAED;;;;OAIG;IACH,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,eAAe,EAAE,eAAe,CAAC,2BAA2B,GAAG,eAAe,CAAC,uBAAuB,CAAC;KACxG;CACF;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D;;;OAGG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEjC;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhC;;;OAGG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,4BAA6B,SAAQ,4BAA4B;IAChF;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAEtB;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhC;;;OAGG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;CACxC;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,qDAAqD,IAAI,qDAAqD,EACnH,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
|
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
exports.
|
|
5
|
-
const resource_1 = require("../../resource.js");
|
|
6
|
-
const
|
|
7
|
-
const pagination_1 = require("../../pagination.js");
|
|
4
|
+
exports.CreditGrants = void 0;
|
|
5
|
+
const resource_1 = require("../../core/resource.js");
|
|
6
|
+
const pagination_1 = require("../../core/pagination.js");
|
|
8
7
|
class CreditGrants extends resource_1.APIResource {
|
|
9
8
|
/**
|
|
10
9
|
* Create a new credit grant
|
|
@@ -33,12 +32,32 @@ class CreditGrants extends resource_1.APIResource {
|
|
|
33
32
|
create(body, options) {
|
|
34
33
|
return this._client.post('/v1/credits/createGrant', { body, ...options });
|
|
35
34
|
}
|
|
35
|
+
/**
|
|
36
|
+
* List credit grants. This list does not included voided grants.
|
|
37
|
+
*
|
|
38
|
+
* @example
|
|
39
|
+
* ```ts
|
|
40
|
+
* // Automatically fetches more pages as needed.
|
|
41
|
+
* for await (const creditGrantListResponse of client.v1.creditGrants.list(
|
|
42
|
+
* {
|
|
43
|
+
* credit_type_ids: [
|
|
44
|
+
* '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
|
|
45
|
+
* ],
|
|
46
|
+
* customer_ids: [
|
|
47
|
+
* 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
|
|
48
|
+
* '0e5b8609-d901-4992-b394-c3c2e3f37b1c',
|
|
49
|
+
* ],
|
|
50
|
+
* effective_before: '2022-02-01T00:00:00Z',
|
|
51
|
+
* not_expiring_before: '2022-02-01T00:00:00Z',
|
|
52
|
+
* },
|
|
53
|
+
* )) {
|
|
54
|
+
* // ...
|
|
55
|
+
* }
|
|
56
|
+
* ```
|
|
57
|
+
*/
|
|
36
58
|
list(params = {}, options) {
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
}
|
|
40
|
-
const { limit, next_page, ...body } = params;
|
|
41
|
-
return this._client.getAPIList('/v1/credits/listGrants', CreditGrantListResponsesCursorPage, {
|
|
59
|
+
const { limit, next_page, ...body } = params ?? {};
|
|
60
|
+
return this._client.getAPIList('/v1/credits/listGrants', (pagination_1.CursorPage), {
|
|
42
61
|
query: { limit, next_page },
|
|
43
62
|
body,
|
|
44
63
|
method: 'post',
|
|
@@ -60,12 +79,31 @@ class CreditGrants extends resource_1.APIResource {
|
|
|
60
79
|
edit(body, options) {
|
|
61
80
|
return this._client.post('/v1/credits/editGrant', { body, ...options });
|
|
62
81
|
}
|
|
82
|
+
/**
|
|
83
|
+
* Fetches a list of credit ledger entries. Returns lists of ledgers per customer.
|
|
84
|
+
* Ledger entries are returned in chronological order. Ledger entries associated
|
|
85
|
+
* with voided credit grants are not included.
|
|
86
|
+
*
|
|
87
|
+
* @example
|
|
88
|
+
* ```ts
|
|
89
|
+
* // Automatically fetches more pages as needed.
|
|
90
|
+
* for await (const creditGrantListEntriesResponse of client.v1.creditGrants.listEntries(
|
|
91
|
+
* {
|
|
92
|
+
* credit_type_ids: [
|
|
93
|
+
* '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
|
|
94
|
+
* ],
|
|
95
|
+
* customer_ids: ['6a37bb88-8538-48c5-b37b-a41c836328bd'],
|
|
96
|
+
* ending_before: '2021-02-01T00:00:00Z',
|
|
97
|
+
* starting_on: '2021-01-01T00:00:00Z',
|
|
98
|
+
* },
|
|
99
|
+
* )) {
|
|
100
|
+
* // ...
|
|
101
|
+
* }
|
|
102
|
+
* ```
|
|
103
|
+
*/
|
|
63
104
|
listEntries(params = {}, options) {
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
}
|
|
67
|
-
const { next_page, sort, ...body } = params;
|
|
68
|
-
return this._client.post('/v1/credits/listEntries', { query: { next_page, sort }, body, ...options });
|
|
105
|
+
const { next_page, sort, ...body } = params ?? {};
|
|
106
|
+
return this._client.getAPIList('/v1/credits/listEntries', (pagination_1.CursorPageWithoutLimit), { query: { next_page, sort }, body, method: 'post', ...options });
|
|
69
107
|
}
|
|
70
108
|
/**
|
|
71
109
|
* Void a credit grant
|
|
@@ -82,8 +120,4 @@ class CreditGrants extends resource_1.APIResource {
|
|
|
82
120
|
}
|
|
83
121
|
}
|
|
84
122
|
exports.CreditGrants = CreditGrants;
|
|
85
|
-
class CreditGrantListResponsesCursorPage extends pagination_1.CursorPage {
|
|
86
|
-
}
|
|
87
|
-
exports.CreditGrantListResponsesCursorPage = CreditGrantListResponsesCursorPage;
|
|
88
|
-
CreditGrants.CreditGrantListResponsesCursorPage = CreditGrantListResponsesCursorPage;
|
|
89
123
|
//# sourceMappingURL=credit-grants.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"credit-grants.js","sourceRoot":"","sources":["../../src/resources/v1/credit-grants.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,
|
|
1
|
+
{"version":3,"file":"credit-grants.js","sourceRoot":"","sources":["../../src/resources/v1/credit-grants.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,yDAM+B;AAG/B,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CAAC,IAA6B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,IAAI,CACF,SAAmD,EAAE,EACrD,OAAwB;QAExB,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,wBAAwB,EAAE,CAAA,uBAAmC,CAAA,EAAE;YAC5F,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;YAC3B,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,IAA2B,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,WAAW,CACT,SAA0D,EAAE,EAC5D,OAAwB;QAExB,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,yBAAyB,EACzB,CAAA,mCAAsD,CAAA,EACtD,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,CACjE,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,IAA2B,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;CACF;AAhID,oCAgIC"}
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
-
import { APIResource } from "../../resource.mjs";
|
|
3
|
-
import {
|
|
4
|
-
import { CursorPage } from "../../pagination.mjs";
|
|
2
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
3
|
+
import { CursorPage, CursorPageWithoutLimit, } from "../../core/pagination.mjs";
|
|
5
4
|
export class CreditGrants extends APIResource {
|
|
6
5
|
/**
|
|
7
6
|
* Create a new credit grant
|
|
@@ -30,12 +29,32 @@ export class CreditGrants extends APIResource {
|
|
|
30
29
|
create(body, options) {
|
|
31
30
|
return this._client.post('/v1/credits/createGrant', { body, ...options });
|
|
32
31
|
}
|
|
32
|
+
/**
|
|
33
|
+
* List credit grants. This list does not included voided grants.
|
|
34
|
+
*
|
|
35
|
+
* @example
|
|
36
|
+
* ```ts
|
|
37
|
+
* // Automatically fetches more pages as needed.
|
|
38
|
+
* for await (const creditGrantListResponse of client.v1.creditGrants.list(
|
|
39
|
+
* {
|
|
40
|
+
* credit_type_ids: [
|
|
41
|
+
* '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
|
|
42
|
+
* ],
|
|
43
|
+
* customer_ids: [
|
|
44
|
+
* 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
|
|
45
|
+
* '0e5b8609-d901-4992-b394-c3c2e3f37b1c',
|
|
46
|
+
* ],
|
|
47
|
+
* effective_before: '2022-02-01T00:00:00Z',
|
|
48
|
+
* not_expiring_before: '2022-02-01T00:00:00Z',
|
|
49
|
+
* },
|
|
50
|
+
* )) {
|
|
51
|
+
* // ...
|
|
52
|
+
* }
|
|
53
|
+
* ```
|
|
54
|
+
*/
|
|
33
55
|
list(params = {}, options) {
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
}
|
|
37
|
-
const { limit, next_page, ...body } = params;
|
|
38
|
-
return this._client.getAPIList('/v1/credits/listGrants', CreditGrantListResponsesCursorPage, {
|
|
56
|
+
const { limit, next_page, ...body } = params ?? {};
|
|
57
|
+
return this._client.getAPIList('/v1/credits/listGrants', (CursorPage), {
|
|
39
58
|
query: { limit, next_page },
|
|
40
59
|
body,
|
|
41
60
|
method: 'post',
|
|
@@ -57,12 +76,31 @@ export class CreditGrants extends APIResource {
|
|
|
57
76
|
edit(body, options) {
|
|
58
77
|
return this._client.post('/v1/credits/editGrant', { body, ...options });
|
|
59
78
|
}
|
|
79
|
+
/**
|
|
80
|
+
* Fetches a list of credit ledger entries. Returns lists of ledgers per customer.
|
|
81
|
+
* Ledger entries are returned in chronological order. Ledger entries associated
|
|
82
|
+
* with voided credit grants are not included.
|
|
83
|
+
*
|
|
84
|
+
* @example
|
|
85
|
+
* ```ts
|
|
86
|
+
* // Automatically fetches more pages as needed.
|
|
87
|
+
* for await (const creditGrantListEntriesResponse of client.v1.creditGrants.listEntries(
|
|
88
|
+
* {
|
|
89
|
+
* credit_type_ids: [
|
|
90
|
+
* '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
|
|
91
|
+
* ],
|
|
92
|
+
* customer_ids: ['6a37bb88-8538-48c5-b37b-a41c836328bd'],
|
|
93
|
+
* ending_before: '2021-02-01T00:00:00Z',
|
|
94
|
+
* starting_on: '2021-01-01T00:00:00Z',
|
|
95
|
+
* },
|
|
96
|
+
* )) {
|
|
97
|
+
* // ...
|
|
98
|
+
* }
|
|
99
|
+
* ```
|
|
100
|
+
*/
|
|
60
101
|
listEntries(params = {}, options) {
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
}
|
|
64
|
-
const { next_page, sort, ...body } = params;
|
|
65
|
-
return this._client.post('/v1/credits/listEntries', { query: { next_page, sort }, body, ...options });
|
|
102
|
+
const { next_page, sort, ...body } = params ?? {};
|
|
103
|
+
return this._client.getAPIList('/v1/credits/listEntries', (CursorPageWithoutLimit), { query: { next_page, sort }, body, method: 'post', ...options });
|
|
66
104
|
}
|
|
67
105
|
/**
|
|
68
106
|
* Void a credit grant
|
|
@@ -78,7 +116,4 @@ export class CreditGrants extends APIResource {
|
|
|
78
116
|
return this._client.post('/v1/credits/voidGrant', { body, ...options });
|
|
79
117
|
}
|
|
80
118
|
}
|
|
81
|
-
export class CreditGrantListResponsesCursorPage extends CursorPage {
|
|
82
|
-
}
|
|
83
|
-
CreditGrants.CreditGrantListResponsesCursorPage = CreditGrantListResponsesCursorPage;
|
|
84
119
|
//# sourceMappingURL=credit-grants.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"credit-grants.mjs","sourceRoot":"","sources":["../../src/resources/v1/credit-grants.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;
|
|
1
|
+
{"version":3,"file":"credit-grants.mjs","sourceRoot":"","sources":["../../src/resources/v1/credit-grants.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EACL,UAAU,EAEV,sBAAsB,GAGvB;AAGD,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CAAC,IAA6B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,IAAI,CACF,SAAmD,EAAE,EACrD,OAAwB;QAExB,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,wBAAwB,EAAE,CAAA,UAAmC,CAAA,EAAE;YAC5F,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;YAC3B,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,IAA2B,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,WAAW,CACT,SAA0D,EAAE,EAC5D,OAAwB;QAExB,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,yBAAyB,EACzB,CAAA,sBAAsD,CAAA,EACtD,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,CACjE,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,IAA2B,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;CACF"}
|
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../../core/api-promise.mjs";
|
|
3
|
+
import { CursorPageWithoutLimit, type CursorPageWithoutLimitParams, PagePromise } from "../../core/pagination.mjs";
|
|
4
|
+
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
5
|
+
export declare class CustomFields extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Creates a new custom field key for a given entity (e.g. billable metric,
|
|
8
|
+
* contract, alert).
|
|
9
|
+
*
|
|
10
|
+
* Custom fields are properties that you can add to Metronome objects to store
|
|
11
|
+
* metadata like foreign keys or other descriptors. This metadata can get
|
|
12
|
+
* transferred to or accessed by other systems to contextualize Metronome data and
|
|
13
|
+
* power business processes. For example, to service workflows like revenue
|
|
14
|
+
* recognition, reconciliation, and invoicing, custom fields help Metronome know
|
|
15
|
+
* the relationship between entities in the platform and third-party systems.
|
|
16
|
+
*
|
|
17
|
+
* ### Use this endpoint to:
|
|
18
|
+
*
|
|
19
|
+
* - Create a new custom field key for Customer objects in Metronome. You can then
|
|
20
|
+
* use the Set Custom Field Values endpoint to set the value of this key for a
|
|
21
|
+
* specific customer.
|
|
22
|
+
* - Specify whether the key should enforce uniqueness. If the key is set to
|
|
23
|
+
* enforce uniqueness and you attempt to set a custom field value for the key
|
|
24
|
+
* that already exists, it will fail.
|
|
25
|
+
*
|
|
26
|
+
* ### Usage guidelines:
|
|
27
|
+
*
|
|
28
|
+
* - Custom fields set on commits, credits, and contracts can be used to scope
|
|
29
|
+
* alert evaluation. For example, you can create a spend threshold alert that
|
|
30
|
+
* only considers spend associated with contracts with custom field key
|
|
31
|
+
* `contract_type` and value `paygo`
|
|
32
|
+
* - Custom fields set on products can be used in the Stripe integration to set
|
|
33
|
+
* metadata on invoices.
|
|
34
|
+
* - Custom fields for customers, contracts, invoices, products, commits, scheduled
|
|
35
|
+
* charges, and subscriptions are passed down to the invoice.
|
|
36
|
+
*
|
|
37
|
+
* @example
|
|
38
|
+
* ```ts
|
|
39
|
+
* await client.v1.customFields.addKey({
|
|
40
|
+
* enforce_uniqueness: true,
|
|
41
|
+
* entity: 'customer',
|
|
42
|
+
* key: 'x_account_id',
|
|
43
|
+
* });
|
|
44
|
+
* ```
|
|
45
|
+
*/
|
|
46
|
+
addKey(body: CustomFieldAddKeyParams, options?: RequestOptions): APIPromise<void>;
|
|
47
|
+
/**
|
|
48
|
+
* Remove specific custom field values from a Metronome entity instance by
|
|
49
|
+
* specifying the field keys to delete. Use this endpoint to clean up unwanted
|
|
50
|
+
* custom field data while preserving other fields on the same entity. Requires the
|
|
51
|
+
* entity type, entity ID, and array of keys to remove.
|
|
52
|
+
*
|
|
53
|
+
* @example
|
|
54
|
+
* ```ts
|
|
55
|
+
* await client.v1.customFields.deleteValues({
|
|
56
|
+
* entity: 'customer',
|
|
57
|
+
* entity_id: '99594816-e8a5-4bca-be21-8d1de0f45120',
|
|
58
|
+
* keys: ['x_account_id'],
|
|
59
|
+
* });
|
|
60
|
+
* ```
|
|
61
|
+
*/
|
|
62
|
+
deleteValues(body: CustomFieldDeleteValuesParams, options?: RequestOptions): APIPromise<void>;
|
|
63
|
+
/**
|
|
64
|
+
* Retrieve all your active custom field keys, with optional filtering by entity
|
|
65
|
+
* type (customer, contract, product, etc.). Use this endpoint to discover what
|
|
66
|
+
* custom field keys are available before setting values on entities or to audit
|
|
67
|
+
* your custom field configuration across different entity types.
|
|
68
|
+
*
|
|
69
|
+
* @example
|
|
70
|
+
* ```ts
|
|
71
|
+
* // Automatically fetches more pages as needed.
|
|
72
|
+
* for await (const customFieldListKeysResponse of client.v1.customFields.listKeys(
|
|
73
|
+
* { entities: ['customer'] },
|
|
74
|
+
* )) {
|
|
75
|
+
* // ...
|
|
76
|
+
* }
|
|
77
|
+
* ```
|
|
78
|
+
*/
|
|
79
|
+
listKeys(params?: CustomFieldListKeysParams | null | undefined, options?: RequestOptions): PagePromise<CustomFieldListKeysResponsesCursorPageWithoutLimit, CustomFieldListKeysResponse>;
|
|
80
|
+
/**
|
|
81
|
+
* Removes a custom field key from the allowlist for a specific entity type,
|
|
82
|
+
* preventing future use of that key across all instances of the entity. Existing
|
|
83
|
+
* values for this key on entity instances will no longer be accessible once the
|
|
84
|
+
* key is removed.
|
|
85
|
+
*
|
|
86
|
+
* @example
|
|
87
|
+
* ```ts
|
|
88
|
+
* await client.v1.customFields.removeKey({
|
|
89
|
+
* entity: 'customer',
|
|
90
|
+
* key: 'x_account_id',
|
|
91
|
+
* });
|
|
92
|
+
* ```
|
|
93
|
+
*/
|
|
94
|
+
removeKey(body: CustomFieldRemoveKeyParams, options?: RequestOptions): APIPromise<void>;
|
|
95
|
+
/**
|
|
96
|
+
* Sets custom field values on a specific Metronome entity instance. Overwrites
|
|
97
|
+
* existing values for matching keys while preserving other fields. All updates are
|
|
98
|
+
* transactional—either all values are set or none are. Custom field values are
|
|
99
|
+
* limited to 200 characters each.
|
|
100
|
+
*
|
|
101
|
+
* @example
|
|
102
|
+
* ```ts
|
|
103
|
+
* await client.v1.customFields.setValues({
|
|
104
|
+
* custom_fields: { x_account_id: 'KyVnHhSBWl7eY2bl' },
|
|
105
|
+
* entity: 'customer',
|
|
106
|
+
* entity_id: '99594816-e8a5-4bca-be21-8d1de0f45120',
|
|
107
|
+
* });
|
|
108
|
+
* ```
|
|
109
|
+
*/
|
|
110
|
+
setValues(body: CustomFieldSetValuesParams, options?: RequestOptions): APIPromise<void>;
|
|
111
|
+
}
|
|
112
|
+
export type CustomFieldListKeysResponsesCursorPageWithoutLimit = CursorPageWithoutLimit<CustomFieldListKeysResponse>;
|
|
113
|
+
export interface CustomFieldListKeysResponse {
|
|
114
|
+
enforce_uniqueness: boolean;
|
|
115
|
+
entity: 'alert' | 'billable_metric' | 'charge' | 'commit' | 'contract_credit' | 'contract_product' | 'contract' | 'credit_grant' | 'customer_plan' | 'customer' | 'discount' | 'invoice' | 'plan' | 'professional_service' | 'product' | 'rate_card' | 'scheduled_charge' | 'subscription';
|
|
116
|
+
key: string;
|
|
117
|
+
}
|
|
118
|
+
export interface CustomFieldAddKeyParams {
|
|
119
|
+
enforce_uniqueness: boolean;
|
|
120
|
+
entity: 'alert' | 'billable_metric' | 'charge' | 'commit' | 'contract_credit' | 'contract_product' | 'contract' | 'credit_grant' | 'customer_plan' | 'customer' | 'discount' | 'invoice' | 'plan' | 'professional_service' | 'product' | 'rate_card' | 'scheduled_charge' | 'subscription';
|
|
121
|
+
key: string;
|
|
122
|
+
}
|
|
123
|
+
export interface CustomFieldDeleteValuesParams {
|
|
124
|
+
entity: 'alert' | 'billable_metric' | 'charge' | 'commit' | 'contract_credit' | 'contract_product' | 'contract' | 'credit_grant' | 'customer_plan' | 'customer' | 'discount' | 'invoice' | 'plan' | 'professional_service' | 'product' | 'rate_card' | 'scheduled_charge' | 'subscription';
|
|
125
|
+
entity_id: string;
|
|
126
|
+
keys: Array<string>;
|
|
127
|
+
}
|
|
128
|
+
export interface CustomFieldListKeysParams extends CursorPageWithoutLimitParams {
|
|
129
|
+
/**
|
|
130
|
+
* Body param: Optional list of entity types to return keys for
|
|
131
|
+
*/
|
|
132
|
+
entities?: Array<'alert' | 'billable_metric' | 'charge' | 'commit' | 'contract_credit' | 'contract_product' | 'contract' | 'credit_grant' | 'customer_plan' | 'customer' | 'discount' | 'invoice' | 'plan' | 'professional_service' | 'product' | 'rate_card' | 'scheduled_charge' | 'subscription'>;
|
|
133
|
+
}
|
|
134
|
+
export interface CustomFieldRemoveKeyParams {
|
|
135
|
+
entity: 'alert' | 'billable_metric' | 'charge' | 'commit' | 'contract_credit' | 'contract_product' | 'contract' | 'credit_grant' | 'customer_plan' | 'customer' | 'discount' | 'invoice' | 'plan' | 'professional_service' | 'product' | 'rate_card' | 'scheduled_charge' | 'subscription';
|
|
136
|
+
key: string;
|
|
137
|
+
}
|
|
138
|
+
export interface CustomFieldSetValuesParams {
|
|
139
|
+
/**
|
|
140
|
+
* Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
|
|
141
|
+
*/
|
|
142
|
+
custom_fields: {
|
|
143
|
+
[key: string]: string;
|
|
144
|
+
};
|
|
145
|
+
entity: 'alert' | 'billable_metric' | 'charge' | 'commit' | 'contract_credit' | 'contract_product' | 'contract' | 'credit_grant' | 'customer_plan' | 'customer' | 'discount' | 'invoice' | 'plan' | 'professional_service' | 'product' | 'rate_card' | 'scheduled_charge' | 'subscription';
|
|
146
|
+
entity_id: string;
|
|
147
|
+
}
|
|
148
|
+
export declare namespace CustomFields {
|
|
149
|
+
export { type CustomFieldListKeysResponse as CustomFieldListKeysResponse, type CustomFieldListKeysResponsesCursorPageWithoutLimit as CustomFieldListKeysResponsesCursorPageWithoutLimit, type CustomFieldAddKeyParams as CustomFieldAddKeyParams, type CustomFieldDeleteValuesParams as CustomFieldDeleteValuesParams, type CustomFieldListKeysParams as CustomFieldListKeysParams, type CustomFieldRemoveKeyParams as CustomFieldRemoveKeyParams, type CustomFieldSetValuesParams as CustomFieldSetValuesParams, };
|
|
150
|
+
}
|
|
151
|
+
//# sourceMappingURL=custom-fields.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"custom-fields.d.mts","sourceRoot":"","sources":["../../src/resources/v1/custom-fields.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EACL,sBAAsB,EACtB,KAAK,4BAA4B,EACjC,WAAW,EACZ;OAEM,EAAE,cAAc,EAAE;AAEzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,MAAM,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQjF;;;;;;;;;;;;;;OAcG;IACH,YAAY,CAAC,IAAI,EAAE,6BAA6B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQ7F;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CACN,MAAM,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kDAAkD,EAAE,2BAA2B,CAAC;IAS/F;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,IAAI,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQvF;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,IAAI,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAOxF;AAED,MAAM,MAAM,kDAAkD,GAC5D,sBAAsB,CAAC,2BAA2B,CAAC,CAAC;AAEtD,MAAM,WAAW,2BAA2B;IAC1C,kBAAkB,EAAE,OAAO,CAAC;IAE5B,MAAM,EACF,OAAO,GACP,iBAAiB,GACjB,QAAQ,GACR,QAAQ,GACR,iBAAiB,GACjB,kBAAkB,GAClB,UAAU,GACV,cAAc,GACd,eAAe,GACf,UAAU,GACV,UAAU,GACV,SAAS,GACT,MAAM,GACN,sBAAsB,GACtB,SAAS,GACT,WAAW,GACX,kBAAkB,GAClB,cAAc,CAAC;IAEnB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,uBAAuB;IACtC,kBAAkB,EAAE,OAAO,CAAC;IAE5B,MAAM,EACF,OAAO,GACP,iBAAiB,GACjB,QAAQ,GACR,QAAQ,GACR,iBAAiB,GACjB,kBAAkB,GAClB,UAAU,GACV,cAAc,GACd,eAAe,GACf,UAAU,GACV,UAAU,GACV,SAAS,GACT,MAAM,GACN,sBAAsB,GACtB,SAAS,GACT,WAAW,GACX,kBAAkB,GAClB,cAAc,CAAC;IAEnB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,6BAA6B;IAC5C,MAAM,EACF,OAAO,GACP,iBAAiB,GACjB,QAAQ,GACR,QAAQ,GACR,iBAAiB,GACjB,kBAAkB,GAClB,UAAU,GACV,cAAc,GACd,eAAe,GACf,UAAU,GACV,UAAU,GACV,SAAS,GACT,MAAM,GACN,sBAAsB,GACtB,SAAS,GACT,WAAW,GACX,kBAAkB,GAClB,cAAc,CAAC;IAEnB,SAAS,EAAE,MAAM,CAAC;IAElB,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACrB;AAED,MAAM,WAAW,yBAA0B,SAAQ,4BAA4B;IAC7E;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CACZ,OAAO,GACP,iBAAiB,GACjB,QAAQ,GACR,QAAQ,GACR,iBAAiB,GACjB,kBAAkB,GAClB,UAAU,GACV,cAAc,GACd,eAAe,GACf,UAAU,GACV,UAAU,GACV,SAAS,GACT,MAAM,GACN,sBAAsB,GACtB,SAAS,GACT,WAAW,GACX,kBAAkB,GAClB,cAAc,CACjB,CAAC;CACH;AAED,MAAM,WAAW,0BAA0B;IACzC,MAAM,EACF,OAAO,GACP,iBAAiB,GACjB,QAAQ,GACR,QAAQ,GACR,iBAAiB,GACjB,kBAAkB,GAClB,UAAU,GACV,cAAc,GACd,eAAe,GACf,UAAU,GACV,UAAU,GACV,SAAS,GACT,MAAM,GACN,sBAAsB,GACtB,SAAS,GACT,WAAW,GACX,kBAAkB,GAClB,cAAc,CAAC;IAEnB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEzC,MAAM,EACF,OAAO,GACP,iBAAiB,GACjB,QAAQ,GACR,QAAQ,GACR,iBAAiB,GACjB,kBAAkB,GAClB,UAAU,GACV,cAAc,GACd,eAAe,GACf,UAAU,GACV,UAAU,GACV,SAAS,GACT,MAAM,GACN,sBAAsB,GACtB,SAAS,GACT,WAAW,GACX,kBAAkB,GAClB,cAAc,CAAC;IAEnB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kDAAkD,IAAI,kDAAkD,EAC7G,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}
|