@flexprice/sdk 2.1.30 → 2.1.33
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 +2 -2
- package/docs/sdk/models/add-addon-params.md +5 -4
- package/docs/sdk/models/add-addon-request.md +1 -0
- package/docs/sdk/models/add-addon-to-subscription-request.md +1 -0
- package/docs/sdk/models/aggregated-entitlement-bucket.md +1 -0
- package/docs/sdk/models/aggregated-entitlement.md +16 -10
- package/docs/sdk/models/analytics-column.md +18 -0
- package/docs/sdk/models/analytics-filter.md +18 -0
- package/docs/sdk/models/analytics-query-meta.md +15 -0
- package/docs/sdk/models/analytics-query-request.md +23 -0
- package/docs/sdk/models/analytics-query-result.md +17 -0
- package/docs/sdk/models/analytics-sort-spec.md +16 -0
- package/docs/sdk/models/analytics-time-spec-raw.md +16 -0
- package/docs/sdk/models/analytics-variable.md +20 -0
- package/docs/sdk/models/analytics-view-definition.md +27 -0
- package/docs/sdk/models/cancel-checkout-session-request.md +17 -0
- package/docs/sdk/models/changed-addon-association-action.md +19 -0
- package/docs/sdk/models/changed-addon-association.md +20 -0
- package/docs/sdk/models/changed-resources.md +6 -5
- package/docs/sdk/models/checkout-action.md +2 -2
- package/docs/sdk/models/checkout-configuration.md +1 -0
- package/docs/sdk/models/checkout-params.md +1 -0
- package/docs/sdk/models/checkout-session-response.md +1 -0
- package/docs/sdk/models/column-role.md +17 -0
- package/docs/sdk/models/column-type.md +17 -0
- package/docs/sdk/models/create-checkout-session-request.md +1 -0
- package/docs/sdk/models/create-entitlement-request.md +1 -0
- package/docs/sdk/models/create-invoice-request.md +1 -0
- package/docs/sdk/models/create-scheduled-task-request.md +1 -1
- package/docs/sdk/models/create-subscription-request.md +1 -0
- package/docs/sdk/models/create-view-request.md +24 -0
- package/docs/sdk/models/entitlement-grant-status.md +17 -0
- package/docs/sdk/models/entity-creation-conflict-policies.md +15 -0
- package/docs/sdk/models/entity-creation-options.md +15 -0
- package/docs/sdk/models/entity-creation-result.md +16 -0
- package/docs/sdk/models/entity-creation-status.md +17 -0
- package/docs/sdk/models/event.md +11 -10
- package/docs/sdk/models/execute-subscription-modify-request-request.md +1 -1
- package/docs/sdk/models/execute-subscription-modify-request.md +2 -0
- package/docs/sdk/models/fact-status.md +17 -0
- package/docs/sdk/models/feature-usage-summary.md +18 -11
- package/docs/sdk/models/filter-operator-type.md +3 -1
- package/docs/sdk/models/get-event-by-id-response.md +1 -0
- package/docs/sdk/models/grain.md +17 -0
- package/docs/sdk/models/grant-allowance-state.md +27 -0
- package/docs/sdk/models/grant-state.md +15 -0
- package/docs/sdk/models/invoice-filter.md +3 -1
- package/docs/sdk/models/invoice-response.md +2 -0
- package/docs/sdk/models/invoice-source-type.md +15 -0
- package/docs/sdk/models/line-item-change.md +20 -0
- package/docs/sdk/models/line-item-grouping.md +17 -0
- package/docs/sdk/models/metric.md +17 -0
- package/docs/sdk/models/modify-subscription-line-item.md +1 -0
- package/docs/sdk/models/modify-subscription-params.md +1 -0
- package/docs/sdk/models/modify-subscription-type.md +15 -0
- package/docs/sdk/models/on-existing-entity-policy.md +15 -0
- package/docs/sdk/models/override-entitlement-request.md +7 -0
- package/docs/sdk/models/pay-invoice-params.md +17 -0
- package/docs/sdk/models/preview-subscription-modify-request.md +1 -1
- package/docs/sdk/models/price-filter.md +22 -21
- package/docs/sdk/models/query-analytics-view-request.md +19 -0
- package/docs/sdk/models/remove-addon-ref.md +18 -0
- package/docs/sdk/models/remove-addon-request.md +1 -0
- package/docs/sdk/models/revenue-allocation-policy.md +17 -0
- package/docs/sdk/models/revenue-analytics-request.md +28 -0
- package/docs/sdk/models/revenue-analytics-response.md +17 -0
- package/docs/sdk/models/revenue-analytics-row.md +28 -0
- package/docs/sdk/models/revenue-granularity.md +17 -0
- package/docs/sdk/models/scheduled-task-entity-type.md +1 -1
- package/docs/sdk/models/shape.md +17 -0
- package/docs/sdk/models/sort-direction.md +3 -1
- package/docs/sdk/models/sub-modify-bulk-addon-params.md +16 -0
- package/docs/sdk/models/sub-modify-line-item-change-request.md +21 -0
- package/docs/sdk/models/subscription-change-entity-type.md +2 -2
- package/docs/sdk/models/subscription-modify-type.md +2 -2
- package/docs/sdk/models/subscription-response-v2.md +1 -0
- package/docs/sdk/models/subscription-response.md +1 -0
- package/docs/sdk/models/subscription-schedule-response.md +2 -2
- package/docs/sdk/models/update-entitlement-request.md +15 -15
- package/docs/sdk/models/usage-analytic-item.md +1 -0
- package/docs/sdk/models/variable-type.md +17 -0
- package/docs/sdk/models/view-query-request.md +15 -0
- package/docs/sdk/models/view-response.md +18 -0
- package/docs/sdks/analytics/README.md +329 -0
- package/docs/sdks/checkout/README.md +74 -2
- package/docs/sdks/invoices/README.md +1 -0
- package/docs/sdks/subscriptions/README.md +6 -4
- package/esm/funcs/analytics-create-analytics-view.d.ts +17 -0
- package/esm/funcs/analytics-create-analytics-view.d.ts.map +1 -0
- package/esm/funcs/analytics-create-analytics-view.js +83 -0
- package/esm/funcs/analytics-create-analytics-view.js.map +1 -0
- package/esm/funcs/analytics-get-revenue-analytics.d.ts +17 -0
- package/esm/funcs/analytics-get-revenue-analytics.d.ts.map +1 -0
- package/esm/funcs/analytics-get-revenue-analytics.js +83 -0
- package/esm/funcs/analytics-get-revenue-analytics.js.map +1 -0
- package/esm/funcs/analytics-query-analytics-view.d.ts +17 -0
- package/esm/funcs/analytics-query-analytics-view.d.ts.map +1 -0
- package/esm/funcs/analytics-query-analytics-view.js +93 -0
- package/esm/funcs/analytics-query-analytics-view.js.map +1 -0
- package/esm/funcs/analytics-query-analytics.d.ts +17 -0
- package/esm/funcs/analytics-query-analytics.d.ts.map +1 -0
- package/esm/funcs/analytics-query-analytics.js +83 -0
- package/esm/funcs/analytics-query-analytics.js.map +1 -0
- package/esm/funcs/checkout-cancel-checkout-session.d.ts +14 -0
- package/esm/funcs/checkout-cancel-checkout-session.d.ts.map +1 -0
- package/esm/funcs/checkout-cancel-checkout-session.js +88 -0
- package/esm/funcs/checkout-cancel-checkout-session.js.map +1 -0
- package/esm/funcs/invoices-create-invoice.d.ts +1 -0
- package/esm/funcs/invoices-create-invoice.d.ts.map +1 -1
- package/esm/funcs/invoices-create-invoice.js +1 -0
- package/esm/funcs/invoices-create-invoice.js.map +1 -1
- package/esm/funcs/subscriptions-execute-subscription-modify.d.ts +2 -1
- package/esm/funcs/subscriptions-execute-subscription-modify.d.ts.map +1 -1
- package/esm/funcs/subscriptions-execute-subscription-modify.js +2 -1
- package/esm/funcs/subscriptions-execute-subscription-modify.js.map +1 -1
- package/esm/funcs/subscriptions-preview-subscription-modify.d.ts +2 -1
- package/esm/funcs/subscriptions-preview-subscription-modify.d.ts.map +1 -1
- package/esm/funcs/subscriptions-preview-subscription-modify.js +2 -1
- package/esm/funcs/subscriptions-preview-subscription-modify.js.map +1 -1
- package/esm/lib/config.d.ts +3 -3
- package/esm/lib/config.js +3 -3
- package/esm/sdk/analytics.d.ts +33 -0
- package/esm/sdk/analytics.d.ts.map +1 -0
- package/esm/sdk/analytics.js +48 -0
- package/esm/sdk/analytics.js.map +1 -0
- package/esm/sdk/checkout.d.ts +4 -0
- package/esm/sdk/checkout.d.ts.map +1 -1
- package/esm/sdk/checkout.js +7 -0
- package/esm/sdk/checkout.js.map +1 -1
- package/esm/sdk/invoices.d.ts +1 -0
- package/esm/sdk/invoices.d.ts.map +1 -1
- package/esm/sdk/invoices.js +1 -0
- package/esm/sdk/invoices.js.map +1 -1
- package/esm/sdk/models/add-addon-params.d.ts +3 -0
- package/esm/sdk/models/add-addon-params.d.ts.map +1 -1
- package/esm/sdk/models/add-addon-params.js +2 -0
- package/esm/sdk/models/add-addon-params.js.map +1 -1
- package/esm/sdk/models/add-addon-request.d.ts +3 -0
- package/esm/sdk/models/add-addon-request.d.ts.map +1 -1
- package/esm/sdk/models/add-addon-request.js +3 -0
- package/esm/sdk/models/add-addon-request.js.map +1 -1
- package/esm/sdk/models/add-addon-to-subscription-request.d.ts +3 -0
- package/esm/sdk/models/add-addon-to-subscription-request.d.ts.map +1 -1
- package/esm/sdk/models/add-addon-to-subscription-request.js +3 -0
- package/esm/sdk/models/add-addon-to-subscription-request.js.map +1 -1
- package/esm/sdk/models/aggregated-entitlement-bucket.d.ts +1 -0
- package/esm/sdk/models/aggregated-entitlement-bucket.d.ts.map +1 -1
- package/esm/sdk/models/aggregated-entitlement-bucket.js +2 -0
- package/esm/sdk/models/aggregated-entitlement-bucket.js.map +1 -1
- package/esm/sdk/models/aggregated-entitlement.d.ts +9 -0
- package/esm/sdk/models/aggregated-entitlement.d.ts.map +1 -1
- package/esm/sdk/models/aggregated-entitlement.js +15 -0
- package/esm/sdk/models/aggregated-entitlement.js.map +1 -1
- package/esm/sdk/models/analytics-column.d.ts +15 -0
- package/esm/sdk/models/analytics-column.d.ts.map +1 -0
- package/esm/sdk/models/analytics-column.js +19 -0
- package/esm/sdk/models/analytics-column.js.map +1 -0
- package/esm/sdk/models/analytics-filter.d.ts +24 -0
- package/esm/sdk/models/analytics-filter.d.ts.map +1 -0
- package/esm/sdk/models/analytics-filter.js +28 -0
- package/esm/sdk/models/analytics-filter.js.map +1 -0
- package/esm/sdk/models/analytics-query-meta.d.ts +10 -0
- package/esm/sdk/models/analytics-query-meta.d.ts.map +1 -0
- package/esm/sdk/models/analytics-query-meta.js +19 -0
- package/esm/sdk/models/analytics-query-meta.js.map +1 -0
- package/esm/sdk/models/analytics-query-request.d.ts +19 -0
- package/esm/sdk/models/analytics-query-request.d.ts.map +1 -0
- package/esm/sdk/models/analytics-query-request.js +14 -0
- package/esm/sdk/models/analytics-query-request.js.map +1 -0
- package/esm/sdk/models/analytics-query-result.d.ts +14 -0
- package/esm/sdk/models/analytics-query-result.d.ts.map +1 -0
- package/esm/sdk/models/analytics-query-result.js +18 -0
- package/esm/sdk/models/analytics-query-result.js.map +1 -0
- package/esm/sdk/models/analytics-sort-spec.d.ts +20 -0
- package/esm/sdk/models/analytics-sort-spec.d.ts.map +1 -0
- package/esm/sdk/models/analytics-sort-spec.js +24 -0
- package/esm/sdk/models/analytics-sort-spec.js.map +1 -0
- package/esm/sdk/models/analytics-time-spec-raw.d.ts +20 -0
- package/esm/sdk/models/analytics-time-spec-raw.d.ts.map +1 -0
- package/esm/sdk/models/analytics-time-spec-raw.js +24 -0
- package/esm/sdk/models/analytics-time-spec-raw.js.map +1 -0
- package/esm/sdk/models/analytics-variable.d.ts +24 -0
- package/esm/sdk/models/analytics-variable.d.ts.map +1 -0
- package/esm/sdk/models/analytics-variable.js +28 -0
- package/esm/sdk/models/analytics-variable.js.map +1 -0
- package/esm/sdk/models/analytics-view-definition.d.ts +37 -0
- package/esm/sdk/models/analytics-view-definition.d.ts.map +1 -0
- package/esm/sdk/models/analytics-view-definition.js +41 -0
- package/esm/sdk/models/analytics-view-definition.js.map +1 -0
- package/esm/sdk/models/cancel-checkout-session-op.d.ts +15 -0
- package/esm/sdk/models/cancel-checkout-session-op.d.ts.map +1 -0
- package/esm/sdk/models/cancel-checkout-session-op.js +12 -0
- package/esm/sdk/models/cancel-checkout-session-op.js.map +1 -0
- package/esm/sdk/models/changed-addon-association-action.d.ts +16 -0
- package/esm/sdk/models/changed-addon-association-action.d.ts.map +1 -0
- package/esm/sdk/models/changed-addon-association-action.js +14 -0
- package/esm/sdk/models/changed-addon-association-action.js.map +1 -0
- package/esm/sdk/models/changed-addon-association.d.ts +20 -0
- package/esm/sdk/models/changed-addon-association.d.ts.map +1 -0
- package/esm/sdk/models/changed-addon-association.js +30 -0
- package/esm/sdk/models/changed-addon-association.js.map +1 -0
- package/esm/sdk/models/changed-resources.d.ts +2 -0
- package/esm/sdk/models/changed-resources.d.ts.map +1 -1
- package/esm/sdk/models/changed-resources.js +3 -0
- package/esm/sdk/models/changed-resources.js.map +1 -1
- package/esm/sdk/models/checkout-action.d.ts +1 -0
- package/esm/sdk/models/checkout-action.d.ts.map +1 -1
- package/esm/sdk/models/checkout-action.js +1 -0
- package/esm/sdk/models/checkout-action.js.map +1 -1
- package/esm/sdk/models/checkout-configuration.d.ts +3 -0
- package/esm/sdk/models/checkout-configuration.d.ts.map +1 -1
- package/esm/sdk/models/checkout-configuration.js +3 -0
- package/esm/sdk/models/checkout-configuration.js.map +1 -1
- package/esm/sdk/models/checkout-params.d.ts +3 -0
- package/esm/sdk/models/checkout-params.d.ts.map +1 -1
- package/esm/sdk/models/checkout-params.js +3 -0
- package/esm/sdk/models/checkout-params.js.map +1 -1
- package/esm/sdk/models/checkout-session-response.d.ts +2 -0
- package/esm/sdk/models/checkout-session-response.d.ts.map +1 -1
- package/esm/sdk/models/checkout-session-response.js +3 -0
- package/esm/sdk/models/checkout-session-response.js.map +1 -1
- package/esm/sdk/models/column-role.d.ts +10 -0
- package/esm/sdk/models/column-role.d.ts.map +1 -0
- package/esm/sdk/models/column-role.js +11 -0
- package/esm/sdk/models/column-role.js.map +1 -0
- package/esm/sdk/models/column-type.d.ts +11 -0
- package/esm/sdk/models/column-type.d.ts.map +1 -0
- package/esm/sdk/models/column-type.js +12 -0
- package/esm/sdk/models/column-type.js.map +1 -0
- package/esm/sdk/models/create-checkout-session-request.d.ts +3 -0
- package/esm/sdk/models/create-checkout-session-request.d.ts.map +1 -1
- package/esm/sdk/models/create-checkout-session-request.js +3 -0
- package/esm/sdk/models/create-checkout-session-request.js.map +1 -1
- package/esm/sdk/models/create-entitlement-request.d.ts +2 -0
- package/esm/sdk/models/create-entitlement-request.d.ts.map +1 -1
- package/esm/sdk/models/create-entitlement-request.js +2 -0
- package/esm/sdk/models/create-entitlement-request.js.map +1 -1
- package/esm/sdk/models/create-invoice-request.d.ts +3 -0
- package/esm/sdk/models/create-invoice-request.d.ts.map +1 -1
- package/esm/sdk/models/create-invoice-request.js +2 -0
- package/esm/sdk/models/create-invoice-request.js.map +1 -1
- package/esm/sdk/models/create-subscription-request.d.ts +3 -0
- package/esm/sdk/models/create-subscription-request.d.ts.map +1 -1
- package/esm/sdk/models/create-subscription-request.js +3 -0
- package/esm/sdk/models/create-subscription-request.js.map +1 -1
- package/esm/sdk/models/create-view-request.d.ts +15 -0
- package/esm/sdk/models/create-view-request.d.ts.map +1 -0
- package/esm/sdk/models/create-view-request.js +14 -0
- package/esm/sdk/models/create-view-request.js.map +1 -0
- package/esm/sdk/models/entitlement-grant-status.d.ts +10 -0
- package/esm/sdk/models/entitlement-grant-status.d.ts.map +1 -0
- package/esm/sdk/models/entitlement-grant-status.js +11 -0
- package/esm/sdk/models/entitlement-grant-status.js.map +1 -0
- package/esm/sdk/models/entity-creation-conflict-policies.d.ts +13 -0
- package/esm/sdk/models/entity-creation-conflict-policies.d.ts.map +1 -0
- package/esm/sdk/models/entity-creation-conflict-policies.js +18 -0
- package/esm/sdk/models/entity-creation-conflict-policies.js.map +1 -0
- package/esm/sdk/models/entity-creation-options.d.ts +13 -0
- package/esm/sdk/models/entity-creation-options.d.ts.map +1 -0
- package/esm/sdk/models/entity-creation-options.js +18 -0
- package/esm/sdk/models/entity-creation-options.js.map +1 -0
- package/esm/sdk/models/entity-creation-result.d.ts +12 -0
- package/esm/sdk/models/entity-creation-result.d.ts.map +1 -0
- package/esm/sdk/models/entity-creation-result.js +21 -0
- package/esm/sdk/models/entity-creation-result.js.map +1 -0
- package/esm/sdk/models/entity-creation-status.d.ts +11 -0
- package/esm/sdk/models/entity-creation-status.d.ts.map +1 -0
- package/esm/sdk/models/entity-creation-status.js +12 -0
- package/esm/sdk/models/entity-creation-status.js.map +1 -0
- package/esm/sdk/models/event.d.ts +1 -0
- package/esm/sdk/models/event.d.ts.map +1 -1
- package/esm/sdk/models/event.js +2 -0
- package/esm/sdk/models/event.js.map +1 -1
- package/esm/sdk/models/execute-subscription-modify-request.d.ts +6 -0
- package/esm/sdk/models/execute-subscription-modify-request.d.ts.map +1 -1
- package/esm/sdk/models/execute-subscription-modify-request.js +6 -0
- package/esm/sdk/models/execute-subscription-modify-request.js.map +1 -1
- package/esm/sdk/models/fact-status.d.ts +12 -0
- package/esm/sdk/models/fact-status.d.ts.map +1 -0
- package/esm/sdk/models/fact-status.js +13 -0
- package/esm/sdk/models/fact-status.js.map +1 -0
- package/esm/sdk/models/feature-usage-summary.d.ts +19 -0
- package/esm/sdk/models/feature-usage-summary.d.ts.map +1 -1
- package/esm/sdk/models/feature-usage-summary.js +17 -0
- package/esm/sdk/models/feature-usage-summary.js.map +1 -1
- package/esm/sdk/models/filter-operator-type.d.ts +5 -3
- package/esm/sdk/models/filter-operator-type.d.ts.map +1 -1
- package/esm/sdk/models/filter-operator-type.js +4 -2
- package/esm/sdk/models/filter-operator-type.js.map +1 -1
- package/esm/sdk/models/get-event-by-id-response.d.ts +1 -0
- package/esm/sdk/models/get-event-by-id-response.d.ts.map +1 -1
- package/esm/sdk/models/get-event-by-id-response.js +1 -0
- package/esm/sdk/models/get-event-by-id-response.js.map +1 -1
- package/esm/sdk/models/grain.d.ts +14 -0
- package/esm/sdk/models/grain.d.ts.map +1 -0
- package/esm/sdk/models/grain.js +17 -0
- package/esm/sdk/models/grain.js.map +1 -0
- package/esm/sdk/models/grant-allowance-state.d.ts +24 -0
- package/esm/sdk/models/grant-allowance-state.d.ts.map +1 -0
- package/esm/sdk/models/grant-allowance-state.js +39 -0
- package/esm/sdk/models/grant-allowance-state.js.map +1 -0
- package/esm/sdk/models/grant-state.d.ts +11 -0
- package/esm/sdk/models/grant-state.d.ts.map +1 -0
- package/esm/sdk/models/grant-state.js +16 -0
- package/esm/sdk/models/grant-state.js.map +1 -0
- package/esm/sdk/models/index.d.ts +44 -0
- package/esm/sdk/models/index.d.ts.map +1 -1
- package/esm/sdk/models/index.js +44 -0
- package/esm/sdk/models/index.js.map +1 -1
- package/esm/sdk/models/invoice-filter.d.ts +10 -0
- package/esm/sdk/models/invoice-filter.d.ts.map +1 -1
- package/esm/sdk/models/invoice-filter.js +4 -0
- package/esm/sdk/models/invoice-filter.js.map +1 -1
- package/esm/sdk/models/invoice-response.d.ts +4 -0
- package/esm/sdk/models/invoice-response.d.ts.map +1 -1
- package/esm/sdk/models/invoice-response.js +6 -0
- package/esm/sdk/models/invoice-response.js.map +1 -1
- package/esm/sdk/models/invoice-source-type.d.ts +9 -0
- package/esm/sdk/models/invoice-source-type.d.ts.map +1 -0
- package/esm/sdk/models/invoice-source-type.js +10 -0
- package/esm/sdk/models/invoice-source-type.js.map +1 -0
- package/esm/sdk/models/line-item-change.d.ts +21 -0
- package/esm/sdk/models/line-item-change.d.ts.map +1 -0
- package/esm/sdk/models/line-item-change.js +20 -0
- package/esm/sdk/models/line-item-change.js.map +1 -0
- package/esm/sdk/models/line-item-grouping.d.ts +12 -0
- package/esm/sdk/models/line-item-grouping.d.ts.map +1 -0
- package/esm/sdk/models/line-item-grouping.js +13 -0
- package/esm/sdk/models/line-item-grouping.js.map +1 -0
- package/esm/sdk/models/metric.d.ts +12 -0
- package/esm/sdk/models/metric.d.ts.map +1 -0
- package/esm/sdk/models/metric.js +15 -0
- package/esm/sdk/models/metric.js.map +1 -0
- package/esm/sdk/models/modify-subscription-line-item.d.ts +2 -0
- package/esm/sdk/models/modify-subscription-line-item.d.ts.map +1 -1
- package/esm/sdk/models/modify-subscription-line-item.js +1 -0
- package/esm/sdk/models/modify-subscription-line-item.js.map +1 -1
- package/esm/sdk/models/modify-subscription-params.d.ts +3 -0
- package/esm/sdk/models/modify-subscription-params.d.ts.map +1 -1
- package/esm/sdk/models/modify-subscription-params.js +3 -0
- package/esm/sdk/models/modify-subscription-params.js.map +1 -1
- package/esm/sdk/models/modify-subscription-type.d.ts +10 -0
- package/esm/sdk/models/modify-subscription-type.d.ts.map +1 -0
- package/esm/sdk/models/modify-subscription-type.js +11 -0
- package/esm/sdk/models/modify-subscription-type.js.map +1 -0
- package/esm/sdk/models/on-existing-entity-policy.d.ts +10 -0
- package/esm/sdk/models/on-existing-entity-policy.d.ts.map +1 -0
- package/esm/sdk/models/on-existing-entity-policy.js +11 -0
- package/esm/sdk/models/on-existing-entity-policy.js.map +1 -0
- package/esm/sdk/models/override-entitlement-request.d.ts +18 -0
- package/esm/sdk/models/override-entitlement-request.d.ts.map +1 -1
- package/esm/sdk/models/override-entitlement-request.js +18 -0
- package/esm/sdk/models/override-entitlement-request.js.map +1 -1
- package/esm/sdk/models/pay-invoice-params.d.ts +12 -0
- package/esm/sdk/models/pay-invoice-params.d.ts.map +1 -0
- package/esm/sdk/models/pay-invoice-params.js +17 -0
- package/esm/sdk/models/pay-invoice-params.js.map +1 -0
- package/esm/sdk/models/price-filter.d.ts +9 -0
- package/esm/sdk/models/price-filter.d.ts.map +1 -1
- package/esm/sdk/models/price-filter.js +2 -0
- package/esm/sdk/models/price-filter.js.map +1 -1
- package/esm/sdk/models/query-analytics-view-op.d.ts +21 -0
- package/esm/sdk/models/query-analytics-view-op.d.ts.map +1 -0
- package/esm/sdk/models/query-analytics-view-op.js +14 -0
- package/esm/sdk/models/query-analytics-view-op.js.map +1 -0
- package/esm/sdk/models/remove-addon-ref.d.ts +19 -0
- package/esm/sdk/models/remove-addon-ref.d.ts.map +1 -0
- package/esm/sdk/models/remove-addon-ref.js +23 -0
- package/esm/sdk/models/remove-addon-ref.js.map +1 -0
- package/esm/sdk/models/remove-addon-request.d.ts +3 -0
- package/esm/sdk/models/remove-addon-request.d.ts.map +1 -1
- package/esm/sdk/models/remove-addon-request.js +3 -0
- package/esm/sdk/models/remove-addon-request.js.map +1 -1
- package/esm/sdk/models/revenue-allocation-policy.d.ts +12 -0
- package/esm/sdk/models/revenue-allocation-policy.d.ts.map +1 -0
- package/esm/sdk/models/revenue-allocation-policy.js +13 -0
- package/esm/sdk/models/revenue-allocation-policy.js.map +1 -0
- package/esm/sdk/models/revenue-analytics-request.d.ts +70 -0
- package/esm/sdk/models/revenue-analytics-request.d.ts.map +1 -0
- package/esm/sdk/models/revenue-analytics-request.js +71 -0
- package/esm/sdk/models/revenue-analytics-request.js.map +1 -0
- package/esm/sdk/models/revenue-analytics-response.d.ts +22 -0
- package/esm/sdk/models/revenue-analytics-response.d.ts.map +1 -0
- package/esm/sdk/models/revenue-analytics-response.js +23 -0
- package/esm/sdk/models/revenue-analytics-response.js.map +1 -0
- package/esm/sdk/models/revenue-analytics-row.d.ts +38 -0
- package/esm/sdk/models/revenue-analytics-row.d.ts.map +1 -0
- package/esm/sdk/models/revenue-analytics-row.js +43 -0
- package/esm/sdk/models/revenue-analytics-row.js.map +1 -0
- package/esm/sdk/models/revenue-granularity.d.ts +13 -0
- package/esm/sdk/models/revenue-granularity.d.ts.map +1 -0
- package/esm/sdk/models/revenue-granularity.js +14 -0
- package/esm/sdk/models/revenue-granularity.js.map +1 -0
- package/esm/sdk/models/scheduled-task-entity-type.d.ts +1 -0
- package/esm/sdk/models/scheduled-task-entity-type.d.ts.map +1 -1
- package/esm/sdk/models/scheduled-task-entity-type.js +1 -0
- package/esm/sdk/models/scheduled-task-entity-type.js.map +1 -1
- package/esm/sdk/models/shape.d.ts +12 -0
- package/esm/sdk/models/shape.d.ts.map +1 -0
- package/esm/sdk/models/shape.js +15 -0
- package/esm/sdk/models/shape.js.map +1 -0
- package/esm/sdk/models/sort-direction.d.ts +5 -3
- package/esm/sdk/models/sort-direction.d.ts.map +1 -1
- package/esm/sdk/models/sort-direction.js +4 -2
- package/esm/sdk/models/sort-direction.js.map +1 -1
- package/esm/sdk/models/sub-modify-bulk-addon-params.d.ts +16 -0
- package/esm/sdk/models/sub-modify-bulk-addon-params.d.ts.map +1 -0
- package/esm/sdk/models/sub-modify-bulk-addon-params.js +15 -0
- package/esm/sdk/models/sub-modify-bulk-addon-params.js.map +1 -0
- package/esm/sdk/models/sub-modify-line-item-change-request.d.ts +13 -0
- package/esm/sdk/models/sub-modify-line-item-change-request.d.ts.map +1 -0
- package/esm/sdk/models/sub-modify-line-item-change-request.js +18 -0
- package/esm/sdk/models/sub-modify-line-item-change-request.js.map +1 -0
- package/esm/sdk/models/subscription-change-entity-type.d.ts +1 -1
- package/esm/sdk/models/subscription-change-entity-type.js +1 -1
- package/esm/sdk/models/subscription-change-entity-type.js.map +1 -1
- package/esm/sdk/models/subscription-modify-type.d.ts +1 -0
- package/esm/sdk/models/subscription-modify-type.d.ts.map +1 -1
- package/esm/sdk/models/subscription-modify-type.js +1 -0
- package/esm/sdk/models/subscription-modify-type.js.map +1 -1
- package/esm/sdk/models/subscription-response-v2.d.ts +2 -0
- package/esm/sdk/models/subscription-response-v2.d.ts.map +1 -1
- package/esm/sdk/models/subscription-response-v2.js +3 -0
- package/esm/sdk/models/subscription-response-v2.js.map +1 -1
- package/esm/sdk/models/subscription-response.d.ts +2 -0
- package/esm/sdk/models/subscription-response.d.ts.map +1 -1
- package/esm/sdk/models/subscription-response.js +3 -0
- package/esm/sdk/models/subscription-response.js.map +1 -1
- package/esm/sdk/models/subscription-schedule-response.d.ts +6 -16
- package/esm/sdk/models/subscription-schedule-response.d.ts.map +1 -1
- package/esm/sdk/models/subscription-schedule-response.js +2 -12
- package/esm/sdk/models/subscription-schedule-response.js.map +1 -1
- package/esm/sdk/models/update-entitlement-request.d.ts +2 -8
- package/esm/sdk/models/update-entitlement-request.d.ts.map +1 -1
- package/esm/sdk/models/update-entitlement-request.js +2 -2
- package/esm/sdk/models/update-entitlement-request.js.map +1 -1
- package/esm/sdk/models/usage-analytic-item.d.ts +4 -0
- package/esm/sdk/models/usage-analytic-item.d.ts.map +1 -1
- package/esm/sdk/models/usage-analytic-item.js +2 -0
- package/esm/sdk/models/usage-analytic-item.js.map +1 -1
- package/esm/sdk/models/variable-type.d.ts +16 -0
- package/esm/sdk/models/variable-type.d.ts.map +1 -0
- package/esm/sdk/models/variable-type.js +17 -0
- package/esm/sdk/models/variable-type.js.map +1 -0
- package/esm/sdk/models/view-query-request.d.ts +16 -0
- package/esm/sdk/models/view-query-request.d.ts.map +1 -0
- package/esm/sdk/models/view-query-request.js +12 -0
- package/esm/sdk/models/view-query-request.js.map +1 -0
- package/esm/sdk/models/view-response.d.ts +14 -0
- package/esm/sdk/models/view-response.d.ts.map +1 -0
- package/esm/sdk/models/view-response.js +18 -0
- package/esm/sdk/models/view-response.js.map +1 -0
- package/esm/sdk/sdk.d.ts +3 -0
- package/esm/sdk/sdk.d.ts.map +1 -1
- package/esm/sdk/sdk.js +5 -0
- package/esm/sdk/sdk.js.map +1 -1
- package/esm/sdk/subscriptions.d.ts +4 -2
- package/esm/sdk/subscriptions.d.ts.map +1 -1
- package/esm/sdk/subscriptions.js +4 -2
- package/esm/sdk/subscriptions.js.map +1 -1
- package/examples/README.md +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/analytics-create-analytics-view.ts +172 -0
- package/src/funcs/analytics-get-revenue-analytics.ts +172 -0
- package/src/funcs/analytics-query-analytics-view.ts +186 -0
- package/src/funcs/analytics-query-analytics.ts +172 -0
- package/src/funcs/checkout-cancel-checkout-session.ts +179 -0
- package/src/funcs/invoices-create-invoice.ts +1 -0
- package/src/funcs/subscriptions-execute-subscription-modify.ts +2 -1
- package/src/funcs/subscriptions-preview-subscription-modify.ts +2 -1
- package/src/lib/config.ts +3 -3
- package/src/sdk/analytics.ts +83 -0
- package/src/sdk/checkout.ts +15 -0
- package/src/sdk/invoices.ts +1 -0
- package/src/sdk/models/add-addon-params.ts +8 -0
- package/src/sdk/models/add-addon-request.ts +5 -0
- package/src/sdk/models/add-addon-to-subscription-request.ts +5 -0
- package/src/sdk/models/aggregated-entitlement-bucket.ts +3 -0
- package/src/sdk/models/aggregated-entitlement.ts +29 -0
- package/src/sdk/models/analytics-column.ts +39 -0
- package/src/sdk/models/analytics-filter.ts +65 -0
- package/src/sdk/models/analytics-query-meta.ts +39 -0
- package/src/sdk/models/analytics-query-request.ts +38 -0
- package/src/sdk/models/analytics-query-result.ts +43 -0
- package/src/sdk/models/analytics-sort-spec.ts +59 -0
- package/src/sdk/models/analytics-time-spec-raw.ts +55 -0
- package/src/sdk/models/analytics-variable.ts +67 -0
- package/src/sdk/models/analytics-view-definition.ts +108 -0
- package/src/sdk/models/cancel-checkout-session-op.ts +35 -0
- package/src/sdk/models/changed-addon-association-action.ts +27 -0
- package/src/sdk/models/changed-addon-association.ts +61 -0
- package/src/sdk/models/changed-resources.ts +9 -0
- package/src/sdk/models/checkout-action.ts +1 -0
- package/src/sdk/models/checkout-configuration.ts +9 -0
- package/src/sdk/models/checkout-params.ts +9 -0
- package/src/sdk/models/checkout-session-response.ts +7 -0
- package/src/sdk/models/column-role.ts +17 -0
- package/src/sdk/models/column-type.ts +18 -0
- package/src/sdk/models/create-checkout-session-request.ts +9 -0
- package/src/sdk/models/create-entitlement-request.ts +4 -0
- package/src/sdk/models/create-invoice-request.ts +8 -0
- package/src/sdk/models/create-subscription-request.ts +8 -0
- package/src/sdk/models/create-view-request.ts +38 -0
- package/src/sdk/models/entitlement-grant-status.ts +19 -0
- package/src/sdk/models/entity-creation-conflict-policies.ts +44 -0
- package/src/sdk/models/entity-creation-options.ts +47 -0
- package/src/sdk/models/entity-creation-result.ts +45 -0
- package/src/sdk/models/entity-creation-status.ts +20 -0
- package/src/sdk/models/event.ts +3 -0
- package/src/sdk/models/execute-subscription-modify-request.ts +20 -0
- package/src/sdk/models/fact-status.ts +20 -0
- package/src/sdk/models/feature-usage-summary.ts +43 -0
- package/src/sdk/models/filter-operator-type.ts +12 -5
- package/src/sdk/models/get-event-by-id-response.ts +2 -0
- package/src/sdk/models/grain.ts +22 -0
- package/src/sdk/models/grant-allowance-state.ts +77 -0
- package/src/sdk/models/grant-state.ts +33 -0
- package/src/sdk/models/index.ts +44 -0
- package/src/sdk/models/invoice-filter.ts +18 -0
- package/src/sdk/models/invoice-response.ts +14 -0
- package/src/sdk/models/invoice-source-type.ts +16 -0
- package/src/sdk/models/line-item-change.ts +48 -0
- package/src/sdk/models/line-item-grouping.ts +24 -0
- package/src/sdk/models/metric.ts +20 -0
- package/src/sdk/models/modify-subscription-line-item.ts +3 -0
- package/src/sdk/models/modify-subscription-params.ts +8 -0
- package/src/sdk/models/modify-subscription-type.ts +17 -0
- package/src/sdk/models/on-existing-entity-policy.ts +17 -0
- package/src/sdk/models/override-entitlement-request.ts +46 -0
- package/src/sdk/models/pay-invoice-params.ts +38 -0
- package/src/sdk/models/price-filter.ts +11 -0
- package/src/sdk/models/query-analytics-view-op.ts +44 -0
- package/src/sdk/models/remove-addon-ref.ts +51 -0
- package/src/sdk/models/remove-addon-request.ts +5 -0
- package/src/sdk/models/revenue-allocation-policy.ts +24 -0
- package/src/sdk/models/revenue-analytics-request.ts +168 -0
- package/src/sdk/models/revenue-analytics-response.ts +59 -0
- package/src/sdk/models/revenue-analytics-row.ts +88 -0
- package/src/sdk/models/revenue-granularity.ts +25 -0
- package/src/sdk/models/scheduled-task-entity-type.ts +1 -0
- package/src/sdk/models/shape.ts +20 -0
- package/src/sdk/models/sort-direction.ts +12 -4
- package/src/sdk/models/sub-modify-bulk-addon-params.ts +43 -0
- package/src/sdk/models/sub-modify-line-item-change-request.ts +45 -0
- package/src/sdk/models/subscription-change-entity-type.ts +1 -1
- package/src/sdk/models/subscription-modify-type.ts +1 -0
- package/src/sdk/models/subscription-response-v2.ts +7 -0
- package/src/sdk/models/subscription-response.ts +7 -0
- package/src/sdk/models/subscription-schedule-response.ts +4 -48
- package/src/sdk/models/update-entitlement-request.ts +4 -10
- package/src/sdk/models/usage-analytic-item.ts +6 -0
- package/src/sdk/models/variable-type.ts +24 -0
- package/src/sdk/models/view-query-request.ts +30 -0
- package/src/sdk/models/view-response.ts +39 -0
- package/src/sdk/sdk.ts +6 -0
- package/src/sdk/subscriptions.ts +4 -2
- package/docs/sdk/models/configuration.md +0 -16
- package/docs/sdk/models/execution-result.md +0 -16
|
@@ -8,7 +8,7 @@ import { OpenEnum } from "../../types/enums.js";
|
|
|
8
8
|
|
|
9
9
|
export const SubscriptionChangeEntityType = {
|
|
10
10
|
Plan: "plan",
|
|
11
|
-
|
|
11
|
+
AddonAssociation: "addon_association",
|
|
12
12
|
CreditGrant: "credit_grant",
|
|
13
13
|
Entitlement: "entitlement",
|
|
14
14
|
EntitlementGrant: "entitlement_grant",
|
|
@@ -28,6 +28,10 @@ import {
|
|
|
28
28
|
CustomerResponse,
|
|
29
29
|
CustomerResponse$inboundSchema,
|
|
30
30
|
} from "./customer-response.js";
|
|
31
|
+
import {
|
|
32
|
+
LineItemGrouping,
|
|
33
|
+
LineItemGrouping$inboundSchema,
|
|
34
|
+
} from "./line-item-grouping.js";
|
|
31
35
|
import { PauseStatus, PauseStatus$inboundSchema } from "./pause-status.js";
|
|
32
36
|
import { PaymentTerms, PaymentTerms$inboundSchema } from "./payment-terms.js";
|
|
33
37
|
import { PlanResponse, PlanResponse$inboundSchema } from "./plan-response.js";
|
|
@@ -170,6 +174,7 @@ export type SubscriptionResponseV2 = {
|
|
|
170
174
|
* This can differ from the subscription customer (e.g., parent company invoicing for child company)
|
|
171
175
|
*/
|
|
172
176
|
invoicingCustomerId?: string | undefined;
|
|
177
|
+
lineItemGrouping?: LineItemGrouping | undefined;
|
|
173
178
|
/**
|
|
174
179
|
* LineItems is expanded only if "subscription_line_items" is in expand parameter
|
|
175
180
|
*
|
|
@@ -287,6 +292,7 @@ export const SubscriptionResponseV2$inboundSchema: z.ZodMiniType<
|
|
|
287
292
|
gateway_payment_method_id: types.optional(types.string()),
|
|
288
293
|
id: types.optional(types.string()),
|
|
289
294
|
invoicing_customer_id: types.optional(types.string()),
|
|
295
|
+
line_item_grouping: types.optional(LineItemGrouping$inboundSchema),
|
|
290
296
|
line_items: types.optional(
|
|
291
297
|
z.array(SubscriptionLineItemResponse$inboundSchema),
|
|
292
298
|
),
|
|
@@ -345,6 +351,7 @@ export const SubscriptionResponseV2$inboundSchema: z.ZodMiniType<
|
|
|
345
351
|
"environment_id": "environmentId",
|
|
346
352
|
"gateway_payment_method_id": "gatewayPaymentMethodId",
|
|
347
353
|
"invoicing_customer_id": "invoicingCustomerId",
|
|
354
|
+
"line_item_grouping": "lineItemGrouping",
|
|
348
355
|
"line_items": "lineItems",
|
|
349
356
|
"lookup_key": "lookupKey",
|
|
350
357
|
"overage_factor": "overageFactor",
|
|
@@ -40,6 +40,10 @@ import {
|
|
|
40
40
|
InvoiceResponse,
|
|
41
41
|
InvoiceResponse$inboundSchema,
|
|
42
42
|
} from "./invoice-response.js";
|
|
43
|
+
import {
|
|
44
|
+
LineItemGrouping,
|
|
45
|
+
LineItemGrouping$inboundSchema,
|
|
46
|
+
} from "./line-item-grouping.js";
|
|
43
47
|
import { PauseStatus, PauseStatus$inboundSchema } from "./pause-status.js";
|
|
44
48
|
import { PaymentTerms, PaymentTerms$inboundSchema } from "./payment-terms.js";
|
|
45
49
|
import { PlanResponse, PlanResponse$inboundSchema } from "./plan-response.js";
|
|
@@ -192,6 +196,7 @@ export type SubscriptionResponse = {
|
|
|
192
196
|
*/
|
|
193
197
|
invoicingCustomerId?: string | undefined;
|
|
194
198
|
latestInvoice?: InvoiceResponse | undefined;
|
|
199
|
+
lineItemGrouping?: LineItemGrouping | undefined;
|
|
195
200
|
lineItems?: Array<SubscriptionSubscriptionLineItem> | undefined;
|
|
196
201
|
/**
|
|
197
202
|
* LookupKey is the key used to lookup the subscription in our system
|
|
@@ -295,6 +300,7 @@ export const SubscriptionResponse$inboundSchema: z.ZodMiniType<
|
|
|
295
300
|
id: types.optional(types.string()),
|
|
296
301
|
invoicing_customer_id: types.optional(types.string()),
|
|
297
302
|
latest_invoice: types.optional(z.lazy(() => InvoiceResponse$inboundSchema)),
|
|
303
|
+
line_item_grouping: types.optional(LineItemGrouping$inboundSchema),
|
|
298
304
|
line_items: types.optional(
|
|
299
305
|
z.array(SubscriptionSubscriptionLineItem$inboundSchema),
|
|
300
306
|
),
|
|
@@ -354,6 +360,7 @@ export const SubscriptionResponse$inboundSchema: z.ZodMiniType<
|
|
|
354
360
|
"gateway_payment_method_id": "gatewayPaymentMethodId",
|
|
355
361
|
"invoicing_customer_id": "invoicingCustomerId",
|
|
356
362
|
"latest_invoice": "latestInvoice",
|
|
363
|
+
"line_item_grouping": "lineItemGrouping",
|
|
357
364
|
"line_items": "lineItems",
|
|
358
365
|
"lookup_key": "lookupKey",
|
|
359
366
|
"overage_factor": "overageFactor",
|
|
@@ -17,16 +17,6 @@ import {
|
|
|
17
17
|
SubscriptionScheduleChangeType$inboundSchema,
|
|
18
18
|
} from "./subscription-schedule-change-type.js";
|
|
19
19
|
|
|
20
|
-
/**
|
|
21
|
-
* configuration contains type-specific configuration (e.g., target_plan_id for plan changes)
|
|
22
|
-
*/
|
|
23
|
-
export type Configuration = {};
|
|
24
|
-
|
|
25
|
-
/**
|
|
26
|
-
* execution_result contains type-specific execution result
|
|
27
|
-
*/
|
|
28
|
-
export type ExecutionResult = {};
|
|
29
|
-
|
|
30
20
|
/**
|
|
31
21
|
* Full details of a subscription schedule
|
|
32
22
|
*/
|
|
@@ -42,7 +32,7 @@ export type SubscriptionScheduleResponse = {
|
|
|
42
32
|
/**
|
|
43
33
|
* configuration contains type-specific configuration (e.g., target_plan_id for plan changes)
|
|
44
34
|
*/
|
|
45
|
-
configuration?:
|
|
35
|
+
configuration?: { [k: string]: any } | undefined;
|
|
46
36
|
/**
|
|
47
37
|
* created_at timestamp
|
|
48
38
|
*/
|
|
@@ -62,7 +52,7 @@ export type SubscriptionScheduleResponse = {
|
|
|
62
52
|
/**
|
|
63
53
|
* execution_result contains type-specific execution result
|
|
64
54
|
*/
|
|
65
|
-
executionResult?:
|
|
55
|
+
executionResult?: { [k: string]: any } | undefined;
|
|
66
56
|
/**
|
|
67
57
|
* id of the schedule
|
|
68
58
|
*/
|
|
@@ -87,38 +77,6 @@ export type SubscriptionScheduleResponse = {
|
|
|
87
77
|
updatedAt?: Date | undefined;
|
|
88
78
|
};
|
|
89
79
|
|
|
90
|
-
/** @internal */
|
|
91
|
-
export const Configuration$inboundSchema: z.ZodMiniType<
|
|
92
|
-
Configuration,
|
|
93
|
-
unknown
|
|
94
|
-
> = z.object({});
|
|
95
|
-
|
|
96
|
-
export function configurationFromJSON(
|
|
97
|
-
jsonString: string,
|
|
98
|
-
): SafeParseResult<Configuration, SDKValidationError> {
|
|
99
|
-
return safeParse(
|
|
100
|
-
jsonString,
|
|
101
|
-
(x) => Configuration$inboundSchema.parse(JSON.parse(x)),
|
|
102
|
-
`Failed to parse 'Configuration' from JSON`,
|
|
103
|
-
);
|
|
104
|
-
}
|
|
105
|
-
|
|
106
|
-
/** @internal */
|
|
107
|
-
export const ExecutionResult$inboundSchema: z.ZodMiniType<
|
|
108
|
-
ExecutionResult,
|
|
109
|
-
unknown
|
|
110
|
-
> = z.object({});
|
|
111
|
-
|
|
112
|
-
export function executionResultFromJSON(
|
|
113
|
-
jsonString: string,
|
|
114
|
-
): SafeParseResult<ExecutionResult, SDKValidationError> {
|
|
115
|
-
return safeParse(
|
|
116
|
-
jsonString,
|
|
117
|
-
(x) => ExecutionResult$inboundSchema.parse(JSON.parse(x)),
|
|
118
|
-
`Failed to parse 'ExecutionResult' from JSON`,
|
|
119
|
-
);
|
|
120
|
-
}
|
|
121
|
-
|
|
122
80
|
/** @internal */
|
|
123
81
|
export const SubscriptionScheduleResponse$inboundSchema: z.ZodMiniType<
|
|
124
82
|
SubscriptionScheduleResponse,
|
|
@@ -127,14 +85,12 @@ export const SubscriptionScheduleResponse$inboundSchema: z.ZodMiniType<
|
|
|
127
85
|
z.object({
|
|
128
86
|
can_be_cancelled: types.optional(types.boolean()),
|
|
129
87
|
cancelled_at: types.optional(types.date()),
|
|
130
|
-
configuration: types.optional(z.
|
|
88
|
+
configuration: types.optional(z.record(z.string(), z.any())),
|
|
131
89
|
created_at: types.optional(types.date()),
|
|
132
90
|
days_until_execution: types.optional(types.number()),
|
|
133
91
|
error_message: types.optional(types.string()),
|
|
134
92
|
executed_at: types.optional(types.date()),
|
|
135
|
-
execution_result: types.optional(
|
|
136
|
-
z.lazy(() => ExecutionResult$inboundSchema),
|
|
137
|
-
),
|
|
93
|
+
execution_result: types.optional(z.record(z.string(), z.any())),
|
|
138
94
|
id: types.optional(types.string()),
|
|
139
95
|
metadata: types.optional(z.record(z.string(), types.string())),
|
|
140
96
|
schedule_type: types.optional(SubscriptionScheduleChangeType$inboundSchema),
|
|
@@ -27,19 +27,13 @@ import {
|
|
|
27
27
|
|
|
28
28
|
export type UpdateEntitlementRequest = {
|
|
29
29
|
aggregationMode?: EntitlementAggregationMode | undefined;
|
|
30
|
-
/**
|
|
31
|
-
* Grant config — nil fields leave the current value alone.
|
|
32
|
-
*
|
|
33
|
-
* @remarks
|
|
34
|
-
* ClearGrantConfig=true wipes the whole grant config (back to a legacy entitlement).
|
|
35
|
-
*/
|
|
36
|
-
clearGrantConfig?: boolean | undefined;
|
|
37
30
|
configValue?: { [k: string]: any } | undefined;
|
|
38
31
|
grantAllocationBehavior?: EntitlementGrantAllocationBehavior | undefined;
|
|
39
32
|
grantDurationUnit?: EntitlementGrantDurationUnit | undefined;
|
|
40
33
|
grantDurationValue?: number | undefined;
|
|
41
34
|
grantMeasure?: EntitlementGrantMeasure | undefined;
|
|
42
35
|
grantQuota?: string | undefined;
|
|
36
|
+
grantUnlimited?: boolean | undefined;
|
|
43
37
|
isEnabled?: boolean | undefined;
|
|
44
38
|
isSoftLimit?: boolean | undefined;
|
|
45
39
|
staticValue?: string | undefined;
|
|
@@ -50,13 +44,13 @@ export type UpdateEntitlementRequest = {
|
|
|
50
44
|
/** @internal */
|
|
51
45
|
export type UpdateEntitlementRequest$Outbound = {
|
|
52
46
|
aggregation_mode?: string | undefined;
|
|
53
|
-
clear_grant_config?: boolean | undefined;
|
|
54
47
|
config_value?: { [k: string]: any } | undefined;
|
|
55
48
|
grant_allocation_behavior?: string | undefined;
|
|
56
49
|
grant_duration_unit?: string | undefined;
|
|
57
50
|
grant_duration_value?: number | undefined;
|
|
58
51
|
grant_measure?: string | undefined;
|
|
59
52
|
grant_quota?: string | undefined;
|
|
53
|
+
grant_unlimited?: boolean | undefined;
|
|
60
54
|
is_enabled?: boolean | undefined;
|
|
61
55
|
is_soft_limit?: boolean | undefined;
|
|
62
56
|
static_value?: string | undefined;
|
|
@@ -71,7 +65,6 @@ export const UpdateEntitlementRequest$outboundSchema: z.ZodMiniType<
|
|
|
71
65
|
> = z.pipe(
|
|
72
66
|
z.object({
|
|
73
67
|
aggregationMode: z.optional(EntitlementAggregationMode$outboundSchema),
|
|
74
|
-
clearGrantConfig: z.optional(z.boolean()),
|
|
75
68
|
configValue: z.optional(z.record(z.string(), z.any())),
|
|
76
69
|
grantAllocationBehavior: z.optional(
|
|
77
70
|
EntitlementGrantAllocationBehavior$outboundSchema,
|
|
@@ -80,6 +73,7 @@ export const UpdateEntitlementRequest$outboundSchema: z.ZodMiniType<
|
|
|
80
73
|
grantDurationValue: z.optional(z.int()),
|
|
81
74
|
grantMeasure: z.optional(EntitlementGrantMeasure$outboundSchema),
|
|
82
75
|
grantQuota: z.optional(z.string()),
|
|
76
|
+
grantUnlimited: z.optional(z.boolean()),
|
|
83
77
|
isEnabled: z.optional(z.boolean()),
|
|
84
78
|
isSoftLimit: z.optional(z.boolean()),
|
|
85
79
|
staticValue: z.optional(z.string()),
|
|
@@ -89,13 +83,13 @@ export const UpdateEntitlementRequest$outboundSchema: z.ZodMiniType<
|
|
|
89
83
|
z.transform((v) => {
|
|
90
84
|
return remap$(v, {
|
|
91
85
|
aggregationMode: "aggregation_mode",
|
|
92
|
-
clearGrantConfig: "clear_grant_config",
|
|
93
86
|
configValue: "config_value",
|
|
94
87
|
grantAllocationBehavior: "grant_allocation_behavior",
|
|
95
88
|
grantDurationUnit: "grant_duration_unit",
|
|
96
89
|
grantDurationValue: "grant_duration_value",
|
|
97
90
|
grantMeasure: "grant_measure",
|
|
98
91
|
grantQuota: "grant_quota",
|
|
92
|
+
grantUnlimited: "grant_unlimited",
|
|
99
93
|
isEnabled: "is_enabled",
|
|
100
94
|
isSoftLimit: "is_soft_limit",
|
|
101
95
|
staticValue: "static_value",
|
|
@@ -61,6 +61,10 @@ export type UsageAnalyticItem = {
|
|
|
61
61
|
*/
|
|
62
62
|
eventCount?: number | undefined;
|
|
63
63
|
eventName?: string | undefined;
|
|
64
|
+
/**
|
|
65
|
+
* Populated only when "external_customer_id" is a group_by dimension
|
|
66
|
+
*/
|
|
67
|
+
externalCustomerId?: string | undefined;
|
|
64
68
|
feature?: Feature | undefined;
|
|
65
69
|
featureId?: string | undefined;
|
|
66
70
|
group?: GroupGroup | undefined;
|
|
@@ -127,6 +131,7 @@ export const UsageAnalyticItem$inboundSchema: z.ZodMiniType<
|
|
|
127
131
|
currency: types.optional(types.string()),
|
|
128
132
|
event_count: types.optional(types.number()),
|
|
129
133
|
event_name: types.optional(types.string()),
|
|
134
|
+
external_customer_id: types.optional(types.string()),
|
|
130
135
|
feature: types.optional(Feature$inboundSchema),
|
|
131
136
|
feature_id: types.optional(types.string()),
|
|
132
137
|
group: types.optional(GroupGroup$inboundSchema),
|
|
@@ -164,6 +169,7 @@ export const UsageAnalyticItem$inboundSchema: z.ZodMiniType<
|
|
|
164
169
|
"commitment_info": "commitmentInfo",
|
|
165
170
|
"event_count": "eventCount",
|
|
166
171
|
"event_name": "eventName",
|
|
172
|
+
"external_customer_id": "externalCustomerId",
|
|
167
173
|
"feature_id": "featureId",
|
|
168
174
|
"meter_id": "meterId",
|
|
169
175
|
"plan_id": "planId",
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v4-mini";
|
|
6
|
+
import * as openEnums from "../../types/enums.js";
|
|
7
|
+
import { OpenEnum } from "../../types/enums.js";
|
|
8
|
+
|
|
9
|
+
export const VariableType = {
|
|
10
|
+
DateRange: "date_range",
|
|
11
|
+
String: "string",
|
|
12
|
+
StringList: "string_list",
|
|
13
|
+
Number: "number",
|
|
14
|
+
Enum: "enum",
|
|
15
|
+
Boolean: "boolean",
|
|
16
|
+
} as const;
|
|
17
|
+
export type VariableType = OpenEnum<typeof VariableType>;
|
|
18
|
+
|
|
19
|
+
/** @internal */
|
|
20
|
+
export const VariableType$inboundSchema: z.ZodMiniType<VariableType, unknown> =
|
|
21
|
+
openEnums.inboundSchema(VariableType);
|
|
22
|
+
/** @internal */
|
|
23
|
+
export const VariableType$outboundSchema: z.ZodMiniType<string, VariableType> =
|
|
24
|
+
openEnums.outboundSchema(VariableType);
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v4-mini";
|
|
6
|
+
|
|
7
|
+
export type ViewQueryRequest = {
|
|
8
|
+
variables?: { [k: string]: Array<string> } | undefined;
|
|
9
|
+
};
|
|
10
|
+
|
|
11
|
+
/** @internal */
|
|
12
|
+
export type ViewQueryRequest$Outbound = {
|
|
13
|
+
variables?: { [k: string]: Array<string> } | undefined;
|
|
14
|
+
};
|
|
15
|
+
|
|
16
|
+
/** @internal */
|
|
17
|
+
export const ViewQueryRequest$outboundSchema: z.ZodMiniType<
|
|
18
|
+
ViewQueryRequest$Outbound,
|
|
19
|
+
ViewQueryRequest
|
|
20
|
+
> = z.object({
|
|
21
|
+
variables: z.optional(z.record(z.string(), z.array(z.string()))),
|
|
22
|
+
});
|
|
23
|
+
|
|
24
|
+
export function viewQueryRequestToJSON(
|
|
25
|
+
viewQueryRequest: ViewQueryRequest,
|
|
26
|
+
): string {
|
|
27
|
+
return JSON.stringify(
|
|
28
|
+
ViewQueryRequest$outboundSchema.parse(viewQueryRequest),
|
|
29
|
+
);
|
|
30
|
+
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v4-mini";
|
|
6
|
+
import { safeParse } from "../../lib/schemas.js";
|
|
7
|
+
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
8
|
+
import * as types from "../../types/primitives.js";
|
|
9
|
+
import {
|
|
10
|
+
AnalyticsViewDefinition,
|
|
11
|
+
AnalyticsViewDefinition$inboundSchema,
|
|
12
|
+
} from "./analytics-view-definition.js";
|
|
13
|
+
import { SDKValidationError } from "./sdk-validation-error.js";
|
|
14
|
+
|
|
15
|
+
export type ViewResponse = {
|
|
16
|
+
definition?: AnalyticsViewDefinition | undefined;
|
|
17
|
+
id?: string | undefined;
|
|
18
|
+
name?: string | undefined;
|
|
19
|
+
version?: number | undefined;
|
|
20
|
+
};
|
|
21
|
+
|
|
22
|
+
/** @internal */
|
|
23
|
+
export const ViewResponse$inboundSchema: z.ZodMiniType<ViewResponse, unknown> =
|
|
24
|
+
z.object({
|
|
25
|
+
definition: types.optional(AnalyticsViewDefinition$inboundSchema),
|
|
26
|
+
id: types.optional(types.string()),
|
|
27
|
+
name: types.optional(types.string()),
|
|
28
|
+
version: types.optional(types.number()),
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
export function viewResponseFromJSON(
|
|
32
|
+
jsonString: string,
|
|
33
|
+
): SafeParseResult<ViewResponse, SDKValidationError> {
|
|
34
|
+
return safeParse(
|
|
35
|
+
jsonString,
|
|
36
|
+
(x) => ViewResponse$inboundSchema.parse(JSON.parse(x)),
|
|
37
|
+
`Failed to parse 'ViewResponse' from JSON`,
|
|
38
|
+
);
|
|
39
|
+
}
|
package/src/sdk/sdk.ts
CHANGED
|
@@ -6,6 +6,7 @@ import { ClientSDK } from "../lib/sdks.js";
|
|
|
6
6
|
import { Addons } from "./addons.js";
|
|
7
7
|
import { AlertSettings } from "./alert-settings.js";
|
|
8
8
|
import { Alerts } from "./alerts.js";
|
|
9
|
+
import { Analytics } from "./analytics.js";
|
|
9
10
|
import { Checkout } from "./checkout.js";
|
|
10
11
|
import { Costs } from "./costs.js";
|
|
11
12
|
import { CouponAssociations } from "./coupon-associations.js";
|
|
@@ -66,6 +67,11 @@ export class Flexprice extends ClientSDK {
|
|
|
66
67
|
return (this._alertSettings ??= new AlertSettings(this._options));
|
|
67
68
|
}
|
|
68
69
|
|
|
70
|
+
private _analytics?: Analytics;
|
|
71
|
+
get analytics(): Analytics {
|
|
72
|
+
return (this._analytics ??= new Analytics(this._options));
|
|
73
|
+
}
|
|
74
|
+
|
|
69
75
|
private _checkout?: Checkout;
|
|
70
76
|
get checkout(): Checkout {
|
|
71
77
|
return (this._checkout ??= new Checkout(this._options));
|
package/src/sdk/subscriptions.ts
CHANGED
|
@@ -473,7 +473,8 @@ export class Subscriptions extends ClientSDK {
|
|
|
473
473
|
* Execute subscription modification
|
|
474
474
|
*
|
|
475
475
|
* @remarks
|
|
476
|
-
* Execute a mid-cycle subscription modification (inheritance,
|
|
476
|
+
* Execute a mid-cycle subscription modification (inheritance, line item change, grouped invoicing, trial end, coupon, tax, a single addon add/remove, or a batch of addon adds and removes settled as one netted document).
|
|
477
|
+
* Type "quantity_change" is deprecated: use "line_item_change", which changes a fixed charge's quantity, price, or both, with the same proration and checkout behaviour.
|
|
477
478
|
*/
|
|
478
479
|
async executeSubscriptionModify(
|
|
479
480
|
id: string,
|
|
@@ -492,7 +493,8 @@ export class Subscriptions extends ClientSDK {
|
|
|
492
493
|
* Preview subscription modification
|
|
493
494
|
*
|
|
494
495
|
* @remarks
|
|
495
|
-
* Preview the impact of a mid-cycle subscription modification (inheritance,
|
|
496
|
+
* Preview the impact of a mid-cycle subscription modification (inheritance, line item change, grouped invoicing, trial end, coupon, tax, a single addon add/remove, or a batch of addon adds and removes) without committing changes.
|
|
497
|
+
* Type "quantity_change" is deprecated: use "line_item_change".
|
|
496
498
|
*/
|
|
497
499
|
async previewSubscriptionModify(
|
|
498
500
|
id: string,
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
# Configuration
|
|
2
|
-
|
|
3
|
-
configuration contains type-specific configuration (e.g., target_plan_id for plan changes)
|
|
4
|
-
|
|
5
|
-
## Example Usage
|
|
6
|
-
|
|
7
|
-
```typescript
|
|
8
|
-
import { Configuration } from "@flexprice/sdk/sdk/models";
|
|
9
|
-
|
|
10
|
-
let value: Configuration = {};
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Fields
|
|
14
|
-
|
|
15
|
-
| Field | Type | Required | Description |
|
|
16
|
-
| ----------- | ----------- | ----------- | ----------- |
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
# ExecutionResult
|
|
2
|
-
|
|
3
|
-
execution_result contains type-specific execution result
|
|
4
|
-
|
|
5
|
-
## Example Usage
|
|
6
|
-
|
|
7
|
-
```typescript
|
|
8
|
-
import { ExecutionResult } from "@flexprice/sdk/sdk/models";
|
|
9
|
-
|
|
10
|
-
let value: ExecutionResult = {};
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Fields
|
|
14
|
-
|
|
15
|
-
| Field | Type | Required | Description |
|
|
16
|
-
| ----------- | ----------- | ----------- | ----------- |
|