@flexprice/sdk 2.1.17 → 2.1.18
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/docs/sdk/models/attributed-to-customer-result.md +17 -0
- package/docs/sdk/models/bucket-summary.md +26 -0
- package/docs/sdk/models/bucket.md +16 -0
- package/docs/sdk/models/cancel-subscription-request.md +7 -7
- package/docs/sdk/models/commitment-bucket-request.md +22 -0
- package/docs/sdk/models/coupon-response.md +1 -0
- package/docs/sdk/models/coupon.md +1 -0
- package/docs/sdk/models/create-coupon-request.md +1 -0
- package/docs/sdk/models/create-subscription-line-item-request.md +1 -0
- package/docs/sdk/models/create-subscription-request.md +3 -2
- package/docs/sdk/models/create-tax-association-request.md +12 -10
- package/docs/sdk/models/create-user-request.md +1 -0
- package/docs/sdk/models/create-user-response.md +1 -0
- package/docs/sdk/models/debug-tracker-status.md +2 -2
- package/docs/sdk/models/debug-tracker.md +1 -0
- package/docs/sdk/models/delete-service-account-request.md +17 -0
- package/docs/sdk/models/delink-integration-mapping-request.md +21 -0
- package/docs/sdk/models/execute-subscription-modify-request-request.md +1 -1
- package/docs/sdk/models/execute-subscription-modify-request.md +3 -1
- package/docs/sdk/models/failure-point-type.md +1 -1
- package/docs/sdk/models/get-coupon-association-request.md +17 -0
- package/docs/sdk/models/get-usage-analytics-request.md +13 -12
- package/docs/sdk/models/inheritance-action.md +15 -0
- package/docs/sdk/models/line-item-commitment-config.md +10 -9
- package/docs/sdk/models/list-coupon-associations-request.md +19 -0
- package/docs/sdk/models/list-coupon-associations-response.md +16 -0
- package/docs/sdk/models/meter-usage-attribution.md +17 -0
- package/docs/sdk/models/preview-subscription-modify-request.md +1 -1
- package/docs/sdk/models/price-filter.md +1 -0
- package/docs/sdk/models/sub-modify-coupon-action.md +15 -0
- package/docs/sdk/models/sub-modify-coupon-params.md +24 -0
- package/docs/sdk/models/sub-modify-inheritance-request.md +5 -3
- package/docs/sdk/models/sub-modify-tax-action.md +15 -0
- package/docs/sdk/models/sub-modify-tax-params.md +20 -0
- package/docs/sdk/models/subscription-coupon-input.md +20 -0
- package/docs/sdk/models/subscription-line-item-response.md +1 -0
- package/docs/sdk/models/subscription-modify-type.md +2 -2
- package/docs/sdk/models/subscription-phase-create-request.md +4 -3
- package/docs/sdk/models/subscription-subscription-line-item.md +1 -0
- package/docs/sdk/models/tax-association-response.md +2 -0
- package/docs/sdk/models/time-of-day-bucket.md +22 -0
- package/docs/sdk/models/update-service-account-request-request.md +21 -0
- package/docs/sdk/models/update-service-account-request.md +17 -0
- package/docs/sdk/models/update-service-account-response.md +21 -0
- package/docs/sdk/models/update-subscription-line-item-request.md +17 -16
- package/docs/sdk/models/update-user-request.md +2 -1
- package/docs/sdk/models/update-user-response.md +1 -0
- package/docs/sdk/models/usage-analytic-item.md +34 -33
- package/docs/sdk/models/usage-analytic-point.md +11 -9
- package/docs/sdk/models/user-response.md +1 -0
- package/docs/sdk/models/window-size.md +2 -2
- package/docs/sdks/couponassociations/README.md +150 -0
- package/docs/sdks/integrations/README.md +80 -0
- package/docs/sdks/subscriptions/README.md +4 -4
- package/docs/sdks/users/README.md +150 -1
- package/esm/funcs/coupon-associations-get-coupon-association.d.ts +17 -0
- package/esm/funcs/coupon-associations-get-coupon-association.d.ts.map +1 -0
- package/esm/funcs/coupon-associations-get-coupon-association.js +91 -0
- package/esm/funcs/coupon-associations-get-coupon-association.js.map +1 -0
- package/esm/funcs/coupon-associations-list-coupon-associations.d.ts +17 -0
- package/esm/funcs/coupon-associations-list-coupon-associations.d.ts.map +1 -0
- package/esm/funcs/coupon-associations-list-coupon-associations.js +91 -0
- package/esm/funcs/coupon-associations-list-coupon-associations.js.map +1 -0
- package/esm/funcs/integrations-delink-integration-mapping.d.ts +17 -0
- package/esm/funcs/integrations-delink-integration-mapping.d.ts.map +1 -0
- package/esm/funcs/integrations-delink-integration-mapping.js +83 -0
- package/esm/funcs/integrations-delink-integration-mapping.js.map +1 -0
- package/esm/funcs/subscriptions-execute-subscription-modify.d.ts +1 -1
- package/esm/funcs/subscriptions-execute-subscription-modify.js +1 -1
- package/esm/funcs/subscriptions-preview-subscription-modify.d.ts +1 -1
- package/esm/funcs/subscriptions-preview-subscription-modify.js +1 -1
- package/esm/funcs/users-delete-service-account.d.ts +17 -0
- package/esm/funcs/users-delete-service-account.d.ts.map +1 -0
- package/esm/funcs/users-delete-service-account.js +91 -0
- package/esm/funcs/users-delete-service-account.js.map +1 -0
- package/esm/funcs/users-update-service-account.d.ts +17 -0
- package/esm/funcs/users-update-service-account.d.ts.map +1 -0
- package/esm/funcs/users-update-service-account.js +93 -0
- package/esm/funcs/users-update-service-account.js.map +1 -0
- package/esm/funcs/users-update-user.d.ts +1 -1
- package/esm/funcs/users-update-user.js +1 -1
- package/esm/hooks/types.d.ts +1 -0
- package/esm/hooks/types.d.ts.map +1 -1
- package/esm/lib/config.d.ts +3 -3
- package/esm/lib/config.js +3 -3
- package/esm/lib/encodings.js +1 -1
- package/esm/lib/encodings.js.map +1 -1
- package/esm/lib/matchers.js +1 -1
- package/esm/lib/matchers.js.map +1 -1
- package/esm/lib/primitives.d.ts +1 -0
- package/esm/lib/primitives.d.ts.map +1 -1
- package/esm/lib/primitives.js +17 -0
- package/esm/lib/primitives.js.map +1 -1
- package/esm/lib/sdks.d.ts.map +1 -1
- package/esm/lib/sdks.js +50 -16
- package/esm/lib/sdks.js.map +1 -1
- package/esm/sdk/coupon-associations.d.ts +19 -0
- package/esm/sdk/coupon-associations.d.ts.map +1 -0
- package/esm/sdk/coupon-associations.js +28 -0
- package/esm/sdk/coupon-associations.js.map +1 -0
- package/esm/sdk/integrations.d.ts +7 -0
- package/esm/sdk/integrations.d.ts.map +1 -1
- package/esm/sdk/integrations.js +10 -0
- package/esm/sdk/integrations.js.map +1 -1
- package/esm/sdk/models/attributed-to-customer-result.d.ts +15 -0
- package/esm/sdk/models/attributed-to-customer-result.d.ts.map +1 -0
- package/esm/sdk/models/attributed-to-customer-result.js +24 -0
- package/esm/sdk/models/attributed-to-customer-result.js.map +1 -0
- package/esm/sdk/models/bucket-summary.d.ts +31 -0
- package/esm/sdk/models/bucket-summary.d.ts.map +1 -0
- package/esm/sdk/models/bucket-summary.js +40 -0
- package/esm/sdk/models/bucket-summary.js.map +1 -0
- package/esm/sdk/models/bucket.d.ts +19 -0
- package/esm/sdk/models/bucket.d.ts.map +1 -0
- package/esm/sdk/models/bucket.js +24 -0
- package/esm/sdk/models/bucket.js.map +1 -0
- package/esm/sdk/models/cancel-subscription-request.d.ts +8 -0
- package/esm/sdk/models/cancel-subscription-request.d.ts.map +1 -1
- package/esm/sdk/models/cancel-subscription-request.js.map +1 -1
- package/esm/sdk/models/commitment-bucket-request.d.ts +29 -0
- package/esm/sdk/models/commitment-bucket-request.d.ts.map +1 -0
- package/esm/sdk/models/commitment-bucket-request.js +30 -0
- package/esm/sdk/models/commitment-bucket-request.js.map +1 -0
- package/esm/sdk/models/coupon-response.d.ts +1 -0
- package/esm/sdk/models/coupon-response.d.ts.map +1 -1
- package/esm/sdk/models/coupon-response.js +2 -0
- package/esm/sdk/models/coupon-response.js.map +1 -1
- package/esm/sdk/models/coupon.d.ts +1 -0
- package/esm/sdk/models/coupon.d.ts.map +1 -1
- package/esm/sdk/models/coupon.js +2 -0
- package/esm/sdk/models/coupon.js.map +1 -1
- package/esm/sdk/models/create-coupon-request.d.ts +2 -0
- package/esm/sdk/models/create-coupon-request.d.ts.map +1 -1
- package/esm/sdk/models/create-coupon-request.js +2 -0
- package/esm/sdk/models/create-coupon-request.js.map +1 -1
- package/esm/sdk/models/create-subscription-line-item-request.d.ts +3 -0
- package/esm/sdk/models/create-subscription-line-item-request.d.ts.map +1 -1
- package/esm/sdk/models/create-subscription-line-item-request.js +3 -0
- package/esm/sdk/models/create-subscription-line-item-request.js.map +1 -1
- package/esm/sdk/models/create-subscription-request.d.ts +15 -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-tax-association-request.d.ts +10 -0
- package/esm/sdk/models/create-tax-association-request.d.ts.map +1 -1
- package/esm/sdk/models/create-tax-association-request.js +4 -0
- package/esm/sdk/models/create-tax-association-request.js.map +1 -1
- package/esm/sdk/models/create-user-request.d.ts +5 -0
- package/esm/sdk/models/create-user-request.d.ts.map +1 -1
- package/esm/sdk/models/create-user-request.js +1 -0
- package/esm/sdk/models/create-user-request.js.map +1 -1
- package/esm/sdk/models/create-user-response.d.ts +1 -0
- package/esm/sdk/models/create-user-response.d.ts.map +1 -1
- package/esm/sdk/models/create-user-response.js +1 -0
- package/esm/sdk/models/create-user-response.js.map +1 -1
- package/esm/sdk/models/debug-tracker-status.d.ts +2 -0
- package/esm/sdk/models/debug-tracker-status.d.ts.map +1 -1
- package/esm/sdk/models/debug-tracker-status.js +2 -0
- package/esm/sdk/models/debug-tracker-status.js.map +1 -1
- package/esm/sdk/models/debug-tracker.d.ts +2 -0
- package/esm/sdk/models/debug-tracker.d.ts.map +1 -1
- package/esm/sdk/models/debug-tracker.js +3 -0
- package/esm/sdk/models/debug-tracker.js.map +1 -1
- package/esm/sdk/models/delete-service-account-op.d.ts +15 -0
- package/esm/sdk/models/delete-service-account-op.d.ts.map +1 -0
- package/esm/sdk/models/delete-service-account-op.js +12 -0
- package/esm/sdk/models/delete-service-account-op.js.map +1 -0
- package/esm/sdk/models/delink-integration-mapping-request.d.ts +17 -0
- package/esm/sdk/models/delink-integration-mapping-request.d.ts.map +1 -0
- package/esm/sdk/models/delink-integration-mapping-request.js +22 -0
- package/esm/sdk/models/delink-integration-mapping-request.js.map +1 -0
- 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/failure-point-type.d.ts +1 -0
- package/esm/sdk/models/failure-point-type.d.ts.map +1 -1
- package/esm/sdk/models/failure-point-type.js +1 -0
- package/esm/sdk/models/failure-point-type.js.map +1 -1
- package/esm/sdk/models/get-coupon-association-op.d.ts +15 -0
- package/esm/sdk/models/get-coupon-association-op.d.ts.map +1 -0
- package/esm/sdk/models/get-coupon-association-op.js +12 -0
- package/esm/sdk/models/get-coupon-association-op.js.map +1 -0
- package/esm/sdk/models/get-usage-analytics-request.d.ts +10 -0
- package/esm/sdk/models/get-usage-analytics-request.d.ts.map +1 -1
- package/esm/sdk/models/get-usage-analytics-request.js +2 -0
- package/esm/sdk/models/get-usage-analytics-request.js.map +1 -1
- package/esm/sdk/models/index.d.ts +20 -0
- package/esm/sdk/models/index.d.ts.map +1 -1
- package/esm/sdk/models/index.js +20 -0
- package/esm/sdk/models/index.js.map +1 -1
- package/esm/sdk/models/inheritance-action.d.ts +10 -0
- package/esm/sdk/models/inheritance-action.d.ts.map +1 -0
- package/esm/sdk/models/inheritance-action.js +11 -0
- package/esm/sdk/models/inheritance-action.js.map +1 -0
- package/esm/sdk/models/line-item-commitment-config.d.ts +11 -0
- package/esm/sdk/models/line-item-commitment-config.d.ts.map +1 -1
- package/esm/sdk/models/line-item-commitment-config.js +3 -0
- package/esm/sdk/models/line-item-commitment-config.js.map +1 -1
- package/esm/sdk/models/list-coupon-associations-op.d.ts +35 -0
- package/esm/sdk/models/list-coupon-associations-op.d.ts.map +1 -0
- package/esm/sdk/models/list-coupon-associations-op.js +23 -0
- package/esm/sdk/models/list-coupon-associations-op.js.map +1 -0
- package/esm/sdk/models/list-coupon-associations-response.d.ts +13 -0
- package/esm/sdk/models/list-coupon-associations-response.d.ts.map +1 -0
- package/esm/sdk/models/list-coupon-associations-response.js +17 -0
- package/esm/sdk/models/list-coupon-associations-response.js.map +1 -0
- package/esm/sdk/models/meter-usage-attribution.d.ts +12 -0
- package/esm/sdk/models/meter-usage-attribution.d.ts.map +1 -0
- package/esm/sdk/models/meter-usage-attribution.js +23 -0
- package/esm/sdk/models/meter-usage-attribution.js.map +1 -0
- package/esm/sdk/models/price-filter.d.ts +3 -0
- package/esm/sdk/models/price-filter.d.ts.map +1 -1
- package/esm/sdk/models/price-filter.js +3 -0
- package/esm/sdk/models/price-filter.js.map +1 -1
- package/esm/sdk/models/sub-modify-coupon-action.d.ts +10 -0
- package/esm/sdk/models/sub-modify-coupon-action.d.ts.map +1 -0
- package/esm/sdk/models/sub-modify-coupon-action.js +11 -0
- package/esm/sdk/models/sub-modify-coupon-action.js.map +1 -0
- package/esm/sdk/models/sub-modify-coupon-params.d.ts +48 -0
- package/esm/sdk/models/sub-modify-coupon-params.d.ts.map +1 -0
- package/esm/sdk/models/sub-modify-coupon-params.js +31 -0
- package/esm/sdk/models/sub-modify-coupon-params.js.map +1 -0
- package/esm/sdk/models/sub-modify-inheritance-request.d.ts +11 -0
- package/esm/sdk/models/sub-modify-inheritance-request.d.ts.map +1 -1
- package/esm/sdk/models/sub-modify-inheritance-request.js +4 -0
- package/esm/sdk/models/sub-modify-inheritance-request.js.map +1 -1
- package/esm/sdk/models/sub-modify-tax-action.d.ts +10 -0
- package/esm/sdk/models/sub-modify-tax-action.d.ts.map +1 -0
- package/esm/sdk/models/sub-modify-tax-action.js +11 -0
- package/esm/sdk/models/sub-modify-tax-action.js.map +1 -0
- package/esm/sdk/models/sub-modify-tax-params.d.ts +28 -0
- package/esm/sdk/models/sub-modify-tax-params.d.ts.map +1 -0
- package/esm/sdk/models/sub-modify-tax-params.js +23 -0
- package/esm/sdk/models/sub-modify-tax-params.js.map +1 -0
- package/esm/sdk/models/subscription-coupon-input.d.ts +30 -0
- package/esm/sdk/models/subscription-coupon-input.d.ts.map +1 -0
- package/esm/sdk/models/subscription-coupon-input.js +23 -0
- package/esm/sdk/models/subscription-coupon-input.js.map +1 -0
- package/esm/sdk/models/subscription-line-item-response.d.ts +2 -0
- package/esm/sdk/models/subscription-line-item-response.d.ts.map +1 -1
- package/esm/sdk/models/subscription-line-item-response.js +3 -0
- package/esm/sdk/models/subscription-line-item-response.js.map +1 -1
- package/esm/sdk/models/subscription-modify-type.d.ts +2 -0
- package/esm/sdk/models/subscription-modify-type.d.ts.map +1 -1
- package/esm/sdk/models/subscription-modify-type.js +2 -0
- package/esm/sdk/models/subscription-modify-type.js.map +1 -1
- package/esm/sdk/models/subscription-phase-create-request.d.ts +8 -2
- package/esm/sdk/models/subscription-phase-create-request.d.ts.map +1 -1
- package/esm/sdk/models/subscription-phase-create-request.js +3 -0
- package/esm/sdk/models/subscription-phase-create-request.js.map +1 -1
- package/esm/sdk/models/subscription-subscription-line-item.d.ts +2 -0
- package/esm/sdk/models/subscription-subscription-line-item.d.ts.map +1 -1
- package/esm/sdk/models/subscription-subscription-line-item.js +3 -0
- package/esm/sdk/models/subscription-subscription-line-item.js.map +1 -1
- package/esm/sdk/models/tax-association-response.d.ts +8 -0
- package/esm/sdk/models/tax-association-response.d.ts.map +1 -1
- package/esm/sdk/models/tax-association-response.js +4 -0
- package/esm/sdk/models/tax-association-response.js.map +1 -1
- package/esm/sdk/models/time-of-day-bucket.d.ts +31 -0
- package/esm/sdk/models/time-of-day-bucket.d.ts.map +1 -0
- package/esm/sdk/models/time-of-day-bucket.js +32 -0
- package/esm/sdk/models/time-of-day-bucket.js.map +1 -0
- package/esm/sdk/models/update-service-account-op.d.ts +21 -0
- package/esm/sdk/models/update-service-account-op.d.ts.map +1 -0
- package/esm/sdk/models/update-service-account-op.js +14 -0
- package/esm/sdk/models/update-service-account-op.js.map +1 -0
- package/esm/sdk/models/update-service-account-request.d.ts +12 -0
- package/esm/sdk/models/update-service-account-request.d.ts.map +1 -0
- package/esm/sdk/models/update-service-account-request.js +12 -0
- package/esm/sdk/models/update-service-account-request.js.map +1 -0
- package/esm/sdk/models/update-service-account-response.d.ts +23 -0
- package/esm/sdk/models/update-service-account-response.d.ts.map +1 -0
- package/esm/sdk/models/update-service-account-response.js +22 -0
- package/esm/sdk/models/update-service-account-response.js.map +1 -0
- package/esm/sdk/models/update-subscription-line-item-request.d.ts +6 -0
- package/esm/sdk/models/update-subscription-line-item-request.d.ts.map +1 -1
- package/esm/sdk/models/update-subscription-line-item-request.js +3 -0
- package/esm/sdk/models/update-subscription-line-item-request.js.map +1 -1
- package/esm/sdk/models/update-user-request.d.ts +2 -0
- package/esm/sdk/models/update-user-request.d.ts.map +1 -1
- package/esm/sdk/models/update-user-request.js +1 -0
- package/esm/sdk/models/update-user-request.js.map +1 -1
- package/esm/sdk/models/update-user-response.d.ts +1 -0
- package/esm/sdk/models/update-user-response.d.ts.map +1 -1
- package/esm/sdk/models/update-user-response.js +1 -0
- package/esm/sdk/models/update-user-response.js.map +1 -1
- package/esm/sdk/models/usage-analytic-item.d.ts +8 -0
- package/esm/sdk/models/usage-analytic-item.d.ts.map +1 -1
- package/esm/sdk/models/usage-analytic-item.js +3 -0
- package/esm/sdk/models/usage-analytic-item.js.map +1 -1
- package/esm/sdk/models/usage-analytic-point.d.ts +8 -0
- package/esm/sdk/models/usage-analytic-point.d.ts.map +1 -1
- package/esm/sdk/models/usage-analytic-point.js +4 -0
- package/esm/sdk/models/usage-analytic-point.js.map +1 -1
- package/esm/sdk/models/user-response.d.ts +1 -0
- package/esm/sdk/models/user-response.d.ts.map +1 -1
- package/esm/sdk/models/user-response.js +1 -0
- package/esm/sdk/models/user-response.js.map +1 -1
- package/esm/sdk/models/window-size.d.ts +1 -1
- package/esm/sdk/models/window-size.js +1 -1
- package/esm/sdk/models/window-size.js.map +1 -1
- 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 +2 -2
- package/esm/sdk/subscriptions.js +2 -2
- package/esm/sdk/users.d.ts +15 -1
- package/esm/sdk/users.d.ts.map +1 -1
- package/esm/sdk/users.js +21 -1
- package/esm/sdk/users.js.map +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/coupon-associations-get-coupon-association.ts +182 -0
- package/src/funcs/coupon-associations-list-coupon-associations.ts +188 -0
- package/src/funcs/integrations-delink-integration-mapping.ts +173 -0
- package/src/funcs/subscriptions-execute-subscription-modify.ts +1 -1
- package/src/funcs/subscriptions-preview-subscription-modify.ts +1 -1
- package/src/funcs/users-delete-service-account.ts +182 -0
- package/src/funcs/users-update-service-account.ts +187 -0
- package/src/funcs/users-update-user.ts +1 -1
- package/src/hooks/types.ts +1 -0
- package/src/lib/config.ts +3 -3
- package/src/lib/encodings.ts +1 -1
- package/src/lib/matchers.ts +1 -1
- package/src/lib/primitives.ts +16 -0
- package/src/lib/sdks.ts +54 -17
- package/src/sdk/coupon-associations.ts +45 -0
- package/src/sdk/integrations.ts +18 -0
- package/src/sdk/models/attributed-to-customer-result.ts +55 -0
- package/src/sdk/models/bucket-summary.ts +80 -0
- package/src/sdk/models/bucket.ts +45 -0
- package/src/sdk/models/cancel-subscription-request.ts +8 -0
- package/src/sdk/models/commitment-bucket-request.ts +72 -0
- package/src/sdk/models/coupon-response.ts +3 -0
- package/src/sdk/models/coupon.ts +3 -0
- package/src/sdk/models/create-coupon-request.ts +4 -0
- package/src/sdk/models/create-subscription-line-item-request.ts +11 -0
- package/src/sdk/models/create-subscription-request.ts +23 -0
- package/src/sdk/models/create-tax-association-request.ts +14 -0
- package/src/sdk/models/create-user-request.ts +6 -0
- package/src/sdk/models/create-user-response.ts +2 -0
- package/src/sdk/models/debug-tracker-status.ts +2 -0
- package/src/sdk/models/debug-tracker.ts +9 -0
- package/src/sdk/models/delete-service-account-op.ts +35 -0
- package/src/sdk/models/delink-integration-mapping-request.ts +52 -0
- package/src/sdk/models/execute-subscription-modify-request.ts +18 -0
- package/src/sdk/models/failure-point-type.ts +1 -0
- package/src/sdk/models/get-coupon-association-op.ts +35 -0
- package/src/sdk/models/get-usage-analytics-request.ts +12 -0
- package/src/sdk/models/index.ts +20 -0
- package/src/sdk/models/inheritance-action.ts +17 -0
- package/src/sdk/models/line-item-commitment-config.ts +19 -0
- package/src/sdk/models/list-coupon-associations-op.ts +69 -0
- package/src/sdk/models/list-coupon-associations-response.ts +41 -0
- package/src/sdk/models/meter-usage-attribution.ts +45 -0
- package/src/sdk/models/price-filter.ts +8 -0
- package/src/sdk/models/sub-modify-coupon-action.ts +17 -0
- package/src/sdk/models/sub-modify-coupon-params.ts +92 -0
- package/src/sdk/models/sub-modify-inheritance-request.ts +17 -0
- package/src/sdk/models/sub-modify-tax-action.ts +17 -0
- package/src/sdk/models/sub-modify-tax-params.ts +64 -0
- package/src/sdk/models/subscription-coupon-input.ts +62 -0
- package/src/sdk/models/subscription-line-item-response.ts +9 -0
- package/src/sdk/models/subscription-modify-type.ts +2 -0
- package/src/sdk/models/subscription-phase-create-request.ts +16 -2
- package/src/sdk/models/subscription-subscription-line-item.ts +9 -0
- package/src/sdk/models/tax-association-response.ts +12 -0
- package/src/sdk/models/time-of-day-bucket.ts +74 -0
- package/src/sdk/models/update-service-account-op.ts +46 -0
- package/src/sdk/models/update-service-account-request.ts +32 -0
- package/src/sdk/models/update-service-account-response.ts +51 -0
- package/src/sdk/models/update-subscription-line-item-request.ts +14 -0
- package/src/sdk/models/update-user-request.ts +3 -0
- package/src/sdk/models/update-user-response.ts +2 -0
- package/src/sdk/models/usage-analytic-item.ts +13 -0
- package/src/sdk/models/usage-analytic-point.ts +12 -0
- package/src/sdk/models/user-response.ts +2 -0
- package/src/sdk/models/window-size.ts +1 -1
- package/src/sdk/sdk.ts +6 -0
- package/src/sdk/subscriptions.ts +2 -2
- package/src/sdk/users.ts +39 -1
- package/esm/lib/dlv.d.ts +0 -14
- package/esm/lib/dlv.d.ts.map +0 -1
- package/esm/lib/dlv.js +0 -46
- package/esm/lib/dlv.js.map +0 -1
- package/esm/lib/is-plain-object.d.ts +0 -2
- package/esm/lib/is-plain-object.d.ts.map +0 -1
- package/esm/lib/is-plain-object.js +0 -38
- package/esm/lib/is-plain-object.js.map +0 -1
- package/src/lib/dlv.ts +0 -53
- package/src/lib/is-plain-object.ts +0 -43
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# AttributedToCustomerResult
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { AttributedToCustomerResult } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: AttributedToCustomerResult = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
|
|
15
|
+
| `error` | [models.ErrorResponse](../../sdk/models/error-response.md) | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `meterUsage` | [models.MeterUsageAttribution](../../sdk/models/meter-usage-attribution.md) | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `status` | [models.DebugTrackerStatus](../../sdk/models/debug-tracker-status.md) | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# BucketSummary
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { BucketSummary } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: BucketSummary = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
|
15
|
+
| `baseCharge` | *string* | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `bucketId` | *string* | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `commitmentType` | *string* | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `commitmentValue` | *string* | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `computedOverage` | *string* | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `computedTrueUp` | *string* | :heavy_minus_sign: | N/A |
|
|
21
|
+
| `computedUtilized` | *string* | :heavy_minus_sign: | N/A |
|
|
22
|
+
| `end` | [models.Bucket](../../sdk/models/bucket.md) | :heavy_minus_sign: | N/A |
|
|
23
|
+
| `priceId` | *string* | :heavy_minus_sign: | PriceID is the bucket's own price (the line item's price for the<br/>out-of-bucket row). |
|
|
24
|
+
| `start` | [models.Bucket](../../sdk/models/bucket.md) | :heavy_minus_sign: | N/A |
|
|
25
|
+
| `subscriptionLineItemId` | *string* | :heavy_minus_sign: | SubscriptionLineItemID is the line item this bucket is configured on. |
|
|
26
|
+
| `totalUsage` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Bucket
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { Bucket } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: Bucket = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
15
|
+
| `hour` | *number* | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `minute` | *number* | :heavy_minus_sign: | N/A |
|
|
@@ -12,10 +12,10 @@ let value: CancelSubscriptionRequest = {
|
|
|
12
12
|
|
|
13
13
|
## Fields
|
|
14
14
|
|
|
15
|
-
| Field
|
|
16
|
-
|
|
|
17
|
-
| `cancelAt`
|
|
18
|
-
| `cancelImmediatelyInovicePolicy`
|
|
19
|
-
| `cancellationType`
|
|
20
|
-
| `prorationBehavior`
|
|
21
|
-
| `reason`
|
|
15
|
+
| Field | Type | Required | Description |
|
|
16
|
+
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
17
|
+
| `cancelAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | CancelAt is the exact date/time when the subscription should be cancelled.<br/>Required for cancellation_type "scheduled_date"; optional for "immediate" (past dates only — backdated cancellation).<br/>For "scheduled_date", accepts both future dates (deferred cancellation) and past dates (backdated cancellation).<br/>For "immediate", accepts past/current dates only; use "scheduled_date" for future dates. |
|
|
18
|
+
| `cancelImmediatelyInovicePolicy` | [models.CancelImmediatelyInvoicePolicy](../../sdk/models/cancel-immediately-invoice-policy.md) | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `cancellationType` | [models.CancellationType](../../sdk/models/cancellation-type.md) | :heavy_check_mark: | N/A |
|
|
20
|
+
| `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
|
|
21
|
+
| `reason` | *string* | :heavy_minus_sign: | Reason for cancellation (for audit and business intelligence) |
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# CommitmentBucketRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { CommitmentBucketRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: CommitmentBucketRequest = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
|
15
|
+
| `commitmentType` | [models.CommitmentType](../../sdk/models/commitment-type.md) | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `commitmentValue` | *string* | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `end` | [models.Bucket](../../sdk/models/bucket.md) | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `id` | *string* | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `overageFactor` | *string* | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `price` | [models.CreatePriceRequest](../../sdk/models/create-price-request.md) | :heavy_minus_sign: | N/A |
|
|
21
|
+
| `start` | [models.Bucket](../../sdk/models/bucket.md) | :heavy_minus_sign: | N/A |
|
|
22
|
+
| `trueUpEnabled` | *boolean* | :heavy_minus_sign: | N/A |
|
|
@@ -14,6 +14,7 @@ let value: CouponResponse = {};
|
|
|
14
14
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
15
15
|
| `amountOff` | *string* | :heavy_minus_sign: | N/A |
|
|
16
16
|
| `cadence` | [models.CouponCadence](../../sdk/models/coupon-cadence.md) | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `couponCode` | *string* | :heavy_minus_sign: | N/A |
|
|
17
18
|
| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
18
19
|
| `createdBy` | *string* | :heavy_minus_sign: | N/A |
|
|
19
20
|
| `currency` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -14,6 +14,7 @@ let value: Coupon = {};
|
|
|
14
14
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
15
15
|
| `amountOff` | *string* | :heavy_minus_sign: | N/A |
|
|
16
16
|
| `cadence` | [models.CouponCadence](../../sdk/models/coupon-cadence.md) | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `couponCode` | *string* | :heavy_minus_sign: | N/A |
|
|
17
18
|
| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
18
19
|
| `createdBy` | *string* | :heavy_minus_sign: | N/A |
|
|
19
20
|
| `currency` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -18,6 +18,7 @@ let value: CreateCouponRequest = {
|
|
|
18
18
|
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
|
19
19
|
| `amountOff` | *string* | :heavy_minus_sign: | N/A |
|
|
20
20
|
| `cadence` | [models.CouponCadence](../../sdk/models/coupon-cadence.md) | :heavy_check_mark: | N/A |
|
|
21
|
+
| `couponCode` | *string* | :heavy_minus_sign: | N/A |
|
|
21
22
|
| `currency` | *string* | :heavy_minus_sign: | N/A |
|
|
22
23
|
| `durationInPeriods` | *number* | :heavy_minus_sign: | N/A |
|
|
23
24
|
| `maxRedemptions` | *number* | :heavy_minus_sign: | N/A |
|
|
@@ -16,6 +16,7 @@ let value: CreateSubscriptionLineItemRequest = {};
|
|
|
16
16
|
| `commitmentDuration` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
|
|
17
17
|
| `commitmentOverageFactor` | *number* | :heavy_minus_sign: | N/A |
|
|
18
18
|
| `commitmentQuantity` | *number* | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `commitmentTimeBuckets` | [models.CommitmentBucketRequest](../../sdk/models/commitment-bucket-request.md)[] | :heavy_minus_sign: | N/A |
|
|
19
20
|
| `commitmentTrueUpEnabled` | *boolean* | :heavy_minus_sign: | N/A |
|
|
20
21
|
| `commitmentType` | [models.CommitmentType](../../sdk/models/commitment-type.md) | :heavy_minus_sign: | N/A |
|
|
21
22
|
| `commitmentWindowed` | *boolean* | :heavy_minus_sign: | N/A |
|
|
@@ -25,7 +25,7 @@ let value: CreateSubscriptionRequest = {
|
|
|
25
25
|
| `collectionMethod` | [models.CollectionMethod](../../sdk/models/collection-method.md) | :heavy_minus_sign: | N/A |
|
|
26
26
|
| `commitmentAmount` | *string* | :heavy_minus_sign: | CommitmentAmount is the minimum amount a customer commits to paying for a billing period |
|
|
27
27
|
| `commitmentDuration` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
|
|
28
|
-
| `coupons` | *string*[] | :heavy_minus_sign: |
|
|
28
|
+
| `coupons` | *string*[] | :heavy_minus_sign: | Deprecated: use SubscriptionCoupons instead. |
|
|
29
29
|
| `creditGrants` | [models.CreateCreditGrantRequest](../../sdk/models/create-credit-grant-request.md)[] | :heavy_minus_sign: | Credit grants to be applied when subscription is created |
|
|
30
30
|
| `currency` | *string* | :heavy_check_mark: | N/A |
|
|
31
31
|
| `customerId` | *string* | :heavy_minus_sign: | customer_id is the flexprice customer id<br/>and it is prioritized over external_customer_id in case both are provided. |
|
|
@@ -36,7 +36,7 @@ let value: CreateSubscriptionRequest = {
|
|
|
36
36
|
| `gatewayPaymentMethodId` | *string* | :heavy_minus_sign: | N/A |
|
|
37
37
|
| `inheritance` | [models.SubscriptionInheritanceConfig](../../sdk/models/subscription-inheritance-config.md) | :heavy_minus_sign: | N/A |
|
|
38
38
|
| `lineItemCommitments` | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)> | :heavy_minus_sign: | LineItemCommitments allows setting commitment configuration per line item (keyed by price_id) |
|
|
39
|
-
| `lineItemCoupons` | Record<string, *string*[]> | :heavy_minus_sign: |
|
|
39
|
+
| `lineItemCoupons` | Record<string, *string*[]> | :heavy_minus_sign: | Deprecated: use SubscriptionCoupons instead. |
|
|
40
40
|
| `lineItems` | [models.CreateSubscriptionLineItemRequest](../../sdk/models/create-subscription-line-item-request.md)[] | :heavy_minus_sign: | LineItems are extra line items to add at creation (each with price_id or price), in addition to plan prices |
|
|
41
41
|
| `lookupKey` | *string* | :heavy_minus_sign: | N/A |
|
|
42
42
|
| `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
|
|
@@ -49,6 +49,7 @@ let value: CreateSubscriptionRequest = {
|
|
|
49
49
|
| `planId` | *string* | :heavy_check_mark: | N/A |
|
|
50
50
|
| `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
|
|
51
51
|
| `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
52
|
+
| `subscriptionCoupons` | [models.SubscriptionCouponInput](../../sdk/models/subscription-coupon-input.md)[] | :heavy_minus_sign: | SubscriptionCoupons is the preferred way to attach coupons at creation.<br/>Accepts coupon_code; optionally targets a line item via price_id. |
|
|
52
53
|
| `subscriptionStatus` | [models.SubscriptionStatus](../../sdk/models/subscription-status.md) | :heavy_minus_sign: | N/A |
|
|
53
54
|
| `taxRateOverrides` | [models.TaxRateOverride](../../sdk/models/tax-rate-override.md)[] | :heavy_minus_sign: | tax_rate_overrides is the tax rate overrides to be applied to the subscription |
|
|
54
55
|
| `trialPeriodDays` | *number* | :heavy_minus_sign: | TrialPeriodDays: nil = inherit trial length from plan recurring-fixed prices (must be uniform).<br/>0 = explicitly no trial (overrides catalog). >0 = override duration in days. |
|
|
@@ -12,13 +12,15 @@ let value: CreateTaxAssociationRequest = {
|
|
|
12
12
|
|
|
13
13
|
## Fields
|
|
14
14
|
|
|
15
|
-
| Field
|
|
16
|
-
|
|
|
17
|
-
| `autoApply`
|
|
18
|
-
| `currency`
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
23
|
-
| `
|
|
24
|
-
| `
|
|
15
|
+
| Field | Type | Required | Description |
|
|
16
|
+
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
17
|
+
| `autoApply` | *boolean* | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `currency` | *string* | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | EndDate sets when this association expires. Must be after StartDate when both are provided. |
|
|
20
|
+
| `entityId` | *string* | :heavy_minus_sign: | N/A |
|
|
21
|
+
| `entityType` | [models.TaxRateEntityType](../../sdk/models/tax-rate-entity-type.md) | :heavy_minus_sign: | N/A |
|
|
22
|
+
| `externalCustomerId` | *string* | :heavy_minus_sign: | N/A |
|
|
23
|
+
| `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
|
|
24
|
+
| `priority` | *number* | :heavy_minus_sign: | N/A |
|
|
25
|
+
| `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | StartDate sets when this association becomes active. Defaults to now if omitted. |
|
|
26
|
+
| `taxRateCode` | *string* | :heavy_check_mark: | N/A |
|
|
@@ -15,5 +15,6 @@ let value: CreateUserRequest = {
|
|
|
15
15
|
| Field | Type | Required | Description |
|
|
16
16
|
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
|
|
17
17
|
| `email` | *string* | :heavy_minus_sign: | Required when type is "user" |
|
|
18
|
+
| `name` | *string* | :heavy_minus_sign: | Display name; optional for service accounts |
|
|
18
19
|
| `roles` | *string*[] | :heavy_minus_sign: | Required when type is "service_account" |
|
|
19
20
|
| `type` | [models.UserType](../../sdk/models/user-type.md) | :heavy_check_mark: | N/A |
|
|
@@ -15,6 +15,7 @@ let value: CreateUserResponse = {};
|
|
|
15
15
|
| `email` | *string* | :heavy_minus_sign: | Empty for service accounts |
|
|
16
16
|
| `id` | *string* | :heavy_minus_sign: | N/A |
|
|
17
17
|
| `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `name` | *string* | :heavy_minus_sign: | N/A |
|
|
18
19
|
| `password` | *string* | :heavy_minus_sign: | N/A |
|
|
19
20
|
| `roles` | *string*[] | :heavy_minus_sign: | N/A |
|
|
20
21
|
| `tenant` | [models.TenantResponse](../../sdk/models/tenant-response.md) | :heavy_minus_sign: | N/A |
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
```typescript
|
|
6
6
|
import { DebugTrackerStatus } from "@flexprice/sdk/sdk/models";
|
|
7
7
|
|
|
8
|
-
let value: DebugTrackerStatus = "
|
|
8
|
+
let value: DebugTrackerStatus = "attributed";
|
|
9
9
|
|
|
10
10
|
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
11
|
```
|
|
@@ -13,5 +13,5 @@ let value: DebugTrackerStatus = "error";
|
|
|
13
13
|
## Values
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
"unprocessed" | "not_found" | "found" | "error" | Unrecognized<string>
|
|
16
|
+
"unprocessed" | "not_found" | "found" | "error" | "processing" | "attributed" | Unrecognized<string>
|
|
17
17
|
```
|
|
@@ -12,6 +12,7 @@ let value: DebugTracker = {};
|
|
|
12
12
|
|
|
13
13
|
| Field | Type | Required | Description |
|
|
14
14
|
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
|
15
|
+
| `attributedToCustomer` | [models.AttributedToCustomerResult](../../sdk/models/attributed-to-customer-result.md) | :heavy_minus_sign: | N/A |
|
|
15
16
|
| `customerLookup` | [models.CustomerLookupResult](../../sdk/models/customer-lookup-result.md) | :heavy_minus_sign: | N/A |
|
|
16
17
|
| `failurePoint` | [models.FailurePoint](../../sdk/models/failure-point.md) | :heavy_minus_sign: | N/A |
|
|
17
18
|
| `meterMatching` | [models.MeterMatchingResult](../../sdk/models/meter-matching-result.md) | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# DeleteServiceAccountRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { DeleteServiceAccountRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: DeleteServiceAccountRequest = {
|
|
9
|
+
id: "<id>",
|
|
10
|
+
};
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Fields
|
|
14
|
+
|
|
15
|
+
| Field | Type | Required | Description |
|
|
16
|
+
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
17
|
+
| `id` | *string* | :heavy_check_mark: | Service Account ID |
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# DelinkIntegrationMappingRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { DelinkIntegrationMappingRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: DelinkIntegrationMappingRequest = {
|
|
9
|
+
entityId: "<id>",
|
|
10
|
+
entityType: "invoice",
|
|
11
|
+
providerType: "<value>",
|
|
12
|
+
};
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Fields
|
|
16
|
+
|
|
17
|
+
| Field | Type | Required | Description |
|
|
18
|
+
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
|
|
19
|
+
| `entityId` | *string* | :heavy_check_mark: | N/A |
|
|
20
|
+
| `entityType` | [models.IntegrationEntityType](../../sdk/models/integration-entity-type.md) | :heavy_check_mark: | N/A |
|
|
21
|
+
| `providerType` | *string* | :heavy_check_mark: | N/A |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
import { ExecuteSubscriptionModifyRequest } from "@flexprice/sdk/sdk/models";
|
|
7
7
|
|
|
8
8
|
let value: ExecuteSubscriptionModifyRequest = {
|
|
9
|
-
type: "
|
|
9
|
+
type: "coupon",
|
|
10
10
|
};
|
|
11
11
|
```
|
|
12
12
|
|
|
@@ -14,8 +14,10 @@ let value: ExecuteSubscriptionModifyRequest = {
|
|
|
14
14
|
|
|
15
15
|
| Field | Type | Required | Description |
|
|
16
16
|
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
|
17
|
+
| `couponParams` | [models.SubModifyCouponParams](../../sdk/models/sub-modify-coupon-params.md) | :heavy_minus_sign: | N/A |
|
|
17
18
|
| `groupedInvoicingParams` | [models.SubModifyGroupedInvoicingParams](../../sdk/models/sub-modify-grouped-invoicing-params.md) | :heavy_minus_sign: | N/A |
|
|
18
19
|
| `inheritanceParams` | [models.SubModifyInheritanceRequest](../../sdk/models/sub-modify-inheritance-request.md) | :heavy_minus_sign: | N/A |
|
|
19
20
|
| `quantityChangeParams` | [models.SubModifyQuantityChangeRequest](../../sdk/models/sub-modify-quantity-change-request.md) | :heavy_minus_sign: | N/A |
|
|
21
|
+
| `taxParams` | [models.SubModifyTaxParams](../../sdk/models/sub-modify-tax-params.md) | :heavy_minus_sign: | N/A |
|
|
20
22
|
| `trialEndParams` | [models.SubModifyTrialEndRequest](../../sdk/models/sub-modify-trial-end-request.md) | :heavy_minus_sign: | N/A |
|
|
21
23
|
| `type` | [models.SubscriptionModifyType](../../sdk/models/subscription-modify-type.md) | :heavy_check_mark: | N/A |
|
|
@@ -13,5 +13,5 @@ let value: FailurePointType = "customer_lookup";
|
|
|
13
13
|
## Values
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
"customer_lookup" | "meter_lookup" | "price_lookup" | "subscription_line_item_lookup" | Unrecognized<string>
|
|
16
|
+
"customer_lookup" | "meter_lookup" | "price_lookup" | "subscription_line_item_lookup" | "attributed_to_customer" | Unrecognized<string>
|
|
17
17
|
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# GetCouponAssociationRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { GetCouponAssociationRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: GetCouponAssociationRequest = {
|
|
9
|
+
id: "<id>",
|
|
10
|
+
};
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Fields
|
|
14
|
+
|
|
15
|
+
| Field | Type | Required | Description |
|
|
16
|
+
| --------------------- | --------------------- | --------------------- | --------------------- |
|
|
17
|
+
| `id` | *string* | :heavy_check_mark: | Coupon Association ID |
|
|
@@ -10,15 +10,16 @@ let value: GetUsageAnalyticsRequest = {};
|
|
|
10
10
|
|
|
11
11
|
## Fields
|
|
12
12
|
|
|
13
|
-
| Field
|
|
14
|
-
|
|
|
15
|
-
| `
|
|
16
|
-
| `
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
23
|
-
| `
|
|
24
|
-
| `
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
15
|
+
| `breakdownBucket` | *boolean* | :heavy_minus_sign: | BreakdownBucket when true augments each time-series point with BucketID/PriceID<br/>and appends a BucketSummaries rollup to each item. Requires WindowSize to be set<br/>and the item to be linked to a subscription line item that has CommitmentTimeBuckets.<br/>Default: false (opt-in, backward compatible). |
|
|
16
|
+
| `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `expand` | *string*[] | :heavy_minus_sign: | allowed values: "price", "meter", "feature", "subscription_line_item","plan","addon" |
|
|
18
|
+
| `externalCustomerId` | *string* | :heavy_minus_sign: | ExternalCustomerID is the single external customer ID.<br/>Optional when ExternalCustomerIDs is provided; required otherwise. |
|
|
19
|
+
| `featureIds` | *string*[] | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `groupBy` | *string*[] | :heavy_minus_sign: | allowed values: "source", "feature_id", "properties.<field_name>" |
|
|
21
|
+
| `includeChildren` | *boolean* | :heavy_minus_sign: | IncludeChildren when true folds child customers' usage into the single aggregated total.<br/>Default: false. |
|
|
22
|
+
| `propertyFilters` | Record<string, *string*[]> | :heavy_minus_sign: | Property filters to filter the events by the keys in `properties` field of the event |
|
|
23
|
+
| `sources` | *string*[] | :heavy_minus_sign: | N/A |
|
|
24
|
+
| `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
25
|
+
| `windowSize` | [models.WindowSize](../../sdk/models/window-size.md) | :heavy_minus_sign: | N/A |
|