@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
package/README.md
CHANGED
|
@@ -51,7 +51,7 @@ Runnable samples are in the `examples/` directory.
|
|
|
51
51
|
| `FLEXPRICE_API_KEY` | Yes | API key |
|
|
52
52
|
| `FLEXPRICE_API_HOST` | Optional | Full base URL including `https://` and `/v1` (default: `https://us.api.flexprice.io/v1`). No trailing slash. |
|
|
53
53
|
|
|
54
|
-
**Integration tests** in [api/tests/ts/test_sdk.ts](
|
|
54
|
+
**Integration tests** in [api/tests/ts/test_sdk.ts](../../tests/ts/test_sdk.ts) use a different env shape; see [api/tests/README.md](../../tests/README.md).
|
|
55
55
|
|
|
56
56
|
## Quick start
|
|
57
57
|
|
|
@@ -228,4 +228,4 @@ function handleWebhook(rawBody: string): void {
|
|
|
228
228
|
|
|
229
229
|
- [FlexPrice API documentation](https://docs.flexprice.io)
|
|
230
230
|
- [TypeScript SDK examples](examples/) in this repo
|
|
231
|
-
- [SDK integration tests](
|
|
231
|
+
- [SDK integration tests](../../tests/README.md) — different `FLEXPRICE_API_HOST` shape for automated tests
|
|
@@ -10,7 +10,8 @@ let value: AddAddonParams = {};
|
|
|
10
10
|
|
|
11
11
|
## Fields
|
|
12
12
|
|
|
13
|
-
| Field
|
|
14
|
-
|
|
|
15
|
-
| `addons`
|
|
16
|
-
| `
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
|
|
15
|
+
| `addons` | [models.AddAddonRef](../../sdk/models/add-addon-ref.md)[] | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `removes` | [models.RemoveAddonRef](../../sdk/models/remove-addon-ref.md)[] | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `subscriptionId` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -17,6 +17,7 @@ let value: AddAddonRequest = {
|
|
|
17
17
|
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
|
18
18
|
| `addonId` | *string* | :heavy_check_mark: | N/A |
|
|
19
19
|
| `cadence` | [models.AddonCadence](../../sdk/models/addon-cadence.md) | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `changeAt` | [models.ScheduleType](../../sdk/models/schedule-type.md) | :heavy_minus_sign: | N/A |
|
|
20
21
|
| `checkout` | [models.CheckoutParams](../../sdk/models/checkout-params.md) | :heavy_minus_sign: | N/A |
|
|
21
22
|
| `lineItemCommitments` | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)> | :heavy_minus_sign: | LineItemCommitments allows setting commitment configuration per addon line item (keyed by price_id) |
|
|
22
23
|
| `metadata` | Record<string, *any*> | :heavy_minus_sign: | N/A |
|
|
@@ -16,6 +16,7 @@ let value: AddAddonToSubscriptionRequest = {
|
|
|
16
16
|
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
|
17
17
|
| `addonId` | *string* | :heavy_check_mark: | N/A |
|
|
18
18
|
| `cadence` | [models.AddonCadence](../../sdk/models/addon-cadence.md) | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `changeAt` | [models.ScheduleType](../../sdk/models/schedule-type.md) | :heavy_minus_sign: | N/A |
|
|
19
20
|
| `lineItemCommitments` | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)> | :heavy_minus_sign: | LineItemCommitments allows setting commitment configuration per addon line item (keyed by price_id) |
|
|
20
21
|
| `metadata` | Record<string, *any*> | :heavy_minus_sign: | N/A |
|
|
21
22
|
| `overrideLineItems` | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[] | :heavy_minus_sign: | OverrideLineItems allows overriding price/quantity/billing model for specific addon prices |
|
|
@@ -17,5 +17,6 @@ let value: AggregatedEntitlementBucket = {};
|
|
|
17
17
|
| `grantDurationValue` | *number* | :heavy_minus_sign: | N/A |
|
|
18
18
|
| `grantMeasure` | [models.EntitlementGrantMeasure](../../sdk/models/entitlement-grant-measure.md) | :heavy_minus_sign: | N/A |
|
|
19
19
|
| `grantQuota` | *string* | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `grantUnlimited` | *boolean* | :heavy_minus_sign: | N/A |
|
|
20
21
|
| `sourceEntityId` | *string* | :heavy_minus_sign: | N/A |
|
|
21
22
|
| `usageLimit` | *number* | :heavy_minus_sign: | N/A |
|
|
@@ -10,13 +10,19 @@ let value: AggregatedEntitlement = {};
|
|
|
10
10
|
|
|
11
11
|
## Fields
|
|
12
12
|
|
|
13
|
-
| Field
|
|
14
|
-
|
|
|
15
|
-
| `aggregationMode`
|
|
16
|
-
| `buckets`
|
|
17
|
-
| `configValues`
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
|
15
|
+
| `aggregationMode` | [models.EntitlementAggregationMode](../../sdk/models/entitlement-aggregation-mode.md) | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `buckets` | [models.AggregatedEntitlementBucket](../../sdk/models/aggregated-entitlement-bucket.md)[] | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `configValues` | Record<string, [models.ConfigValue](../../sdk/models/config-value.md)>[] | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `grantDurationUnit` | [models.EntitlementGrantDurationUnit](../../sdk/models/entitlement-grant-duration-unit.md) | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `grantDurationValue` | *number* | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `grantMeasure` | [models.EntitlementGrantMeasure](../../sdk/models/entitlement-grant-measure.md) | :heavy_minus_sign: | N/A |
|
|
21
|
+
| `grantQuota` | *string* | :heavy_minus_sign: | N/A |
|
|
22
|
+
| `grantState` | [models.GrantState](../../sdk/models/grant-state.md) | :heavy_minus_sign: | N/A |
|
|
23
|
+
| `grantUnlimited` | *boolean* | :heavy_minus_sign: | N/A |
|
|
24
|
+
| `isEnabled` | *boolean* | :heavy_minus_sign: | N/A |
|
|
25
|
+
| `isSoftLimit` | *boolean* | :heavy_minus_sign: | N/A |
|
|
26
|
+
| `staticValues` | *string*[] | :heavy_minus_sign: | N/A |
|
|
27
|
+
| `usageLimit` | *number* | :heavy_minus_sign: | N/A |
|
|
28
|
+
| `usageResetPeriod` | [models.EntitlementUsageResetPeriod](../../sdk/models/entitlement-usage-reset-period.md) | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# AnalyticsColumn
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { AnalyticsColumn } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: AnalyticsColumn = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
|
|
15
|
+
| `currency` | *string* | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `name` | *string* | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `role` | [models.ColumnRole](../../sdk/models/column-role.md) | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `type` | [models.ColumnType](../../sdk/models/column-type.md) | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# AnalyticsFilter
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { AnalyticsFilter } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: AnalyticsFilter = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
|
15
|
+
| `field` | *string* | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `op` | [models.FilterOperatorType](../../sdk/models/filter-operator-type.md) | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `optional` | *boolean* | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `value` | *string*[] | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# AnalyticsQueryMeta
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { AnalyticsQueryMeta } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: AnalyticsQueryMeta = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
15
|
+
| `querySource` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# AnalyticsQueryRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { AnalyticsQueryRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: AnalyticsQueryRequest = {
|
|
9
|
+
definition: {
|
|
10
|
+
metrics: [
|
|
11
|
+
"usage_quantity",
|
|
12
|
+
],
|
|
13
|
+
shape: "breakdown",
|
|
14
|
+
},
|
|
15
|
+
};
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Fields
|
|
19
|
+
|
|
20
|
+
| Field | Type | Required | Description |
|
|
21
|
+
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
|
|
22
|
+
| `definition` | [models.AnalyticsViewDefinition](../../sdk/models/analytics-view-definition.md) | :heavy_check_mark: | N/A |
|
|
23
|
+
| `variables` | Record<string, *string*[]> | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# AnalyticsQueryResult
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { AnalyticsQueryResult } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: AnalyticsQueryResult = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
|
15
|
+
| `columns` | [models.AnalyticsColumn](../../sdk/models/analytics-column.md)[] | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `meta` | [models.AnalyticsQueryMeta](../../sdk/models/analytics-query-meta.md) | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `rows` | *string*[][] | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# AnalyticsSortSpec
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { AnalyticsSortSpec } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: AnalyticsSortSpec = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
|
15
|
+
| `dir` | [models.SortDirection](../../sdk/models/sort-direction.md) | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `field` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# AnalyticsTimeSpecRaw
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { AnalyticsTimeSpecRaw } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: AnalyticsTimeSpecRaw = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
|
|
15
|
+
| `grain` | [models.Grain](../../sdk/models/grain.md) | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `range` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# AnalyticsVariable
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { AnalyticsVariable } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: AnalyticsVariable = {
|
|
9
|
+
type: "enum",
|
|
10
|
+
};
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Fields
|
|
14
|
+
|
|
15
|
+
| Field | Type | Required | Description |
|
|
16
|
+
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
|
17
|
+
| `default` | *string*[] | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `name` | *string* | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `required` | *boolean* | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `type` | [models.VariableType](../../sdk/models/variable-type.md) | :heavy_check_mark: | N/A |
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# AnalyticsViewDefinition
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { AnalyticsViewDefinition } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: AnalyticsViewDefinition = {
|
|
9
|
+
metrics: [
|
|
10
|
+
"event_count",
|
|
11
|
+
],
|
|
12
|
+
shape: "breakdown",
|
|
13
|
+
};
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Fields
|
|
17
|
+
|
|
18
|
+
| Field | Type | Required | Description |
|
|
19
|
+
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
|
20
|
+
| `dimensions` | *string*[] | :heavy_minus_sign: | N/A |
|
|
21
|
+
| `filters` | [models.AnalyticsFilter](../../sdk/models/analytics-filter.md)[] | :heavy_minus_sign: | N/A |
|
|
22
|
+
| `limit` | *number* | :heavy_minus_sign: | N/A |
|
|
23
|
+
| `metrics` | [models.Metric](../../sdk/models/metric.md)[] | :heavy_check_mark: | N/A |
|
|
24
|
+
| `shape` | [models.Shape](../../sdk/models/shape.md) | :heavy_check_mark: | N/A |
|
|
25
|
+
| `sort` | [models.AnalyticsSortSpec](../../sdk/models/analytics-sort-spec.md)[] | :heavy_minus_sign: | N/A |
|
|
26
|
+
| `time` | [models.AnalyticsTimeSpecRaw](../../sdk/models/analytics-time-spec-raw.md) | :heavy_minus_sign: | N/A |
|
|
27
|
+
| `variables` | [models.AnalyticsVariable](../../sdk/models/analytics-variable.md)[] | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# CancelCheckoutSessionRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { CancelCheckoutSessionRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: CancelCheckoutSessionRequest = {
|
|
9
|
+
id: "<id>",
|
|
10
|
+
};
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Fields
|
|
14
|
+
|
|
15
|
+
| Field | Type | Required | Description |
|
|
16
|
+
| ------------------- | ------------------- | ------------------- | ------------------- |
|
|
17
|
+
| `id` | *string* | :heavy_check_mark: | Checkout session ID |
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ChangedAddonAssociationAction
|
|
2
|
+
|
|
3
|
+
created | ended
|
|
4
|
+
|
|
5
|
+
## Example Usage
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
import { ChangedAddonAssociationAction } from "@flexprice/sdk/sdk/models";
|
|
9
|
+
|
|
10
|
+
let value: ChangedAddonAssociationAction = "created";
|
|
11
|
+
|
|
12
|
+
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Values
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
"created" | "ended" | Unrecognized<string>
|
|
19
|
+
```
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ChangedAddonAssociation
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ChangedAddonAssociation } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ChangedAddonAssociation = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
15
|
+
| `addonId` | *string* | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `addonStatus` | [models.AddonStatus](../../sdk/models/addon-status.md) | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `changeAction` | [models.ChangedAddonAssociationAction](../../sdk/models/changed-addon-association-action.md) | :heavy_minus_sign: | created \| ended |
|
|
18
|
+
| `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `id` | *string* | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
@@ -125,8 +125,9 @@ let value: ChangedResources = {
|
|
|
125
125
|
|
|
126
126
|
## Fields
|
|
127
127
|
|
|
128
|
-
| Field
|
|
129
|
-
|
|
|
130
|
-
| `
|
|
131
|
-
| `
|
|
132
|
-
| `
|
|
128
|
+
| Field | Type | Required | Description |
|
|
129
|
+
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
|
130
|
+
| `addonAssociations` | [models.ChangedAddonAssociation](../../sdk/models/changed-addon-association.md)[] | :heavy_minus_sign: | N/A |
|
|
131
|
+
| `invoices` | [models.ChangedInvoice](../../sdk/models/changed-invoice.md)[] | :heavy_minus_sign: | N/A |
|
|
132
|
+
| `lineItems` | [models.ChangedLineItem](../../sdk/models/changed-line-item.md)[] | :heavy_minus_sign: | N/A |
|
|
133
|
+
| `subscriptions` | [models.ChangedSubscription](../../sdk/models/changed-subscription.md)[] | :heavy_minus_sign: | N/A |
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
```typescript
|
|
6
6
|
import { CheckoutAction } from "@flexprice/sdk/sdk/models";
|
|
7
7
|
|
|
8
|
-
let value: CheckoutAction = "
|
|
8
|
+
let value: CheckoutAction = "add_addon";
|
|
9
9
|
|
|
10
10
|
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
11
|
```
|
|
@@ -13,5 +13,5 @@ let value: CheckoutAction = "wallet_topup";
|
|
|
13
13
|
## Values
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
"create_subscription" | "modify_subscription" | "wallet_topup" | "add_addon" | Unrecognized<string>
|
|
16
|
+
"create_subscription" | "modify_subscription" | "wallet_topup" | "add_addon" | "pay_invoice" | Unrecognized<string>
|
|
17
17
|
```
|
|
@@ -15,4 +15,5 @@ let value: CheckoutConfiguration = {};
|
|
|
15
15
|
| `addAddonParams` | [models.AddAddonParams](../../sdk/models/add-addon-params.md) | :heavy_minus_sign: | N/A |
|
|
16
16
|
| `createSubscriptionParams` | [models.CreateSubscriptionParams](../../sdk/models/create-subscription-params.md) | :heavy_minus_sign: | N/A |
|
|
17
17
|
| `modifySubscriptionParams` | [models.ModifySubscriptionParams](../../sdk/models/modify-subscription-params.md) | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `payInvoiceParams` | [models.PayInvoiceParams](../../sdk/models/pay-invoice-params.md) | :heavy_minus_sign: | N/A |
|
|
18
19
|
| `walletTopupParams` | [models.WalletTopupParams](../../sdk/models/wallet-topup-params.md) | :heavy_minus_sign: | N/A |
|
|
@@ -15,6 +15,7 @@ let value: CheckoutParams = {
|
|
|
15
15
|
| Field | Type | Required | Description |
|
|
16
16
|
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
|
17
17
|
| `cancelUrl` | *string* | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `entityCreationOptions` | [models.EntityCreationOptions](../../sdk/models/entity-creation-options.md) | :heavy_minus_sign: | N/A |
|
|
18
19
|
| `failureUrl` | *string* | :heavy_minus_sign: | N/A |
|
|
19
20
|
| `idempotencyKey` | *string* | :heavy_minus_sign: | N/A |
|
|
20
21
|
| `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
|
|
@@ -21,6 +21,7 @@ let value: CheckoutSessionResponse = {};
|
|
|
21
21
|
| `completedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
22
22
|
| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
23
23
|
| `customerId` | *string* | :heavy_minus_sign: | N/A |
|
|
24
|
+
| `entityCreationResult` | [models.EntityCreationResult](../../sdk/models/entity-creation-result.md) | :heavy_minus_sign: | N/A |
|
|
24
25
|
| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
25
26
|
| `failureReason` | *string* | :heavy_minus_sign: | N/A |
|
|
26
27
|
| `failureUrl` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# ColumnRole
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ColumnRole } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ColumnRole = "metric";
|
|
9
|
+
|
|
10
|
+
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Values
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
"dimension" | "metric" | Unrecognized<string>
|
|
17
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# ColumnType
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ColumnType } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ColumnType = "datetime";
|
|
9
|
+
|
|
10
|
+
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Values
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
"string" | "decimal" | "datetime" | Unrecognized<string>
|
|
17
|
+
```
|
|
@@ -20,6 +20,7 @@ let value: CreateCheckoutSessionRequest = {
|
|
|
20
20
|
| `cancelUrl` | *string* | :heavy_minus_sign: | N/A |
|
|
21
21
|
| `configuration` | [models.CheckoutConfiguration](../../sdk/models/checkout-configuration.md) | :heavy_minus_sign: | N/A |
|
|
22
22
|
| `customerExternalId` | *string* | :heavy_check_mark: | N/A |
|
|
23
|
+
| `entityCreationOptions` | [models.EntityCreationOptions](../../sdk/models/entity-creation-options.md) | :heavy_minus_sign: | N/A |
|
|
23
24
|
| `failureUrl` | *string* | :heavy_minus_sign: | N/A |
|
|
24
25
|
| `idempotencyKey` | *string* | :heavy_minus_sign: | N/A |
|
|
25
26
|
| `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
|
|
@@ -27,6 +27,7 @@ let value: CreateEntitlementRequest = {
|
|
|
27
27
|
| `grantDurationValue` | *number* | :heavy_minus_sign: | N/A |
|
|
28
28
|
| `grantMeasure` | [models.EntitlementGrantMeasure](../../sdk/models/entitlement-grant-measure.md) | :heavy_minus_sign: | N/A |
|
|
29
29
|
| `grantQuota` | *string* | :heavy_minus_sign: | N/A |
|
|
30
|
+
| `grantUnlimited` | *boolean* | :heavy_minus_sign: | N/A |
|
|
30
31
|
| `isEnabled` | *boolean* | :heavy_minus_sign: | N/A |
|
|
31
32
|
| `isSoftLimit` | *boolean* | :heavy_minus_sign: | N/A |
|
|
32
33
|
| `parentEntitlementId` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -22,6 +22,7 @@ let value: CreateInvoiceRequest = {
|
|
|
22
22
|
| `amountPaid` | *string* | :heavy_minus_sign: | amount_paid is the amount that has been paid towards this invoice |
|
|
23
23
|
| `billingPeriod` | *string* | :heavy_minus_sign: | billing_period is the period this invoice covers (e.g., "monthly", "yearly") |
|
|
24
24
|
| `billingReason` | [models.InvoiceBillingReason](../../sdk/models/invoice-billing-reason.md) | :heavy_minus_sign: | N/A |
|
|
25
|
+
| `checkout` | [models.CheckoutParams](../../sdk/models/checkout-params.md) | :heavy_minus_sign: | N/A |
|
|
25
26
|
| `coupons` | *string*[] | :heavy_minus_sign: | coupons |
|
|
26
27
|
| `currency` | *string* | :heavy_check_mark: | currency is the three-letter ISO currency code (e.g., USD, EUR) for the invoice |
|
|
27
28
|
| `customerId` | *string* | :heavy_check_mark: | customer_id is the unique identifier of the customer this invoice belongs to |
|