@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
|
@@ -40,36 +40,37 @@ let value: UsageAnalyticItem = {
|
|
|
40
40
|
|
|
41
41
|
## Fields
|
|
42
42
|
|
|
43
|
-
| Field
|
|
44
|
-
|
|
|
45
|
-
| `addOnId`
|
|
46
|
-
| `addon`
|
|
47
|
-
| `aggregationType`
|
|
48
|
-
| `
|
|
49
|
-
| `
|
|
50
|
-
| `
|
|
51
|
-
| `
|
|
52
|
-
| `
|
|
53
|
-
| `
|
|
54
|
-
| `
|
|
55
|
-
| `
|
|
56
|
-
| `
|
|
57
|
-
| `
|
|
58
|
-
| `
|
|
59
|
-
| `
|
|
60
|
-
| `
|
|
61
|
-
| `
|
|
62
|
-
| `
|
|
63
|
-
| `
|
|
64
|
-
| `
|
|
65
|
-
| `
|
|
66
|
-
| `
|
|
67
|
-
| `
|
|
68
|
-
| `
|
|
69
|
-
| `
|
|
70
|
-
| `
|
|
71
|
-
| `
|
|
72
|
-
| `
|
|
73
|
-
| `
|
|
74
|
-
| `
|
|
75
|
-
| `
|
|
43
|
+
| Field | Type | Required | Description |
|
|
44
|
+
| -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
45
|
+
| `addOnId` | *string* | :heavy_minus_sign: | N/A |
|
|
46
|
+
| `addon` | [models.Addon](../../sdk/models/addon.md) | :heavy_minus_sign: | N/A |
|
|
47
|
+
| `aggregationType` | [models.AggregationType](../../sdk/models/aggregation-type.md) | :heavy_minus_sign: | N/A |
|
|
48
|
+
| `bucketSummaries` | [models.BucketSummary](../../sdk/models/bucket-summary.md)[] | :heavy_minus_sign: | BucketSummaries is populated only when BreakdownBucket=true. Contains one<br/>entry per defined CommitmentTimeBucket plus one for out-of-bucket usage. |
|
|
49
|
+
| `commitmentInfo` | [models.CommitmentInfo](../../sdk/models/commitment-info.md) | :heavy_minus_sign: | N/A |
|
|
50
|
+
| `currency` | *string* | :heavy_minus_sign: | N/A |
|
|
51
|
+
| `eventCount` | *number* | :heavy_minus_sign: | Number of events that contributed to this aggregation |
|
|
52
|
+
| `eventName` | *string* | :heavy_minus_sign: | N/A |
|
|
53
|
+
| `feature` | [models.Feature](../../sdk/models/feature.md) | :heavy_minus_sign: | N/A |
|
|
54
|
+
| `featureId` | *string* | :heavy_minus_sign: | N/A |
|
|
55
|
+
| `group` | [models.GroupGroup](../../sdk/models/group-group.md) | :heavy_minus_sign: | N/A |
|
|
56
|
+
| `meter` | [models.MeterMeter](../../sdk/models/meter-meter.md) | :heavy_minus_sign: | N/A |
|
|
57
|
+
| `meterId` | *string* | :heavy_minus_sign: | Meter ID |
|
|
58
|
+
| `name` | *string* | :heavy_minus_sign: | N/A |
|
|
59
|
+
| `plan` | [models.Plan](../../sdk/models/plan.md) | :heavy_minus_sign: | N/A |
|
|
60
|
+
| `planId` | *string* | :heavy_minus_sign: | N/A |
|
|
61
|
+
| `points` | [models.UsageAnalyticPoint](../../sdk/models/usage-analytic-point.md)[] | :heavy_minus_sign: | N/A |
|
|
62
|
+
| `price` | [models.PriceResponse](../../sdk/models/price-response.md) | :heavy_minus_sign: | N/A |
|
|
63
|
+
| `priceId` | *string* | :heavy_minus_sign: | Price ID used for this usage |
|
|
64
|
+
| `properties` | Record<string, *string*> | :heavy_minus_sign: | Stores property values for flexible grouping (e.g., org_id -> "org123") |
|
|
65
|
+
| `reportingUnit` | [models.ReportingUnit](../../sdk/models/reporting-unit.md) | :heavy_minus_sign: | N/A |
|
|
66
|
+
| `source` | *string* | :heavy_minus_sign: | N/A |
|
|
67
|
+
| `sources` | *string*[] | :heavy_minus_sign: | List of sources when not grouping by source |
|
|
68
|
+
| `subLineItemId` | *string* | :heavy_minus_sign: | Subscription line item ID |
|
|
69
|
+
| `subscriptionId` | *string* | :heavy_minus_sign: | Subscription ID |
|
|
70
|
+
| `subscriptionLineItem` | [models.SubscriptionSubscriptionLineItem](../../sdk/models/subscription-subscription-line-item.md) | :heavy_minus_sign: | N/A |
|
|
71
|
+
| `totalCost` | *string* | :heavy_minus_sign: | N/A |
|
|
72
|
+
| `totalUsage` | *string* | :heavy_minus_sign: | N/A |
|
|
73
|
+
| `totalUsageDisplay` | *string* | :heavy_minus_sign: | Empty string when feature has no reporting unit; otherwise the value in reporting units |
|
|
74
|
+
| `unit` | *string* | :heavy_minus_sign: | N/A |
|
|
75
|
+
| `unitPlural` | *string* | :heavy_minus_sign: | N/A |
|
|
76
|
+
| `windowSize` | [models.WindowSize](../../sdk/models/window-size.md) | :heavy_minus_sign: | N/A |
|
|
@@ -10,12 +10,14 @@ let value: UsageAnalyticPoint = {};
|
|
|
10
10
|
|
|
11
11
|
## Fields
|
|
12
12
|
|
|
13
|
-
| Field
|
|
14
|
-
|
|
|
15
|
-
| `
|
|
16
|
-
| `
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
15
|
+
| `bucketId` | *string* | :heavy_minus_sign: | Bucket identity (only populated when BreakdownBucket=true and the line item<br/>has CommitmentTimeBuckets). Empty strings indicate out-of-bucket windows. |
|
|
16
|
+
| `bucketPriceId` | *string* | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `computedCommitmentUtilizedAmount` | *string* | :heavy_minus_sign: | Commitment breakdown (only populated for windowed commitments) |
|
|
18
|
+
| `computedOverageAmount` | *string* | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `computedTrueUpAmount` | *string* | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `cost` | *string* | :heavy_minus_sign: | N/A |
|
|
21
|
+
| `eventCount` | *number* | :heavy_minus_sign: | Number of events in this time window |
|
|
22
|
+
| `timestamp` | *string* | :heavy_minus_sign: | N/A |
|
|
23
|
+
| `usage` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -15,6 +15,7 @@ let value: UserResponse = {};
|
|
|
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
|
| `roles` | *string*[] | :heavy_minus_sign: | N/A |
|
|
19
20
|
| `tenant` | [models.TenantResponse](../../sdk/models/tenant-response.md) | :heavy_minus_sign: | N/A |
|
|
20
21
|
| `type` | [models.UserType](../../sdk/models/user-type.md) | :heavy_minus_sign: | N/A |
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
```typescript
|
|
6
6
|
import { WindowSize } from "@flexprice/sdk/sdk/models";
|
|
7
7
|
|
|
8
|
-
let value: WindowSize = "
|
|
8
|
+
let value: WindowSize = "12HOUR";
|
|
9
9
|
|
|
10
10
|
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
11
|
```
|
|
@@ -13,5 +13,5 @@ let value: WindowSize = "6HOUR";
|
|
|
13
13
|
## Values
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
"
|
|
16
|
+
"MINUTE" | "15MIN" | "30MIN" | "HOUR" | "3HOUR" | "6HOUR" | "12HOUR" | "DAY" | "WEEK" | "MONTH" | Unrecognized<string>
|
|
17
17
|
```
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
# CouponAssociations
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
### Available Operations
|
|
6
|
+
|
|
7
|
+
* [listCouponAssociations](#listcouponassociations) - List coupon associations
|
|
8
|
+
* [getCouponAssociation](#getcouponassociation) - Get coupon association
|
|
9
|
+
|
|
10
|
+
## listCouponAssociations
|
|
11
|
+
|
|
12
|
+
List coupon associations with optional filters. Coupon associations are created and removed via the subscription modify API.
|
|
13
|
+
|
|
14
|
+
### Example Usage
|
|
15
|
+
|
|
16
|
+
<!-- UsageSnippet language="typescript" operationID="listCouponAssociations" method="get" path="/coupons/associations" -->
|
|
17
|
+
```typescript
|
|
18
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
19
|
+
|
|
20
|
+
const flexprice = new Flexprice({
|
|
21
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
22
|
+
});
|
|
23
|
+
|
|
24
|
+
async function run() {
|
|
25
|
+
const result = await flexprice.couponAssociations.listCouponAssociations();
|
|
26
|
+
|
|
27
|
+
console.log(result);
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
run();
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Standalone function
|
|
34
|
+
|
|
35
|
+
The standalone function version of this method:
|
|
36
|
+
|
|
37
|
+
```typescript
|
|
38
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
39
|
+
import { couponAssociationsListCouponAssociations } from "@flexprice/sdk/funcs/coupon-associations-list-coupon-associations.js";
|
|
40
|
+
|
|
41
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
42
|
+
// You can create one instance of it to use across an application.
|
|
43
|
+
const flexprice = new FlexpriceCore({
|
|
44
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
45
|
+
});
|
|
46
|
+
|
|
47
|
+
async function run() {
|
|
48
|
+
const res = await couponAssociationsListCouponAssociations(flexprice);
|
|
49
|
+
if (res.ok) {
|
|
50
|
+
const { value: result } = res;
|
|
51
|
+
console.log(result);
|
|
52
|
+
} else {
|
|
53
|
+
console.log("couponAssociationsListCouponAssociations failed:", res.error);
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
run();
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### Parameters
|
|
61
|
+
|
|
62
|
+
| Parameter | Type | Required | Description |
|
|
63
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
64
|
+
| `request` | [models.ListCouponAssociationsRequest](../../sdk/models/list-coupon-associations-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
65
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
66
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
67
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
68
|
+
|
|
69
|
+
### Response
|
|
70
|
+
|
|
71
|
+
**Promise\<[models.ListCouponAssociationsResponse](../../sdk/models/list-coupon-associations-response.md)\>**
|
|
72
|
+
|
|
73
|
+
### Errors
|
|
74
|
+
|
|
75
|
+
| Error Type | Status Code | Content Type |
|
|
76
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
77
|
+
| models.ErrorsErrorResponse | 400 | application/json |
|
|
78
|
+
| models.ErrorsErrorResponse | 500 | application/json |
|
|
79
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
80
|
+
|
|
81
|
+
## getCouponAssociation
|
|
82
|
+
|
|
83
|
+
Get a single coupon association by ID. Coupon associations are created and removed via the subscription modify API.
|
|
84
|
+
|
|
85
|
+
### Example Usage
|
|
86
|
+
|
|
87
|
+
<!-- UsageSnippet language="typescript" operationID="getCouponAssociation" method="get" path="/coupons/associations/{id}" -->
|
|
88
|
+
```typescript
|
|
89
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
90
|
+
|
|
91
|
+
const flexprice = new Flexprice({
|
|
92
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
93
|
+
});
|
|
94
|
+
|
|
95
|
+
async function run() {
|
|
96
|
+
const result = await flexprice.couponAssociations.getCouponAssociation("<id>");
|
|
97
|
+
|
|
98
|
+
console.log(result);
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
run();
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### Standalone function
|
|
105
|
+
|
|
106
|
+
The standalone function version of this method:
|
|
107
|
+
|
|
108
|
+
```typescript
|
|
109
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
110
|
+
import { couponAssociationsGetCouponAssociation } from "@flexprice/sdk/funcs/coupon-associations-get-coupon-association.js";
|
|
111
|
+
|
|
112
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
113
|
+
// You can create one instance of it to use across an application.
|
|
114
|
+
const flexprice = new FlexpriceCore({
|
|
115
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
116
|
+
});
|
|
117
|
+
|
|
118
|
+
async function run() {
|
|
119
|
+
const res = await couponAssociationsGetCouponAssociation(flexprice, "<id>");
|
|
120
|
+
if (res.ok) {
|
|
121
|
+
const { value: result } = res;
|
|
122
|
+
console.log(result);
|
|
123
|
+
} else {
|
|
124
|
+
console.log("couponAssociationsGetCouponAssociation failed:", res.error);
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
run();
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
### Parameters
|
|
132
|
+
|
|
133
|
+
| Parameter | Type | Required | Description |
|
|
134
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
135
|
+
| `id` | *string* | :heavy_check_mark: | Coupon Association ID |
|
|
136
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
137
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
138
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
139
|
+
|
|
140
|
+
### Response
|
|
141
|
+
|
|
142
|
+
**Promise\<[models.CouponAssociationResponse](../../sdk/models/coupon-association-response.md)\>**
|
|
143
|
+
|
|
144
|
+
### Errors
|
|
145
|
+
|
|
146
|
+
| Error Type | Status Code | Content Type |
|
|
147
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
148
|
+
| models.ErrorsErrorResponse | 404 | application/json |
|
|
149
|
+
| models.ErrorsErrorResponse | 500 | application/json |
|
|
150
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
* [getIntegrationConfig](#getintegrationconfig) - Get integration configurations
|
|
8
8
|
* [linkIntegrationMapping](#linkintegrationmapping) - Link integration mapping
|
|
9
|
+
* [delinkIntegrationMapping](#delinkintegrationmapping) - Delink integration mapping
|
|
9
10
|
* [getEntityIntegrationMappings](#getentityintegrationmappings) - Get entity integration mappings
|
|
10
11
|
|
|
11
12
|
## getIntegrationConfig
|
|
@@ -158,6 +159,85 @@ run();
|
|
|
158
159
|
| models.ErrorsErrorResponse | 500 | application/json |
|
|
159
160
|
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
160
161
|
|
|
162
|
+
## delinkIntegrationMapping
|
|
163
|
+
|
|
164
|
+
Soft-delete (archive) the mapping between a FlexPrice entity and a provider entity.
|
|
165
|
+
|
|
166
|
+
### Example Usage
|
|
167
|
+
|
|
168
|
+
<!-- UsageSnippet language="typescript" operationID="delinkIntegrationMapping" method="delete" path="/integrations/link" -->
|
|
169
|
+
```typescript
|
|
170
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
171
|
+
|
|
172
|
+
const flexprice = new Flexprice({
|
|
173
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
174
|
+
});
|
|
175
|
+
|
|
176
|
+
async function run() {
|
|
177
|
+
const result = await flexprice.integrations.delinkIntegrationMapping({
|
|
178
|
+
entityId: "<id>",
|
|
179
|
+
entityType: "item_price",
|
|
180
|
+
providerType: "<value>",
|
|
181
|
+
});
|
|
182
|
+
|
|
183
|
+
console.log(result);
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
run();
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
### Standalone function
|
|
190
|
+
|
|
191
|
+
The standalone function version of this method:
|
|
192
|
+
|
|
193
|
+
```typescript
|
|
194
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
195
|
+
import { integrationsDelinkIntegrationMapping } from "@flexprice/sdk/funcs/integrations-delink-integration-mapping.js";
|
|
196
|
+
|
|
197
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
198
|
+
// You can create one instance of it to use across an application.
|
|
199
|
+
const flexprice = new FlexpriceCore({
|
|
200
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
201
|
+
});
|
|
202
|
+
|
|
203
|
+
async function run() {
|
|
204
|
+
const res = await integrationsDelinkIntegrationMapping(flexprice, {
|
|
205
|
+
entityId: "<id>",
|
|
206
|
+
entityType: "item_price",
|
|
207
|
+
providerType: "<value>",
|
|
208
|
+
});
|
|
209
|
+
if (res.ok) {
|
|
210
|
+
const { value: result } = res;
|
|
211
|
+
console.log(result);
|
|
212
|
+
} else {
|
|
213
|
+
console.log("integrationsDelinkIntegrationMapping failed:", res.error);
|
|
214
|
+
}
|
|
215
|
+
}
|
|
216
|
+
|
|
217
|
+
run();
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
### Parameters
|
|
221
|
+
|
|
222
|
+
| Parameter | Type | Required | Description |
|
|
223
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
224
|
+
| `request` | [models.DelinkIntegrationMappingRequest](../../sdk/models/delink-integration-mapping-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
225
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
226
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
227
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
228
|
+
|
|
229
|
+
### Response
|
|
230
|
+
|
|
231
|
+
**Promise\<[models.SuccessResponse](../../sdk/models/success-response.md)\>**
|
|
232
|
+
|
|
233
|
+
### Errors
|
|
234
|
+
|
|
235
|
+
| Error Type | Status Code | Content Type |
|
|
236
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
237
|
+
| models.ErrorsErrorResponse | 400, 404 | application/json |
|
|
238
|
+
| models.ErrorsErrorResponse | 500 | application/json |
|
|
239
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
240
|
+
|
|
161
241
|
## getEntityIntegrationMappings
|
|
162
242
|
|
|
163
243
|
Get integration mappings for a specific entity by entity type and entity ID.
|
|
@@ -1379,7 +1379,7 @@ run();
|
|
|
1379
1379
|
|
|
1380
1380
|
## executeSubscriptionModify
|
|
1381
1381
|
|
|
1382
|
-
Execute a mid-cycle subscription modification (inheritance
|
|
1382
|
+
Execute a mid-cycle subscription modification (inheritance, quantity change, grouped invoicing, trial end, coupon, or tax).
|
|
1383
1383
|
|
|
1384
1384
|
### Example Usage
|
|
1385
1385
|
|
|
@@ -1455,7 +1455,7 @@ run();
|
|
|
1455
1455
|
|
|
1456
1456
|
## previewSubscriptionModify
|
|
1457
1457
|
|
|
1458
|
-
Preview the impact of a mid-cycle subscription modification without committing changes.
|
|
1458
|
+
Preview the impact of a mid-cycle subscription modification (inheritance, quantity change, grouped invoicing, trial end, coupon, or tax) without committing changes.
|
|
1459
1459
|
|
|
1460
1460
|
### Example Usage
|
|
1461
1461
|
|
|
@@ -1469,7 +1469,7 @@ const flexprice = new Flexprice({
|
|
|
1469
1469
|
|
|
1470
1470
|
async function run() {
|
|
1471
1471
|
const result = await flexprice.subscriptions.previewSubscriptionModify("<id>", {
|
|
1472
|
-
type: "
|
|
1472
|
+
type: "coupon",
|
|
1473
1473
|
});
|
|
1474
1474
|
|
|
1475
1475
|
console.log(result);
|
|
@@ -1494,7 +1494,7 @@ const flexprice = new FlexpriceCore({
|
|
|
1494
1494
|
|
|
1495
1495
|
async function run() {
|
|
1496
1496
|
const res = await subscriptionsPreviewSubscriptionModify(flexprice, "<id>", {
|
|
1497
|
-
type: "
|
|
1497
|
+
type: "coupon",
|
|
1498
1498
|
});
|
|
1499
1499
|
if (res.ok) {
|
|
1500
1500
|
const { value: result } = res;
|