@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
|
@@ -13,7 +13,7 @@ exports.metadata = {
|
|
|
13
13
|
};
|
|
14
14
|
exports.tool = {
|
|
15
15
|
name: 'create_v1_contracts',
|
|
16
|
-
description: '
|
|
16
|
+
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",
|
|
17
17
|
inputSchema: {
|
|
18
18
|
type: 'object',
|
|
19
19
|
properties: {
|
|
@@ -110,6 +110,7 @@ exports.tool = {
|
|
|
110
110
|
},
|
|
111
111
|
custom_fields: {
|
|
112
112
|
type: 'object',
|
|
113
|
+
description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
|
|
113
114
|
additionalProperties: true,
|
|
114
115
|
},
|
|
115
116
|
description: {
|
|
@@ -117,51 +118,7 @@ exports.tool = {
|
|
|
117
118
|
description: 'Used only in UI/API. It is not exposed to end customers.',
|
|
118
119
|
},
|
|
119
120
|
hierarchy_configuration: {
|
|
120
|
-
|
|
121
|
-
description: 'Optional configuration for commit hierarchy access control',
|
|
122
|
-
properties: {
|
|
123
|
-
child_access: {
|
|
124
|
-
anyOf: [
|
|
125
|
-
{
|
|
126
|
-
type: 'object',
|
|
127
|
-
properties: {
|
|
128
|
-
type: {
|
|
129
|
-
type: 'string',
|
|
130
|
-
enum: ['ALL'],
|
|
131
|
-
},
|
|
132
|
-
},
|
|
133
|
-
required: ['type'],
|
|
134
|
-
},
|
|
135
|
-
{
|
|
136
|
-
type: 'object',
|
|
137
|
-
properties: {
|
|
138
|
-
type: {
|
|
139
|
-
type: 'string',
|
|
140
|
-
enum: ['NONE'],
|
|
141
|
-
},
|
|
142
|
-
},
|
|
143
|
-
required: ['type'],
|
|
144
|
-
},
|
|
145
|
-
{
|
|
146
|
-
type: 'object',
|
|
147
|
-
properties: {
|
|
148
|
-
contract_ids: {
|
|
149
|
-
type: 'array',
|
|
150
|
-
items: {
|
|
151
|
-
type: 'string',
|
|
152
|
-
},
|
|
153
|
-
},
|
|
154
|
-
type: {
|
|
155
|
-
type: 'string',
|
|
156
|
-
enum: ['CONTRACT_IDS'],
|
|
157
|
-
},
|
|
158
|
-
},
|
|
159
|
-
required: ['contract_ids', 'type'],
|
|
160
|
-
},
|
|
161
|
-
],
|
|
162
|
-
},
|
|
163
|
-
},
|
|
164
|
-
required: ['child_access'],
|
|
121
|
+
$ref: '#/$defs/commit_hierarchy_configuration',
|
|
165
122
|
},
|
|
166
123
|
invoice_schedule: {
|
|
167
124
|
type: 'object',
|
|
@@ -297,7 +254,7 @@ exports.tool = {
|
|
|
297
254
|
tax_type: {
|
|
298
255
|
type: 'string',
|
|
299
256
|
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.',
|
|
300
|
-
enum: ['NONE', 'STRIPE', 'ANROK', 'PRECALCULATED'],
|
|
257
|
+
enum: ['NONE', 'STRIPE', 'ANROK', 'AVALARA', 'PRECALCULATED'],
|
|
301
258
|
},
|
|
302
259
|
},
|
|
303
260
|
required: ['payment_gate_type'],
|
|
@@ -318,28 +275,7 @@ exports.tool = {
|
|
|
318
275
|
type: 'array',
|
|
319
276
|
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`.",
|
|
320
277
|
items: {
|
|
321
|
-
|
|
322
|
-
properties: {
|
|
323
|
-
presentation_group_values: {
|
|
324
|
-
type: 'object',
|
|
325
|
-
additionalProperties: true,
|
|
326
|
-
},
|
|
327
|
-
pricing_group_values: {
|
|
328
|
-
type: 'object',
|
|
329
|
-
additionalProperties: true,
|
|
330
|
-
},
|
|
331
|
-
product_id: {
|
|
332
|
-
type: 'string',
|
|
333
|
-
description: 'If provided, the specifier will only apply to the product with the specified ID.',
|
|
334
|
-
},
|
|
335
|
-
product_tags: {
|
|
336
|
-
type: 'array',
|
|
337
|
-
description: 'If provided, the specifier will only apply to products with all the specified tags.',
|
|
338
|
-
items: {
|
|
339
|
-
type: 'string',
|
|
340
|
-
},
|
|
341
|
-
},
|
|
342
|
-
},
|
|
278
|
+
$ref: '#/$defs/commit_specifier_input',
|
|
343
279
|
},
|
|
344
280
|
},
|
|
345
281
|
temporary_id: {
|
|
@@ -407,6 +343,7 @@ exports.tool = {
|
|
|
407
343
|
},
|
|
408
344
|
custom_fields: {
|
|
409
345
|
type: 'object',
|
|
346
|
+
description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
|
|
410
347
|
additionalProperties: true,
|
|
411
348
|
},
|
|
412
349
|
description: {
|
|
@@ -414,51 +351,7 @@ exports.tool = {
|
|
|
414
351
|
description: 'Used only in UI/API. It is not exposed to end customers.',
|
|
415
352
|
},
|
|
416
353
|
hierarchy_configuration: {
|
|
417
|
-
|
|
418
|
-
description: 'Optional configuration for credit hierarchy access control',
|
|
419
|
-
properties: {
|
|
420
|
-
child_access: {
|
|
421
|
-
anyOf: [
|
|
422
|
-
{
|
|
423
|
-
type: 'object',
|
|
424
|
-
properties: {
|
|
425
|
-
type: {
|
|
426
|
-
type: 'string',
|
|
427
|
-
enum: ['ALL'],
|
|
428
|
-
},
|
|
429
|
-
},
|
|
430
|
-
required: ['type'],
|
|
431
|
-
},
|
|
432
|
-
{
|
|
433
|
-
type: 'object',
|
|
434
|
-
properties: {
|
|
435
|
-
type: {
|
|
436
|
-
type: 'string',
|
|
437
|
-
enum: ['NONE'],
|
|
438
|
-
},
|
|
439
|
-
},
|
|
440
|
-
required: ['type'],
|
|
441
|
-
},
|
|
442
|
-
{
|
|
443
|
-
type: 'object',
|
|
444
|
-
properties: {
|
|
445
|
-
contract_ids: {
|
|
446
|
-
type: 'array',
|
|
447
|
-
items: {
|
|
448
|
-
type: 'string',
|
|
449
|
-
},
|
|
450
|
-
},
|
|
451
|
-
type: {
|
|
452
|
-
type: 'string',
|
|
453
|
-
enum: ['CONTRACT_IDS'],
|
|
454
|
-
},
|
|
455
|
-
},
|
|
456
|
-
required: ['contract_ids', 'type'],
|
|
457
|
-
},
|
|
458
|
-
],
|
|
459
|
-
},
|
|
460
|
-
},
|
|
461
|
-
required: ['child_access'],
|
|
354
|
+
$ref: '#/$defs/commit_hierarchy_configuration',
|
|
462
355
|
},
|
|
463
356
|
name: {
|
|
464
357
|
type: 'string',
|
|
@@ -480,28 +373,7 @@ exports.tool = {
|
|
|
480
373
|
type: 'array',
|
|
481
374
|
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`.",
|
|
482
375
|
items: {
|
|
483
|
-
|
|
484
|
-
properties: {
|
|
485
|
-
presentation_group_values: {
|
|
486
|
-
type: 'object',
|
|
487
|
-
additionalProperties: true,
|
|
488
|
-
},
|
|
489
|
-
pricing_group_values: {
|
|
490
|
-
type: 'object',
|
|
491
|
-
additionalProperties: true,
|
|
492
|
-
},
|
|
493
|
-
product_id: {
|
|
494
|
-
type: 'string',
|
|
495
|
-
description: 'If provided, the specifier will only apply to the product with the specified ID.',
|
|
496
|
-
},
|
|
497
|
-
product_tags: {
|
|
498
|
-
type: 'array',
|
|
499
|
-
description: 'If provided, the specifier will only apply to products with all the specified tags.',
|
|
500
|
-
items: {
|
|
501
|
-
type: 'string',
|
|
502
|
-
},
|
|
503
|
-
},
|
|
504
|
-
},
|
|
376
|
+
$ref: '#/$defs/commit_specifier_input',
|
|
505
377
|
},
|
|
506
378
|
},
|
|
507
379
|
},
|
|
@@ -510,6 +382,7 @@ exports.tool = {
|
|
|
510
382
|
},
|
|
511
383
|
custom_fields: {
|
|
512
384
|
type: 'object',
|
|
385
|
+
description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
|
|
513
386
|
additionalProperties: true,
|
|
514
387
|
},
|
|
515
388
|
discounts: {
|
|
@@ -601,6 +474,7 @@ exports.tool = {
|
|
|
601
474
|
},
|
|
602
475
|
custom_fields: {
|
|
603
476
|
type: 'object',
|
|
477
|
+
description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
|
|
604
478
|
additionalProperties: true,
|
|
605
479
|
},
|
|
606
480
|
name: {
|
|
@@ -635,8 +509,27 @@ exports.tool = {
|
|
|
635
509
|
},
|
|
636
510
|
required: ['contract_id', 'customer_id'],
|
|
637
511
|
},
|
|
512
|
+
parent_behavior: {
|
|
513
|
+
type: 'object',
|
|
514
|
+
properties: {
|
|
515
|
+
invoice_consolidation_type: {
|
|
516
|
+
type: 'string',
|
|
517
|
+
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',
|
|
518
|
+
enum: ['CONCATENATE', 'NONE'],
|
|
519
|
+
},
|
|
520
|
+
},
|
|
521
|
+
},
|
|
522
|
+
payer: {
|
|
523
|
+
type: 'string',
|
|
524
|
+
description: "Indicates whether the parent should pay for the child's invoice charges",
|
|
525
|
+
enum: ['SELF', 'PARENT'],
|
|
526
|
+
},
|
|
527
|
+
usage_statement_behavior: {
|
|
528
|
+
type: 'string',
|
|
529
|
+
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",
|
|
530
|
+
enum: ['CONSOLIDATE', 'SEPARATE'],
|
|
531
|
+
},
|
|
638
532
|
},
|
|
639
|
-
required: ['parent'],
|
|
640
533
|
},
|
|
641
534
|
multiplier_override_prioritization: {
|
|
642
535
|
type: 'string',
|
|
@@ -698,7 +591,7 @@ exports.tool = {
|
|
|
698
591
|
},
|
|
699
592
|
commit_ids: {
|
|
700
593
|
type: 'array',
|
|
701
|
-
description: 'Can only be used for commit specific overrides. Must be used in conjunction with one of product_id
|
|
594
|
+
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.',
|
|
702
595
|
items: {
|
|
703
596
|
type: 'string',
|
|
704
597
|
},
|
|
@@ -726,14 +619,14 @@ exports.tool = {
|
|
|
726
619
|
},
|
|
727
620
|
recurring_commit_ids: {
|
|
728
621
|
type: 'array',
|
|
729
|
-
description: 'Can only be used for commit specific overrides. Must be used in conjunction with one of product_id
|
|
622
|
+
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.',
|
|
730
623
|
items: {
|
|
731
624
|
type: 'string',
|
|
732
625
|
},
|
|
733
626
|
},
|
|
734
627
|
recurring_credit_ids: {
|
|
735
628
|
type: 'array',
|
|
736
|
-
description: 'Can only be used for commit specific overrides. Must be used in conjunction with one of product_id
|
|
629
|
+
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.',
|
|
737
630
|
items: {
|
|
738
631
|
type: 'string',
|
|
739
632
|
},
|
|
@@ -818,133 +711,7 @@ exports.tool = {
|
|
|
818
711
|
},
|
|
819
712
|
},
|
|
820
713
|
prepaid_balance_threshold_configuration: {
|
|
821
|
-
|
|
822
|
-
properties: {
|
|
823
|
-
commit: {
|
|
824
|
-
type: 'object',
|
|
825
|
-
properties: {
|
|
826
|
-
product_id: {
|
|
827
|
-
type: 'string',
|
|
828
|
-
description: 'The commit product that will be used to generate the line item for commit payment.',
|
|
829
|
-
},
|
|
830
|
-
applicable_product_ids: {
|
|
831
|
-
type: 'array',
|
|
832
|
-
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.',
|
|
833
|
-
items: {
|
|
834
|
-
type: 'string',
|
|
835
|
-
},
|
|
836
|
-
},
|
|
837
|
-
applicable_product_tags: {
|
|
838
|
-
type: 'array',
|
|
839
|
-
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.',
|
|
840
|
-
items: {
|
|
841
|
-
type: 'string',
|
|
842
|
-
},
|
|
843
|
-
},
|
|
844
|
-
description: {
|
|
845
|
-
type: 'string',
|
|
846
|
-
},
|
|
847
|
-
name: {
|
|
848
|
-
type: 'string',
|
|
849
|
-
description: 'Specify the name of the line item for the threshold charge. If left blank, it will default to the commit product name.',
|
|
850
|
-
},
|
|
851
|
-
specifiers: {
|
|
852
|
-
type: 'array',
|
|
853
|
-
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`.",
|
|
854
|
-
items: {
|
|
855
|
-
type: 'object',
|
|
856
|
-
properties: {
|
|
857
|
-
presentation_group_values: {
|
|
858
|
-
type: 'object',
|
|
859
|
-
additionalProperties: true,
|
|
860
|
-
},
|
|
861
|
-
pricing_group_values: {
|
|
862
|
-
type: 'object',
|
|
863
|
-
additionalProperties: true,
|
|
864
|
-
},
|
|
865
|
-
product_id: {
|
|
866
|
-
type: 'string',
|
|
867
|
-
description: 'If provided, the specifier will only apply to the product with the specified ID.',
|
|
868
|
-
},
|
|
869
|
-
product_tags: {
|
|
870
|
-
type: 'array',
|
|
871
|
-
description: 'If provided, the specifier will only apply to products with all the specified tags.',
|
|
872
|
-
items: {
|
|
873
|
-
type: 'string',
|
|
874
|
-
},
|
|
875
|
-
},
|
|
876
|
-
},
|
|
877
|
-
},
|
|
878
|
-
},
|
|
879
|
-
},
|
|
880
|
-
required: ['product_id'],
|
|
881
|
-
},
|
|
882
|
-
is_enabled: {
|
|
883
|
-
type: 'boolean',
|
|
884
|
-
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.',
|
|
885
|
-
},
|
|
886
|
-
payment_gate_config: {
|
|
887
|
-
type: 'object',
|
|
888
|
-
properties: {
|
|
889
|
-
payment_gate_type: {
|
|
890
|
-
type: 'string',
|
|
891
|
-
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.',
|
|
892
|
-
enum: ['NONE', 'STRIPE', 'EXTERNAL'],
|
|
893
|
-
},
|
|
894
|
-
precalculated_tax_config: {
|
|
895
|
-
type: 'object',
|
|
896
|
-
description: 'Only applicable if using PRECALCULATED as your tax type.',
|
|
897
|
-
properties: {
|
|
898
|
-
tax_amount: {
|
|
899
|
-
type: 'number',
|
|
900
|
-
description: "Amount of tax to be applied. This should be in the same currency and denomination as the commit's invoice schedule",
|
|
901
|
-
},
|
|
902
|
-
tax_name: {
|
|
903
|
-
type: 'string',
|
|
904
|
-
description: 'Name of the tax to be applied. This may be used in an invoice line item description.',
|
|
905
|
-
},
|
|
906
|
-
},
|
|
907
|
-
required: ['tax_amount'],
|
|
908
|
-
},
|
|
909
|
-
stripe_config: {
|
|
910
|
-
type: 'object',
|
|
911
|
-
description: 'Only applicable if using STRIPE as your payment gate type.',
|
|
912
|
-
properties: {
|
|
913
|
-
payment_type: {
|
|
914
|
-
type: 'string',
|
|
915
|
-
description: 'If left blank, will default to INVOICE',
|
|
916
|
-
enum: ['INVOICE', 'PAYMENT_INTENT'],
|
|
917
|
-
},
|
|
918
|
-
invoice_metadata: {
|
|
919
|
-
type: 'object',
|
|
920
|
-
description: 'Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as your payment type.',
|
|
921
|
-
additionalProperties: true,
|
|
922
|
-
},
|
|
923
|
-
},
|
|
924
|
-
required: ['payment_type'],
|
|
925
|
-
},
|
|
926
|
-
tax_type: {
|
|
927
|
-
type: 'string',
|
|
928
|
-
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.',
|
|
929
|
-
enum: ['NONE', 'STRIPE', 'ANROK', 'PRECALCULATED'],
|
|
930
|
-
},
|
|
931
|
-
},
|
|
932
|
-
required: ['payment_gate_type'],
|
|
933
|
-
},
|
|
934
|
-
recharge_to_amount: {
|
|
935
|
-
type: 'number',
|
|
936
|
-
description: 'Specify the amount the balance should be recharged to.',
|
|
937
|
-
},
|
|
938
|
-
threshold_amount: {
|
|
939
|
-
type: 'number',
|
|
940
|
-
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.",
|
|
941
|
-
},
|
|
942
|
-
custom_credit_type_id: {
|
|
943
|
-
type: 'string',
|
|
944
|
-
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.',
|
|
945
|
-
},
|
|
946
|
-
},
|
|
947
|
-
required: ['commit', 'is_enabled', 'payment_gate_config', 'recharge_to_amount', 'threshold_amount'],
|
|
714
|
+
$ref: '#/$defs/prepaid_balance_threshold_configuration',
|
|
948
715
|
},
|
|
949
716
|
priority: {
|
|
950
717
|
type: 'number',
|
|
@@ -973,6 +740,7 @@ exports.tool = {
|
|
|
973
740
|
},
|
|
974
741
|
custom_fields: {
|
|
975
742
|
type: 'object',
|
|
743
|
+
description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
|
|
976
744
|
additionalProperties: true,
|
|
977
745
|
},
|
|
978
746
|
description: {
|
|
@@ -1065,51 +833,7 @@ exports.tool = {
|
|
|
1065
833
|
format: 'date-time',
|
|
1066
834
|
},
|
|
1067
835
|
hierarchy_configuration: {
|
|
1068
|
-
|
|
1069
|
-
description: 'Optional configuration for recurring commit/credit hierarchy access control',
|
|
1070
|
-
properties: {
|
|
1071
|
-
child_access: {
|
|
1072
|
-
anyOf: [
|
|
1073
|
-
{
|
|
1074
|
-
type: 'object',
|
|
1075
|
-
properties: {
|
|
1076
|
-
type: {
|
|
1077
|
-
type: 'string',
|
|
1078
|
-
enum: ['ALL'],
|
|
1079
|
-
},
|
|
1080
|
-
},
|
|
1081
|
-
required: ['type'],
|
|
1082
|
-
},
|
|
1083
|
-
{
|
|
1084
|
-
type: 'object',
|
|
1085
|
-
properties: {
|
|
1086
|
-
type: {
|
|
1087
|
-
type: 'string',
|
|
1088
|
-
enum: ['NONE'],
|
|
1089
|
-
},
|
|
1090
|
-
},
|
|
1091
|
-
required: ['type'],
|
|
1092
|
-
},
|
|
1093
|
-
{
|
|
1094
|
-
type: 'object',
|
|
1095
|
-
properties: {
|
|
1096
|
-
contract_ids: {
|
|
1097
|
-
type: 'array',
|
|
1098
|
-
items: {
|
|
1099
|
-
type: 'string',
|
|
1100
|
-
},
|
|
1101
|
-
},
|
|
1102
|
-
type: {
|
|
1103
|
-
type: 'string',
|
|
1104
|
-
enum: ['CONTRACT_IDS'],
|
|
1105
|
-
},
|
|
1106
|
-
},
|
|
1107
|
-
required: ['contract_ids', 'type'],
|
|
1108
|
-
},
|
|
1109
|
-
],
|
|
1110
|
-
},
|
|
1111
|
-
},
|
|
1112
|
-
required: ['child_access'],
|
|
836
|
+
$ref: '#/$defs/commit_hierarchy_configuration',
|
|
1113
837
|
},
|
|
1114
838
|
invoice_amount: {
|
|
1115
839
|
type: 'object',
|
|
@@ -1158,28 +882,7 @@ exports.tool = {
|
|
|
1158
882
|
type: 'array',
|
|
1159
883
|
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`.",
|
|
1160
884
|
items: {
|
|
1161
|
-
|
|
1162
|
-
properties: {
|
|
1163
|
-
presentation_group_values: {
|
|
1164
|
-
type: 'object',
|
|
1165
|
-
additionalProperties: true,
|
|
1166
|
-
},
|
|
1167
|
-
pricing_group_values: {
|
|
1168
|
-
type: 'object',
|
|
1169
|
-
additionalProperties: true,
|
|
1170
|
-
},
|
|
1171
|
-
product_id: {
|
|
1172
|
-
type: 'string',
|
|
1173
|
-
description: 'If provided, the specifier will only apply to the product with the specified ID.',
|
|
1174
|
-
},
|
|
1175
|
-
product_tags: {
|
|
1176
|
-
type: 'array',
|
|
1177
|
-
description: 'If provided, the specifier will only apply to products with all the specified tags.',
|
|
1178
|
-
items: {
|
|
1179
|
-
type: 'string',
|
|
1180
|
-
},
|
|
1181
|
-
},
|
|
1182
|
-
},
|
|
885
|
+
$ref: '#/$defs/commit_specifier_input',
|
|
1183
886
|
},
|
|
1184
887
|
},
|
|
1185
888
|
subscription_config: {
|
|
@@ -1203,7 +906,7 @@ exports.tool = {
|
|
|
1203
906
|
allocation: {
|
|
1204
907
|
type: 'string',
|
|
1205
908
|
description: 'If set to POOLED, allocation added per seat is pooled across the account.',
|
|
1206
|
-
enum: ['POOLED'],
|
|
909
|
+
enum: ['INDIVIDUAL', 'POOLED'],
|
|
1207
910
|
},
|
|
1208
911
|
},
|
|
1209
912
|
required: ['apply_seat_increase_config', 'subscription_id'],
|
|
@@ -1288,51 +991,7 @@ exports.tool = {
|
|
|
1288
991
|
format: 'date-time',
|
|
1289
992
|
},
|
|
1290
993
|
hierarchy_configuration: {
|
|
1291
|
-
|
|
1292
|
-
description: 'Optional configuration for recurring commit/credit hierarchy access control',
|
|
1293
|
-
properties: {
|
|
1294
|
-
child_access: {
|
|
1295
|
-
anyOf: [
|
|
1296
|
-
{
|
|
1297
|
-
type: 'object',
|
|
1298
|
-
properties: {
|
|
1299
|
-
type: {
|
|
1300
|
-
type: 'string',
|
|
1301
|
-
enum: ['ALL'],
|
|
1302
|
-
},
|
|
1303
|
-
},
|
|
1304
|
-
required: ['type'],
|
|
1305
|
-
},
|
|
1306
|
-
{
|
|
1307
|
-
type: 'object',
|
|
1308
|
-
properties: {
|
|
1309
|
-
type: {
|
|
1310
|
-
type: 'string',
|
|
1311
|
-
enum: ['NONE'],
|
|
1312
|
-
},
|
|
1313
|
-
},
|
|
1314
|
-
required: ['type'],
|
|
1315
|
-
},
|
|
1316
|
-
{
|
|
1317
|
-
type: 'object',
|
|
1318
|
-
properties: {
|
|
1319
|
-
contract_ids: {
|
|
1320
|
-
type: 'array',
|
|
1321
|
-
items: {
|
|
1322
|
-
type: 'string',
|
|
1323
|
-
},
|
|
1324
|
-
},
|
|
1325
|
-
type: {
|
|
1326
|
-
type: 'string',
|
|
1327
|
-
enum: ['CONTRACT_IDS'],
|
|
1328
|
-
},
|
|
1329
|
-
},
|
|
1330
|
-
required: ['contract_ids', 'type'],
|
|
1331
|
-
},
|
|
1332
|
-
],
|
|
1333
|
-
},
|
|
1334
|
-
},
|
|
1335
|
-
required: ['child_access'],
|
|
994
|
+
$ref: '#/$defs/commit_hierarchy_configuration',
|
|
1336
995
|
},
|
|
1337
996
|
name: {
|
|
1338
997
|
type: 'string',
|
|
@@ -1365,28 +1024,7 @@ exports.tool = {
|
|
|
1365
1024
|
type: 'array',
|
|
1366
1025
|
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`.",
|
|
1367
1026
|
items: {
|
|
1368
|
-
|
|
1369
|
-
properties: {
|
|
1370
|
-
presentation_group_values: {
|
|
1371
|
-
type: 'object',
|
|
1372
|
-
additionalProperties: true,
|
|
1373
|
-
},
|
|
1374
|
-
pricing_group_values: {
|
|
1375
|
-
type: 'object',
|
|
1376
|
-
additionalProperties: true,
|
|
1377
|
-
},
|
|
1378
|
-
product_id: {
|
|
1379
|
-
type: 'string',
|
|
1380
|
-
description: 'If provided, the specifier will only apply to the product with the specified ID.',
|
|
1381
|
-
},
|
|
1382
|
-
product_tags: {
|
|
1383
|
-
type: 'array',
|
|
1384
|
-
description: 'If provided, the specifier will only apply to products with all the specified tags.',
|
|
1385
|
-
items: {
|
|
1386
|
-
type: 'string',
|
|
1387
|
-
},
|
|
1388
|
-
},
|
|
1389
|
-
},
|
|
1027
|
+
$ref: '#/$defs/commit_specifier_input',
|
|
1390
1028
|
},
|
|
1391
1029
|
},
|
|
1392
1030
|
subscription_config: {
|
|
@@ -1410,7 +1048,7 @@ exports.tool = {
|
|
|
1410
1048
|
allocation: {
|
|
1411
1049
|
type: 'string',
|
|
1412
1050
|
description: 'If set to POOLED, allocation added per seat is pooled across the account.',
|
|
1413
|
-
enum: ['POOLED'],
|
|
1051
|
+
enum: ['INDIVIDUAL', 'POOLED'],
|
|
1414
1052
|
},
|
|
1415
1053
|
},
|
|
1416
1054
|
required: ['apply_seat_increase_config', 'subscription_id'],
|
|
@@ -1585,6 +1223,7 @@ exports.tool = {
|
|
|
1585
1223
|
},
|
|
1586
1224
|
custom_fields: {
|
|
1587
1225
|
type: 'object',
|
|
1226
|
+
description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
|
|
1588
1227
|
additionalProperties: true,
|
|
1589
1228
|
},
|
|
1590
1229
|
name: {
|
|
@@ -1605,83 +1244,7 @@ exports.tool = {
|
|
|
1605
1244
|
enum: ['ALL'],
|
|
1606
1245
|
},
|
|
1607
1246
|
spend_threshold_configuration: {
|
|
1608
|
-
|
|
1609
|
-
properties: {
|
|
1610
|
-
commit: {
|
|
1611
|
-
type: 'object',
|
|
1612
|
-
properties: {
|
|
1613
|
-
product_id: {
|
|
1614
|
-
type: 'string',
|
|
1615
|
-
description: 'The commit product that will be used to generate the line item for commit payment.',
|
|
1616
|
-
},
|
|
1617
|
-
description: {
|
|
1618
|
-
type: 'string',
|
|
1619
|
-
},
|
|
1620
|
-
name: {
|
|
1621
|
-
type: 'string',
|
|
1622
|
-
description: 'Specify the name of the line item for the threshold charge. If left blank, it will default to the commit product name.',
|
|
1623
|
-
},
|
|
1624
|
-
},
|
|
1625
|
-
required: ['product_id'],
|
|
1626
|
-
},
|
|
1627
|
-
is_enabled: {
|
|
1628
|
-
type: 'boolean',
|
|
1629
|
-
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.',
|
|
1630
|
-
},
|
|
1631
|
-
payment_gate_config: {
|
|
1632
|
-
type: 'object',
|
|
1633
|
-
properties: {
|
|
1634
|
-
payment_gate_type: {
|
|
1635
|
-
type: 'string',
|
|
1636
|
-
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.',
|
|
1637
|
-
enum: ['NONE', 'STRIPE', 'EXTERNAL'],
|
|
1638
|
-
},
|
|
1639
|
-
precalculated_tax_config: {
|
|
1640
|
-
type: 'object',
|
|
1641
|
-
description: 'Only applicable if using PRECALCULATED as your tax type.',
|
|
1642
|
-
properties: {
|
|
1643
|
-
tax_amount: {
|
|
1644
|
-
type: 'number',
|
|
1645
|
-
description: "Amount of tax to be applied. This should be in the same currency and denomination as the commit's invoice schedule",
|
|
1646
|
-
},
|
|
1647
|
-
tax_name: {
|
|
1648
|
-
type: 'string',
|
|
1649
|
-
description: 'Name of the tax to be applied. This may be used in an invoice line item description.',
|
|
1650
|
-
},
|
|
1651
|
-
},
|
|
1652
|
-
required: ['tax_amount'],
|
|
1653
|
-
},
|
|
1654
|
-
stripe_config: {
|
|
1655
|
-
type: 'object',
|
|
1656
|
-
description: 'Only applicable if using STRIPE as your payment gate type.',
|
|
1657
|
-
properties: {
|
|
1658
|
-
payment_type: {
|
|
1659
|
-
type: 'string',
|
|
1660
|
-
description: 'If left blank, will default to INVOICE',
|
|
1661
|
-
enum: ['INVOICE', 'PAYMENT_INTENT'],
|
|
1662
|
-
},
|
|
1663
|
-
invoice_metadata: {
|
|
1664
|
-
type: 'object',
|
|
1665
|
-
description: 'Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as your payment type.',
|
|
1666
|
-
additionalProperties: true,
|
|
1667
|
-
},
|
|
1668
|
-
},
|
|
1669
|
-
required: ['payment_type'],
|
|
1670
|
-
},
|
|
1671
|
-
tax_type: {
|
|
1672
|
-
type: 'string',
|
|
1673
|
-
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.',
|
|
1674
|
-
enum: ['NONE', 'STRIPE', 'ANROK', 'PRECALCULATED'],
|
|
1675
|
-
},
|
|
1676
|
-
},
|
|
1677
|
-
required: ['payment_gate_type'],
|
|
1678
|
-
},
|
|
1679
|
-
threshold_amount: {
|
|
1680
|
-
type: 'number',
|
|
1681
|
-
description: "Specify the threshold amount for the contract. Each time the contract's usage hits this amount, a threshold charge will be initiated.",
|
|
1682
|
-
},
|
|
1683
|
-
},
|
|
1684
|
-
required: ['commit', 'is_enabled', 'payment_gate_config', 'threshold_amount'],
|
|
1247
|
+
$ref: '#/$defs/spend_threshold_configuration',
|
|
1685
1248
|
},
|
|
1686
1249
|
subscriptions: {
|
|
1687
1250
|
type: 'array',
|
|
@@ -1693,10 +1256,6 @@ exports.tool = {
|
|
|
1693
1256
|
type: 'string',
|
|
1694
1257
|
enum: ['ADVANCE', 'ARREARS'],
|
|
1695
1258
|
},
|
|
1696
|
-
initial_quantity: {
|
|
1697
|
-
type: 'number',
|
|
1698
|
-
description: 'The initial quantity for the subscription. It must be non-negative value.',
|
|
1699
|
-
},
|
|
1700
1259
|
proration: {
|
|
1701
1260
|
type: 'object',
|
|
1702
1261
|
properties: {
|
|
@@ -1728,6 +1287,7 @@ exports.tool = {
|
|
|
1728
1287
|
},
|
|
1729
1288
|
custom_fields: {
|
|
1730
1289
|
type: 'object',
|
|
1290
|
+
description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }',
|
|
1731
1291
|
additionalProperties: true,
|
|
1732
1292
|
},
|
|
1733
1293
|
description: {
|
|
@@ -1738,9 +1298,18 @@ exports.tool = {
|
|
|
1738
1298
|
description: 'Exclusive end time for the subscription. If not provided, subscription inherits contract end date.',
|
|
1739
1299
|
format: 'date-time',
|
|
1740
1300
|
},
|
|
1301
|
+
initial_quantity: {
|
|
1302
|
+
type: 'number',
|
|
1303
|
+
description: 'The initial quantity for the subscription. It must be non-negative value. Required if quantity_management_mode is QUANTITY_ONLY.',
|
|
1304
|
+
},
|
|
1741
1305
|
name: {
|
|
1742
1306
|
type: 'string',
|
|
1743
1307
|
},
|
|
1308
|
+
quantity_management_mode: {
|
|
1309
|
+
type: 'string',
|
|
1310
|
+
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.",
|
|
1311
|
+
enum: ['SEAT_BASED', 'QUANTITY_ONLY'],
|
|
1312
|
+
},
|
|
1744
1313
|
starting_at: {
|
|
1745
1314
|
type: 'string',
|
|
1746
1315
|
description: 'Inclusive start time for the subscription. If not provided, defaults to contract start date',
|
|
@@ -1751,7 +1320,7 @@ exports.tool = {
|
|
|
1751
1320
|
description: 'A temporary ID used to reference the subscription in recurring commit/credit subscription configs created within the same payload.',
|
|
1752
1321
|
},
|
|
1753
1322
|
},
|
|
1754
|
-
required: ['collection_schedule', '
|
|
1323
|
+
required: ['collection_schedule', 'proration', 'subscription_rate'],
|
|
1755
1324
|
},
|
|
1756
1325
|
},
|
|
1757
1326
|
total_contract_value: {
|
|
@@ -1817,6 +1386,76 @@ exports.tool = {
|
|
|
1817
1386
|
},
|
|
1818
1387
|
required: ['customer_id', 'starting_at'],
|
|
1819
1388
|
$defs: {
|
|
1389
|
+
commit_hierarchy_configuration: {
|
|
1390
|
+
type: 'object',
|
|
1391
|
+
properties: {
|
|
1392
|
+
child_access: {
|
|
1393
|
+
anyOf: [
|
|
1394
|
+
{
|
|
1395
|
+
type: 'object',
|
|
1396
|
+
properties: {
|
|
1397
|
+
type: {
|
|
1398
|
+
type: 'string',
|
|
1399
|
+
enum: ['ALL'],
|
|
1400
|
+
},
|
|
1401
|
+
},
|
|
1402
|
+
required: ['type'],
|
|
1403
|
+
},
|
|
1404
|
+
{
|
|
1405
|
+
type: 'object',
|
|
1406
|
+
properties: {
|
|
1407
|
+
type: {
|
|
1408
|
+
type: 'string',
|
|
1409
|
+
enum: ['NONE'],
|
|
1410
|
+
},
|
|
1411
|
+
},
|
|
1412
|
+
required: ['type'],
|
|
1413
|
+
},
|
|
1414
|
+
{
|
|
1415
|
+
type: 'object',
|
|
1416
|
+
properties: {
|
|
1417
|
+
contract_ids: {
|
|
1418
|
+
type: 'array',
|
|
1419
|
+
items: {
|
|
1420
|
+
type: 'string',
|
|
1421
|
+
},
|
|
1422
|
+
},
|
|
1423
|
+
type: {
|
|
1424
|
+
type: 'string',
|
|
1425
|
+
enum: ['CONTRACT_IDS'],
|
|
1426
|
+
},
|
|
1427
|
+
},
|
|
1428
|
+
required: ['contract_ids', 'type'],
|
|
1429
|
+
},
|
|
1430
|
+
],
|
|
1431
|
+
},
|
|
1432
|
+
},
|
|
1433
|
+
required: ['child_access'],
|
|
1434
|
+
},
|
|
1435
|
+
commit_specifier_input: {
|
|
1436
|
+
type: 'object',
|
|
1437
|
+
properties: {
|
|
1438
|
+
presentation_group_values: {
|
|
1439
|
+
type: 'object',
|
|
1440
|
+
additionalProperties: true,
|
|
1441
|
+
},
|
|
1442
|
+
pricing_group_values: {
|
|
1443
|
+
type: 'object',
|
|
1444
|
+
additionalProperties: true,
|
|
1445
|
+
},
|
|
1446
|
+
product_id: {
|
|
1447
|
+
type: 'string',
|
|
1448
|
+
description: 'If provided, the specifier will only apply to the product with the specified ID.',
|
|
1449
|
+
},
|
|
1450
|
+
product_tags: {
|
|
1451
|
+
type: 'array',
|
|
1452
|
+
description: 'If provided, the specifier will only apply to products with all the specified tags.',
|
|
1453
|
+
items: {
|
|
1454
|
+
type: 'string',
|
|
1455
|
+
},
|
|
1456
|
+
},
|
|
1457
|
+
},
|
|
1458
|
+
},
|
|
1820
1459
|
tier: {
|
|
1821
1460
|
type: 'object',
|
|
1822
1461
|
properties: {
|
|
@@ -1829,6 +1468,123 @@ exports.tool = {
|
|
|
1829
1468
|
},
|
|
1830
1469
|
required: ['price'],
|
|
1831
1470
|
},
|
|
1471
|
+
prepaid_balance_threshold_configuration: {
|
|
1472
|
+
type: 'object',
|
|
1473
|
+
properties: {
|
|
1474
|
+
commit: {
|
|
1475
|
+
allOf: [
|
|
1476
|
+
{
|
|
1477
|
+
$ref: '#/$defs/base_threshold_commit',
|
|
1478
|
+
},
|
|
1479
|
+
],
|
|
1480
|
+
},
|
|
1481
|
+
is_enabled: {
|
|
1482
|
+
type: 'boolean',
|
|
1483
|
+
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.',
|
|
1484
|
+
},
|
|
1485
|
+
payment_gate_config: {
|
|
1486
|
+
$ref: '#/$defs/payment_gate_config',
|
|
1487
|
+
},
|
|
1488
|
+
recharge_to_amount: {
|
|
1489
|
+
type: 'number',
|
|
1490
|
+
description: 'Specify the amount the balance should be recharged to.',
|
|
1491
|
+
},
|
|
1492
|
+
threshold_amount: {
|
|
1493
|
+
type: 'number',
|
|
1494
|
+
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.",
|
|
1495
|
+
},
|
|
1496
|
+
custom_credit_type_id: {
|
|
1497
|
+
type: 'string',
|
|
1498
|
+
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.',
|
|
1499
|
+
},
|
|
1500
|
+
},
|
|
1501
|
+
required: ['commit', 'is_enabled', 'payment_gate_config', 'recharge_to_amount', 'threshold_amount'],
|
|
1502
|
+
},
|
|
1503
|
+
base_threshold_commit: {
|
|
1504
|
+
type: 'object',
|
|
1505
|
+
properties: {
|
|
1506
|
+
product_id: {
|
|
1507
|
+
type: 'string',
|
|
1508
|
+
description: 'The commit product that will be used to generate the line item for commit payment.',
|
|
1509
|
+
},
|
|
1510
|
+
description: {
|
|
1511
|
+
type: 'string',
|
|
1512
|
+
},
|
|
1513
|
+
name: {
|
|
1514
|
+
type: 'string',
|
|
1515
|
+
description: 'Specify the name of the line item for the threshold charge. If left blank, it will default to the commit product name.',
|
|
1516
|
+
},
|
|
1517
|
+
},
|
|
1518
|
+
required: ['product_id'],
|
|
1519
|
+
},
|
|
1520
|
+
payment_gate_config: {
|
|
1521
|
+
type: 'object',
|
|
1522
|
+
properties: {
|
|
1523
|
+
payment_gate_type: {
|
|
1524
|
+
type: 'string',
|
|
1525
|
+
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.',
|
|
1526
|
+
enum: ['NONE', 'STRIPE', 'EXTERNAL'],
|
|
1527
|
+
},
|
|
1528
|
+
precalculated_tax_config: {
|
|
1529
|
+
type: 'object',
|
|
1530
|
+
description: 'Only applicable if using PRECALCULATED as your tax type.',
|
|
1531
|
+
properties: {
|
|
1532
|
+
tax_amount: {
|
|
1533
|
+
type: 'number',
|
|
1534
|
+
description: "Amount of tax to be applied. This should be in the same currency and denomination as the commit's invoice schedule",
|
|
1535
|
+
},
|
|
1536
|
+
tax_name: {
|
|
1537
|
+
type: 'string',
|
|
1538
|
+
description: 'Name of the tax to be applied. This may be used in an invoice line item description.',
|
|
1539
|
+
},
|
|
1540
|
+
},
|
|
1541
|
+
required: ['tax_amount'],
|
|
1542
|
+
},
|
|
1543
|
+
stripe_config: {
|
|
1544
|
+
type: 'object',
|
|
1545
|
+
description: 'Only applicable if using STRIPE as your payment gate type.',
|
|
1546
|
+
properties: {
|
|
1547
|
+
payment_type: {
|
|
1548
|
+
type: 'string',
|
|
1549
|
+
description: 'If left blank, will default to INVOICE',
|
|
1550
|
+
enum: ['INVOICE', 'PAYMENT_INTENT'],
|
|
1551
|
+
},
|
|
1552
|
+
invoice_metadata: {
|
|
1553
|
+
type: 'object',
|
|
1554
|
+
description: 'Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as your payment type.',
|
|
1555
|
+
additionalProperties: true,
|
|
1556
|
+
},
|
|
1557
|
+
},
|
|
1558
|
+
required: ['payment_type'],
|
|
1559
|
+
},
|
|
1560
|
+
tax_type: {
|
|
1561
|
+
type: 'string',
|
|
1562
|
+
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.',
|
|
1563
|
+
enum: ['NONE', 'STRIPE', 'ANROK', 'AVALARA', 'PRECALCULATED'],
|
|
1564
|
+
},
|
|
1565
|
+
},
|
|
1566
|
+
required: ['payment_gate_type'],
|
|
1567
|
+
},
|
|
1568
|
+
spend_threshold_configuration: {
|
|
1569
|
+
type: 'object',
|
|
1570
|
+
properties: {
|
|
1571
|
+
commit: {
|
|
1572
|
+
$ref: '#/$defs/base_threshold_commit',
|
|
1573
|
+
},
|
|
1574
|
+
is_enabled: {
|
|
1575
|
+
type: 'boolean',
|
|
1576
|
+
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.',
|
|
1577
|
+
},
|
|
1578
|
+
payment_gate_config: {
|
|
1579
|
+
$ref: '#/$defs/payment_gate_config',
|
|
1580
|
+
},
|
|
1581
|
+
threshold_amount: {
|
|
1582
|
+
type: 'number',
|
|
1583
|
+
description: "Specify the threshold amount for the contract. Each time the contract's usage hits this amount, a threshold charge will be initiated.",
|
|
1584
|
+
},
|
|
1585
|
+
},
|
|
1586
|
+
required: ['commit', 'is_enabled', 'payment_gate_config', 'threshold_amount'],
|
|
1587
|
+
},
|
|
1832
1588
|
base_usage_filter: {
|
|
1833
1589
|
type: 'object',
|
|
1834
1590
|
properties: {
|