@metronome/mcp 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/README.md +1062 -76
- package/code-tool-paths.cjs +6 -0
- package/code-tool-paths.cjs.map +1 -0
- package/code-tool-paths.d.cts +2 -0
- package/code-tool-paths.d.cts.map +1 -0
- package/code-tool-types.d.mts +14 -0
- package/code-tool-types.d.mts.map +1 -0
- package/code-tool-types.d.ts +14 -0
- package/code-tool-types.d.ts.map +1 -0
- package/code-tool-types.js +4 -0
- package/code-tool-types.js.map +1 -0
- package/code-tool-types.mjs +3 -0
- package/code-tool-types.mjs.map +1 -0
- package/code-tool-worker.d.mts +5 -0
- package/code-tool-worker.d.mts.map +1 -0
- package/code-tool-worker.d.ts +5 -0
- package/code-tool-worker.d.ts.map +1 -0
- package/code-tool-worker.js +45 -0
- package/code-tool-worker.js.map +1 -0
- package/code-tool-worker.mjs +40 -0
- package/code-tool-worker.mjs.map +1 -0
- package/code-tool.d.mts +12 -0
- package/code-tool.d.mts.map +1 -0
- package/code-tool.d.ts +12 -0
- package/code-tool.d.ts.map +1 -0
- package/code-tool.js +158 -0
- package/code-tool.js.map +1 -0
- package/code-tool.mjs +122 -0
- package/code-tool.mjs.map +1 -0
- package/compat.d.mts +4 -2
- package/compat.d.mts.map +1 -1
- package/compat.d.ts +4 -2
- package/compat.d.ts.map +1 -1
- package/compat.js +3 -1
- package/compat.js.map +1 -1
- package/compat.mjs +2 -0
- package/compat.mjs.map +1 -1
- package/docs-search-tool.d.mts +44 -0
- package/docs-search-tool.d.mts.map +1 -0
- package/docs-search-tool.d.ts +44 -0
- package/docs-search-tool.d.ts.map +1 -0
- package/docs-search-tool.js +43 -0
- package/docs-search-tool.js.map +1 -0
- package/docs-search-tool.mjs +39 -0
- package/docs-search-tool.mjs.map +1 -0
- package/dynamic-tools.js +3 -3
- package/dynamic-tools.js.map +1 -1
- package/dynamic-tools.mjs +3 -3
- package/dynamic-tools.mjs.map +1 -1
- package/headers.d.mts +1 -1
- package/headers.d.mts.map +1 -1
- package/headers.d.ts +1 -1
- package/headers.d.ts.map +1 -1
- package/headers.js +1 -1
- package/headers.js.map +1 -1
- package/headers.mjs +1 -1
- package/headers.mjs.map +1 -1
- package/http.d.mts +6 -3
- package/http.d.mts.map +1 -1
- package/http.d.ts +6 -3
- package/http.d.ts.map +1 -1
- package/http.js +25 -10
- package/http.js.map +1 -1
- package/http.mjs +25 -10
- package/http.mjs.map +1 -1
- package/index.js +6 -6
- package/index.js.map +1 -1
- package/index.mjs +7 -7
- package/index.mjs.map +1 -1
- package/options.d.mts +9 -6
- package/options.d.mts.map +1 -1
- package/options.d.ts +9 -6
- package/options.d.ts.map +1 -1
- package/options.js +126 -16
- package/options.js.map +1 -1
- package/options.mjs +125 -16
- package/options.mjs.map +1 -1
- package/package.json +171 -10
- package/server.d.mts +3 -16
- package/server.d.mts.map +1 -1
- package/server.d.ts +3 -16
- package/server.d.ts.map +1 -1
- package/server.js +87 -25
- package/server.js.map +1 -1
- package/server.mjs +86 -24
- package/server.mjs.map +1 -1
- package/src/code-tool-paths.cts +3 -0
- package/src/code-tool-types.ts +14 -0
- package/src/code-tool-worker.ts +46 -0
- package/src/code-tool.ts +147 -0
- package/src/compat.ts +4 -2
- package/src/docs-search-tool.ts +48 -0
- package/src/dynamic-tools.ts +3 -3
- package/src/headers.ts +2 -3
- package/src/http.ts +54 -26
- package/src/index.ts +7 -7
- package/src/options.ts +147 -22
- package/src/server.ts +99 -36
- package/src/stdio.ts +3 -4
- package/src/tools/index.ts +12 -0
- package/src/tools/v1/alerts/archive-v1-alerts.ts +3 -3
- package/src/tools/v1/alerts/create-v1-alerts.ts +15 -14
- package/src/tools/v1/audit-logs/list-v1-audit-logs.ts +1 -1
- package/src/tools/v1/billable-metrics/archive-v1-billable-metrics.ts +1 -1
- package/src/tools/v1/billable-metrics/create-v1-billable-metrics.ts +1 -1
- package/src/tools/v1/billable-metrics/list-v1-billable-metrics.ts +1 -1
- package/src/tools/v1/billable-metrics/retrieve-v1-billable-metrics.ts +1 -1
- package/src/tools/v1/contracts/add-manual-balance-entry-v1-contracts.ts +2 -1
- package/src/tools/v1/contracts/amend-v1-contracts.ts +86 -143
- package/src/tools/v1/contracts/archive-v1-contracts.ts +1 -1
- package/src/tools/v1/contracts/create-historical-invoices-v1-contracts.ts +3 -1
- package/src/tools/v1/contracts/create-v1-contracts.ts +258 -517
- package/src/tools/v1/contracts/list-balances-v1-contracts.ts +4 -2
- package/src/tools/v1/contracts/list-v1-contracts.ts +1 -1
- package/src/tools/v1/contracts/named-schedules/retrieve-contracts-v1-named-schedules.ts +1 -1
- package/src/tools/v1/contracts/products/archive-contracts-v1-products.ts +1 -1
- package/src/tools/v1/contracts/products/create-contracts-v1-products.ts +2 -1
- package/src/tools/v1/contracts/products/list-contracts-v1-products.ts +1 -1
- package/src/tools/v1/contracts/products/retrieve-contracts-v1-products.ts +1 -1
- package/src/tools/v1/contracts/products/update-contracts-v1-products.ts +1 -1
- package/src/tools/v1/contracts/rate-cards/archive-contracts-v1-rate-cards.ts +1 -1
- package/src/tools/v1/contracts/rate-cards/create-contracts-v1-rate-cards.ts +2 -1
- package/src/tools/v1/contracts/rate-cards/list-contracts-v1-rate-cards.ts +1 -1
- package/src/tools/v1/contracts/rate-cards/named-schedules/retrieve-rate-cards-contracts-v1-named-schedules.ts +1 -1
- package/src/tools/v1/contracts/rate-cards/product-orders/set-rate-cards-contracts-v1-product-orders.ts +1 -1
- package/src/tools/v1/contracts/rate-cards/product-orders/update-rate-cards-contracts-v1-product-orders.ts +1 -1
- package/src/tools/v1/contracts/rate-cards/rates/add-many-rate-cards-contracts-v1-rates.ts +25 -22
- package/src/tools/v1/contracts/rate-cards/rates/add-rate-cards-contracts-v1-rates.ts +25 -22
- package/src/tools/v1/contracts/rate-cards/rates/list-rate-cards-contracts-v1-rates.ts +1 -1
- package/src/tools/v1/contracts/rate-cards/retrieve-contracts-v1-rate-cards.ts +1 -1
- package/src/tools/v1/contracts/rate-cards/retrieve-rate-schedule-contracts-v1-rate-cards.ts +1 -1
- package/src/tools/v1/contracts/rate-cards/update-contracts-v1-rate-cards.ts +1 -1
- package/src/tools/v1/contracts/retrieve-rate-schedule-v1-contracts.ts +1 -1
- package/src/tools/v1/contracts/retrieve-subscription-quantity-history-v1-contracts.ts +1 -1
- package/src/tools/v1/contracts/set-usage-filter-v1-contracts.ts +2 -1
- package/src/tools/v1/contracts/update-end-date-v1-contracts.ts +1 -1
- package/src/tools/v1/credit-grants/create-v1-credit-grants.ts +1 -1
- package/src/tools/v1/credit-grants/edit-v1-credit-grants.ts +1 -1
- package/src/tools/v1/credit-grants/list-entries-v1-credit-grants.ts +3 -2
- package/src/tools/v1/credit-grants/list-v1-credit-grants.ts +1 -1
- package/src/tools/v1/credit-grants/void-v1-credit-grants.ts +1 -1
- package/src/tools/v1/custom-fields/add-key-v1-custom-fields.ts +1 -1
- package/src/tools/v1/custom-fields/delete-values-v1-custom-fields.ts +2 -1
- package/src/tools/v1/custom-fields/list-keys-v1-custom-fields.ts +3 -2
- package/src/tools/v1/custom-fields/remove-key-v1-custom-fields.ts +2 -1
- package/src/tools/v1/custom-fields/set-values-v1-custom-fields.ts +2 -1
- package/src/tools/v1/customers/alerts/list-customers-v1-alerts.ts +5 -3
- package/src/tools/v1/customers/alerts/reset-customers-v1-alerts.ts +3 -2
- package/src/tools/v1/customers/alerts/retrieve-customers-v1-alerts.ts +24 -12
- package/src/tools/v1/customers/archive-v1-customers.ts +1 -1
- package/src/tools/v1/customers/billing-config/create-customers-v1-billing-config.ts +6 -1
- package/src/tools/v1/customers/billing-config/retrieve-customers-v1-billing-config.ts +1 -1
- package/src/tools/v1/customers/commits/create-customers-v1-commits.ts +32 -33
- package/src/tools/v1/customers/commits/list-customers-v1-commits.ts +4 -2
- package/src/tools/v1/customers/commits/update-end-date-customers-v1-commits.ts +1 -1
- package/src/tools/v1/customers/create-v1-customers.ts +14 -2
- package/src/tools/v1/customers/credits/create-customers-v1-credits.ts +30 -24
- package/src/tools/v1/customers/credits/list-customers-v1-credits.ts +4 -2
- package/src/tools/v1/customers/credits/update-end-date-customers-v1-credits.ts +1 -1
- package/src/tools/v1/customers/invoices/add-charge-customers-v1-invoices.ts +1 -1
- package/src/tools/v1/customers/invoices/list-breakdowns-customers-v1-invoices.ts +1 -1
- package/src/tools/v1/customers/invoices/list-customers-v1-invoices.ts +1 -1
- package/src/tools/v1/customers/invoices/retrieve-customers-v1-invoices.ts +2 -1
- package/src/tools/v1/customers/invoices/retrieve-pdf-customers-v1-invoices.ts +43 -0
- package/src/tools/v1/customers/list-billable-metrics-v1-customers.ts +1 -1
- package/src/tools/v1/customers/list-costs-v1-customers.ts +1 -1
- package/src/tools/v1/customers/list-v1-customers.ts +1 -1
- package/src/tools/v1/customers/named-schedules/retrieve-customers-v1-named-schedules.ts +1 -1
- package/src/tools/v1/customers/plans/add-customers-v1-plans.ts +1 -1
- package/src/tools/v1/customers/plans/end-customers-v1-plans.ts +1 -1
- package/src/tools/v1/customers/plans/list-customers-v1-plans.ts +1 -1
- package/src/tools/v1/customers/plans/list-price-adjustments-customers-v1-plans.ts +1 -1
- package/src/tools/v1/customers/preview-events-v1-customers.ts +2 -7
- package/src/tools/v1/customers/retrieve-billing-configurations-v1-customers.ts +50 -0
- package/src/tools/v1/customers/retrieve-v1-customers.ts +1 -1
- package/src/tools/v1/customers/set-billing-configurations-v1-customers.ts +85 -0
- package/src/tools/v1/customers/set-ingest-aliases-v1-customers.ts +1 -1
- package/src/tools/v1/customers/set-name-v1-customers.ts +1 -1
- package/src/tools/v1/customers/update-config-v1-customers.ts +2 -1
- package/src/tools/v1/dashboards/get-embeddable-url-v1-dashboards.ts +1 -1
- package/src/tools/v1/invoices/regenerate-v1-invoices.ts +1 -1
- package/src/tools/v1/invoices/void-v1-invoices.ts +1 -1
- package/src/tools/v1/payments/attempt-v1-payments.ts +48 -0
- package/src/tools/v1/payments/cancel-v1-payments.ts +48 -0
- package/src/tools/v1/payments/list-v1-payments.ts +69 -0
- package/src/tools/v1/plans/get-details-v1-plans.ts +1 -1
- package/src/tools/v1/plans/list-charges-v1-plans.ts +1 -1
- package/src/tools/v1/plans/list-customers-v1-plans.ts +1 -1
- package/src/tools/v1/plans/list-v1-plans.ts +1 -1
- package/src/tools/v1/pricing-units/list-v1-pricing-units.ts +1 -1
- package/src/tools/v1/services/list-v1-services.ts +1 -1
- package/src/tools/v1/usage/ingest-v1-usage.ts +2 -2
- package/src/tools/v1/usage/list-v1-usage.ts +3 -2
- package/src/tools/v1/usage/list-with-groups-v1-usage.ts +1 -1
- package/src/tools/v1/usage/search-v1-usage.ts +1 -1
- package/src/tools/v2/contracts/edit-commit-v2-contracts.ts +84 -24
- package/src/tools/v2/contracts/edit-credit-v2-contracts.ts +84 -24
- package/src/tools/v2/contracts/edit-v2-contracts.ts +314 -782
- package/src/tools/v2/contracts/get-edit-history-v2-contracts.ts +1 -1
- package/src/tools/v2/contracts/list-v2-contracts.ts +1 -1
- package/src/tools/v2/contracts/retrieve-v2-contracts.ts +2 -1
- package/stdio.d.mts +1 -2
- package/stdio.d.mts.map +1 -1
- package/stdio.d.ts +1 -2
- package/stdio.d.ts.map +1 -1
- package/stdio.js +2 -2
- package/stdio.js.map +1 -1
- package/stdio.mjs +3 -3
- package/stdio.mjs.map +1 -1
- package/tools/index.d.mts.map +1 -1
- package/tools/index.d.ts.map +1 -1
- package/tools/index.js +12 -0
- package/tools/index.js.map +1 -1
- package/tools/index.mjs +12 -0
- package/tools/index.mjs.map +1 -1
- package/tools/v1/alerts/archive-v1-alerts.js +3 -3
- package/tools/v1/alerts/archive-v1-alerts.js.map +1 -1
- package/tools/v1/alerts/archive-v1-alerts.mjs +3 -3
- package/tools/v1/alerts/archive-v1-alerts.mjs.map +1 -1
- package/tools/v1/alerts/create-v1-alerts.d.mts.map +1 -1
- package/tools/v1/alerts/create-v1-alerts.d.ts.map +1 -1
- package/tools/v1/alerts/create-v1-alerts.js +14 -14
- package/tools/v1/alerts/create-v1-alerts.js.map +1 -1
- package/tools/v1/alerts/create-v1-alerts.mjs +14 -14
- package/tools/v1/alerts/create-v1-alerts.mjs.map +1 -1
- package/tools/v1/audit-logs/list-v1-audit-logs.js +1 -1
- package/tools/v1/audit-logs/list-v1-audit-logs.js.map +1 -1
- package/tools/v1/audit-logs/list-v1-audit-logs.mjs +1 -1
- package/tools/v1/audit-logs/list-v1-audit-logs.mjs.map +1 -1
- package/tools/v1/billable-metrics/archive-v1-billable-metrics.js +1 -1
- package/tools/v1/billable-metrics/archive-v1-billable-metrics.js.map +1 -1
- package/tools/v1/billable-metrics/archive-v1-billable-metrics.mjs +1 -1
- package/tools/v1/billable-metrics/archive-v1-billable-metrics.mjs.map +1 -1
- package/tools/v1/billable-metrics/create-v1-billable-metrics.js +1 -1
- package/tools/v1/billable-metrics/create-v1-billable-metrics.js.map +1 -1
- package/tools/v1/billable-metrics/create-v1-billable-metrics.mjs +1 -1
- package/tools/v1/billable-metrics/create-v1-billable-metrics.mjs.map +1 -1
- package/tools/v1/billable-metrics/list-v1-billable-metrics.js +1 -1
- package/tools/v1/billable-metrics/list-v1-billable-metrics.js.map +1 -1
- package/tools/v1/billable-metrics/list-v1-billable-metrics.mjs +1 -1
- package/tools/v1/billable-metrics/list-v1-billable-metrics.mjs.map +1 -1
- package/tools/v1/billable-metrics/retrieve-v1-billable-metrics.js +1 -1
- package/tools/v1/billable-metrics/retrieve-v1-billable-metrics.js.map +1 -1
- package/tools/v1/billable-metrics/retrieve-v1-billable-metrics.mjs +1 -1
- package/tools/v1/billable-metrics/retrieve-v1-billable-metrics.mjs.map +1 -1
- package/tools/v1/contracts/add-manual-balance-entry-v1-contracts.d.mts.map +1 -1
- package/tools/v1/contracts/add-manual-balance-entry-v1-contracts.d.ts.map +1 -1
- package/tools/v1/contracts/add-manual-balance-entry-v1-contracts.js +1 -1
- package/tools/v1/contracts/add-manual-balance-entry-v1-contracts.js.map +1 -1
- package/tools/v1/contracts/add-manual-balance-entry-v1-contracts.mjs +1 -1
- package/tools/v1/contracts/add-manual-balance-entry-v1-contracts.mjs.map +1 -1
- package/tools/v1/contracts/amend-v1-contracts.d.mts.map +1 -1
- package/tools/v1/contracts/amend-v1-contracts.d.ts.map +1 -1
- package/tools/v1/contracts/amend-v1-contracts.js +85 -139
- package/tools/v1/contracts/amend-v1-contracts.js.map +1 -1
- package/tools/v1/contracts/amend-v1-contracts.mjs +85 -139
- package/tools/v1/contracts/amend-v1-contracts.mjs.map +1 -1
- package/tools/v1/contracts/archive-v1-contracts.js +1 -1
- package/tools/v1/contracts/archive-v1-contracts.js.map +1 -1
- package/tools/v1/contracts/archive-v1-contracts.mjs +1 -1
- package/tools/v1/contracts/archive-v1-contracts.mjs.map +1 -1
- package/tools/v1/contracts/create-historical-invoices-v1-contracts.d.mts.map +1 -1
- package/tools/v1/contracts/create-historical-invoices-v1-contracts.d.ts.map +1 -1
- package/tools/v1/contracts/create-historical-invoices-v1-contracts.js +2 -1
- package/tools/v1/contracts/create-historical-invoices-v1-contracts.js.map +1 -1
- package/tools/v1/contracts/create-historical-invoices-v1-contracts.mjs +2 -1
- package/tools/v1/contracts/create-historical-invoices-v1-contracts.mjs.map +1 -1
- package/tools/v1/contracts/create-v1-contracts.d.mts.map +1 -1
- package/tools/v1/contracts/create-v1-contracts.d.ts.map +1 -1
- package/tools/v1/contracts/create-v1-contracts.js +241 -485
- package/tools/v1/contracts/create-v1-contracts.js.map +1 -1
- package/tools/v1/contracts/create-v1-contracts.mjs +241 -485
- package/tools/v1/contracts/create-v1-contracts.mjs.map +1 -1
- package/tools/v1/contracts/list-balances-v1-contracts.d.mts.map +1 -1
- package/tools/v1/contracts/list-balances-v1-contracts.d.ts.map +1 -1
- package/tools/v1/contracts/list-balances-v1-contracts.js +3 -2
- package/tools/v1/contracts/list-balances-v1-contracts.js.map +1 -1
- package/tools/v1/contracts/list-balances-v1-contracts.mjs +3 -2
- package/tools/v1/contracts/list-balances-v1-contracts.mjs.map +1 -1
- package/tools/v1/contracts/list-v1-contracts.js +1 -1
- package/tools/v1/contracts/list-v1-contracts.js.map +1 -1
- package/tools/v1/contracts/list-v1-contracts.mjs +1 -1
- package/tools/v1/contracts/list-v1-contracts.mjs.map +1 -1
- package/tools/v1/contracts/named-schedules/retrieve-contracts-v1-named-schedules.js +1 -1
- package/tools/v1/contracts/named-schedules/retrieve-contracts-v1-named-schedules.js.map +1 -1
- package/tools/v1/contracts/named-schedules/retrieve-contracts-v1-named-schedules.mjs +1 -1
- package/tools/v1/contracts/named-schedules/retrieve-contracts-v1-named-schedules.mjs.map +1 -1
- package/tools/v1/contracts/products/archive-contracts-v1-products.js +1 -1
- package/tools/v1/contracts/products/archive-contracts-v1-products.js.map +1 -1
- package/tools/v1/contracts/products/archive-contracts-v1-products.mjs +1 -1
- package/tools/v1/contracts/products/archive-contracts-v1-products.mjs.map +1 -1
- package/tools/v1/contracts/products/create-contracts-v1-products.d.mts.map +1 -1
- package/tools/v1/contracts/products/create-contracts-v1-products.d.ts.map +1 -1
- package/tools/v1/contracts/products/create-contracts-v1-products.js +2 -1
- package/tools/v1/contracts/products/create-contracts-v1-products.js.map +1 -1
- package/tools/v1/contracts/products/create-contracts-v1-products.mjs +2 -1
- package/tools/v1/contracts/products/create-contracts-v1-products.mjs.map +1 -1
- package/tools/v1/contracts/products/list-contracts-v1-products.js +1 -1
- package/tools/v1/contracts/products/list-contracts-v1-products.js.map +1 -1
- package/tools/v1/contracts/products/list-contracts-v1-products.mjs +1 -1
- package/tools/v1/contracts/products/list-contracts-v1-products.mjs.map +1 -1
- package/tools/v1/contracts/products/retrieve-contracts-v1-products.js +1 -1
- package/tools/v1/contracts/products/retrieve-contracts-v1-products.js.map +1 -1
- package/tools/v1/contracts/products/retrieve-contracts-v1-products.mjs +1 -1
- package/tools/v1/contracts/products/retrieve-contracts-v1-products.mjs.map +1 -1
- package/tools/v1/contracts/products/update-contracts-v1-products.js +1 -1
- package/tools/v1/contracts/products/update-contracts-v1-products.js.map +1 -1
- package/tools/v1/contracts/products/update-contracts-v1-products.mjs +1 -1
- package/tools/v1/contracts/products/update-contracts-v1-products.mjs.map +1 -1
- package/tools/v1/contracts/rate-cards/archive-contracts-v1-rate-cards.js +1 -1
- package/tools/v1/contracts/rate-cards/archive-contracts-v1-rate-cards.js.map +1 -1
- package/tools/v1/contracts/rate-cards/archive-contracts-v1-rate-cards.mjs +1 -1
- package/tools/v1/contracts/rate-cards/archive-contracts-v1-rate-cards.mjs.map +1 -1
- package/tools/v1/contracts/rate-cards/create-contracts-v1-rate-cards.d.mts.map +1 -1
- package/tools/v1/contracts/rate-cards/create-contracts-v1-rate-cards.d.ts.map +1 -1
- package/tools/v1/contracts/rate-cards/create-contracts-v1-rate-cards.js +2 -1
- package/tools/v1/contracts/rate-cards/create-contracts-v1-rate-cards.js.map +1 -1
- package/tools/v1/contracts/rate-cards/create-contracts-v1-rate-cards.mjs +2 -1
- package/tools/v1/contracts/rate-cards/create-contracts-v1-rate-cards.mjs.map +1 -1
- package/tools/v1/contracts/rate-cards/list-contracts-v1-rate-cards.js +1 -1
- package/tools/v1/contracts/rate-cards/list-contracts-v1-rate-cards.js.map +1 -1
- package/tools/v1/contracts/rate-cards/list-contracts-v1-rate-cards.mjs +1 -1
- package/tools/v1/contracts/rate-cards/list-contracts-v1-rate-cards.mjs.map +1 -1
- package/tools/v1/contracts/rate-cards/named-schedules/retrieve-rate-cards-contracts-v1-named-schedules.js +1 -1
- package/tools/v1/contracts/rate-cards/named-schedules/retrieve-rate-cards-contracts-v1-named-schedules.js.map +1 -1
- package/tools/v1/contracts/rate-cards/named-schedules/retrieve-rate-cards-contracts-v1-named-schedules.mjs +1 -1
- package/tools/v1/contracts/rate-cards/named-schedules/retrieve-rate-cards-contracts-v1-named-schedules.mjs.map +1 -1
- package/tools/v1/contracts/rate-cards/product-orders/set-rate-cards-contracts-v1-product-orders.js +1 -1
- package/tools/v1/contracts/rate-cards/product-orders/set-rate-cards-contracts-v1-product-orders.js.map +1 -1
- package/tools/v1/contracts/rate-cards/product-orders/set-rate-cards-contracts-v1-product-orders.mjs +1 -1
- package/tools/v1/contracts/rate-cards/product-orders/set-rate-cards-contracts-v1-product-orders.mjs.map +1 -1
- package/tools/v1/contracts/rate-cards/product-orders/update-rate-cards-contracts-v1-product-orders.js +1 -1
- package/tools/v1/contracts/rate-cards/product-orders/update-rate-cards-contracts-v1-product-orders.js.map +1 -1
- package/tools/v1/contracts/rate-cards/product-orders/update-rate-cards-contracts-v1-product-orders.mjs +1 -1
- package/tools/v1/contracts/rate-cards/product-orders/update-rate-cards-contracts-v1-product-orders.mjs.map +1 -1
- package/tools/v1/contracts/rate-cards/rates/add-many-rate-cards-contracts-v1-rates.d.mts.map +1 -1
- package/tools/v1/contracts/rate-cards/rates/add-many-rate-cards-contracts-v1-rates.d.ts.map +1 -1
- package/tools/v1/contracts/rate-cards/rates/add-many-rate-cards-contracts-v1-rates.js +24 -21
- package/tools/v1/contracts/rate-cards/rates/add-many-rate-cards-contracts-v1-rates.js.map +1 -1
- package/tools/v1/contracts/rate-cards/rates/add-many-rate-cards-contracts-v1-rates.mjs +24 -21
- package/tools/v1/contracts/rate-cards/rates/add-many-rate-cards-contracts-v1-rates.mjs.map +1 -1
- package/tools/v1/contracts/rate-cards/rates/add-rate-cards-contracts-v1-rates.d.mts.map +1 -1
- package/tools/v1/contracts/rate-cards/rates/add-rate-cards-contracts-v1-rates.d.ts.map +1 -1
- package/tools/v1/contracts/rate-cards/rates/add-rate-cards-contracts-v1-rates.js +24 -21
- package/tools/v1/contracts/rate-cards/rates/add-rate-cards-contracts-v1-rates.js.map +1 -1
- package/tools/v1/contracts/rate-cards/rates/add-rate-cards-contracts-v1-rates.mjs +24 -21
- package/tools/v1/contracts/rate-cards/rates/add-rate-cards-contracts-v1-rates.mjs.map +1 -1
- package/tools/v1/contracts/rate-cards/rates/list-rate-cards-contracts-v1-rates.js +1 -1
- package/tools/v1/contracts/rate-cards/rates/list-rate-cards-contracts-v1-rates.js.map +1 -1
- package/tools/v1/contracts/rate-cards/rates/list-rate-cards-contracts-v1-rates.mjs +1 -1
- package/tools/v1/contracts/rate-cards/rates/list-rate-cards-contracts-v1-rates.mjs.map +1 -1
- package/tools/v1/contracts/rate-cards/retrieve-contracts-v1-rate-cards.js +1 -1
- package/tools/v1/contracts/rate-cards/retrieve-contracts-v1-rate-cards.js.map +1 -1
- package/tools/v1/contracts/rate-cards/retrieve-contracts-v1-rate-cards.mjs +1 -1
- package/tools/v1/contracts/rate-cards/retrieve-contracts-v1-rate-cards.mjs.map +1 -1
- package/tools/v1/contracts/rate-cards/retrieve-rate-schedule-contracts-v1-rate-cards.js +1 -1
- package/tools/v1/contracts/rate-cards/retrieve-rate-schedule-contracts-v1-rate-cards.js.map +1 -1
- package/tools/v1/contracts/rate-cards/retrieve-rate-schedule-contracts-v1-rate-cards.mjs +1 -1
- package/tools/v1/contracts/rate-cards/retrieve-rate-schedule-contracts-v1-rate-cards.mjs.map +1 -1
- package/tools/v1/contracts/rate-cards/update-contracts-v1-rate-cards.js +1 -1
- package/tools/v1/contracts/rate-cards/update-contracts-v1-rate-cards.js.map +1 -1
- package/tools/v1/contracts/rate-cards/update-contracts-v1-rate-cards.mjs +1 -1
- package/tools/v1/contracts/rate-cards/update-contracts-v1-rate-cards.mjs.map +1 -1
- package/tools/v1/contracts/retrieve-rate-schedule-v1-contracts.js +1 -1
- package/tools/v1/contracts/retrieve-rate-schedule-v1-contracts.js.map +1 -1
- package/tools/v1/contracts/retrieve-rate-schedule-v1-contracts.mjs +1 -1
- package/tools/v1/contracts/retrieve-rate-schedule-v1-contracts.mjs.map +1 -1
- package/tools/v1/contracts/retrieve-subscription-quantity-history-v1-contracts.js +1 -1
- package/tools/v1/contracts/retrieve-subscription-quantity-history-v1-contracts.js.map +1 -1
- package/tools/v1/contracts/retrieve-subscription-quantity-history-v1-contracts.mjs +1 -1
- package/tools/v1/contracts/retrieve-subscription-quantity-history-v1-contracts.mjs.map +1 -1
- package/tools/v1/contracts/set-usage-filter-v1-contracts.d.mts.map +1 -1
- package/tools/v1/contracts/set-usage-filter-v1-contracts.d.ts.map +1 -1
- package/tools/v1/contracts/set-usage-filter-v1-contracts.js +1 -1
- package/tools/v1/contracts/set-usage-filter-v1-contracts.js.map +1 -1
- package/tools/v1/contracts/set-usage-filter-v1-contracts.mjs +1 -1
- package/tools/v1/contracts/set-usage-filter-v1-contracts.mjs.map +1 -1
- package/tools/v1/contracts/update-end-date-v1-contracts.js +1 -1
- package/tools/v1/contracts/update-end-date-v1-contracts.js.map +1 -1
- package/tools/v1/contracts/update-end-date-v1-contracts.mjs +1 -1
- package/tools/v1/contracts/update-end-date-v1-contracts.mjs.map +1 -1
- package/tools/v1/credit-grants/create-v1-credit-grants.js +1 -1
- package/tools/v1/credit-grants/create-v1-credit-grants.js.map +1 -1
- package/tools/v1/credit-grants/create-v1-credit-grants.mjs +1 -1
- package/tools/v1/credit-grants/create-v1-credit-grants.mjs.map +1 -1
- package/tools/v1/credit-grants/edit-v1-credit-grants.js +1 -1
- package/tools/v1/credit-grants/edit-v1-credit-grants.js.map +1 -1
- package/tools/v1/credit-grants/edit-v1-credit-grants.mjs +1 -1
- package/tools/v1/credit-grants/edit-v1-credit-grants.mjs.map +1 -1
- package/tools/v1/credit-grants/list-entries-v1-credit-grants.d.mts.map +1 -1
- package/tools/v1/credit-grants/list-entries-v1-credit-grants.d.ts.map +1 -1
- package/tools/v1/credit-grants/list-entries-v1-credit-grants.js +3 -2
- package/tools/v1/credit-grants/list-entries-v1-credit-grants.js.map +1 -1
- package/tools/v1/credit-grants/list-entries-v1-credit-grants.mjs +3 -2
- package/tools/v1/credit-grants/list-entries-v1-credit-grants.mjs.map +1 -1
- package/tools/v1/credit-grants/list-v1-credit-grants.js +1 -1
- package/tools/v1/credit-grants/list-v1-credit-grants.js.map +1 -1
- package/tools/v1/credit-grants/list-v1-credit-grants.mjs +1 -1
- package/tools/v1/credit-grants/list-v1-credit-grants.mjs.map +1 -1
- package/tools/v1/credit-grants/void-v1-credit-grants.js +1 -1
- package/tools/v1/credit-grants/void-v1-credit-grants.js.map +1 -1
- package/tools/v1/credit-grants/void-v1-credit-grants.mjs +1 -1
- package/tools/v1/credit-grants/void-v1-credit-grants.mjs.map +1 -1
- package/tools/v1/custom-fields/add-key-v1-custom-fields.js +1 -1
- package/tools/v1/custom-fields/add-key-v1-custom-fields.js.map +1 -1
- package/tools/v1/custom-fields/add-key-v1-custom-fields.mjs +1 -1
- package/tools/v1/custom-fields/add-key-v1-custom-fields.mjs.map +1 -1
- package/tools/v1/custom-fields/delete-values-v1-custom-fields.d.mts.map +1 -1
- package/tools/v1/custom-fields/delete-values-v1-custom-fields.d.ts.map +1 -1
- package/tools/v1/custom-fields/delete-values-v1-custom-fields.js +1 -1
- package/tools/v1/custom-fields/delete-values-v1-custom-fields.js.map +1 -1
- package/tools/v1/custom-fields/delete-values-v1-custom-fields.mjs +1 -1
- package/tools/v1/custom-fields/delete-values-v1-custom-fields.mjs.map +1 -1
- package/tools/v1/custom-fields/list-keys-v1-custom-fields.d.mts.map +1 -1
- package/tools/v1/custom-fields/list-keys-v1-custom-fields.d.ts.map +1 -1
- package/tools/v1/custom-fields/list-keys-v1-custom-fields.js +3 -2
- package/tools/v1/custom-fields/list-keys-v1-custom-fields.js.map +1 -1
- package/tools/v1/custom-fields/list-keys-v1-custom-fields.mjs +3 -2
- package/tools/v1/custom-fields/list-keys-v1-custom-fields.mjs.map +1 -1
- package/tools/v1/custom-fields/remove-key-v1-custom-fields.d.mts.map +1 -1
- package/tools/v1/custom-fields/remove-key-v1-custom-fields.d.ts.map +1 -1
- package/tools/v1/custom-fields/remove-key-v1-custom-fields.js +1 -1
- package/tools/v1/custom-fields/remove-key-v1-custom-fields.js.map +1 -1
- package/tools/v1/custom-fields/remove-key-v1-custom-fields.mjs +1 -1
- package/tools/v1/custom-fields/remove-key-v1-custom-fields.mjs.map +1 -1
- package/tools/v1/custom-fields/set-values-v1-custom-fields.d.mts.map +1 -1
- package/tools/v1/custom-fields/set-values-v1-custom-fields.d.ts.map +1 -1
- package/tools/v1/custom-fields/set-values-v1-custom-fields.js +2 -1
- package/tools/v1/custom-fields/set-values-v1-custom-fields.js.map +1 -1
- package/tools/v1/custom-fields/set-values-v1-custom-fields.mjs +2 -1
- package/tools/v1/custom-fields/set-values-v1-custom-fields.mjs.map +1 -1
- package/tools/v1/customers/alerts/list-customers-v1-alerts.d.mts.map +1 -1
- package/tools/v1/customers/alerts/list-customers-v1-alerts.d.ts.map +1 -1
- package/tools/v1/customers/alerts/list-customers-v1-alerts.js +4 -3
- package/tools/v1/customers/alerts/list-customers-v1-alerts.js.map +1 -1
- package/tools/v1/customers/alerts/list-customers-v1-alerts.mjs +4 -3
- package/tools/v1/customers/alerts/list-customers-v1-alerts.mjs.map +1 -1
- package/tools/v1/customers/alerts/reset-customers-v1-alerts.d.mts.map +1 -1
- package/tools/v1/customers/alerts/reset-customers-v1-alerts.d.ts.map +1 -1
- package/tools/v1/customers/alerts/reset-customers-v1-alerts.js +2 -2
- package/tools/v1/customers/alerts/reset-customers-v1-alerts.js.map +1 -1
- package/tools/v1/customers/alerts/reset-customers-v1-alerts.mjs +2 -2
- package/tools/v1/customers/alerts/reset-customers-v1-alerts.mjs.map +1 -1
- package/tools/v1/customers/alerts/retrieve-customers-v1-alerts.d.mts.map +1 -1
- package/tools/v1/customers/alerts/retrieve-customers-v1-alerts.d.ts.map +1 -1
- package/tools/v1/customers/alerts/retrieve-customers-v1-alerts.js +22 -11
- package/tools/v1/customers/alerts/retrieve-customers-v1-alerts.js.map +1 -1
- package/tools/v1/customers/alerts/retrieve-customers-v1-alerts.mjs +22 -11
- package/tools/v1/customers/alerts/retrieve-customers-v1-alerts.mjs.map +1 -1
- package/tools/v1/customers/archive-v1-customers.js +1 -1
- package/tools/v1/customers/archive-v1-customers.js.map +1 -1
- package/tools/v1/customers/archive-v1-customers.mjs +1 -1
- package/tools/v1/customers/archive-v1-customers.mjs.map +1 -1
- package/tools/v1/customers/billing-config/create-customers-v1-billing-config.d.mts.map +1 -1
- package/tools/v1/customers/billing-config/create-customers-v1-billing-config.d.ts.map +1 -1
- package/tools/v1/customers/billing-config/create-customers-v1-billing-config.js +6 -1
- package/tools/v1/customers/billing-config/create-customers-v1-billing-config.js.map +1 -1
- package/tools/v1/customers/billing-config/create-customers-v1-billing-config.mjs +6 -1
- package/tools/v1/customers/billing-config/create-customers-v1-billing-config.mjs.map +1 -1
- package/tools/v1/customers/billing-config/retrieve-customers-v1-billing-config.js +1 -1
- package/tools/v1/customers/billing-config/retrieve-customers-v1-billing-config.js.map +1 -1
- package/tools/v1/customers/billing-config/retrieve-customers-v1-billing-config.mjs +1 -1
- package/tools/v1/customers/billing-config/retrieve-customers-v1-billing-config.mjs.map +1 -1
- package/tools/v1/customers/commits/create-customers-v1-commits.d.mts.map +1 -1
- package/tools/v1/customers/commits/create-customers-v1-commits.d.ts.map +1 -1
- package/tools/v1/customers/commits/create-customers-v1-commits.js +31 -31
- package/tools/v1/customers/commits/create-customers-v1-commits.js.map +1 -1
- package/tools/v1/customers/commits/create-customers-v1-commits.mjs +31 -31
- package/tools/v1/customers/commits/create-customers-v1-commits.mjs.map +1 -1
- package/tools/v1/customers/commits/list-customers-v1-commits.d.mts.map +1 -1
- package/tools/v1/customers/commits/list-customers-v1-commits.d.ts.map +1 -1
- package/tools/v1/customers/commits/list-customers-v1-commits.js +3 -2
- package/tools/v1/customers/commits/list-customers-v1-commits.js.map +1 -1
- package/tools/v1/customers/commits/list-customers-v1-commits.mjs +3 -2
- package/tools/v1/customers/commits/list-customers-v1-commits.mjs.map +1 -1
- package/tools/v1/customers/commits/update-end-date-customers-v1-commits.js +1 -1
- package/tools/v1/customers/commits/update-end-date-customers-v1-commits.js.map +1 -1
- package/tools/v1/customers/commits/update-end-date-customers-v1-commits.mjs +1 -1
- package/tools/v1/customers/commits/update-end-date-customers-v1-commits.mjs.map +1 -1
- package/tools/v1/customers/create-v1-customers.d.mts.map +1 -1
- package/tools/v1/customers/create-v1-customers.d.ts.map +1 -1
- package/tools/v1/customers/create-v1-customers.js +13 -2
- package/tools/v1/customers/create-v1-customers.js.map +1 -1
- package/tools/v1/customers/create-v1-customers.mjs +13 -2
- package/tools/v1/customers/create-v1-customers.mjs.map +1 -1
- package/tools/v1/customers/credits/create-customers-v1-credits.d.mts.map +1 -1
- package/tools/v1/customers/credits/create-customers-v1-credits.d.ts.map +1 -1
- package/tools/v1/customers/credits/create-customers-v1-credits.js +29 -23
- package/tools/v1/customers/credits/create-customers-v1-credits.js.map +1 -1
- package/tools/v1/customers/credits/create-customers-v1-credits.mjs +29 -23
- package/tools/v1/customers/credits/create-customers-v1-credits.mjs.map +1 -1
- package/tools/v1/customers/credits/list-customers-v1-credits.d.mts.map +1 -1
- package/tools/v1/customers/credits/list-customers-v1-credits.d.ts.map +1 -1
- package/tools/v1/customers/credits/list-customers-v1-credits.js +3 -2
- package/tools/v1/customers/credits/list-customers-v1-credits.js.map +1 -1
- package/tools/v1/customers/credits/list-customers-v1-credits.mjs +3 -2
- package/tools/v1/customers/credits/list-customers-v1-credits.mjs.map +1 -1
- package/tools/v1/customers/credits/update-end-date-customers-v1-credits.js +1 -1
- package/tools/v1/customers/credits/update-end-date-customers-v1-credits.js.map +1 -1
- package/tools/v1/customers/credits/update-end-date-customers-v1-credits.mjs +1 -1
- package/tools/v1/customers/credits/update-end-date-customers-v1-credits.mjs.map +1 -1
- package/tools/v1/customers/invoices/add-charge-customers-v1-invoices.js +1 -1
- package/tools/v1/customers/invoices/add-charge-customers-v1-invoices.js.map +1 -1
- package/tools/v1/customers/invoices/add-charge-customers-v1-invoices.mjs +1 -1
- package/tools/v1/customers/invoices/add-charge-customers-v1-invoices.mjs.map +1 -1
- package/tools/v1/customers/invoices/list-breakdowns-customers-v1-invoices.js +1 -1
- package/tools/v1/customers/invoices/list-breakdowns-customers-v1-invoices.js.map +1 -1
- package/tools/v1/customers/invoices/list-breakdowns-customers-v1-invoices.mjs +1 -1
- package/tools/v1/customers/invoices/list-breakdowns-customers-v1-invoices.mjs.map +1 -1
- package/tools/v1/customers/invoices/list-customers-v1-invoices.js +1 -1
- package/tools/v1/customers/invoices/list-customers-v1-invoices.js.map +1 -1
- package/tools/v1/customers/invoices/list-customers-v1-invoices.mjs +1 -1
- package/tools/v1/customers/invoices/list-customers-v1-invoices.mjs.map +1 -1
- package/tools/v1/customers/invoices/retrieve-customers-v1-invoices.d.mts.map +1 -1
- package/tools/v1/customers/invoices/retrieve-customers-v1-invoices.d.ts.map +1 -1
- package/tools/v1/customers/invoices/retrieve-customers-v1-invoices.js +1 -1
- package/tools/v1/customers/invoices/retrieve-customers-v1-invoices.js.map +1 -1
- package/tools/v1/customers/invoices/retrieve-customers-v1-invoices.mjs +1 -1
- package/tools/v1/customers/invoices/retrieve-customers-v1-invoices.mjs.map +1 -1
- package/tools/v1/customers/invoices/retrieve-pdf-customers-v1-invoices.d.mts +45 -0
- package/tools/v1/customers/invoices/retrieve-pdf-customers-v1-invoices.d.mts.map +1 -0
- package/tools/v1/customers/invoices/retrieve-pdf-customers-v1-invoices.d.ts +45 -0
- package/tools/v1/customers/invoices/retrieve-pdf-customers-v1-invoices.d.ts.map +1 -0
- package/tools/v1/customers/invoices/retrieve-pdf-customers-v1-invoices.js +39 -0
- package/tools/v1/customers/invoices/retrieve-pdf-customers-v1-invoices.js.map +1 -0
- package/tools/v1/customers/invoices/retrieve-pdf-customers-v1-invoices.mjs +35 -0
- package/tools/v1/customers/invoices/retrieve-pdf-customers-v1-invoices.mjs.map +1 -0
- package/tools/v1/customers/list-billable-metrics-v1-customers.js +1 -1
- package/tools/v1/customers/list-billable-metrics-v1-customers.js.map +1 -1
- package/tools/v1/customers/list-billable-metrics-v1-customers.mjs +1 -1
- package/tools/v1/customers/list-billable-metrics-v1-customers.mjs.map +1 -1
- package/tools/v1/customers/list-costs-v1-customers.js +1 -1
- package/tools/v1/customers/list-costs-v1-customers.js.map +1 -1
- package/tools/v1/customers/list-costs-v1-customers.mjs +1 -1
- package/tools/v1/customers/list-costs-v1-customers.mjs.map +1 -1
- package/tools/v1/customers/list-v1-customers.js +1 -1
- package/tools/v1/customers/list-v1-customers.js.map +1 -1
- package/tools/v1/customers/list-v1-customers.mjs +1 -1
- package/tools/v1/customers/list-v1-customers.mjs.map +1 -1
- package/tools/v1/customers/named-schedules/retrieve-customers-v1-named-schedules.js +1 -1
- package/tools/v1/customers/named-schedules/retrieve-customers-v1-named-schedules.js.map +1 -1
- package/tools/v1/customers/named-schedules/retrieve-customers-v1-named-schedules.mjs +1 -1
- package/tools/v1/customers/named-schedules/retrieve-customers-v1-named-schedules.mjs.map +1 -1
- package/tools/v1/customers/plans/add-customers-v1-plans.js +1 -1
- package/tools/v1/customers/plans/add-customers-v1-plans.js.map +1 -1
- package/tools/v1/customers/plans/add-customers-v1-plans.mjs +1 -1
- package/tools/v1/customers/plans/add-customers-v1-plans.mjs.map +1 -1
- package/tools/v1/customers/plans/end-customers-v1-plans.js +1 -1
- package/tools/v1/customers/plans/end-customers-v1-plans.js.map +1 -1
- package/tools/v1/customers/plans/end-customers-v1-plans.mjs +1 -1
- package/tools/v1/customers/plans/end-customers-v1-plans.mjs.map +1 -1
- package/tools/v1/customers/plans/list-customers-v1-plans.js +1 -1
- package/tools/v1/customers/plans/list-customers-v1-plans.js.map +1 -1
- package/tools/v1/customers/plans/list-customers-v1-plans.mjs +1 -1
- package/tools/v1/customers/plans/list-customers-v1-plans.mjs.map +1 -1
- package/tools/v1/customers/plans/list-price-adjustments-customers-v1-plans.js +1 -1
- package/tools/v1/customers/plans/list-price-adjustments-customers-v1-plans.js.map +1 -1
- package/tools/v1/customers/plans/list-price-adjustments-customers-v1-plans.mjs +1 -1
- package/tools/v1/customers/plans/list-price-adjustments-customers-v1-plans.mjs.map +1 -1
- package/tools/v1/customers/preview-events-v1-customers.d.mts.map +1 -1
- package/tools/v1/customers/preview-events-v1-customers.d.ts.map +1 -1
- package/tools/v1/customers/preview-events-v1-customers.js +2 -6
- package/tools/v1/customers/preview-events-v1-customers.js.map +1 -1
- package/tools/v1/customers/preview-events-v1-customers.mjs +2 -6
- package/tools/v1/customers/preview-events-v1-customers.mjs.map +1 -1
- package/tools/v1/customers/retrieve-billing-configurations-v1-customers.d.mts +45 -0
- package/tools/v1/customers/retrieve-billing-configurations-v1-customers.d.mts.map +1 -0
- package/tools/v1/customers/retrieve-billing-configurations-v1-customers.d.ts +45 -0
- package/tools/v1/customers/retrieve-billing-configurations-v1-customers.d.ts.map +1 -0
- package/tools/v1/customers/retrieve-billing-configurations-v1-customers.js +43 -0
- package/tools/v1/customers/retrieve-billing-configurations-v1-customers.js.map +1 -0
- package/tools/v1/customers/retrieve-billing-configurations-v1-customers.mjs +39 -0
- package/tools/v1/customers/retrieve-billing-configurations-v1-customers.mjs.map +1 -0
- package/tools/v1/customers/retrieve-v1-customers.js +1 -1
- package/tools/v1/customers/retrieve-v1-customers.js.map +1 -1
- package/tools/v1/customers/retrieve-v1-customers.mjs +1 -1
- package/tools/v1/customers/retrieve-v1-customers.mjs.map +1 -1
- package/tools/v1/customers/set-billing-configurations-v1-customers.d.mts +45 -0
- package/tools/v1/customers/set-billing-configurations-v1-customers.d.mts.map +1 -0
- package/tools/v1/customers/set-billing-configurations-v1-customers.d.ts +45 -0
- package/tools/v1/customers/set-billing-configurations-v1-customers.d.ts.map +1 -0
- package/tools/v1/customers/set-billing-configurations-v1-customers.js +77 -0
- package/tools/v1/customers/set-billing-configurations-v1-customers.js.map +1 -0
- package/tools/v1/customers/set-billing-configurations-v1-customers.mjs +73 -0
- package/tools/v1/customers/set-billing-configurations-v1-customers.mjs.map +1 -0
- package/tools/v1/customers/set-ingest-aliases-v1-customers.js +1 -1
- package/tools/v1/customers/set-ingest-aliases-v1-customers.js.map +1 -1
- package/tools/v1/customers/set-ingest-aliases-v1-customers.mjs +1 -1
- package/tools/v1/customers/set-ingest-aliases-v1-customers.mjs.map +1 -1
- package/tools/v1/customers/set-name-v1-customers.js +1 -1
- package/tools/v1/customers/set-name-v1-customers.js.map +1 -1
- package/tools/v1/customers/set-name-v1-customers.mjs +1 -1
- package/tools/v1/customers/set-name-v1-customers.mjs.map +1 -1
- package/tools/v1/customers/update-config-v1-customers.d.mts.map +1 -1
- package/tools/v1/customers/update-config-v1-customers.d.ts.map +1 -1
- package/tools/v1/customers/update-config-v1-customers.js +1 -1
- package/tools/v1/customers/update-config-v1-customers.js.map +1 -1
- package/tools/v1/customers/update-config-v1-customers.mjs +1 -1
- package/tools/v1/customers/update-config-v1-customers.mjs.map +1 -1
- package/tools/v1/dashboards/get-embeddable-url-v1-dashboards.js +1 -1
- package/tools/v1/dashboards/get-embeddable-url-v1-dashboards.js.map +1 -1
- package/tools/v1/dashboards/get-embeddable-url-v1-dashboards.mjs +1 -1
- package/tools/v1/dashboards/get-embeddable-url-v1-dashboards.mjs.map +1 -1
- package/tools/v1/invoices/regenerate-v1-invoices.js +1 -1
- package/tools/v1/invoices/regenerate-v1-invoices.js.map +1 -1
- package/tools/v1/invoices/regenerate-v1-invoices.mjs +1 -1
- package/tools/v1/invoices/regenerate-v1-invoices.mjs.map +1 -1
- package/tools/v1/invoices/void-v1-invoices.js +1 -1
- package/tools/v1/invoices/void-v1-invoices.js.map +1 -1
- package/tools/v1/invoices/void-v1-invoices.mjs +1 -1
- package/tools/v1/invoices/void-v1-invoices.mjs.map +1 -1
- package/tools/v1/payments/attempt-v1-payments.d.mts +45 -0
- package/tools/v1/payments/attempt-v1-payments.d.mts.map +1 -0
- package/tools/v1/payments/attempt-v1-payments.d.ts +45 -0
- package/tools/v1/payments/attempt-v1-payments.d.ts.map +1 -0
- package/tools/v1/payments/attempt-v1-payments.js +43 -0
- package/tools/v1/payments/attempt-v1-payments.js.map +1 -0
- package/tools/v1/payments/attempt-v1-payments.mjs +39 -0
- package/tools/v1/payments/attempt-v1-payments.mjs.map +1 -0
- package/tools/v1/payments/cancel-v1-payments.d.mts +45 -0
- package/tools/v1/payments/cancel-v1-payments.d.mts.map +1 -0
- package/tools/v1/payments/cancel-v1-payments.d.ts +45 -0
- package/tools/v1/payments/cancel-v1-payments.d.ts.map +1 -0
- package/tools/v1/payments/cancel-v1-payments.js +43 -0
- package/tools/v1/payments/cancel-v1-payments.js.map +1 -0
- package/tools/v1/payments/cancel-v1-payments.mjs +39 -0
- package/tools/v1/payments/cancel-v1-payments.mjs.map +1 -0
- package/tools/v1/payments/list-v1-payments.d.mts +45 -0
- package/tools/v1/payments/list-v1-payments.d.mts.map +1 -0
- package/tools/v1/payments/list-v1-payments.d.ts +45 -0
- package/tools/v1/payments/list-v1-payments.d.ts.map +1 -0
- package/tools/v1/payments/list-v1-payments.js +64 -0
- package/tools/v1/payments/list-v1-payments.js.map +1 -0
- package/tools/v1/payments/list-v1-payments.mjs +60 -0
- package/tools/v1/payments/list-v1-payments.mjs.map +1 -0
- package/tools/v1/plans/get-details-v1-plans.js +1 -1
- package/tools/v1/plans/get-details-v1-plans.js.map +1 -1
- package/tools/v1/plans/get-details-v1-plans.mjs +1 -1
- package/tools/v1/plans/get-details-v1-plans.mjs.map +1 -1
- package/tools/v1/plans/list-charges-v1-plans.js +1 -1
- package/tools/v1/plans/list-charges-v1-plans.js.map +1 -1
- package/tools/v1/plans/list-charges-v1-plans.mjs +1 -1
- package/tools/v1/plans/list-charges-v1-plans.mjs.map +1 -1
- package/tools/v1/plans/list-customers-v1-plans.js +1 -1
- package/tools/v1/plans/list-customers-v1-plans.js.map +1 -1
- package/tools/v1/plans/list-customers-v1-plans.mjs +1 -1
- package/tools/v1/plans/list-customers-v1-plans.mjs.map +1 -1
- package/tools/v1/plans/list-v1-plans.js +1 -1
- package/tools/v1/plans/list-v1-plans.js.map +1 -1
- package/tools/v1/plans/list-v1-plans.mjs +1 -1
- package/tools/v1/plans/list-v1-plans.mjs.map +1 -1
- package/tools/v1/pricing-units/list-v1-pricing-units.js +1 -1
- package/tools/v1/pricing-units/list-v1-pricing-units.js.map +1 -1
- package/tools/v1/pricing-units/list-v1-pricing-units.mjs +1 -1
- package/tools/v1/pricing-units/list-v1-pricing-units.mjs.map +1 -1
- package/tools/v1/services/list-v1-services.js +1 -1
- package/tools/v1/services/list-v1-services.js.map +1 -1
- package/tools/v1/services/list-v1-services.mjs +1 -1
- package/tools/v1/services/list-v1-services.mjs.map +1 -1
- package/tools/v1/usage/ingest-v1-usage.js +2 -2
- package/tools/v1/usage/ingest-v1-usage.js.map +1 -1
- package/tools/v1/usage/ingest-v1-usage.mjs +2 -2
- package/tools/v1/usage/ingest-v1-usage.mjs.map +1 -1
- package/tools/v1/usage/list-v1-usage.d.mts.map +1 -1
- package/tools/v1/usage/list-v1-usage.d.ts.map +1 -1
- package/tools/v1/usage/list-v1-usage.js +3 -2
- package/tools/v1/usage/list-v1-usage.js.map +1 -1
- package/tools/v1/usage/list-v1-usage.mjs +3 -2
- package/tools/v1/usage/list-v1-usage.mjs.map +1 -1
- package/tools/v1/usage/list-with-groups-v1-usage.js +1 -1
- package/tools/v1/usage/list-with-groups-v1-usage.js.map +1 -1
- package/tools/v1/usage/list-with-groups-v1-usage.mjs +1 -1
- package/tools/v1/usage/list-with-groups-v1-usage.mjs.map +1 -1
- package/tools/v1/usage/search-v1-usage.js +1 -1
- package/tools/v1/usage/search-v1-usage.js.map +1 -1
- package/tools/v1/usage/search-v1-usage.mjs +1 -1
- package/tools/v1/usage/search-v1-usage.mjs.map +1 -1
- package/tools/v2/contracts/edit-commit-v2-contracts.d.mts.map +1 -1
- package/tools/v2/contracts/edit-commit-v2-contracts.d.ts.map +1 -1
- package/tools/v2/contracts/edit-commit-v2-contracts.js +82 -23
- package/tools/v2/contracts/edit-commit-v2-contracts.js.map +1 -1
- package/tools/v2/contracts/edit-commit-v2-contracts.mjs +82 -23
- package/tools/v2/contracts/edit-commit-v2-contracts.mjs.map +1 -1
- package/tools/v2/contracts/edit-credit-v2-contracts.d.mts.map +1 -1
- package/tools/v2/contracts/edit-credit-v2-contracts.d.ts.map +1 -1
- package/tools/v2/contracts/edit-credit-v2-contracts.js +82 -23
- package/tools/v2/contracts/edit-credit-v2-contracts.js.map +1 -1
- package/tools/v2/contracts/edit-credit-v2-contracts.mjs +82 -23
- package/tools/v2/contracts/edit-credit-v2-contracts.mjs.map +1 -1
- package/tools/v2/contracts/edit-v2-contracts.d.mts.map +1 -1
- package/tools/v2/contracts/edit-v2-contracts.d.ts.map +1 -1
- package/tools/v2/contracts/edit-v2-contracts.js +303 -741
- package/tools/v2/contracts/edit-v2-contracts.js.map +1 -1
- package/tools/v2/contracts/edit-v2-contracts.mjs +303 -741
- package/tools/v2/contracts/edit-v2-contracts.mjs.map +1 -1
- package/tools/v2/contracts/get-edit-history-v2-contracts.js +1 -1
- package/tools/v2/contracts/get-edit-history-v2-contracts.js.map +1 -1
- package/tools/v2/contracts/get-edit-history-v2-contracts.mjs +1 -1
- package/tools/v2/contracts/get-edit-history-v2-contracts.mjs.map +1 -1
- package/tools/v2/contracts/list-v2-contracts.js +1 -1
- package/tools/v2/contracts/list-v2-contracts.js.map +1 -1
- package/tools/v2/contracts/list-v2-contracts.mjs +1 -1
- package/tools/v2/contracts/list-v2-contracts.mjs.map +1 -1
- package/tools/v2/contracts/retrieve-v2-contracts.d.mts.map +1 -1
- package/tools/v2/contracts/retrieve-v2-contracts.d.ts.map +1 -1
- package/tools/v2/contracts/retrieve-v2-contracts.js +1 -1
- package/tools/v2/contracts/retrieve-v2-contracts.js.map +1 -1
- package/tools/v2/contracts/retrieve-v2-contracts.mjs +1 -1
- package/tools/v2/contracts/retrieve-v2-contracts.mjs.map +1 -1
|
@@ -10,7 +10,7 @@ export const metadata = {
|
|
|
10
10
|
};
|
|
11
11
|
export const tool = {
|
|
12
12
|
name: 'create_v1_contracts',
|
|
13
|
-
description: '
|
|
13
|
+
description: "Contracts define a customer's products, pricing, discounts, access duration, and billing configuration. Contracts serve as the central billing agreement for both PLG and Enterprise customers, you can automatically customers access to your products and services directly from your product or CRM.\n\n### Use this endpoint to:\n- PLG onboarding: Automatically provision new self-serve customers with contracts when they sign up.\n- Enterprise sales: Push negotiated contracts from Salesforce with custom pricing and commitments\n- Promotional pricing: Implement time-limited discounts and free trials through overrides\n\n### Key components:\n#### Contract Term and Billing Schedule\n- Set contract duration using `starting_at` and `ending_before` fields. PLG contracts typically use perpetual agreements (no end date), while Enterprise contracts have fixed end dates which can be edited over time in the case of co-term upsells.\n\n#### Rate Card\nIf you are offering usage based pricing, you can set a rate card for the contract to reference through `rate_card_id` or `rate_card_alias`. The rate card is a store of all of your usage based products and their centralized pricing. Any new products or price changes on the rate card can be set to automatically propagate to all associated contracts - this ensures consistent pricing and product launches flow to contracts without manual updates and migrations. The `usage_statement_schedule` determines the cadence on which Metronome will finalize a usage invoice for the customer. This defaults to monthly on the 1st, with options for custom dates, quarterly, or annual cadences. Note: Most usage based billing companies align usage statements to be evaluated aligned to the first of the month.\nRead more about [Rate Cards](https://docs.metronome.com/pricing-packaging/create-manage-rate-cards/).\n\n#### Overrides and discounts\nCustomize pricing on the contract through time-bounded overrides that can target specific products, product families, or complex usage scenarios. Overrides enable two key capabilities:\n- Discounts: Apply percentage discounts, fixed rate reductions, or quantity-based pricing tiers\n- Entitlements: Provide special pricing or access to specific products for negotiated deals\n\nRead more about [Contract Overrides](https://docs.metronome.com/manage-product-access/add-contract-override/).\n\n#### Commits and Credits\nUsing commits, configure prepaid or postpaid spending commitments where customers promise to spend a certain amount over the contract period paid in advance or in arrears. Use credits to provide free spending allowances. Under the hood these are the same mechanisms, however, credits are typically offered for free (SLA or promotional) or as a part of an allotment associated with a Subscription.\n\nIn Metronome, you can set commits and credits to only be applicable for a subset of usage. Use `applicable_product_ids` or `applicable_product_tags` to create product or product-family specific commits or credits, or you can build complex boolean logic specifiers to target usage based on pricing and presentation group values using `override_specifiers`.\n\nThese objects can also also be configured to have a recurrence schedule to easily model customer packaging which includes recurring monthly or quarterly allotments.\n\nCommits support rollover settings (`rollover_fraction`) to transfer unused balances between contract periods, either entirely or as a percentage.\n\nRead more about [Credits and Commits](https://docs.metronome.com/pricing-packaging/apply-credits-commits/).\n\n#### Subscriptions\nYou can add a fixed recurring charge to a contract, like monthly licenses or seat-based fees, using the subscription charge. Subscription charges are defined on your rate card and you can select which subscription is applicable to add to each contract. When you add a subscription to a contract you need to:\n- Define whether the subscription is paid for in-advance or in-arrears (`collection_schedule`)\n- Define the proration behavior (`proration`)\n- Specify an initial quantity (`initial_quantity`)\n- Define which subscription rate on the rate card should be used (`subscription_rate`)\n\nRead more about [Subscriptions](https://docs.metronome.com/manage-product-access/create-subscription/).\n\n#### Scheduled Charges\nSet up one-time, recurring, or entirely custom charges that occur on specific dates, separate from usage-based billing or commitments. These can be used to model non-recurring platform charges or professional services.\n\n#### Threshold Billing\nMetronome allows you to configure automatic billing triggers when customers reach spending thresholds to prevent fraud and manage risk. You can use `spend_threshold_configuration` to trigger an invoice to cover current charges whenever the threshold is reached or you can ensure the customer maintains a minimum prepaid balance using the `prepaid_balance_configuration`.\n\nRead more about [Spend Threshold](https://docs.metronome.com/manage-product-access/spend-thresholds/) and [Prepaid Balance Thresholds](https://docs.metronome.com/manage-product-access/prepaid-balance-thresholds/).\n\n### Usage guidelines:\n- You can always [Edit Contracts](https://docs.metronome.com/manage-product-access/edit-contract/) after it has been created, using the `editContract` endpoint. Metronome keeps track of all edits, both in the audit log and over the `getEditHistory` endpoint.\n- Customers in Metronome can have multiple concurrent contracts at one time. Use `usage_filters` to route the correct usage to each contract. [Read more about usage filters](https://docs.metronome.com/manage-product-access/provision-customer/#create-a-usage-filter).\n",
|
|
14
14
|
inputSchema: {
|
|
15
15
|
type: 'object',
|
|
16
16
|
properties: {
|
|
@@ -107,6 +107,7 @@ export const tool = {
|
|
|
107
107
|
},
|
|
108
108
|
custom_fields: {
|
|
109
109
|
type: 'object',
|
|
110
|
+
description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
|
|
110
111
|
additionalProperties: true,
|
|
111
112
|
},
|
|
112
113
|
description: {
|
|
@@ -114,51 +115,7 @@ export const tool = {
|
|
|
114
115
|
description: 'Used only in UI/API. It is not exposed to end customers.',
|
|
115
116
|
},
|
|
116
117
|
hierarchy_configuration: {
|
|
117
|
-
|
|
118
|
-
description: 'Optional configuration for commit hierarchy access control',
|
|
119
|
-
properties: {
|
|
120
|
-
child_access: {
|
|
121
|
-
anyOf: [
|
|
122
|
-
{
|
|
123
|
-
type: 'object',
|
|
124
|
-
properties: {
|
|
125
|
-
type: {
|
|
126
|
-
type: 'string',
|
|
127
|
-
enum: ['ALL'],
|
|
128
|
-
},
|
|
129
|
-
},
|
|
130
|
-
required: ['type'],
|
|
131
|
-
},
|
|
132
|
-
{
|
|
133
|
-
type: 'object',
|
|
134
|
-
properties: {
|
|
135
|
-
type: {
|
|
136
|
-
type: 'string',
|
|
137
|
-
enum: ['NONE'],
|
|
138
|
-
},
|
|
139
|
-
},
|
|
140
|
-
required: ['type'],
|
|
141
|
-
},
|
|
142
|
-
{
|
|
143
|
-
type: 'object',
|
|
144
|
-
properties: {
|
|
145
|
-
contract_ids: {
|
|
146
|
-
type: 'array',
|
|
147
|
-
items: {
|
|
148
|
-
type: 'string',
|
|
149
|
-
},
|
|
150
|
-
},
|
|
151
|
-
type: {
|
|
152
|
-
type: 'string',
|
|
153
|
-
enum: ['CONTRACT_IDS'],
|
|
154
|
-
},
|
|
155
|
-
},
|
|
156
|
-
required: ['contract_ids', 'type'],
|
|
157
|
-
},
|
|
158
|
-
],
|
|
159
|
-
},
|
|
160
|
-
},
|
|
161
|
-
required: ['child_access'],
|
|
118
|
+
$ref: '#/$defs/commit_hierarchy_configuration',
|
|
162
119
|
},
|
|
163
120
|
invoice_schedule: {
|
|
164
121
|
type: 'object',
|
|
@@ -294,7 +251,7 @@ export const tool = {
|
|
|
294
251
|
tax_type: {
|
|
295
252
|
type: 'string',
|
|
296
253
|
description: 'Stripe tax is only supported for Stripe payment gateway. Select NONE if you do not wish Metronome to calculate tax on your behalf. Leaving this field blank will default to NONE.',
|
|
297
|
-
enum: ['NONE', 'STRIPE', 'ANROK', 'PRECALCULATED'],
|
|
254
|
+
enum: ['NONE', 'STRIPE', 'ANROK', 'AVALARA', 'PRECALCULATED'],
|
|
298
255
|
},
|
|
299
256
|
},
|
|
300
257
|
required: ['payment_gate_type'],
|
|
@@ -315,28 +272,7 @@ export const tool = {
|
|
|
315
272
|
type: 'array',
|
|
316
273
|
description: "List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown. This field cannot be used together with `applicable_product_ids` or `applicable_product_tags`.",
|
|
317
274
|
items: {
|
|
318
|
-
|
|
319
|
-
properties: {
|
|
320
|
-
presentation_group_values: {
|
|
321
|
-
type: 'object',
|
|
322
|
-
additionalProperties: true,
|
|
323
|
-
},
|
|
324
|
-
pricing_group_values: {
|
|
325
|
-
type: 'object',
|
|
326
|
-
additionalProperties: true,
|
|
327
|
-
},
|
|
328
|
-
product_id: {
|
|
329
|
-
type: 'string',
|
|
330
|
-
description: 'If provided, the specifier will only apply to the product with the specified ID.',
|
|
331
|
-
},
|
|
332
|
-
product_tags: {
|
|
333
|
-
type: 'array',
|
|
334
|
-
description: 'If provided, the specifier will only apply to products with all the specified tags.',
|
|
335
|
-
items: {
|
|
336
|
-
type: 'string',
|
|
337
|
-
},
|
|
338
|
-
},
|
|
339
|
-
},
|
|
275
|
+
$ref: '#/$defs/commit_specifier_input',
|
|
340
276
|
},
|
|
341
277
|
},
|
|
342
278
|
temporary_id: {
|
|
@@ -404,6 +340,7 @@ export const tool = {
|
|
|
404
340
|
},
|
|
405
341
|
custom_fields: {
|
|
406
342
|
type: 'object',
|
|
343
|
+
description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
|
|
407
344
|
additionalProperties: true,
|
|
408
345
|
},
|
|
409
346
|
description: {
|
|
@@ -411,51 +348,7 @@ export const tool = {
|
|
|
411
348
|
description: 'Used only in UI/API. It is not exposed to end customers.',
|
|
412
349
|
},
|
|
413
350
|
hierarchy_configuration: {
|
|
414
|
-
|
|
415
|
-
description: 'Optional configuration for credit hierarchy access control',
|
|
416
|
-
properties: {
|
|
417
|
-
child_access: {
|
|
418
|
-
anyOf: [
|
|
419
|
-
{
|
|
420
|
-
type: 'object',
|
|
421
|
-
properties: {
|
|
422
|
-
type: {
|
|
423
|
-
type: 'string',
|
|
424
|
-
enum: ['ALL'],
|
|
425
|
-
},
|
|
426
|
-
},
|
|
427
|
-
required: ['type'],
|
|
428
|
-
},
|
|
429
|
-
{
|
|
430
|
-
type: 'object',
|
|
431
|
-
properties: {
|
|
432
|
-
type: {
|
|
433
|
-
type: 'string',
|
|
434
|
-
enum: ['NONE'],
|
|
435
|
-
},
|
|
436
|
-
},
|
|
437
|
-
required: ['type'],
|
|
438
|
-
},
|
|
439
|
-
{
|
|
440
|
-
type: 'object',
|
|
441
|
-
properties: {
|
|
442
|
-
contract_ids: {
|
|
443
|
-
type: 'array',
|
|
444
|
-
items: {
|
|
445
|
-
type: 'string',
|
|
446
|
-
},
|
|
447
|
-
},
|
|
448
|
-
type: {
|
|
449
|
-
type: 'string',
|
|
450
|
-
enum: ['CONTRACT_IDS'],
|
|
451
|
-
},
|
|
452
|
-
},
|
|
453
|
-
required: ['contract_ids', 'type'],
|
|
454
|
-
},
|
|
455
|
-
],
|
|
456
|
-
},
|
|
457
|
-
},
|
|
458
|
-
required: ['child_access'],
|
|
351
|
+
$ref: '#/$defs/commit_hierarchy_configuration',
|
|
459
352
|
},
|
|
460
353
|
name: {
|
|
461
354
|
type: 'string',
|
|
@@ -477,28 +370,7 @@ export const tool = {
|
|
|
477
370
|
type: 'array',
|
|
478
371
|
description: "List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown. This field cannot be used together with `applicable_product_ids` or `applicable_product_tags`.",
|
|
479
372
|
items: {
|
|
480
|
-
|
|
481
|
-
properties: {
|
|
482
|
-
presentation_group_values: {
|
|
483
|
-
type: 'object',
|
|
484
|
-
additionalProperties: true,
|
|
485
|
-
},
|
|
486
|
-
pricing_group_values: {
|
|
487
|
-
type: 'object',
|
|
488
|
-
additionalProperties: true,
|
|
489
|
-
},
|
|
490
|
-
product_id: {
|
|
491
|
-
type: 'string',
|
|
492
|
-
description: 'If provided, the specifier will only apply to the product with the specified ID.',
|
|
493
|
-
},
|
|
494
|
-
product_tags: {
|
|
495
|
-
type: 'array',
|
|
496
|
-
description: 'If provided, the specifier will only apply to products with all the specified tags.',
|
|
497
|
-
items: {
|
|
498
|
-
type: 'string',
|
|
499
|
-
},
|
|
500
|
-
},
|
|
501
|
-
},
|
|
373
|
+
$ref: '#/$defs/commit_specifier_input',
|
|
502
374
|
},
|
|
503
375
|
},
|
|
504
376
|
},
|
|
@@ -507,6 +379,7 @@ export const tool = {
|
|
|
507
379
|
},
|
|
508
380
|
custom_fields: {
|
|
509
381
|
type: 'object',
|
|
382
|
+
description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
|
|
510
383
|
additionalProperties: true,
|
|
511
384
|
},
|
|
512
385
|
discounts: {
|
|
@@ -598,6 +471,7 @@ export const tool = {
|
|
|
598
471
|
},
|
|
599
472
|
custom_fields: {
|
|
600
473
|
type: 'object',
|
|
474
|
+
description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
|
|
601
475
|
additionalProperties: true,
|
|
602
476
|
},
|
|
603
477
|
name: {
|
|
@@ -632,8 +506,27 @@ export const tool = {
|
|
|
632
506
|
},
|
|
633
507
|
required: ['contract_id', 'customer_id'],
|
|
634
508
|
},
|
|
509
|
+
parent_behavior: {
|
|
510
|
+
type: 'object',
|
|
511
|
+
properties: {
|
|
512
|
+
invoice_consolidation_type: {
|
|
513
|
+
type: 'string',
|
|
514
|
+
description: 'Indicates the desired behavior of consolidated invoices generated by the parent in a customer hierarchy\n**CONCATENATE**: Statements on the invoices of child customers will be appended to the consolidated invoice\n**NONE**: Do not generate consolidated invoices',
|
|
515
|
+
enum: ['CONCATENATE', 'NONE'],
|
|
516
|
+
},
|
|
517
|
+
},
|
|
518
|
+
},
|
|
519
|
+
payer: {
|
|
520
|
+
type: 'string',
|
|
521
|
+
description: "Indicates whether the parent should pay for the child's invoice charges",
|
|
522
|
+
enum: ['SELF', 'PARENT'],
|
|
523
|
+
},
|
|
524
|
+
usage_statement_behavior: {
|
|
525
|
+
type: 'string',
|
|
526
|
+
description: "Indicates the behavior of the child's invoice statements on the parent's invoices\n**CONSOLIDATE**: Child's invoice statements will be added to parent's consolidated invoices\n**SEPARATE**: Child's invoice statements will appear not appear on parent's consolidated invoices",
|
|
527
|
+
enum: ['CONSOLIDATE', 'SEPARATE'],
|
|
528
|
+
},
|
|
635
529
|
},
|
|
636
|
-
required: ['parent'],
|
|
637
530
|
},
|
|
638
531
|
multiplier_override_prioritization: {
|
|
639
532
|
type: 'string',
|
|
@@ -695,7 +588,7 @@ export const tool = {
|
|
|
695
588
|
},
|
|
696
589
|
commit_ids: {
|
|
697
590
|
type: 'array',
|
|
698
|
-
description: 'Can only be used for commit specific overrides. Must be used in conjunction with one of product_id
|
|
591
|
+
description: 'Can only be used for commit specific overrides. Must be used in conjunction with one of `product_id`, `product_tags`, `pricing_group_values`, or `presentation_group_values`. If provided, the override will only apply to the specified commits. If not provided, the override will apply to all commits.',
|
|
699
592
|
items: {
|
|
700
593
|
type: 'string',
|
|
701
594
|
},
|
|
@@ -723,14 +616,14 @@ export const tool = {
|
|
|
723
616
|
},
|
|
724
617
|
recurring_commit_ids: {
|
|
725
618
|
type: 'array',
|
|
726
|
-
description: 'Can only be used for commit specific overrides. Must be used in conjunction with one of product_id
|
|
619
|
+
description: 'Can only be used for commit specific overrides. Must be used in conjunction with one of `product_id`, `product_tags`, `pricing_group_values`, or `presentation_group_values`. If provided, the override will only apply to commits created by the specified recurring commit ids.',
|
|
727
620
|
items: {
|
|
728
621
|
type: 'string',
|
|
729
622
|
},
|
|
730
623
|
},
|
|
731
624
|
recurring_credit_ids: {
|
|
732
625
|
type: 'array',
|
|
733
|
-
description: 'Can only be used for commit specific overrides. Must be used in conjunction with one of product_id
|
|
626
|
+
description: 'Can only be used for commit specific overrides. Must be used in conjunction with one of `product_id`, `product_tags`, `pricing_group_values`, or `presentation_group_values`. If provided, the override will only apply to credits created by the specified recurring credit ids.',
|
|
734
627
|
items: {
|
|
735
628
|
type: 'string',
|
|
736
629
|
},
|
|
@@ -815,133 +708,7 @@ export const tool = {
|
|
|
815
708
|
},
|
|
816
709
|
},
|
|
817
710
|
prepaid_balance_threshold_configuration: {
|
|
818
|
-
|
|
819
|
-
properties: {
|
|
820
|
-
commit: {
|
|
821
|
-
type: 'object',
|
|
822
|
-
properties: {
|
|
823
|
-
product_id: {
|
|
824
|
-
type: 'string',
|
|
825
|
-
description: 'The commit product that will be used to generate the line item for commit payment.',
|
|
826
|
-
},
|
|
827
|
-
applicable_product_ids: {
|
|
828
|
-
type: 'array',
|
|
829
|
-
description: 'Which products the threshold commit applies to. If applicable_product_ids, applicable_product_tags or specifiers are not provided, the commit applies to all products.',
|
|
830
|
-
items: {
|
|
831
|
-
type: 'string',
|
|
832
|
-
},
|
|
833
|
-
},
|
|
834
|
-
applicable_product_tags: {
|
|
835
|
-
type: 'array',
|
|
836
|
-
description: 'Which tags the threshold commit applies to. If applicable_product_ids, applicable_product_tags or specifiers are not provided, the commit applies to all products.',
|
|
837
|
-
items: {
|
|
838
|
-
type: 'string',
|
|
839
|
-
},
|
|
840
|
-
},
|
|
841
|
-
description: {
|
|
842
|
-
type: 'string',
|
|
843
|
-
},
|
|
844
|
-
name: {
|
|
845
|
-
type: 'string',
|
|
846
|
-
description: 'Specify the name of the line item for the threshold charge. If left blank, it will default to the commit product name.',
|
|
847
|
-
},
|
|
848
|
-
specifiers: {
|
|
849
|
-
type: 'array',
|
|
850
|
-
description: "List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown. This field cannot be used together with `applicable_product_ids` or `applicable_product_tags`.",
|
|
851
|
-
items: {
|
|
852
|
-
type: 'object',
|
|
853
|
-
properties: {
|
|
854
|
-
presentation_group_values: {
|
|
855
|
-
type: 'object',
|
|
856
|
-
additionalProperties: true,
|
|
857
|
-
},
|
|
858
|
-
pricing_group_values: {
|
|
859
|
-
type: 'object',
|
|
860
|
-
additionalProperties: true,
|
|
861
|
-
},
|
|
862
|
-
product_id: {
|
|
863
|
-
type: 'string',
|
|
864
|
-
description: 'If provided, the specifier will only apply to the product with the specified ID.',
|
|
865
|
-
},
|
|
866
|
-
product_tags: {
|
|
867
|
-
type: 'array',
|
|
868
|
-
description: 'If provided, the specifier will only apply to products with all the specified tags.',
|
|
869
|
-
items: {
|
|
870
|
-
type: 'string',
|
|
871
|
-
},
|
|
872
|
-
},
|
|
873
|
-
},
|
|
874
|
-
},
|
|
875
|
-
},
|
|
876
|
-
},
|
|
877
|
-
required: ['product_id'],
|
|
878
|
-
},
|
|
879
|
-
is_enabled: {
|
|
880
|
-
type: 'boolean',
|
|
881
|
-
description: 'When set to false, the contract will not be evaluated against the threshold_amount. Toggling to true will result an immediate evaluation, regardless of prior state.',
|
|
882
|
-
},
|
|
883
|
-
payment_gate_config: {
|
|
884
|
-
type: 'object',
|
|
885
|
-
properties: {
|
|
886
|
-
payment_gate_type: {
|
|
887
|
-
type: 'string',
|
|
888
|
-
description: 'Gate access to the commit balance based on successful collection of payment. Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to facilitate payment using your own payment integration. Select NONE if you do not wish to payment gate the commit balance.',
|
|
889
|
-
enum: ['NONE', 'STRIPE', 'EXTERNAL'],
|
|
890
|
-
},
|
|
891
|
-
precalculated_tax_config: {
|
|
892
|
-
type: 'object',
|
|
893
|
-
description: 'Only applicable if using PRECALCULATED as your tax type.',
|
|
894
|
-
properties: {
|
|
895
|
-
tax_amount: {
|
|
896
|
-
type: 'number',
|
|
897
|
-
description: "Amount of tax to be applied. This should be in the same currency and denomination as the commit's invoice schedule",
|
|
898
|
-
},
|
|
899
|
-
tax_name: {
|
|
900
|
-
type: 'string',
|
|
901
|
-
description: 'Name of the tax to be applied. This may be used in an invoice line item description.',
|
|
902
|
-
},
|
|
903
|
-
},
|
|
904
|
-
required: ['tax_amount'],
|
|
905
|
-
},
|
|
906
|
-
stripe_config: {
|
|
907
|
-
type: 'object',
|
|
908
|
-
description: 'Only applicable if using STRIPE as your payment gate type.',
|
|
909
|
-
properties: {
|
|
910
|
-
payment_type: {
|
|
911
|
-
type: 'string',
|
|
912
|
-
description: 'If left blank, will default to INVOICE',
|
|
913
|
-
enum: ['INVOICE', 'PAYMENT_INTENT'],
|
|
914
|
-
},
|
|
915
|
-
invoice_metadata: {
|
|
916
|
-
type: 'object',
|
|
917
|
-
description: 'Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as your payment type.',
|
|
918
|
-
additionalProperties: true,
|
|
919
|
-
},
|
|
920
|
-
},
|
|
921
|
-
required: ['payment_type'],
|
|
922
|
-
},
|
|
923
|
-
tax_type: {
|
|
924
|
-
type: 'string',
|
|
925
|
-
description: 'Stripe tax is only supported for Stripe payment gateway. Select NONE if you do not wish Metronome to calculate tax on your behalf. Leaving this field blank will default to NONE.',
|
|
926
|
-
enum: ['NONE', 'STRIPE', 'ANROK', 'PRECALCULATED'],
|
|
927
|
-
},
|
|
928
|
-
},
|
|
929
|
-
required: ['payment_gate_type'],
|
|
930
|
-
},
|
|
931
|
-
recharge_to_amount: {
|
|
932
|
-
type: 'number',
|
|
933
|
-
description: 'Specify the amount the balance should be recharged to.',
|
|
934
|
-
},
|
|
935
|
-
threshold_amount: {
|
|
936
|
-
type: 'number',
|
|
937
|
-
description: "Specify the threshold amount for the contract. Each time the contract's prepaid balance lowers to this amount, a threshold charge will be initiated.",
|
|
938
|
-
},
|
|
939
|
-
custom_credit_type_id: {
|
|
940
|
-
type: 'string',
|
|
941
|
-
description: 'If provided, the threshold, recharge-to amount, and the resulting threshold commit amount will be in terms of this credit type instead of the fiat currency.',
|
|
942
|
-
},
|
|
943
|
-
},
|
|
944
|
-
required: ['commit', 'is_enabled', 'payment_gate_config', 'recharge_to_amount', 'threshold_amount'],
|
|
711
|
+
$ref: '#/$defs/prepaid_balance_threshold_configuration',
|
|
945
712
|
},
|
|
946
713
|
priority: {
|
|
947
714
|
type: 'number',
|
|
@@ -970,6 +737,7 @@ export const tool = {
|
|
|
970
737
|
},
|
|
971
738
|
custom_fields: {
|
|
972
739
|
type: 'object',
|
|
740
|
+
description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
|
|
973
741
|
additionalProperties: true,
|
|
974
742
|
},
|
|
975
743
|
description: {
|
|
@@ -1062,51 +830,7 @@ export const tool = {
|
|
|
1062
830
|
format: 'date-time',
|
|
1063
831
|
},
|
|
1064
832
|
hierarchy_configuration: {
|
|
1065
|
-
|
|
1066
|
-
description: 'Optional configuration for recurring commit/credit hierarchy access control',
|
|
1067
|
-
properties: {
|
|
1068
|
-
child_access: {
|
|
1069
|
-
anyOf: [
|
|
1070
|
-
{
|
|
1071
|
-
type: 'object',
|
|
1072
|
-
properties: {
|
|
1073
|
-
type: {
|
|
1074
|
-
type: 'string',
|
|
1075
|
-
enum: ['ALL'],
|
|
1076
|
-
},
|
|
1077
|
-
},
|
|
1078
|
-
required: ['type'],
|
|
1079
|
-
},
|
|
1080
|
-
{
|
|
1081
|
-
type: 'object',
|
|
1082
|
-
properties: {
|
|
1083
|
-
type: {
|
|
1084
|
-
type: 'string',
|
|
1085
|
-
enum: ['NONE'],
|
|
1086
|
-
},
|
|
1087
|
-
},
|
|
1088
|
-
required: ['type'],
|
|
1089
|
-
},
|
|
1090
|
-
{
|
|
1091
|
-
type: 'object',
|
|
1092
|
-
properties: {
|
|
1093
|
-
contract_ids: {
|
|
1094
|
-
type: 'array',
|
|
1095
|
-
items: {
|
|
1096
|
-
type: 'string',
|
|
1097
|
-
},
|
|
1098
|
-
},
|
|
1099
|
-
type: {
|
|
1100
|
-
type: 'string',
|
|
1101
|
-
enum: ['CONTRACT_IDS'],
|
|
1102
|
-
},
|
|
1103
|
-
},
|
|
1104
|
-
required: ['contract_ids', 'type'],
|
|
1105
|
-
},
|
|
1106
|
-
],
|
|
1107
|
-
},
|
|
1108
|
-
},
|
|
1109
|
-
required: ['child_access'],
|
|
833
|
+
$ref: '#/$defs/commit_hierarchy_configuration',
|
|
1110
834
|
},
|
|
1111
835
|
invoice_amount: {
|
|
1112
836
|
type: 'object',
|
|
@@ -1155,28 +879,7 @@ export const tool = {
|
|
|
1155
879
|
type: 'array',
|
|
1156
880
|
description: "List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown. This field cannot be used together with `applicable_product_ids` or `applicable_product_tags`.",
|
|
1157
881
|
items: {
|
|
1158
|
-
|
|
1159
|
-
properties: {
|
|
1160
|
-
presentation_group_values: {
|
|
1161
|
-
type: 'object',
|
|
1162
|
-
additionalProperties: true,
|
|
1163
|
-
},
|
|
1164
|
-
pricing_group_values: {
|
|
1165
|
-
type: 'object',
|
|
1166
|
-
additionalProperties: true,
|
|
1167
|
-
},
|
|
1168
|
-
product_id: {
|
|
1169
|
-
type: 'string',
|
|
1170
|
-
description: 'If provided, the specifier will only apply to the product with the specified ID.',
|
|
1171
|
-
},
|
|
1172
|
-
product_tags: {
|
|
1173
|
-
type: 'array',
|
|
1174
|
-
description: 'If provided, the specifier will only apply to products with all the specified tags.',
|
|
1175
|
-
items: {
|
|
1176
|
-
type: 'string',
|
|
1177
|
-
},
|
|
1178
|
-
},
|
|
1179
|
-
},
|
|
882
|
+
$ref: '#/$defs/commit_specifier_input',
|
|
1180
883
|
},
|
|
1181
884
|
},
|
|
1182
885
|
subscription_config: {
|
|
@@ -1200,7 +903,7 @@ export const tool = {
|
|
|
1200
903
|
allocation: {
|
|
1201
904
|
type: 'string',
|
|
1202
905
|
description: 'If set to POOLED, allocation added per seat is pooled across the account.',
|
|
1203
|
-
enum: ['POOLED'],
|
|
906
|
+
enum: ['INDIVIDUAL', 'POOLED'],
|
|
1204
907
|
},
|
|
1205
908
|
},
|
|
1206
909
|
required: ['apply_seat_increase_config', 'subscription_id'],
|
|
@@ -1285,51 +988,7 @@ export const tool = {
|
|
|
1285
988
|
format: 'date-time',
|
|
1286
989
|
},
|
|
1287
990
|
hierarchy_configuration: {
|
|
1288
|
-
|
|
1289
|
-
description: 'Optional configuration for recurring commit/credit hierarchy access control',
|
|
1290
|
-
properties: {
|
|
1291
|
-
child_access: {
|
|
1292
|
-
anyOf: [
|
|
1293
|
-
{
|
|
1294
|
-
type: 'object',
|
|
1295
|
-
properties: {
|
|
1296
|
-
type: {
|
|
1297
|
-
type: 'string',
|
|
1298
|
-
enum: ['ALL'],
|
|
1299
|
-
},
|
|
1300
|
-
},
|
|
1301
|
-
required: ['type'],
|
|
1302
|
-
},
|
|
1303
|
-
{
|
|
1304
|
-
type: 'object',
|
|
1305
|
-
properties: {
|
|
1306
|
-
type: {
|
|
1307
|
-
type: 'string',
|
|
1308
|
-
enum: ['NONE'],
|
|
1309
|
-
},
|
|
1310
|
-
},
|
|
1311
|
-
required: ['type'],
|
|
1312
|
-
},
|
|
1313
|
-
{
|
|
1314
|
-
type: 'object',
|
|
1315
|
-
properties: {
|
|
1316
|
-
contract_ids: {
|
|
1317
|
-
type: 'array',
|
|
1318
|
-
items: {
|
|
1319
|
-
type: 'string',
|
|
1320
|
-
},
|
|
1321
|
-
},
|
|
1322
|
-
type: {
|
|
1323
|
-
type: 'string',
|
|
1324
|
-
enum: ['CONTRACT_IDS'],
|
|
1325
|
-
},
|
|
1326
|
-
},
|
|
1327
|
-
required: ['contract_ids', 'type'],
|
|
1328
|
-
},
|
|
1329
|
-
],
|
|
1330
|
-
},
|
|
1331
|
-
},
|
|
1332
|
-
required: ['child_access'],
|
|
991
|
+
$ref: '#/$defs/commit_hierarchy_configuration',
|
|
1333
992
|
},
|
|
1334
993
|
name: {
|
|
1335
994
|
type: 'string',
|
|
@@ -1362,28 +1021,7 @@ export const tool = {
|
|
|
1362
1021
|
type: 'array',
|
|
1363
1022
|
description: "List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown. This field cannot be used together with `applicable_product_ids` or `applicable_product_tags`.",
|
|
1364
1023
|
items: {
|
|
1365
|
-
|
|
1366
|
-
properties: {
|
|
1367
|
-
presentation_group_values: {
|
|
1368
|
-
type: 'object',
|
|
1369
|
-
additionalProperties: true,
|
|
1370
|
-
},
|
|
1371
|
-
pricing_group_values: {
|
|
1372
|
-
type: 'object',
|
|
1373
|
-
additionalProperties: true,
|
|
1374
|
-
},
|
|
1375
|
-
product_id: {
|
|
1376
|
-
type: 'string',
|
|
1377
|
-
description: 'If provided, the specifier will only apply to the product with the specified ID.',
|
|
1378
|
-
},
|
|
1379
|
-
product_tags: {
|
|
1380
|
-
type: 'array',
|
|
1381
|
-
description: 'If provided, the specifier will only apply to products with all the specified tags.',
|
|
1382
|
-
items: {
|
|
1383
|
-
type: 'string',
|
|
1384
|
-
},
|
|
1385
|
-
},
|
|
1386
|
-
},
|
|
1024
|
+
$ref: '#/$defs/commit_specifier_input',
|
|
1387
1025
|
},
|
|
1388
1026
|
},
|
|
1389
1027
|
subscription_config: {
|
|
@@ -1407,7 +1045,7 @@ export const tool = {
|
|
|
1407
1045
|
allocation: {
|
|
1408
1046
|
type: 'string',
|
|
1409
1047
|
description: 'If set to POOLED, allocation added per seat is pooled across the account.',
|
|
1410
|
-
enum: ['POOLED'],
|
|
1048
|
+
enum: ['INDIVIDUAL', 'POOLED'],
|
|
1411
1049
|
},
|
|
1412
1050
|
},
|
|
1413
1051
|
required: ['apply_seat_increase_config', 'subscription_id'],
|
|
@@ -1582,6 +1220,7 @@ export const tool = {
|
|
|
1582
1220
|
},
|
|
1583
1221
|
custom_fields: {
|
|
1584
1222
|
type: 'object',
|
|
1223
|
+
description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
|
|
1585
1224
|
additionalProperties: true,
|
|
1586
1225
|
},
|
|
1587
1226
|
name: {
|
|
@@ -1602,83 +1241,7 @@ export const tool = {
|
|
|
1602
1241
|
enum: ['ALL'],
|
|
1603
1242
|
},
|
|
1604
1243
|
spend_threshold_configuration: {
|
|
1605
|
-
|
|
1606
|
-
properties: {
|
|
1607
|
-
commit: {
|
|
1608
|
-
type: 'object',
|
|
1609
|
-
properties: {
|
|
1610
|
-
product_id: {
|
|
1611
|
-
type: 'string',
|
|
1612
|
-
description: 'The commit product that will be used to generate the line item for commit payment.',
|
|
1613
|
-
},
|
|
1614
|
-
description: {
|
|
1615
|
-
type: 'string',
|
|
1616
|
-
},
|
|
1617
|
-
name: {
|
|
1618
|
-
type: 'string',
|
|
1619
|
-
description: 'Specify the name of the line item for the threshold charge. If left blank, it will default to the commit product name.',
|
|
1620
|
-
},
|
|
1621
|
-
},
|
|
1622
|
-
required: ['product_id'],
|
|
1623
|
-
},
|
|
1624
|
-
is_enabled: {
|
|
1625
|
-
type: 'boolean',
|
|
1626
|
-
description: 'When set to false, the contract will not be evaluated against the threshold_amount. Toggling to true will result an immediate evaluation, regardless of prior state.',
|
|
1627
|
-
},
|
|
1628
|
-
payment_gate_config: {
|
|
1629
|
-
type: 'object',
|
|
1630
|
-
properties: {
|
|
1631
|
-
payment_gate_type: {
|
|
1632
|
-
type: 'string',
|
|
1633
|
-
description: 'Gate access to the commit balance based on successful collection of payment. Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to facilitate payment using your own payment integration. Select NONE if you do not wish to payment gate the commit balance.',
|
|
1634
|
-
enum: ['NONE', 'STRIPE', 'EXTERNAL'],
|
|
1635
|
-
},
|
|
1636
|
-
precalculated_tax_config: {
|
|
1637
|
-
type: 'object',
|
|
1638
|
-
description: 'Only applicable if using PRECALCULATED as your tax type.',
|
|
1639
|
-
properties: {
|
|
1640
|
-
tax_amount: {
|
|
1641
|
-
type: 'number',
|
|
1642
|
-
description: "Amount of tax to be applied. This should be in the same currency and denomination as the commit's invoice schedule",
|
|
1643
|
-
},
|
|
1644
|
-
tax_name: {
|
|
1645
|
-
type: 'string',
|
|
1646
|
-
description: 'Name of the tax to be applied. This may be used in an invoice line item description.',
|
|
1647
|
-
},
|
|
1648
|
-
},
|
|
1649
|
-
required: ['tax_amount'],
|
|
1650
|
-
},
|
|
1651
|
-
stripe_config: {
|
|
1652
|
-
type: 'object',
|
|
1653
|
-
description: 'Only applicable if using STRIPE as your payment gate type.',
|
|
1654
|
-
properties: {
|
|
1655
|
-
payment_type: {
|
|
1656
|
-
type: 'string',
|
|
1657
|
-
description: 'If left blank, will default to INVOICE',
|
|
1658
|
-
enum: ['INVOICE', 'PAYMENT_INTENT'],
|
|
1659
|
-
},
|
|
1660
|
-
invoice_metadata: {
|
|
1661
|
-
type: 'object',
|
|
1662
|
-
description: 'Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as your payment type.',
|
|
1663
|
-
additionalProperties: true,
|
|
1664
|
-
},
|
|
1665
|
-
},
|
|
1666
|
-
required: ['payment_type'],
|
|
1667
|
-
},
|
|
1668
|
-
tax_type: {
|
|
1669
|
-
type: 'string',
|
|
1670
|
-
description: 'Stripe tax is only supported for Stripe payment gateway. Select NONE if you do not wish Metronome to calculate tax on your behalf. Leaving this field blank will default to NONE.',
|
|
1671
|
-
enum: ['NONE', 'STRIPE', 'ANROK', 'PRECALCULATED'],
|
|
1672
|
-
},
|
|
1673
|
-
},
|
|
1674
|
-
required: ['payment_gate_type'],
|
|
1675
|
-
},
|
|
1676
|
-
threshold_amount: {
|
|
1677
|
-
type: 'number',
|
|
1678
|
-
description: "Specify the threshold amount for the contract. Each time the contract's usage hits this amount, a threshold charge will be initiated.",
|
|
1679
|
-
},
|
|
1680
|
-
},
|
|
1681
|
-
required: ['commit', 'is_enabled', 'payment_gate_config', 'threshold_amount'],
|
|
1244
|
+
$ref: '#/$defs/spend_threshold_configuration',
|
|
1682
1245
|
},
|
|
1683
1246
|
subscriptions: {
|
|
1684
1247
|
type: 'array',
|
|
@@ -1690,10 +1253,6 @@ export const tool = {
|
|
|
1690
1253
|
type: 'string',
|
|
1691
1254
|
enum: ['ADVANCE', 'ARREARS'],
|
|
1692
1255
|
},
|
|
1693
|
-
initial_quantity: {
|
|
1694
|
-
type: 'number',
|
|
1695
|
-
description: 'The initial quantity for the subscription. It must be non-negative value.',
|
|
1696
|
-
},
|
|
1697
1256
|
proration: {
|
|
1698
1257
|
type: 'object',
|
|
1699
1258
|
properties: {
|
|
@@ -1725,6 +1284,7 @@ export const tool = {
|
|
|
1725
1284
|
},
|
|
1726
1285
|
custom_fields: {
|
|
1727
1286
|
type: 'object',
|
|
1287
|
+
description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
|
|
1728
1288
|
additionalProperties: true,
|
|
1729
1289
|
},
|
|
1730
1290
|
description: {
|
|
@@ -1735,9 +1295,18 @@ export const tool = {
|
|
|
1735
1295
|
description: 'Exclusive end time for the subscription. If not provided, subscription inherits contract end date.',
|
|
1736
1296
|
format: 'date-time',
|
|
1737
1297
|
},
|
|
1298
|
+
initial_quantity: {
|
|
1299
|
+
type: 'number',
|
|
1300
|
+
description: 'The initial quantity for the subscription. It must be non-negative value. Required if quantity_management_mode is QUANTITY_ONLY.',
|
|
1301
|
+
},
|
|
1738
1302
|
name: {
|
|
1739
1303
|
type: 'string',
|
|
1740
1304
|
},
|
|
1305
|
+
quantity_management_mode: {
|
|
1306
|
+
type: 'string',
|
|
1307
|
+
description: "Determines how the subscription's quantity is controlled. Defaults to QUANTITY_ONLY. **QUANTITY_ONLY**: The subscription quantity is specified directly on the subscription. `initial_quantity` must be provided with this option. Compatible with recurring commits/credits that use POOLED allocation.",
|
|
1308
|
+
enum: ['SEAT_BASED', 'QUANTITY_ONLY'],
|
|
1309
|
+
},
|
|
1741
1310
|
starting_at: {
|
|
1742
1311
|
type: 'string',
|
|
1743
1312
|
description: 'Inclusive start time for the subscription. If not provided, defaults to contract start date',
|
|
@@ -1748,7 +1317,7 @@ export const tool = {
|
|
|
1748
1317
|
description: 'A temporary ID used to reference the subscription in recurring commit/credit subscription configs created within the same payload.',
|
|
1749
1318
|
},
|
|
1750
1319
|
},
|
|
1751
|
-
required: ['collection_schedule', '
|
|
1320
|
+
required: ['collection_schedule', 'proration', 'subscription_rate'],
|
|
1752
1321
|
},
|
|
1753
1322
|
},
|
|
1754
1323
|
total_contract_value: {
|
|
@@ -1814,6 +1383,76 @@ export const tool = {
|
|
|
1814
1383
|
},
|
|
1815
1384
|
required: ['customer_id', 'starting_at'],
|
|
1816
1385
|
$defs: {
|
|
1386
|
+
commit_hierarchy_configuration: {
|
|
1387
|
+
type: 'object',
|
|
1388
|
+
properties: {
|
|
1389
|
+
child_access: {
|
|
1390
|
+
anyOf: [
|
|
1391
|
+
{
|
|
1392
|
+
type: 'object',
|
|
1393
|
+
properties: {
|
|
1394
|
+
type: {
|
|
1395
|
+
type: 'string',
|
|
1396
|
+
enum: ['ALL'],
|
|
1397
|
+
},
|
|
1398
|
+
},
|
|
1399
|
+
required: ['type'],
|
|
1400
|
+
},
|
|
1401
|
+
{
|
|
1402
|
+
type: 'object',
|
|
1403
|
+
properties: {
|
|
1404
|
+
type: {
|
|
1405
|
+
type: 'string',
|
|
1406
|
+
enum: ['NONE'],
|
|
1407
|
+
},
|
|
1408
|
+
},
|
|
1409
|
+
required: ['type'],
|
|
1410
|
+
},
|
|
1411
|
+
{
|
|
1412
|
+
type: 'object',
|
|
1413
|
+
properties: {
|
|
1414
|
+
contract_ids: {
|
|
1415
|
+
type: 'array',
|
|
1416
|
+
items: {
|
|
1417
|
+
type: 'string',
|
|
1418
|
+
},
|
|
1419
|
+
},
|
|
1420
|
+
type: {
|
|
1421
|
+
type: 'string',
|
|
1422
|
+
enum: ['CONTRACT_IDS'],
|
|
1423
|
+
},
|
|
1424
|
+
},
|
|
1425
|
+
required: ['contract_ids', 'type'],
|
|
1426
|
+
},
|
|
1427
|
+
],
|
|
1428
|
+
},
|
|
1429
|
+
},
|
|
1430
|
+
required: ['child_access'],
|
|
1431
|
+
},
|
|
1432
|
+
commit_specifier_input: {
|
|
1433
|
+
type: 'object',
|
|
1434
|
+
properties: {
|
|
1435
|
+
presentation_group_values: {
|
|
1436
|
+
type: 'object',
|
|
1437
|
+
additionalProperties: true,
|
|
1438
|
+
},
|
|
1439
|
+
pricing_group_values: {
|
|
1440
|
+
type: 'object',
|
|
1441
|
+
additionalProperties: true,
|
|
1442
|
+
},
|
|
1443
|
+
product_id: {
|
|
1444
|
+
type: 'string',
|
|
1445
|
+
description: 'If provided, the specifier will only apply to the product with the specified ID.',
|
|
1446
|
+
},
|
|
1447
|
+
product_tags: {
|
|
1448
|
+
type: 'array',
|
|
1449
|
+
description: 'If provided, the specifier will only apply to products with all the specified tags.',
|
|
1450
|
+
items: {
|
|
1451
|
+
type: 'string',
|
|
1452
|
+
},
|
|
1453
|
+
},
|
|
1454
|
+
},
|
|
1455
|
+
},
|
|
1817
1456
|
tier: {
|
|
1818
1457
|
type: 'object',
|
|
1819
1458
|
properties: {
|
|
@@ -1826,6 +1465,123 @@ export const tool = {
|
|
|
1826
1465
|
},
|
|
1827
1466
|
required: ['price'],
|
|
1828
1467
|
},
|
|
1468
|
+
prepaid_balance_threshold_configuration: {
|
|
1469
|
+
type: 'object',
|
|
1470
|
+
properties: {
|
|
1471
|
+
commit: {
|
|
1472
|
+
allOf: [
|
|
1473
|
+
{
|
|
1474
|
+
$ref: '#/$defs/base_threshold_commit',
|
|
1475
|
+
},
|
|
1476
|
+
],
|
|
1477
|
+
},
|
|
1478
|
+
is_enabled: {
|
|
1479
|
+
type: 'boolean',
|
|
1480
|
+
description: 'When set to false, the contract will not be evaluated against the threshold_amount. Toggling to true will result an immediate evaluation, regardless of prior state.',
|
|
1481
|
+
},
|
|
1482
|
+
payment_gate_config: {
|
|
1483
|
+
$ref: '#/$defs/payment_gate_config',
|
|
1484
|
+
},
|
|
1485
|
+
recharge_to_amount: {
|
|
1486
|
+
type: 'number',
|
|
1487
|
+
description: 'Specify the amount the balance should be recharged to.',
|
|
1488
|
+
},
|
|
1489
|
+
threshold_amount: {
|
|
1490
|
+
type: 'number',
|
|
1491
|
+
description: "Specify the threshold amount for the contract. Each time the contract's prepaid balance lowers to this amount, a threshold charge will be initiated.",
|
|
1492
|
+
},
|
|
1493
|
+
custom_credit_type_id: {
|
|
1494
|
+
type: 'string',
|
|
1495
|
+
description: 'If provided, the threshold, recharge-to amount, and the resulting threshold commit amount will be in terms of this credit type instead of the fiat currency.',
|
|
1496
|
+
},
|
|
1497
|
+
},
|
|
1498
|
+
required: ['commit', 'is_enabled', 'payment_gate_config', 'recharge_to_amount', 'threshold_amount'],
|
|
1499
|
+
},
|
|
1500
|
+
base_threshold_commit: {
|
|
1501
|
+
type: 'object',
|
|
1502
|
+
properties: {
|
|
1503
|
+
product_id: {
|
|
1504
|
+
type: 'string',
|
|
1505
|
+
description: 'The commit product that will be used to generate the line item for commit payment.',
|
|
1506
|
+
},
|
|
1507
|
+
description: {
|
|
1508
|
+
type: 'string',
|
|
1509
|
+
},
|
|
1510
|
+
name: {
|
|
1511
|
+
type: 'string',
|
|
1512
|
+
description: 'Specify the name of the line item for the threshold charge. If left blank, it will default to the commit product name.',
|
|
1513
|
+
},
|
|
1514
|
+
},
|
|
1515
|
+
required: ['product_id'],
|
|
1516
|
+
},
|
|
1517
|
+
payment_gate_config: {
|
|
1518
|
+
type: 'object',
|
|
1519
|
+
properties: {
|
|
1520
|
+
payment_gate_type: {
|
|
1521
|
+
type: 'string',
|
|
1522
|
+
description: 'Gate access to the commit balance based on successful collection of payment. Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to facilitate payment using your own payment integration. Select NONE if you do not wish to payment gate the commit balance.',
|
|
1523
|
+
enum: ['NONE', 'STRIPE', 'EXTERNAL'],
|
|
1524
|
+
},
|
|
1525
|
+
precalculated_tax_config: {
|
|
1526
|
+
type: 'object',
|
|
1527
|
+
description: 'Only applicable if using PRECALCULATED as your tax type.',
|
|
1528
|
+
properties: {
|
|
1529
|
+
tax_amount: {
|
|
1530
|
+
type: 'number',
|
|
1531
|
+
description: "Amount of tax to be applied. This should be in the same currency and denomination as the commit's invoice schedule",
|
|
1532
|
+
},
|
|
1533
|
+
tax_name: {
|
|
1534
|
+
type: 'string',
|
|
1535
|
+
description: 'Name of the tax to be applied. This may be used in an invoice line item description.',
|
|
1536
|
+
},
|
|
1537
|
+
},
|
|
1538
|
+
required: ['tax_amount'],
|
|
1539
|
+
},
|
|
1540
|
+
stripe_config: {
|
|
1541
|
+
type: 'object',
|
|
1542
|
+
description: 'Only applicable if using STRIPE as your payment gate type.',
|
|
1543
|
+
properties: {
|
|
1544
|
+
payment_type: {
|
|
1545
|
+
type: 'string',
|
|
1546
|
+
description: 'If left blank, will default to INVOICE',
|
|
1547
|
+
enum: ['INVOICE', 'PAYMENT_INTENT'],
|
|
1548
|
+
},
|
|
1549
|
+
invoice_metadata: {
|
|
1550
|
+
type: 'object',
|
|
1551
|
+
description: 'Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as your payment type.',
|
|
1552
|
+
additionalProperties: true,
|
|
1553
|
+
},
|
|
1554
|
+
},
|
|
1555
|
+
required: ['payment_type'],
|
|
1556
|
+
},
|
|
1557
|
+
tax_type: {
|
|
1558
|
+
type: 'string',
|
|
1559
|
+
description: 'Stripe tax is only supported for Stripe payment gateway. Select NONE if you do not wish Metronome to calculate tax on your behalf. Leaving this field blank will default to NONE.',
|
|
1560
|
+
enum: ['NONE', 'STRIPE', 'ANROK', 'AVALARA', 'PRECALCULATED'],
|
|
1561
|
+
},
|
|
1562
|
+
},
|
|
1563
|
+
required: ['payment_gate_type'],
|
|
1564
|
+
},
|
|
1565
|
+
spend_threshold_configuration: {
|
|
1566
|
+
type: 'object',
|
|
1567
|
+
properties: {
|
|
1568
|
+
commit: {
|
|
1569
|
+
$ref: '#/$defs/base_threshold_commit',
|
|
1570
|
+
},
|
|
1571
|
+
is_enabled: {
|
|
1572
|
+
type: 'boolean',
|
|
1573
|
+
description: 'When set to false, the contract will not be evaluated against the threshold_amount. Toggling to true will result an immediate evaluation, regardless of prior state.',
|
|
1574
|
+
},
|
|
1575
|
+
payment_gate_config: {
|
|
1576
|
+
$ref: '#/$defs/payment_gate_config',
|
|
1577
|
+
},
|
|
1578
|
+
threshold_amount: {
|
|
1579
|
+
type: 'number',
|
|
1580
|
+
description: "Specify the threshold amount for the contract. Each time the contract's usage hits this amount, a threshold charge will be initiated.",
|
|
1581
|
+
},
|
|
1582
|
+
},
|
|
1583
|
+
required: ['commit', 'is_enabled', 'payment_gate_config', 'threshold_amount'],
|
|
1584
|
+
},
|
|
1829
1585
|
base_usage_filter: {
|
|
1830
1586
|
type: 'object',
|
|
1831
1587
|
properties: {
|