@metronome/sdk 0.1.0-beta.8 → 0.1.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 +227 -0
- package/README.md +37 -52
- package/_shims/index.d.ts +2 -0
- package/_shims/index.js +5 -1
- package/_shims/index.mjs +5 -1
- package/core.d.ts +19 -5
- package/core.d.ts.map +1 -1
- package/core.js +25 -15
- package/core.js.map +1 -1
- package/core.mjs +26 -16
- package/core.mjs.map +1 -1
- package/index.d.mts +10 -42
- package/index.d.ts +10 -42
- package/index.d.ts.map +1 -1
- package/index.js +14 -55
- package/index.js.map +1 -1
- package/index.mjs +14 -55
- package/index.mjs.map +1 -1
- package/package.json +1 -1
- package/pagination.d.ts +1 -0
- package/pagination.d.ts.map +1 -1
- package/pagination.js +3 -0
- package/pagination.js.map +1 -1
- package/pagination.mjs +3 -0
- package/pagination.mjs.map +1 -1
- package/resource.d.ts +1 -1
- package/resource.d.ts.map +1 -1
- package/resource.js.map +1 -1
- package/resource.mjs.map +1 -1
- package/resources/index.d.ts +2 -13
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +5 -38
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +2 -13
- package/resources/index.mjs.map +1 -1
- package/resources/shared.d.ts +512 -24
- package/resources/shared.d.ts.map +1 -1
- package/resources/{alerts.d.ts → v1/alerts.d.ts} +29 -5
- package/resources/v1/alerts.d.ts.map +1 -0
- package/resources/v1/alerts.js +40 -0
- package/resources/v1/alerts.js.map +1 -0
- package/resources/v1/alerts.mjs +36 -0
- package/resources/v1/alerts.mjs.map +1 -0
- package/resources/{audit-logs.d.ts → v1/audit-logs.d.ts} +11 -3
- package/resources/v1/audit-logs.d.ts.map +1 -0
- package/resources/{audit-logs.js → v1/audit-logs.js} +4 -4
- package/resources/v1/audit-logs.js.map +1 -0
- package/resources/{audit-logs.mjs → v1/audit-logs.mjs} +4 -4
- package/resources/v1/audit-logs.mjs.map +1 -0
- package/resources/{billable-metrics.d.ts → v1/billable-metrics.d.ts} +62 -7
- package/resources/v1/billable-metrics.d.ts.map +1 -0
- package/resources/v1/billable-metrics.js +84 -0
- package/resources/v1/billable-metrics.js.map +1 -0
- package/resources/v1/billable-metrics.mjs +79 -0
- package/resources/v1/billable-metrics.mjs.map +1 -0
- package/resources/{contracts → v1/contracts}/contracts.d.ts +1618 -62
- package/resources/v1/contracts/contracts.d.ts.map +1 -0
- package/resources/v1/contracts/contracts.js +312 -0
- package/resources/v1/contracts/contracts.js.map +1 -0
- package/resources/v1/contracts/contracts.mjs +285 -0
- package/resources/v1/contracts/contracts.mjs.map +1 -0
- package/resources/v1/contracts/index.d.ts +5 -0
- package/resources/v1/contracts/index.d.ts.map +1 -0
- package/resources/v1/contracts/index.js.map +1 -0
- package/resources/v1/contracts/index.mjs.map +1 -0
- package/resources/{contracts → v1/contracts}/named-schedules.d.ts +23 -2
- package/resources/v1/contracts/named-schedules.d.ts.map +1 -0
- package/resources/v1/contracts/named-schedules.js +48 -0
- package/resources/v1/contracts/named-schedules.js.map +1 -0
- package/resources/v1/contracts/named-schedules.mjs +44 -0
- package/resources/v1/contracts/named-schedules.mjs.map +1 -0
- package/resources/{contracts → v1/contracts}/products.d.ts +55 -7
- package/resources/v1/contracts/products.d.ts.map +1 -0
- package/resources/v1/contracts/products.js +84 -0
- package/resources/v1/contracts/products.js.map +1 -0
- package/resources/v1/contracts/products.mjs +79 -0
- package/resources/v1/contracts/products.mjs.map +1 -0
- package/resources/{contracts → v1/contracts}/rate-cards/index.d.ts +1 -1
- package/resources/v1/contracts/rate-cards/index.d.ts.map +1 -0
- package/resources/v1/contracts/rate-cards/index.js.map +1 -0
- package/resources/v1/contracts/rate-cards/index.mjs.map +1 -0
- package/resources/{contracts → v1/contracts}/rate-cards/named-schedules.d.ts +27 -2
- package/resources/v1/contracts/rate-cards/named-schedules.d.ts.map +1 -0
- package/resources/v1/contracts/rate-cards/named-schedules.js +52 -0
- package/resources/v1/contracts/rate-cards/named-schedules.js.map +1 -0
- package/resources/v1/contracts/rate-cards/named-schedules.mjs +48 -0
- package/resources/v1/contracts/rate-cards/named-schedules.mjs.map +1 -0
- package/resources/{contracts → v1/contracts}/rate-cards/product-orders.d.ts +33 -3
- package/resources/v1/contracts/rate-cards/product-orders.d.ts.map +1 -0
- package/resources/v1/contracts/rate-cards/product-orders.js +54 -0
- package/resources/v1/contracts/rate-cards/product-orders.js.map +1 -0
- package/resources/v1/contracts/rate-cards/product-orders.mjs +50 -0
- package/resources/v1/contracts/rate-cards/product-orders.mjs.map +1 -0
- package/resources/{contracts → v1/contracts}/rate-cards/rate-cards.d.ts +118 -14
- package/resources/v1/contracts/rate-cards/rate-cards.d.ts.map +1 -0
- package/resources/{contracts → v1/contracts}/rate-cards/rate-cards.js +83 -12
- package/resources/v1/contracts/rate-cards/rate-cards.js.map +1 -0
- package/resources/v1/contracts/rate-cards/rate-cards.mjs +140 -0
- package/resources/v1/contracts/rate-cards/rate-cards.mjs.map +1 -0
- package/resources/{contracts → v1/contracts}/rate-cards/rates.d.ts +118 -14
- package/resources/v1/contracts/rate-cards/rates.d.ts.map +1 -0
- package/resources/v1/contracts/rate-cards/rates.js +106 -0
- package/resources/v1/contracts/rate-cards/rates.js.map +1 -0
- package/resources/v1/contracts/rate-cards/rates.mjs +101 -0
- package/resources/v1/contracts/rate-cards/rates.mjs.map +1 -0
- package/resources/v1/contracts/rate-cards.d.ts +2 -0
- package/resources/v1/contracts/rate-cards.d.ts.map +1 -0
- package/resources/v1/contracts/rate-cards.js +19 -0
- package/resources/v1/contracts/rate-cards.js.map +1 -0
- package/resources/v1/contracts/rate-cards.mjs +3 -0
- package/resources/v1/contracts/rate-cards.mjs.map +1 -0
- package/resources/v1/contracts.d.ts +2 -0
- package/resources/v1/contracts.d.ts.map +1 -0
- package/resources/v1/contracts.js +19 -0
- package/resources/v1/contracts.js.map +1 -0
- package/resources/v1/contracts.mjs +3 -0
- package/resources/v1/contracts.mjs.map +1 -0
- package/resources/{credit-grants.d.ts → v1/credit-grants.d.ts} +81 -6
- package/resources/v1/credit-grants.d.ts.map +1 -0
- package/resources/v1/credit-grants.js +89 -0
- package/resources/v1/credit-grants.js.map +1 -0
- package/resources/v1/credit-grants.mjs +84 -0
- package/resources/v1/credit-grants.mjs.map +1 -0
- package/resources/{custom-fields.d.ts → v1/custom-fields.d.ts} +53 -9
- package/resources/v1/custom-fields.d.ts.map +1 -0
- package/resources/{custom-fields.js → v1/custom-fields.js} +42 -7
- package/resources/v1/custom-fields.js.map +1 -0
- package/resources/{custom-fields.mjs → v1/custom-fields.mjs} +42 -7
- package/resources/v1/custom-fields.mjs.map +1 -0
- package/resources/{customers → v1/customers}/alerts.d.ts +31 -3
- package/resources/v1/customers/alerts.d.ts.map +1 -0
- package/resources/v1/customers/alerts.js +56 -0
- package/resources/v1/customers/alerts.js.map +1 -0
- package/resources/v1/customers/alerts.mjs +52 -0
- package/resources/v1/customers/alerts.mjs.map +1 -0
- package/resources/{customers → v1/customers}/billing-config.d.ts +33 -2
- package/resources/v1/customers/billing-config.d.ts.map +1 -0
- package/resources/v1/customers/billing-config.js +65 -0
- package/resources/v1/customers/billing-config.js.map +1 -0
- package/resources/v1/customers/billing-config.mjs +61 -0
- package/resources/v1/customers/billing-config.mjs.map +1 -0
- package/resources/{customers → v1/customers}/commits.d.ts +97 -10
- package/resources/v1/customers/commits.d.ts.map +1 -0
- package/resources/v1/customers/commits.js +82 -0
- package/resources/v1/customers/commits.js.map +1 -0
- package/resources/v1/customers/commits.mjs +78 -0
- package/resources/v1/customers/commits.mjs.map +1 -0
- package/resources/{customers → v1/customers}/credits.d.ts +76 -6
- package/resources/v1/customers/credits.d.ts.map +1 -0
- package/resources/v1/customers/credits.js +67 -0
- package/resources/v1/customers/credits.js.map +1 -0
- package/resources/v1/customers/credits.mjs +63 -0
- package/resources/v1/customers/credits.mjs.map +1 -0
- package/resources/{customers → v1/customers}/customers.d.ts +197 -14
- package/resources/v1/customers/customers.d.ts.map +1 -0
- package/resources/{customers → v1/customers}/customers.js +118 -16
- package/resources/v1/customers/customers.js.map +1 -0
- package/resources/v1/customers/customers.mjs +228 -0
- package/resources/v1/customers/customers.mjs.map +1 -0
- package/resources/{customers → v1/customers}/index.d.ts +1 -1
- package/resources/v1/customers/index.d.ts.map +1 -0
- package/resources/v1/customers/index.js.map +1 -0
- package/resources/v1/customers/index.mjs.map +1 -0
- package/resources/{customers → v1/customers}/invoices.d.ts +152 -57
- package/resources/v1/customers/invoices.d.ts.map +1 -0
- package/resources/v1/customers/invoices.js +103 -0
- package/resources/v1/customers/invoices.js.map +1 -0
- package/resources/v1/customers/invoices.mjs +97 -0
- package/resources/v1/customers/invoices.mjs.map +1 -0
- package/resources/{customers → v1/customers}/named-schedules.d.ts +23 -2
- package/resources/v1/customers/named-schedules.d.ts.map +1 -0
- package/resources/v1/customers/named-schedules.js +48 -0
- package/resources/v1/customers/named-schedules.js.map +1 -0
- package/resources/v1/customers/named-schedules.mjs +44 -0
- package/resources/v1/customers/named-schedules.mjs.map +1 -0
- package/resources/{customers → v1/customers}/plans.d.ts +50 -5
- package/resources/v1/customers/plans.d.ts.map +1 -0
- package/resources/v1/customers/plans.js +99 -0
- package/resources/v1/customers/plans.js.map +1 -0
- package/resources/v1/customers/plans.mjs +93 -0
- package/resources/v1/customers/plans.mjs.map +1 -0
- package/resources/v1/customers.d.ts +2 -0
- package/resources/v1/customers.d.ts.map +1 -0
- package/resources/v1/customers.js +19 -0
- package/resources/v1/customers.js.map +1 -0
- package/resources/v1/customers.mjs +3 -0
- package/resources/v1/customers.mjs.map +1 -0
- package/resources/{dashboards.d.ts → v1/dashboards.d.ts} +32 -4
- package/resources/v1/dashboards.d.ts.map +1 -0
- package/resources/v1/dashboards.js +43 -0
- package/resources/v1/dashboards.js.map +1 -0
- package/resources/v1/dashboards.mjs +39 -0
- package/resources/v1/dashboards.mjs.map +1 -0
- package/resources/v1/index.d.ts +15 -0
- package/resources/v1/index.d.ts.map +1 -0
- package/resources/v1/index.js +44 -0
- package/resources/v1/index.js.map +1 -0
- package/resources/v1/index.mjs +16 -0
- package/resources/v1/index.mjs.map +1 -0
- package/resources/{invoices.d.ts → v1/invoices.d.ts} +16 -2
- package/resources/v1/invoices.d.ts.map +1 -0
- package/resources/v1/invoices.js +35 -0
- package/resources/v1/invoices.js.map +1 -0
- package/resources/v1/invoices.mjs +31 -0
- package/resources/v1/invoices.mjs.map +1 -0
- package/resources/{plans.d.ts → v1/plans.d.ts} +51 -8
- package/resources/v1/plans.d.ts.map +1 -0
- package/resources/{plans.js → v1/plans.js} +34 -7
- package/resources/v1/plans.js.map +1 -0
- package/resources/v1/plans.mjs +74 -0
- package/resources/v1/plans.mjs.map +1 -0
- package/resources/{pricing-units.d.ts → v1/pricing-units.d.ts} +11 -3
- package/resources/v1/pricing-units.d.ts.map +1 -0
- package/resources/{pricing-units.js → v1/pricing-units.js} +4 -4
- package/resources/v1/pricing-units.js.map +1 -0
- package/resources/{pricing-units.mjs → v1/pricing-units.mjs} +4 -4
- package/resources/v1/pricing-units.mjs.map +1 -0
- package/resources/{services.d.ts → v1/services.d.ts} +7 -2
- package/resources/v1/services.d.ts.map +1 -0
- package/resources/{services.js → v1/services.js} +7 -2
- package/resources/v1/services.js.map +1 -0
- package/resources/{services.mjs → v1/services.mjs} +7 -2
- package/resources/v1/services.mjs.map +1 -0
- package/resources/v1/usage.d.ts +325 -0
- package/resources/v1/usage.d.ts.map +1 -0
- package/resources/v1/usage.js +92 -0
- package/resources/v1/usage.js.map +1 -0
- package/resources/v1/usage.mjs +87 -0
- package/resources/v1/usage.mjs.map +1 -0
- package/resources/v1/v1.d.ts +58 -0
- package/resources/v1/v1.d.ts.map +1 -0
- package/resources/v1/v1.js +98 -0
- package/resources/v1/v1.js.map +1 -0
- package/resources/v1/v1.mjs +71 -0
- package/resources/v1/v1.mjs.map +1 -0
- package/resources/v1.d.ts +2 -0
- package/resources/v1.d.ts.map +1 -0
- package/resources/v1.js +19 -0
- package/resources/v1.js.map +1 -0
- package/resources/v1.mjs +3 -0
- package/resources/v1.mjs.map +1 -0
- package/resources/v2/contracts.d.ts +5955 -0
- package/resources/v2/contracts.d.ts.map +1 -0
- package/resources/v2/contracts.js +136 -0
- package/resources/v2/contracts.js.map +1 -0
- package/resources/v2/contracts.mjs +132 -0
- package/resources/v2/contracts.mjs.map +1 -0
- package/resources/v2/index.d.ts +3 -0
- package/resources/v2/index.d.ts.map +1 -0
- package/resources/v2/index.js +9 -0
- package/resources/v2/index.js.map +1 -0
- package/resources/v2/index.mjs +4 -0
- package/resources/v2/index.mjs.map +1 -0
- package/resources/v2/v2.d.ts +10 -0
- package/resources/v2/v2.d.ts.map +1 -0
- package/resources/v2/v2.js +39 -0
- package/resources/v2/v2.js.map +1 -0
- package/resources/v2/v2.mjs +12 -0
- package/resources/v2/v2.mjs.map +1 -0
- package/resources/v2.d.ts +2 -0
- package/resources/v2.d.ts.map +1 -0
- package/resources/v2.js +19 -0
- package/resources/v2.js.map +1 -0
- package/resources/v2.mjs +3 -0
- package/resources/v2.mjs.map +1 -0
- package/resources/webhooks.js +5 -5
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs +5 -5
- package/resources/webhooks.mjs.map +1 -1
- package/resources.d.ts +2 -0
- package/resources.d.ts.map +1 -0
- package/resources.js +18 -0
- package/resources.js.map +1 -0
- package/resources.mjs +2 -0
- package/resources.mjs.map +1 -0
- package/src/_shims/auto/runtime-bun.ts +1 -1
- package/src/_shims/auto/runtime-node.ts +1 -1
- package/src/_shims/auto/runtime.ts +1 -1
- package/src/_shims/auto/types-node.ts +1 -1
- package/src/_shims/bun-runtime.ts +2 -2
- package/src/_shims/index.d.ts +5 -3
- package/src/_shims/index.js +5 -1
- package/src/_shims/index.mjs +6 -2
- package/src/_shims/node-runtime.ts +3 -3
- package/src/_shims/registry.ts +1 -1
- package/src/_shims/web-runtime.ts +3 -3
- package/src/core.ts +49 -21
- package/src/error.ts +1 -1
- package/src/index.ts +31 -349
- package/src/internal/qs/formats.ts +1 -1
- package/src/internal/qs/index.ts +3 -3
- package/src/internal/qs/stringify.ts +3 -3
- package/src/internal/qs/utils.ts +2 -2
- package/src/pagination.ts +5 -1
- package/src/resource.ts +2 -2
- package/src/resources/index.ts +4 -144
- package/src/resources/shared.ts +587 -26
- package/src/resources/{alerts.ts → v1/alerts.ts} +31 -7
- package/src/resources/{audit-logs.ts → v1/audit-logs.ts} +13 -5
- package/src/resources/{billable-metrics.ts → v1/billable-metrics.ts} +61 -12
- package/src/resources/{contracts → v1/contracts}/contracts.ts +1848 -83
- package/src/resources/{contracts → v1/contracts}/index.ts +8 -4
- package/src/resources/{contracts → v1/contracts}/named-schedules.ts +25 -4
- package/src/resources/{contracts → v1/contracts}/products.ts +58 -14
- package/src/resources/{contracts → v1/contracts}/rate-cards/index.ts +6 -4
- package/src/resources/{contracts → v1/contracts}/rate-cards/named-schedules.ts +29 -4
- package/src/resources/{contracts → v1/contracts}/rate-cards/product-orders.ts +38 -5
- package/src/resources/{contracts → v1/contracts}/rate-cards/rate-cards.ts +137 -25
- package/src/resources/{contracts → v1/contracts}/rate-cards/rates.ts +105 -17
- package/src/resources/v1/contracts/rate-cards.ts +3 -0
- package/src/resources/v1/contracts.ts +3 -0
- package/src/resources/{credit-grants.ts → v1/credit-grants.ts} +86 -14
- package/src/resources/{custom-fields.ts → v1/custom-fields.ts} +62 -14
- package/src/resources/{customers → v1/customers}/alerts.ts +35 -6
- package/src/resources/{customers → v1/customers}/billing-config.ts +37 -5
- package/src/resources/{customers → v1/customers}/commits.ts +100 -13
- package/src/resources/{customers → v1/customers}/credits.ts +79 -9
- package/src/resources/{customers → v1/customers}/customers.ts +229 -40
- package/src/resources/{customers → v1/customers}/index.ts +10 -8
- package/src/resources/{customers → v1/customers}/invoices.ts +131 -62
- package/src/resources/{customers → v1/customers}/named-schedules.ts +25 -4
- package/src/resources/{customers → v1/customers}/plans.ts +55 -9
- package/src/resources/v1/customers.ts +3 -0
- package/src/resources/{dashboards.ts → v1/dashboards.ts} +31 -5
- package/src/resources/v1/index.ts +151 -0
- package/src/resources/{invoices.ts → v1/invoices.ts} +18 -4
- package/src/resources/{plans.ts → v1/plans.ts} +49 -14
- package/src/resources/{pricing-units.ts → v1/pricing-units.ts} +13 -5
- package/src/resources/{services.ts → v1/services.ts} +8 -3
- package/src/resources/v1/usage.ts +429 -0
- package/src/resources/v1/v1.ts +364 -0
- package/src/resources/v1.ts +3 -0
- package/src/resources/v2/contracts.ts +7677 -0
- package/src/resources/v2/index.ts +18 -0
- package/src/resources/v2/v2.ts +43 -0
- package/src/resources/v2.ts +3 -0
- package/src/resources/webhooks.ts +7 -7
- package/src/resources.ts +1 -0
- package/src/shims/node.ts +3 -3
- package/src/shims/web.ts +3 -3
- package/src/uploads.ts +4 -4
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
- package/resources/alerts.d.ts.map +0 -1
- package/resources/alerts.js +0 -21
- package/resources/alerts.js.map +0 -1
- package/resources/alerts.mjs +0 -17
- package/resources/alerts.mjs.map +0 -1
- package/resources/audit-logs.d.ts.map +0 -1
- package/resources/audit-logs.js.map +0 -1
- package/resources/audit-logs.mjs.map +0 -1
- package/resources/billable-metrics.d.ts.map +0 -1
- package/resources/billable-metrics.js +0 -43
- package/resources/billable-metrics.js.map +0 -1
- package/resources/billable-metrics.mjs +0 -38
- package/resources/billable-metrics.mjs.map +0 -1
- package/resources/contracts/contracts.d.ts.map +0 -1
- package/resources/contracts/contracts.js +0 -135
- package/resources/contracts/contracts.js.map +0 -1
- package/resources/contracts/contracts.mjs +0 -108
- package/resources/contracts/contracts.mjs.map +0 -1
- package/resources/contracts/index.d.ts +0 -5
- package/resources/contracts/index.d.ts.map +0 -1
- package/resources/contracts/index.js.map +0 -1
- package/resources/contracts/index.mjs.map +0 -1
- package/resources/contracts/named-schedules.d.ts.map +0 -1
- package/resources/contracts/named-schedules.js +0 -27
- package/resources/contracts/named-schedules.js.map +0 -1
- package/resources/contracts/named-schedules.mjs +0 -23
- package/resources/contracts/named-schedules.mjs.map +0 -1
- package/resources/contracts/products.d.ts.map +0 -1
- package/resources/contracts/products.js +0 -51
- package/resources/contracts/products.js.map +0 -1
- package/resources/contracts/products.mjs +0 -46
- package/resources/contracts/products.mjs.map +0 -1
- package/resources/contracts/rate-cards/index.d.ts.map +0 -1
- package/resources/contracts/rate-cards/index.js.map +0 -1
- package/resources/contracts/rate-cards/index.mjs.map +0 -1
- package/resources/contracts/rate-cards/named-schedules.d.ts.map +0 -1
- package/resources/contracts/rate-cards/named-schedules.js +0 -27
- package/resources/contracts/rate-cards/named-schedules.js.map +0 -1
- package/resources/contracts/rate-cards/named-schedules.mjs +0 -23
- package/resources/contracts/rate-cards/named-schedules.mjs.map +0 -1
- package/resources/contracts/rate-cards/product-orders.d.ts.map +0 -1
- package/resources/contracts/rate-cards/product-orders.js +0 -21
- package/resources/contracts/rate-cards/product-orders.js.map +0 -1
- package/resources/contracts/rate-cards/product-orders.mjs +0 -17
- package/resources/contracts/rate-cards/product-orders.mjs.map +0 -1
- package/resources/contracts/rate-cards/rate-cards.d.ts.map +0 -1
- package/resources/contracts/rate-cards/rate-cards.js.map +0 -1
- package/resources/contracts/rate-cards/rate-cards.mjs +0 -69
- package/resources/contracts/rate-cards/rate-cards.mjs.map +0 -1
- package/resources/contracts/rate-cards/rates.d.ts.map +0 -1
- package/resources/contracts/rate-cards/rates.js +0 -38
- package/resources/contracts/rate-cards/rates.js.map +0 -1
- package/resources/contracts/rate-cards/rates.mjs +0 -33
- package/resources/contracts/rate-cards/rates.mjs.map +0 -1
- package/resources/credit-grants.d.ts.map +0 -1
- package/resources/credit-grants.js +0 -52
- package/resources/credit-grants.js.map +0 -1
- package/resources/credit-grants.mjs +0 -47
- package/resources/credit-grants.mjs.map +0 -1
- package/resources/custom-fields.d.ts.map +0 -1
- package/resources/custom-fields.js.map +0 -1
- package/resources/custom-fields.mjs.map +0 -1
- package/resources/customers/alerts.d.ts.map +0 -1
- package/resources/customers/alerts.js +0 -33
- package/resources/customers/alerts.js.map +0 -1
- package/resources/customers/alerts.mjs +0 -29
- package/resources/customers/alerts.mjs.map +0 -1
- package/resources/customers/billing-config.d.ts.map +0 -1
- package/resources/customers/billing-config.js +0 -38
- package/resources/customers/billing-config.js.map +0 -1
- package/resources/customers/billing-config.mjs +0 -34
- package/resources/customers/billing-config.mjs.map +0 -1
- package/resources/customers/commits.d.ts.map +0 -1
- package/resources/customers/commits.js +0 -27
- package/resources/customers/commits.js.map +0 -1
- package/resources/customers/commits.mjs +0 -23
- package/resources/customers/commits.mjs.map +0 -1
- package/resources/customers/credits.d.ts.map +0 -1
- package/resources/customers/credits.js +0 -27
- package/resources/customers/credits.js.map +0 -1
- package/resources/customers/credits.mjs +0 -23
- package/resources/customers/credits.mjs.map +0 -1
- package/resources/customers/customers.d.ts.map +0 -1
- package/resources/customers/customers.js.map +0 -1
- package/resources/customers/customers.mjs +0 -126
- package/resources/customers/customers.mjs.map +0 -1
- package/resources/customers/index.d.ts.map +0 -1
- package/resources/customers/index.js.map +0 -1
- package/resources/customers/index.mjs.map +0 -1
- package/resources/customers/invoices.d.ts.map +0 -1
- package/resources/customers/invoices.js +0 -51
- package/resources/customers/invoices.js.map +0 -1
- package/resources/customers/invoices.mjs +0 -45
- package/resources/customers/invoices.mjs.map +0 -1
- package/resources/customers/named-schedules.d.ts.map +0 -1
- package/resources/customers/named-schedules.js +0 -27
- package/resources/customers/named-schedules.js.map +0 -1
- package/resources/customers/named-schedules.mjs +0 -23
- package/resources/customers/named-schedules.mjs.map +0 -1
- package/resources/customers/plans.d.ts.map +0 -1
- package/resources/customers/plans.js +0 -53
- package/resources/customers/plans.js.map +0 -1
- package/resources/customers/plans.mjs +0 -47
- package/resources/customers/plans.mjs.map +0 -1
- package/resources/dashboards.d.ts.map +0 -1
- package/resources/dashboards.js +0 -17
- package/resources/dashboards.js.map +0 -1
- package/resources/dashboards.mjs +0 -13
- package/resources/dashboards.mjs.map +0 -1
- package/resources/invoices.d.ts.map +0 -1
- package/resources/invoices.js +0 -21
- package/resources/invoices.js.map +0 -1
- package/resources/invoices.mjs +0 -17
- package/resources/invoices.mjs.map +0 -1
- package/resources/plans.d.ts.map +0 -1
- package/resources/plans.js.map +0 -1
- package/resources/plans.mjs +0 -47
- package/resources/plans.mjs.map +0 -1
- package/resources/pricing-units.d.ts.map +0 -1
- package/resources/pricing-units.js.map +0 -1
- package/resources/pricing-units.mjs.map +0 -1
- package/resources/services.d.ts.map +0 -1
- package/resources/services.js.map +0 -1
- package/resources/services.mjs.map +0 -1
- package/resources/usage.d.ts +0 -166
- package/resources/usage.d.ts.map +0 -1
- package/resources/usage.js +0 -49
- package/resources/usage.js.map +0 -1
- package/resources/usage.mjs +0 -44
- package/resources/usage.mjs.map +0 -1
- package/src/resources/usage.ts +0 -239
- /package/resources/{contracts → v1/contracts}/index.js +0 -0
- /package/resources/{contracts → v1/contracts}/index.mjs +0 -0
- /package/resources/{contracts → v1/contracts}/rate-cards/index.js +0 -0
- /package/resources/{contracts → v1/contracts}/rate-cards/index.mjs +0 -0
- /package/resources/{customers → v1/customers}/index.js +0 -0
- /package/resources/{customers → v1/customers}/index.mjs +0 -0
|
@@ -0,0 +1,228 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../../../resource.mjs";
|
|
3
|
+
import { isRequestOptions } from "../../../core.mjs";
|
|
4
|
+
import * as AlertsAPI from "./alerts.mjs";
|
|
5
|
+
import { Alerts, } from "./alerts.mjs";
|
|
6
|
+
import * as BillingConfigAPI from "./billing-config.mjs";
|
|
7
|
+
import { BillingConfig as BillingConfigAPIBillingConfig, } from "./billing-config.mjs";
|
|
8
|
+
import * as CommitsAPI from "./commits.mjs";
|
|
9
|
+
import { Commits, } from "./commits.mjs";
|
|
10
|
+
import * as CreditsAPI from "./credits.mjs";
|
|
11
|
+
import { Credits, } from "./credits.mjs";
|
|
12
|
+
import * as InvoicesAPI from "./invoices.mjs";
|
|
13
|
+
import { InvoiceListBreakdownsResponsesCursorPage, Invoices, InvoicesCursorPage, } from "./invoices.mjs";
|
|
14
|
+
import * as NamedSchedulesAPI from "./named-schedules.mjs";
|
|
15
|
+
import { NamedSchedules, } from "./named-schedules.mjs";
|
|
16
|
+
import * as PlansAPI from "./plans.mjs";
|
|
17
|
+
import { PlanListPriceAdjustmentsResponsesCursorPage, PlanListResponsesCursorPage, Plans, } from "./plans.mjs";
|
|
18
|
+
import { CursorPage } from "../../../pagination.mjs";
|
|
19
|
+
export class Customers extends APIResource {
|
|
20
|
+
constructor() {
|
|
21
|
+
super(...arguments);
|
|
22
|
+
this.alerts = new AlertsAPI.Alerts(this._client);
|
|
23
|
+
this.plans = new PlansAPI.Plans(this._client);
|
|
24
|
+
this.invoices = new InvoicesAPI.Invoices(this._client);
|
|
25
|
+
this.billingConfig = new BillingConfigAPI.BillingConfig(this._client);
|
|
26
|
+
this.commits = new CommitsAPI.Commits(this._client);
|
|
27
|
+
this.credits = new CreditsAPI.Credits(this._client);
|
|
28
|
+
this.namedSchedules = new NamedSchedulesAPI.NamedSchedules(this._client);
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Create a new customer
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* ```ts
|
|
35
|
+
* const customer = await client.v1.customers.create({
|
|
36
|
+
* name: 'Example, Inc.',
|
|
37
|
+
* customer_billing_provider_configurations: [
|
|
38
|
+
* {
|
|
39
|
+
* billing_provider: 'stripe',
|
|
40
|
+
* delivery_method: 'direct_to_billing_provider',
|
|
41
|
+
* configuration: {
|
|
42
|
+
* stripe_customer_id: 'cus_123',
|
|
43
|
+
* stripe_collection_method: 'charge_automatically',
|
|
44
|
+
* },
|
|
45
|
+
* },
|
|
46
|
+
* ],
|
|
47
|
+
* ingest_aliases: ['team@example.com'],
|
|
48
|
+
* });
|
|
49
|
+
* ```
|
|
50
|
+
*/
|
|
51
|
+
create(body, options) {
|
|
52
|
+
return this._client.post('/v1/customers', { body, ...options });
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* Get a customer by Metronome ID.
|
|
56
|
+
*
|
|
57
|
+
* @example
|
|
58
|
+
* ```ts
|
|
59
|
+
* const customer = await client.v1.customers.retrieve({
|
|
60
|
+
* customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
|
|
61
|
+
* });
|
|
62
|
+
* ```
|
|
63
|
+
*/
|
|
64
|
+
retrieve(params, options) {
|
|
65
|
+
const { customer_id } = params;
|
|
66
|
+
return this._client.get(`/v1/customers/${customer_id}`, options);
|
|
67
|
+
}
|
|
68
|
+
list(query = {}, options) {
|
|
69
|
+
if (isRequestOptions(query)) {
|
|
70
|
+
return this.list({}, query);
|
|
71
|
+
}
|
|
72
|
+
return this._client.getAPIList('/v1/customers', CustomerDetailsCursorPage, { query, ...options });
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* Archive a customer Note: any alerts associated with the customer will not be
|
|
76
|
+
* triggered.
|
|
77
|
+
*
|
|
78
|
+
* @example
|
|
79
|
+
* ```ts
|
|
80
|
+
* const response = await client.v1.customers.archive({
|
|
81
|
+
* id: '8deed800-1b7a-495d-a207-6c52bac54dc9',
|
|
82
|
+
* });
|
|
83
|
+
* ```
|
|
84
|
+
*/
|
|
85
|
+
archive(body, options) {
|
|
86
|
+
return this._client.post('/v1/customers/archive', { body, ...options });
|
|
87
|
+
}
|
|
88
|
+
/**
|
|
89
|
+
* Get all billable metrics for a given customer.
|
|
90
|
+
*
|
|
91
|
+
* @example
|
|
92
|
+
* ```ts
|
|
93
|
+
* // Automatically fetches more pages as needed.
|
|
94
|
+
* for await (const customerListBillableMetricsResponse of client.v1.customers.listBillableMetrics(
|
|
95
|
+
* { customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc' },
|
|
96
|
+
* )) {
|
|
97
|
+
* // ...
|
|
98
|
+
* }
|
|
99
|
+
* ```
|
|
100
|
+
*/
|
|
101
|
+
listBillableMetrics(params, options) {
|
|
102
|
+
const { customer_id, ...query } = params;
|
|
103
|
+
return this._client.getAPIList(`/v1/customers/${customer_id}/billable-metrics`, CustomerListBillableMetricsResponsesCursorPage, { query, ...options });
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* Fetch daily pending costs for the specified customer, broken down by credit type
|
|
107
|
+
* and line items. Note: this is not supported for customers whose plan includes a
|
|
108
|
+
* UNIQUE-type billable metric.
|
|
109
|
+
*
|
|
110
|
+
* @example
|
|
111
|
+
* ```ts
|
|
112
|
+
* // Automatically fetches more pages as needed.
|
|
113
|
+
* for await (const customerListCostsResponse of client.v1.customers.listCosts(
|
|
114
|
+
* {
|
|
115
|
+
* customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
|
|
116
|
+
* ending_before: '2019-12-27T18:11:19.117Z',
|
|
117
|
+
* starting_on: '2019-12-27T18:11:19.117Z',
|
|
118
|
+
* },
|
|
119
|
+
* )) {
|
|
120
|
+
* // ...
|
|
121
|
+
* }
|
|
122
|
+
* ```
|
|
123
|
+
*/
|
|
124
|
+
listCosts(params, options) {
|
|
125
|
+
const { customer_id, ...query } = params;
|
|
126
|
+
return this._client.getAPIList(`/v1/customers/${customer_id}/costs`, CustomerListCostsResponsesCursorPage, { query, ...options });
|
|
127
|
+
}
|
|
128
|
+
/**
|
|
129
|
+
* Preview how a set of events will affect a customer's invoice. Generates a draft
|
|
130
|
+
* invoice for a customer using their current contract configuration and the
|
|
131
|
+
* provided events. This is useful for testing how new events will affect the
|
|
132
|
+
* customer's invoice before they are actually processed.
|
|
133
|
+
*
|
|
134
|
+
* @example
|
|
135
|
+
* ```ts
|
|
136
|
+
* const response = await client.v1.customers.previewEvents({
|
|
137
|
+
* customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
|
|
138
|
+
* events: [
|
|
139
|
+
* {
|
|
140
|
+
* event_type: 'heartbeat',
|
|
141
|
+
* timestamp: '2021-01-01T00:00:00Z',
|
|
142
|
+
* properties: { cpu_hours: 100, memory_gb_hours: 200 },
|
|
143
|
+
* },
|
|
144
|
+
* ],
|
|
145
|
+
* });
|
|
146
|
+
* ```
|
|
147
|
+
*/
|
|
148
|
+
previewEvents(params, options) {
|
|
149
|
+
const { customer_id, ...body } = params;
|
|
150
|
+
return this._client.post(`/v1/customers/${customer_id}/previewEvents`, { body, ...options });
|
|
151
|
+
}
|
|
152
|
+
/**
|
|
153
|
+
* Sets the ingest aliases for a customer. Ingest aliases can be used in the
|
|
154
|
+
* `customer_id` field when sending usage events to Metronome. This call is
|
|
155
|
+
* idempotent. It fully replaces the set of ingest aliases for the given customer.
|
|
156
|
+
*
|
|
157
|
+
* @example
|
|
158
|
+
* ```ts
|
|
159
|
+
* await client.v1.customers.setIngestAliases({
|
|
160
|
+
* customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
|
|
161
|
+
* ingest_aliases: ['team@example.com'],
|
|
162
|
+
* });
|
|
163
|
+
* ```
|
|
164
|
+
*/
|
|
165
|
+
setIngestAliases(params, options) {
|
|
166
|
+
const { customer_id, ...body } = params;
|
|
167
|
+
return this._client.post(`/v1/customers/${customer_id}/setIngestAliases`, {
|
|
168
|
+
body,
|
|
169
|
+
...options,
|
|
170
|
+
headers: { Accept: '*/*', ...options?.headers },
|
|
171
|
+
});
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* Updates the specified customer's name.
|
|
175
|
+
*
|
|
176
|
+
* @example
|
|
177
|
+
* ```ts
|
|
178
|
+
* const response = await client.v1.customers.setName({
|
|
179
|
+
* customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
|
|
180
|
+
* name: 'Example, Inc.',
|
|
181
|
+
* });
|
|
182
|
+
* ```
|
|
183
|
+
*/
|
|
184
|
+
setName(params, options) {
|
|
185
|
+
const { customer_id, ...body } = params;
|
|
186
|
+
return this._client.post(`/v1/customers/${customer_id}/setName`, { body, ...options });
|
|
187
|
+
}
|
|
188
|
+
/**
|
|
189
|
+
* Updates the specified customer's config.
|
|
190
|
+
*
|
|
191
|
+
* @example
|
|
192
|
+
* ```ts
|
|
193
|
+
* await client.v1.customers.updateConfig({
|
|
194
|
+
* customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
|
|
195
|
+
* salesforce_account_id: '0015500001WO1ZiABL',
|
|
196
|
+
* });
|
|
197
|
+
* ```
|
|
198
|
+
*/
|
|
199
|
+
updateConfig(params, options) {
|
|
200
|
+
const { customer_id, ...body } = params;
|
|
201
|
+
return this._client.post(`/v1/customers/${customer_id}/updateConfig`, {
|
|
202
|
+
body,
|
|
203
|
+
...options,
|
|
204
|
+
headers: { Accept: '*/*', ...options?.headers },
|
|
205
|
+
});
|
|
206
|
+
}
|
|
207
|
+
}
|
|
208
|
+
export class CustomerDetailsCursorPage extends CursorPage {
|
|
209
|
+
}
|
|
210
|
+
export class CustomerListBillableMetricsResponsesCursorPage extends CursorPage {
|
|
211
|
+
}
|
|
212
|
+
export class CustomerListCostsResponsesCursorPage extends CursorPage {
|
|
213
|
+
}
|
|
214
|
+
Customers.CustomerDetailsCursorPage = CustomerDetailsCursorPage;
|
|
215
|
+
Customers.CustomerListBillableMetricsResponsesCursorPage = CustomerListBillableMetricsResponsesCursorPage;
|
|
216
|
+
Customers.CustomerListCostsResponsesCursorPage = CustomerListCostsResponsesCursorPage;
|
|
217
|
+
Customers.Alerts = Alerts;
|
|
218
|
+
Customers.Plans = Plans;
|
|
219
|
+
Customers.PlanListResponsesCursorPage = PlanListResponsesCursorPage;
|
|
220
|
+
Customers.PlanListPriceAdjustmentsResponsesCursorPage = PlanListPriceAdjustmentsResponsesCursorPage;
|
|
221
|
+
Customers.Invoices = Invoices;
|
|
222
|
+
Customers.InvoicesCursorPage = InvoicesCursorPage;
|
|
223
|
+
Customers.InvoiceListBreakdownsResponsesCursorPage = InvoiceListBreakdownsResponsesCursorPage;
|
|
224
|
+
Customers.BillingConfig = BillingConfigAPIBillingConfig;
|
|
225
|
+
Customers.Commits = Commits;
|
|
226
|
+
Customers.Credits = Credits;
|
|
227
|
+
Customers.NamedSchedules = NamedSchedules;
|
|
228
|
+
//# sourceMappingURL=customers.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"customers.mjs","sourceRoot":"","sources":["../../../src/resources/v1/customers/customers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAGpB,KAAK,SAAS;OACd,EAML,MAAM,GAEP;OACM,KAAK,gBAAgB;OACrB,EACL,aAAa,IAAI,6BAA6B,GAK/C;OACM,KAAK,UAAU;OACf,EAOL,OAAO,GACR;OACM,KAAK,UAAU;OACf,EAOL,OAAO,GACR;OACM,KAAK,WAAW;OAChB,EAML,wCAAwC,EAIxC,QAAQ,EACR,kBAAkB,GACnB;OACM,KAAK,iBAAiB;OACtB,EAIL,cAAc,GACf;OACM,KAAK,QAAQ;OACb,EAQL,2CAA2C,EAE3C,2BAA2B,EAC3B,KAAK,GACN;OACM,EAAE,UAAU,EAAyB;AAE5C,MAAM,OAAO,SAAU,SAAQ,WAAW;IAA1C;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjG,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,mBAAc,GAAqC,IAAI,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA4OxG,CAAC;IA1OC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CACN,MAA8B,EAC9B,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAkBD,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,yBAAyB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CACL,IAA2B,EAC3B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,mBAAmB,CACjB,MAAyC,EACzC,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,iBAAiB,WAAW,mBAAmB,EAC/C,8CAA8C,EAC9C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,CACP,MAA+B,EAC/B,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,iBAAiB,WAAW,QAAQ,EACpC,oCAAoC,EACpC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,aAAa,CACX,MAAmC,EACnC,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,WAAW,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,gBAAgB,CACd,MAAsC,EACtC,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,WAAW,mBAAmB,EAAE;YACxE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CACL,MAA6B,EAC7B,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,WAAW,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY,CAAC,MAAkC,EAAE,OAA6B;QAC5E,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,WAAW,eAAe,EAAE;YACpE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,OAAO,yBAA0B,SAAQ,UAA0B;CAAG;AAE5E,MAAM,OAAO,8CAA+C,SAAQ,UAA+C;CAAG;AAEtH,MAAM,OAAO,oCAAqC,SAAQ,UAAqC;CAAG;AAqdlG,SAAS,CAAC,yBAAyB,GAAG,yBAAyB,CAAC;AAChE,SAAS,CAAC,8CAA8C,GAAG,8CAA8C,CAAC;AAC1G,SAAS,CAAC,oCAAoC,GAAG,oCAAoC,CAAC;AACtF,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC;AAC1B,SAAS,CAAC,KAAK,GAAG,KAAK,CAAC;AACxB,SAAS,CAAC,2BAA2B,GAAG,2BAA2B,CAAC;AACpE,SAAS,CAAC,2CAA2C,GAAG,2CAA2C,CAAC;AACpG,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC9B,SAAS,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;AAClD,SAAS,CAAC,wCAAwC,GAAG,wCAAwC,CAAC;AAC9F,SAAS,CAAC,aAAa,GAAG,6BAA6B,CAAC;AACxD,SAAS,CAAC,OAAO,GAAG,OAAO,CAAC;AAC5B,SAAS,CAAC,OAAO,GAAG,OAAO,CAAC;AAC5B,SAAS,CAAC,cAAc,GAAG,cAAc,CAAC"}
|
|
@@ -2,7 +2,7 @@ export { Alerts, type CustomerAlert, type AlertRetrieveResponse, type AlertListR
|
|
|
2
2
|
export { BillingConfig, type BillingConfigRetrieveResponse, type BillingConfigCreateParams, type BillingConfigRetrieveParams, type BillingConfigDeleteParams, } from "./billing-config.js";
|
|
3
3
|
export { Commits, type CommitCreateResponse, type CommitListResponse, type CommitUpdateEndDateResponse, type CommitCreateParams, type CommitListParams, type CommitUpdateEndDateParams, } from "./commits.js";
|
|
4
4
|
export { Credits, type CreditCreateResponse, type CreditListResponse, type CreditUpdateEndDateResponse, type CreditCreateParams, type CreditListParams, type CreditUpdateEndDateParams, } from "./credits.js";
|
|
5
|
-
export { CustomerDetailsCursorPage, CustomerListBillableMetricsResponsesCursorPage, CustomerListCostsResponsesCursorPage, Customers, type Customer, type CustomerDetail, type CustomerCreateResponse, type CustomerRetrieveResponse, type CustomerArchiveResponse, type CustomerListBillableMetricsResponse, type CustomerListCostsResponse, type CustomerSetNameResponse, type CustomerCreateParams, type CustomerRetrieveParams, type CustomerListParams, type CustomerArchiveParams, type CustomerListBillableMetricsParams, type CustomerListCostsParams, type CustomerSetIngestAliasesParams, type CustomerSetNameParams, type CustomerUpdateConfigParams, } from "./customers.js";
|
|
5
|
+
export { CustomerDetailsCursorPage, CustomerListBillableMetricsResponsesCursorPage, CustomerListCostsResponsesCursorPage, Customers, type Customer, type CustomerDetail, type CustomerCreateResponse, type CustomerRetrieveResponse, type CustomerArchiveResponse, type CustomerListBillableMetricsResponse, type CustomerListCostsResponse, type CustomerPreviewEventsResponse, type CustomerSetNameResponse, type CustomerCreateParams, type CustomerRetrieveParams, type CustomerListParams, type CustomerArchiveParams, type CustomerListBillableMetricsParams, type CustomerListCostsParams, type CustomerPreviewEventsParams, type CustomerSetIngestAliasesParams, type CustomerSetNameParams, type CustomerUpdateConfigParams, } from "./customers.js";
|
|
6
6
|
export { InvoicesCursorPage, InvoiceListBreakdownsResponsesCursorPage, Invoices, type Invoice, type InvoiceRetrieveResponse, type InvoiceAddChargeResponse, type InvoiceListBreakdownsResponse, type InvoiceRetrieveParams, type InvoiceListParams, type InvoiceAddChargeParams, type InvoiceListBreakdownsParams, } from "./invoices.js";
|
|
7
7
|
export { NamedSchedules, type NamedScheduleRetrieveResponse, type NamedScheduleRetrieveParams, type NamedScheduleUpdateParams, } from "./named-schedules.js";
|
|
8
8
|
export { PlanListResponsesCursorPage, PlanListPriceAdjustmentsResponsesCursorPage, Plans, type PlanListResponse, type PlanAddResponse, type PlanEndResponse, type PlanListPriceAdjustmentsResponse, type PlanListParams, type PlanAddParams, type PlanEndParams, type PlanListPriceAdjustmentsParams, } from "./plans.js";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/customers/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,MAAM,EACN,KAAK,aAAa,EAClB,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,eAAe,EACpB,KAAK,gBAAgB,GACtB,MAAM,UAAU,CAAC;AAClB,OAAO,EACL,aAAa,EACb,KAAK,6BAA6B,EAClC,KAAK,yBAAyB,EAC9B,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,GAC/B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,OAAO,EACP,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,yBAAyB,GAC/B,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,OAAO,EACP,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,yBAAyB,GAC/B,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,yBAAyB,EACzB,8CAA8C,EAC9C,oCAAoC,EACpC,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,cAAc,EACnB,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,uBAAuB,EAC5B,KAAK,mCAAmC,EACxC,KAAK,yBAAyB,EAC9B,KAAK,6BAA6B,EAClC,KAAK,uBAAuB,EAC5B,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,iCAAiC,EACtC,KAAK,uBAAuB,EAC5B,KAAK,2BAA2B,EAChC,KAAK,8BAA8B,EACnC,KAAK,qBAAqB,EAC1B,KAAK,0BAA0B,GAChC,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,kBAAkB,EAClB,wCAAwC,EACxC,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,uBAAuB,EAC5B,KAAK,wBAAwB,EAC7B,KAAK,6BAA6B,EAClC,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,EAC3B,KAAK,2BAA2B,GACjC,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,cAAc,EACd,KAAK,6BAA6B,EAClC,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,GAC/B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,2BAA2B,EAC3B,2CAA2C,EAC3C,KAAK,EACL,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,gCAAgC,EACrC,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,KAAK,8BAA8B,GACpC,MAAM,SAAS,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/v1/customers/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,sCAQkB;AAPhB,gGAAA,MAAM,OAAA;AAQR,sDAM0B;AALxB,+GAAA,aAAa,OAAA;AAMf,wCAQmB;AAPjB,kGAAA,OAAO,OAAA;AAQT,wCAQmB;AAPjB,kGAAA,OAAO,OAAA;AAQT,4CAwBqB;AAvBnB,sHAAA,yBAAyB,OAAA;AACzB,2IAAA,8CAA8C,OAAA;AAC9C,iIAAA,oCAAoC,OAAA;AACpC,sGAAA,SAAS,OAAA;AAqBX,0CAYoB;AAXlB,8GAAA,kBAAkB,OAAA;AAClB,oIAAA,wCAAwC,OAAA;AACxC,oGAAA,QAAQ,OAAA;AAUV,wDAK2B;AAJzB,iHAAA,cAAc,OAAA;AAKhB,oCAYiB;AAXf,oHAAA,2BAA2B,OAAA;AAC3B,oIAAA,2CAA2C,OAAA;AAC3C,8FAAA,KAAK,OAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/v1/customers/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,MAAM,GAOP;OACM,EACL,aAAa,GAKd;OACM,EACL,OAAO,GAOR;OACM,EACL,OAAO,GAOR;OACM,EACL,yBAAyB,EACzB,8CAA8C,EAC9C,oCAAoC,EACpC,SAAS,GAoBV;OACM,EACL,kBAAkB,EAClB,wCAAwC,EACxC,QAAQ,GAST;OACM,EACL,cAAc,GAIf;OACM,EACL,2BAA2B,EAC3B,2CAA2C,EAC3C,KAAK,GASN"}
|
|
@@ -1,24 +1,76 @@
|
|
|
1
|
-
import { APIResource } from "
|
|
2
|
-
import * as Core from "
|
|
3
|
-
import * as Shared from "
|
|
4
|
-
import { CursorPage, type CursorPageParams } from "
|
|
1
|
+
import { APIResource } from "../../../resource.js";
|
|
2
|
+
import * as Core from "../../../core.js";
|
|
3
|
+
import * as Shared from "../../shared.js";
|
|
4
|
+
import { CursorPage, type CursorPageParams } from "../../../pagination.js";
|
|
5
5
|
export declare class Invoices extends APIResource {
|
|
6
6
|
/**
|
|
7
7
|
* Fetch a specific invoice for a given customer.
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```ts
|
|
11
|
+
* const invoice = await client.v1.customers.invoices.retrieve(
|
|
12
|
+
* {
|
|
13
|
+
* customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
|
|
14
|
+
* invoice_id: '6a37bb88-8538-48c5-b37b-a41c836328bd',
|
|
15
|
+
* },
|
|
16
|
+
* );
|
|
17
|
+
* ```
|
|
8
18
|
*/
|
|
9
19
|
retrieve(params: InvoiceRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<InvoiceRetrieveResponse>;
|
|
10
20
|
/**
|
|
11
21
|
* List all invoices for a given customer, optionally filtered by status, date
|
|
12
22
|
* range, and/or credit type.
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```ts
|
|
26
|
+
* // Automatically fetches more pages as needed.
|
|
27
|
+
* for await (const invoice of client.v1.customers.invoices.list(
|
|
28
|
+
* { customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc' },
|
|
29
|
+
* )) {
|
|
30
|
+
* // ...
|
|
31
|
+
* }
|
|
32
|
+
* ```
|
|
13
33
|
*/
|
|
14
34
|
list(params: InvoiceListParams, options?: Core.RequestOptions): Core.PagePromise<InvoicesCursorPage, Invoice>;
|
|
15
35
|
/**
|
|
16
36
|
* Add a one time charge to the specified invoice
|
|
37
|
+
*
|
|
38
|
+
* @example
|
|
39
|
+
* ```ts
|
|
40
|
+
* const response =
|
|
41
|
+
* await client.v1.customers.invoices.addCharge({
|
|
42
|
+
* customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
|
|
43
|
+
* charge_id: '5ae4b726-1ebe-439c-9190-9831760ba195',
|
|
44
|
+
* customer_plan_id:
|
|
45
|
+
* 'a23b3cf4-47fb-4c3f-bb3d-9e64f7704015',
|
|
46
|
+
* description: 'One time charge',
|
|
47
|
+
* invoice_start_timestamp: '2024-01-01T00:00:00Z',
|
|
48
|
+
* price: 250,
|
|
49
|
+
* quantity: 1,
|
|
50
|
+
* });
|
|
51
|
+
* ```
|
|
17
52
|
*/
|
|
18
53
|
addCharge(params: InvoiceAddChargeParams, options?: Core.RequestOptions): Core.APIPromise<InvoiceAddChargeResponse>;
|
|
19
54
|
/**
|
|
20
55
|
* List daily or hourly invoice breakdowns for a given customer, optionally
|
|
21
|
-
* filtered by status, date range, and/or credit type.
|
|
56
|
+
* filtered by status, date range, and/or credit type. Important considerations:
|
|
57
|
+
*
|
|
58
|
+
* - If we receive backdated usage after an invoice has been finalized, the
|
|
59
|
+
* backdated usage will be included in the response and usage numbers may differ.
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* ```ts
|
|
63
|
+
* // Automatically fetches more pages as needed.
|
|
64
|
+
* for await (const invoiceListBreakdownsResponse of client.v1.customers.invoices.listBreakdowns(
|
|
65
|
+
* {
|
|
66
|
+
* customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
|
|
67
|
+
* ending_before: '2019-12-27T18:11:19.117Z',
|
|
68
|
+
* starting_on: '2019-12-27T18:11:19.117Z',
|
|
69
|
+
* },
|
|
70
|
+
* )) {
|
|
71
|
+
* // ...
|
|
72
|
+
* }
|
|
73
|
+
* ```
|
|
22
74
|
*/
|
|
23
75
|
listBreakdowns(params: InvoiceListBreakdownsParams, options?: Core.RequestOptions): Core.PagePromise<InvoiceListBreakdownsResponsesCursorPage, InvoiceListBreakdownsResponse>;
|
|
24
76
|
}
|
|
@@ -39,7 +91,9 @@ export interface Invoice {
|
|
|
39
91
|
* This field's availability is dependent on your client's configuration.
|
|
40
92
|
*/
|
|
41
93
|
billable_status?: 'billable' | 'unbillable';
|
|
42
|
-
contract_custom_fields?:
|
|
94
|
+
contract_custom_fields?: {
|
|
95
|
+
[key: string]: string;
|
|
96
|
+
};
|
|
43
97
|
contract_id?: string;
|
|
44
98
|
correction_record?: Invoice.CorrectionRecord;
|
|
45
99
|
/**
|
|
@@ -47,8 +101,12 @@ export interface Invoice {
|
|
|
47
101
|
* invoices only.
|
|
48
102
|
*/
|
|
49
103
|
created_at?: string;
|
|
50
|
-
custom_fields?:
|
|
51
|
-
|
|
104
|
+
custom_fields?: {
|
|
105
|
+
[key: string]: unknown;
|
|
106
|
+
};
|
|
107
|
+
customer_custom_fields?: {
|
|
108
|
+
[key: string]: string;
|
|
109
|
+
};
|
|
52
110
|
/**
|
|
53
111
|
* End of the usage period this invoice covers (UTC)
|
|
54
112
|
*/
|
|
@@ -64,11 +122,13 @@ export interface Invoice {
|
|
|
64
122
|
* This field's availability is dependent on your client's configuration.
|
|
65
123
|
*/
|
|
66
124
|
netsuite_sales_order_id?: string;
|
|
67
|
-
plan_custom_fields?:
|
|
125
|
+
plan_custom_fields?: {
|
|
126
|
+
[key: string]: string;
|
|
127
|
+
};
|
|
68
128
|
plan_id?: string;
|
|
69
129
|
plan_name?: string;
|
|
70
130
|
/**
|
|
71
|
-
*
|
|
131
|
+
* Only present for contract invoices with reseller royalties.
|
|
72
132
|
*/
|
|
73
133
|
reseller_royalty?: Invoice.ResellerRoyalty;
|
|
74
134
|
/**
|
|
@@ -87,48 +147,51 @@ export declare namespace Invoice {
|
|
|
87
147
|
name: string;
|
|
88
148
|
total: number;
|
|
89
149
|
/**
|
|
90
|
-
*
|
|
150
|
+
* Details about the credit or commit that was applied to this line item. Only
|
|
151
|
+
* present on line items with product of `USAGE`, `SUBSCRIPTION` or `COMPOSITE`
|
|
152
|
+
* types.
|
|
91
153
|
*/
|
|
92
154
|
applied_commit_or_credit?: LineItem.AppliedCommitOrCredit;
|
|
155
|
+
commit_custom_fields?: {
|
|
156
|
+
[key: string]: string;
|
|
157
|
+
};
|
|
93
158
|
/**
|
|
94
|
-
*
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
* only present for beta contract invoices
|
|
159
|
+
* For line items with product of `USAGE`, `SUBSCRIPTION`, or `COMPOSITE` types,
|
|
160
|
+
* the ID of the credit or commit that was applied to this line item. For line
|
|
161
|
+
* items with product type of `FIXED`, the ID of the prepaid or postpaid commit
|
|
162
|
+
* that is being paid for.
|
|
99
163
|
*/
|
|
100
164
|
commit_id?: string;
|
|
101
|
-
/**
|
|
102
|
-
* only present for beta contract invoices. This field's availability is dependent
|
|
103
|
-
* on your client's configuration.
|
|
104
|
-
*/
|
|
105
165
|
commit_netsuite_item_id?: string;
|
|
106
|
-
/**
|
|
107
|
-
* only present for beta contract invoices. This field's availability is dependent
|
|
108
|
-
* on your client's configuration.
|
|
109
|
-
*/
|
|
110
166
|
commit_netsuite_sales_order_id?: string;
|
|
111
|
-
/**
|
|
112
|
-
* only present for beta contract invoices
|
|
113
|
-
*/
|
|
114
167
|
commit_segment_id?: string;
|
|
115
168
|
/**
|
|
116
|
-
*
|
|
169
|
+
* `PrepaidCommit` (for commit types `PREPAID` and `CREDIT`) or `PostpaidCommit`
|
|
170
|
+
* (for commit type `POSTPAID`).
|
|
117
171
|
*/
|
|
118
172
|
commit_type?: string;
|
|
119
|
-
custom_fields?:
|
|
173
|
+
custom_fields?: {
|
|
174
|
+
[key: string]: string;
|
|
175
|
+
};
|
|
176
|
+
discount_custom_fields?: {
|
|
177
|
+
[key: string]: string;
|
|
178
|
+
};
|
|
120
179
|
/**
|
|
121
|
-
*
|
|
180
|
+
* ID of the discount applied to this line item.
|
|
181
|
+
*/
|
|
182
|
+
discount_id?: string;
|
|
183
|
+
/**
|
|
184
|
+
* The line item's end date (exclusive).
|
|
122
185
|
*/
|
|
123
186
|
ending_before?: string;
|
|
124
187
|
group_key?: string;
|
|
125
188
|
group_value?: string | null;
|
|
126
189
|
/**
|
|
127
|
-
*
|
|
190
|
+
* Indicates whether the line item is prorated for `SUBSCRIPTION` type product.
|
|
128
191
|
*/
|
|
129
192
|
is_prorated?: boolean;
|
|
130
193
|
/**
|
|
131
|
-
* Only present for contract invoices and when the include_list_prices query
|
|
194
|
+
* Only present for contract invoices and when the `include_list_prices` query
|
|
132
195
|
* parameter is set to true. This will include the list rate for the charge if
|
|
133
196
|
* applicable. Only present for usage and subscription line items.
|
|
134
197
|
*/
|
|
@@ -142,70 +205,97 @@ export declare namespace Invoice {
|
|
|
142
205
|
* The start date for the billing period on the invoice.
|
|
143
206
|
*/
|
|
144
207
|
netsuite_invoice_billing_start?: string;
|
|
145
|
-
/**
|
|
146
|
-
* only present for beta contract invoices. This field's availability is dependent
|
|
147
|
-
* on your client's configuration.
|
|
148
|
-
*/
|
|
149
208
|
netsuite_item_id?: string;
|
|
150
209
|
/**
|
|
151
|
-
*
|
|
210
|
+
* Only present for line items paying for a postpaid commit true-up.
|
|
152
211
|
*/
|
|
153
212
|
postpaid_commit?: LineItem.PostpaidCommit;
|
|
154
213
|
/**
|
|
155
|
-
*
|
|
156
|
-
*
|
|
214
|
+
* Includes the presentation group values associated with this line item if
|
|
215
|
+
* presentation group keys are used.
|
|
216
|
+
*/
|
|
217
|
+
presentation_group_values?: {
|
|
218
|
+
[key: string]: string | null;
|
|
219
|
+
};
|
|
220
|
+
/**
|
|
221
|
+
* Includes the pricing group values associated with this line item if dimensional
|
|
222
|
+
* pricing is used.
|
|
157
223
|
*/
|
|
158
|
-
|
|
224
|
+
pricing_group_values?: {
|
|
225
|
+
[key: string]: string;
|
|
226
|
+
};
|
|
227
|
+
product_custom_fields?: {
|
|
228
|
+
[key: string]: string;
|
|
229
|
+
};
|
|
159
230
|
/**
|
|
160
|
-
*
|
|
161
|
-
* price
|
|
231
|
+
* ID of the product associated with the line item.
|
|
162
232
|
*/
|
|
163
|
-
pricing_group_values?: Record<string, string>;
|
|
164
|
-
product_custom_fields?: Record<string, string>;
|
|
165
233
|
product_id?: string;
|
|
166
|
-
product_type?: string;
|
|
167
234
|
/**
|
|
168
|
-
*
|
|
235
|
+
* The current product tags associated with the line item's `product_id`.
|
|
169
236
|
*/
|
|
170
|
-
|
|
237
|
+
product_tags?: Array<string>;
|
|
171
238
|
/**
|
|
172
|
-
*
|
|
239
|
+
* The type of the line item's product. Possible values are `FixedProductListItem`
|
|
240
|
+
* (for `FIXED` type products), `UsageProductListItem` (for `USAGE` type products),
|
|
241
|
+
* `SubscriptionProductListItem` (for `SUBSCRIPTION` type products) or
|
|
242
|
+
* `CompositeProductListItem` (for `COMPOSITE` type products). For scheduled
|
|
243
|
+
* charges, commit and credit payments, the value is `FixedProductListItem`.
|
|
173
244
|
*/
|
|
245
|
+
product_type?: string;
|
|
246
|
+
professional_service_custom_fields?: {
|
|
247
|
+
[key: string]: string;
|
|
248
|
+
};
|
|
174
249
|
professional_service_id?: string;
|
|
250
|
+
/**
|
|
251
|
+
* The quantity associated with the line item.
|
|
252
|
+
*/
|
|
175
253
|
quantity?: number;
|
|
176
254
|
reseller_type?: 'AWS' | 'AWS_PRO_SERVICE' | 'GCP' | 'GCP_PRO_SERVICE';
|
|
177
|
-
scheduled_charge_custom_fields?:
|
|
255
|
+
scheduled_charge_custom_fields?: {
|
|
256
|
+
[key: string]: string;
|
|
257
|
+
};
|
|
178
258
|
/**
|
|
179
|
-
*
|
|
259
|
+
* ID of scheduled charge.
|
|
180
260
|
*/
|
|
181
261
|
scheduled_charge_id?: string;
|
|
182
262
|
/**
|
|
183
|
-
*
|
|
263
|
+
* The line item's start date (inclusive).
|
|
184
264
|
*/
|
|
185
265
|
starting_at?: string;
|
|
186
266
|
sub_line_items?: Array<LineItem.SubLineItem>;
|
|
267
|
+
subscription_custom_fields?: {
|
|
268
|
+
[key: string]: string;
|
|
269
|
+
};
|
|
270
|
+
/**
|
|
271
|
+
* Populated if the line item has a tiered price.
|
|
272
|
+
*/
|
|
187
273
|
tier?: LineItem.Tier;
|
|
188
274
|
/**
|
|
189
|
-
*
|
|
275
|
+
* The unit price associated with the line item.
|
|
190
276
|
*/
|
|
191
277
|
unit_price?: number;
|
|
192
278
|
}
|
|
193
279
|
namespace LineItem {
|
|
194
280
|
/**
|
|
195
|
-
*
|
|
281
|
+
* Details about the credit or commit that was applied to this line item. Only
|
|
282
|
+
* present on line items with product of `USAGE`, `SUBSCRIPTION` or `COMPOSITE`
|
|
283
|
+
* types.
|
|
196
284
|
*/
|
|
197
285
|
interface AppliedCommitOrCredit {
|
|
198
286
|
id: string;
|
|
199
287
|
type: 'PREPAID' | 'POSTPAID' | 'CREDIT';
|
|
200
288
|
}
|
|
201
289
|
/**
|
|
202
|
-
*
|
|
290
|
+
* Only present for line items paying for a postpaid commit true-up.
|
|
203
291
|
*/
|
|
204
292
|
interface PostpaidCommit {
|
|
205
293
|
id: string;
|
|
206
294
|
}
|
|
207
295
|
interface SubLineItem {
|
|
208
|
-
custom_fields:
|
|
296
|
+
custom_fields: {
|
|
297
|
+
[key: string]: string;
|
|
298
|
+
};
|
|
209
299
|
name: string;
|
|
210
300
|
quantity: number;
|
|
211
301
|
subtotal: number;
|
|
@@ -248,6 +338,9 @@ export declare namespace Invoice {
|
|
|
248
338
|
subtotal: number;
|
|
249
339
|
}
|
|
250
340
|
}
|
|
341
|
+
/**
|
|
342
|
+
* Populated if the line item has a tiered price.
|
|
343
|
+
*/
|
|
251
344
|
interface Tier {
|
|
252
345
|
level: number;
|
|
253
346
|
starting_at: string;
|
|
@@ -278,11 +371,13 @@ export declare namespace Invoice {
|
|
|
278
371
|
credit_type: Shared.CreditTypeData;
|
|
279
372
|
name: string;
|
|
280
373
|
total: number;
|
|
281
|
-
credit_grant_custom_fields?:
|
|
374
|
+
credit_grant_custom_fields?: {
|
|
375
|
+
[key: string]: string;
|
|
376
|
+
};
|
|
282
377
|
credit_grant_id?: string;
|
|
283
378
|
}
|
|
284
379
|
/**
|
|
285
|
-
*
|
|
380
|
+
* Only present for contract invoices with reseller royalties.
|
|
286
381
|
*/
|
|
287
382
|
interface ResellerRoyalty {
|
|
288
383
|
fraction: string;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"invoices.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/customers/invoices.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,MAAM,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAExE,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;IAK3C;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,MAAM,EAAE,iBAAiB,EACzB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE,OAAO,CAAC;IAQhD;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CACP,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAK5C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,cAAc,CACZ,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,wCAAwC,EAAE,6BAA6B,CAAC;CAQ7F;AAED,qBAAa,kBAAmB,SAAQ,UAAU,CAAC,OAAO,CAAC;CAAG;AAE9D,qBAAa,wCAAyC,SAAQ,UAAU,CAAC,6BAA6B,CAAC;CAAG;AAE1G,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;IAEnC,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEpC,MAAM,EAAE,MAAM,CAAC;IAEf,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;IAEb,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,UAAU,GAAG,YAAY,CAAC;IAE5C,sBAAsB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEnD,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,iBAAiB,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC;IAE7C;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE3C,sBAAsB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEnD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,gBAAgB,CAAC,EAAE,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAElD,mBAAmB,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAEvD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC,kBAAkB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAE/C,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC;IAE3C;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,OAAO,CAAC;IACvB,UAAiB,QAAQ;QACvB,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;QAEnC,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,MAAM,CAAC;QAEd;;;;WAIG;QACH,wBAAwB,CAAC,EAAE,QAAQ,CAAC,qBAAqB,CAAC;QAE1D,oBAAoB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEjD;;;;;WAKG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,uBAAuB,CAAC,EAAE,MAAM,CAAC;QAEjC,8BAA8B,CAAC,EAAE,MAAM,CAAC;QAExC,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,aAAa,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAE1C,sBAAsB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEnD;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;;;WAIG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC;QAEzB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,4BAA4B,CAAC,EAAE,MAAM,CAAC;QAEtC;;WAEG;QACH,8BAA8B,CAAC,EAAE,MAAM,CAAC;QAExC,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,eAAe,CAAC,EAAE,QAAQ,CAAC,cAAc,CAAC;QAE1C;;;WAGG;QACH,yBAAyB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;SAAE,CAAC;QAE7D;;;WAGG;QACH,oBAAoB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEjD,qBAAqB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAElD;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE7B;;;;;;WAMG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,kCAAkC,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAE/D,uBAAuB,CAAC,EAAE,MAAM,CAAC;QAEjC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB,aAAa,CAAC,EAAE,KAAK,GAAG,iBAAiB,GAAG,KAAK,GAAG,iBAAiB,CAAC;QAEtE,8BAA8B,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAE3D;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,cAAc,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAE7C,0BAA0B,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEvD;;WAEG;QACH,IAAI,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC;QAErB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAED,UAAiB,QAAQ,CAAC;QACxB;;;;WAIG;QACH,UAAiB,qBAAqB;YACpC,EAAE,EAAE,MAAM,CAAC;YAEX,IAAI,EAAE,SAAS,GAAG,UAAU,GAAG,QAAQ,CAAC;SACzC;QAED;;WAEG;QACH,UAAiB,cAAc;YAC7B,EAAE,EAAE,MAAM,CAAC;SACZ;QAED,UAAiB,WAAW;YAC1B,aAAa,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;YAEzC,IAAI,EAAE,MAAM,CAAC;YAEb,QAAQ,EAAE,MAAM,CAAC;YAEjB,QAAQ,EAAE,MAAM,CAAC;YAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;YAEnB,eAAe,CAAC,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;;eAGG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,WAAW,CAAC,EAAE,WAAW,CAAC,UAAU,CAAC;YAErC,KAAK,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;SACjC;QAED,UAAiB,WAAW,CAAC;YAC3B;;eAEG;YACH,UAAiB,UAAU;gBACzB,WAAW,EAAE,MAAM,CAAC;gBAEpB,aAAa,CAAC,EAAE,MAAM,CAAC;aACxB;YAED,UAAiB,IAAI;gBACnB,KAAK,EAAE,MAAM,CAAC;gBAEd,QAAQ,EAAE,MAAM,CAAC;gBAEjB;;mBAEG;gBACH,WAAW,EAAE,MAAM,CAAC;gBAEpB,QAAQ,EAAE,MAAM,CAAC;aAClB;SACF;QAED;;WAEG;QACH,UAAiB,IAAI;YACnB,KAAK,EAAE,MAAM,CAAC;YAEd,WAAW,EAAE,MAAM,CAAC;YAEpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACtB;KACF;IAED,UAAiB,gBAAgB;QAC/B,oBAAoB,EAAE,MAAM,CAAC;QAE7B,IAAI,EAAE,MAAM,CAAC;QAEb,MAAM,EAAE,MAAM,CAAC;QAEf,0BAA0B,CAAC,EAAE,gBAAgB,CAAC,wBAAwB,CAAC;KACxE;IAED,UAAiB,gBAAgB,CAAC;QAChC,UAAiB,wBAAwB;YACvC,qBAAqB,EACjB,iBAAiB,GACjB,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,mBAAmB,GACnB,mBAAmB,GACnB,SAAS,GACT,iBAAiB,CAAC;YAEtB,eAAe,CAAC,EACZ,OAAO,GACP,WAAW,GACX,MAAM,GACN,eAAe,GACf,MAAM,GACN,SAAS,GACT,gBAAgB,GAChB,uBAAuB,GACvB,SAAS,GACT,MAAM,GACN,QAAQ,CAAC;YAEb,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB,mBAAmB,CAAC,EAAE,MAAM,CAAC;SAC9B;KACF;IAED,UAAiB,eAAe;QAC9B,qBAAqB,EACjB,iBAAiB,GACjB,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,mBAAmB,GACnB,mBAAmB,GACnB,SAAS,GACT,iBAAiB,CAAC;QAEtB,eAAe,CAAC,EACZ,OAAO,GACP,WAAW,GACX,MAAM,GACN,eAAe,GACf,MAAM,GACN,SAAS,GACT,gBAAgB,GAChB,uBAAuB,GACvB,SAAS,GACT,MAAM,GACN,QAAQ,CAAC;QAEb,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,mBAAmB,CAAC,EAAE,MAAM,CAAC;KAC9B;IAED,UAAiB,iBAAiB;QAChC,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;QAEnC,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,MAAM,CAAC;QAEd,0BAA0B,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEvD,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,eAAe;QAC9B,QAAQ,EAAE,MAAM,CAAC;QAEjB,oBAAoB,EAAE,MAAM,CAAC;QAE7B,aAAa,EAAE,KAAK,GAAG,iBAAiB,GAAG,KAAK,GAAG,iBAAiB,CAAC;QAErE,WAAW,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC;QAEzC,WAAW,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC;KAC1C;IAED,UAAiB,eAAe,CAAC;QAC/B,UAAiB,UAAU;YACzB,kBAAkB,CAAC,EAAE,MAAM,CAAC;YAE5B,YAAY,CAAC,EAAE,MAAM,CAAC;YAEtB,sBAAsB,CAAC,EAAE,MAAM,CAAC;SACjC;QAED,UAAiB,UAAU;YACzB,cAAc,CAAC,EAAE,MAAM,CAAC;YAExB,YAAY,CAAC,EAAE,MAAM,CAAC;SACvB;KACF;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,wBAAwB;CAAG;AAE5C,MAAM,WAAW,6BAA8B,SAAQ,OAAO;IAC5D,uBAAuB,EAAE,MAAM,CAAC;IAEhC,yBAAyB,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;CACpC;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;OAGG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;IAEhC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,2BAA4B,SAAQ,gBAAgB;IACnE;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;OAGG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;IAEhC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;CAC9B;AAKD,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,kBAAkB,IAAI,kBAAkB,EACxC,wCAAwC,IAAI,wCAAwC,EACpF,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
|