@flexprice/sdk 2.1.1 → 2.1.3
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/billing-cadence.md +1 -3
- package/docs/sdk/models/billing-period.md +1 -1
- package/docs/sdk/models/changed-invoice-action.md +19 -0
- package/docs/sdk/models/changed-invoice-status.md +19 -0
- package/docs/sdk/models/changed-invoice.md +30 -0
- package/docs/sdk/models/changed-line-item-action.md +19 -0
- package/docs/sdk/models/changed-line-item.md +20 -0
- package/docs/sdk/models/changed-resources.md +32 -0
- package/docs/sdk/models/changed-subscription-action.md +19 -0
- package/docs/sdk/models/changed-subscription.md +17 -0
- package/docs/sdk/models/clone-environment-request-request.md +19 -0
- package/docs/sdk/models/clone-environment-request.md +17 -0
- package/docs/sdk/models/clone-feature-request-request.md +19 -0
- package/docs/sdk/models/clone-feature-request.md +18 -0
- package/docs/sdk/models/{post-plans-id-clone-request.md → clone-plan-request-request.md} +3 -3
- package/docs/sdk/models/create-price-request.md +7 -9
- package/docs/sdk/models/create-subscription-request.md +40 -41
- package/docs/sdk/models/environment-type.md +15 -0
- package/docs/sdk/models/execute-subscription-change-request.md +2 -2
- package/docs/sdk/models/execute-subscription-modify-request-request.md +21 -0
- package/docs/sdk/models/execute-subscription-modify-request.md +6 -6
- package/docs/sdk/models/invoice-filter.md +1 -0
- package/docs/sdk/models/invoice-response.md +1 -0
- package/docs/sdk/models/line-item-quantity-change.md +20 -0
- package/docs/sdk/models/meter-usage-analytics-request.md +30 -0
- package/docs/sdk/models/meter-usage-analytics-response.md +30 -0
- package/docs/sdk/models/meter-usage-point.md +21 -0
- package/docs/sdk/models/meter-usage-query-request.md +28 -0
- package/docs/sdk/models/meter-usage-query-response.md +30 -0
- package/docs/sdk/models/preview-subscription-change-request.md +2 -2
- package/docs/sdk/models/preview-subscription-modify-request.md +21 -0
- package/docs/sdk/models/secret-provider.md +2 -2
- package/docs/sdk/models/{execute-subscription-inheritance-request.md → sub-modify-inheritance-request.md} +3 -3
- package/docs/sdk/models/sub-modify-quantity-change-request.md +22 -0
- package/docs/sdk/models/subscription-change-request.md +1 -1
- package/docs/sdk/models/subscription-modify-response.md +41 -0
- package/docs/sdk/models/subscription-modify-type.md +15 -0
- package/docs/sdk/models/subscription-phase-create-request.md +9 -8
- package/docs/sdk/models/subscription-price-create-request.md +3 -5
- package/docs/sdks/environments/README.md +79 -0
- package/docs/sdks/features/README.md +73 -0
- package/docs/sdks/invoices/README.md +76 -0
- package/docs/sdks/meterusage/README.md +182 -0
- package/docs/sdks/plans/README.md +7 -7
- package/docs/sdks/prices/README.md +12 -14
- package/docs/sdks/subscriptions/README.md +101 -22
- package/esm/funcs/environments-clone-environment.d.ts +17 -0
- package/esm/funcs/environments-clone-environment.d.ts.map +1 -0
- package/esm/funcs/environments-clone-environment.js +92 -0
- package/esm/funcs/environments-clone-environment.js.map +1 -0
- package/esm/funcs/features-clone-feature.d.ts +17 -0
- package/esm/funcs/features-clone-feature.d.ts.map +1 -0
- package/esm/funcs/features-clone-feature.js +92 -0
- package/esm/funcs/features-clone-feature.js.map +1 -0
- package/esm/funcs/invoices-get-meter-usage-preview-invoice.d.ts +17 -0
- package/esm/funcs/invoices-get-meter-usage-preview-invoice.d.ts.map +1 -0
- package/esm/funcs/invoices-get-meter-usage-preview-invoice.js +82 -0
- package/esm/funcs/invoices-get-meter-usage-preview-invoice.js.map +1 -0
- package/esm/funcs/meter-usage-get-meter-usage-analytics.d.ts +17 -0
- package/esm/funcs/meter-usage-get-meter-usage-analytics.d.ts.map +1 -0
- package/esm/funcs/meter-usage-get-meter-usage-analytics.js +82 -0
- package/esm/funcs/meter-usage-get-meter-usage-analytics.js.map +1 -0
- package/esm/funcs/meter-usage-query-meter-usage.d.ts +17 -0
- package/esm/funcs/meter-usage-query-meter-usage.d.ts.map +1 -0
- package/esm/funcs/meter-usage-query-meter-usage.js +82 -0
- package/esm/funcs/meter-usage-query-meter-usage.js.map +1 -0
- package/esm/funcs/{plans-post-plans-id-clone.d.ts → plans-clone-plan.d.ts} +2 -2
- package/esm/funcs/plans-clone-plan.d.ts.map +1 -0
- package/esm/funcs/{plans-post-plans-id-clone.js → plans-clone-plan.js} +4 -4
- package/esm/funcs/plans-clone-plan.js.map +1 -0
- package/esm/funcs/subscriptions-execute-subscription-modify.d.ts +3 -3
- package/esm/funcs/subscriptions-execute-subscription-modify.d.ts.map +1 -1
- package/esm/funcs/subscriptions-execute-subscription-modify.js +4 -4
- package/esm/funcs/subscriptions-execute-subscription-modify.js.map +1 -1
- package/esm/funcs/subscriptions-preview-subscription-modify.d.ts +17 -0
- package/esm/funcs/subscriptions-preview-subscription-modify.d.ts.map +1 -0
- package/esm/funcs/subscriptions-preview-subscription-modify.js +92 -0
- package/esm/funcs/subscriptions-preview-subscription-modify.js.map +1 -0
- package/esm/lib/config.d.ts +3 -3
- package/esm/lib/config.js +3 -3
- package/esm/lib/config.js.map +1 -1
- package/esm/lib/encodings.d.ts +1 -0
- package/esm/lib/encodings.d.ts.map +1 -1
- package/esm/lib/encodings.js +6 -0
- package/esm/lib/encodings.js.map +1 -1
- package/esm/sdk/environments.d.ts +12 -0
- package/esm/sdk/environments.d.ts.map +1 -0
- package/esm/sdk/environments.js +18 -0
- package/esm/sdk/environments.js.map +1 -0
- package/esm/sdk/features.d.ts +7 -0
- package/esm/sdk/features.d.ts.map +1 -1
- package/esm/sdk/features.js +10 -0
- package/esm/sdk/features.js.map +1 -1
- package/esm/sdk/invoices.d.ts +7 -0
- package/esm/sdk/invoices.d.ts.map +1 -1
- package/esm/sdk/invoices.js +10 -0
- package/esm/sdk/invoices.js.map +1 -1
- package/esm/sdk/meter-usage.d.ts +19 -0
- package/esm/sdk/meter-usage.d.ts.map +1 -0
- package/esm/sdk/meter-usage.js +28 -0
- package/esm/sdk/meter-usage.js.map +1 -0
- package/esm/sdk/models/billing-cadence.d.ts +4 -5
- package/esm/sdk/models/billing-cadence.d.ts.map +1 -1
- package/esm/sdk/models/billing-cadence.js +3 -4
- package/esm/sdk/models/billing-cadence.js.map +1 -1
- package/esm/sdk/models/billing-period.d.ts +1 -0
- package/esm/sdk/models/billing-period.d.ts.map +1 -1
- package/esm/sdk/models/billing-period.js +1 -0
- package/esm/sdk/models/billing-period.js.map +1 -1
- package/esm/sdk/models/changed-invoice-action.d.ts +16 -0
- package/esm/sdk/models/changed-invoice-action.d.ts.map +1 -0
- package/esm/sdk/models/changed-invoice-action.js +14 -0
- package/esm/sdk/models/changed-invoice-action.js.map +1 -0
- package/esm/sdk/models/changed-invoice-status.d.ts +16 -0
- package/esm/sdk/models/changed-invoice-status.d.ts.map +1 -0
- package/esm/sdk/models/changed-invoice-status.js +14 -0
- package/esm/sdk/models/changed-invoice-status.js.map +1 -0
- package/esm/sdk/models/changed-invoice.d.ts +24 -0
- package/esm/sdk/models/changed-invoice.d.ts.map +1 -0
- package/esm/sdk/models/changed-invoice.js +27 -0
- package/esm/sdk/models/changed-invoice.js.map +1 -0
- package/esm/sdk/models/changed-line-item-action.d.ts +17 -0
- package/esm/sdk/models/changed-line-item-action.d.ts.map +1 -0
- package/esm/sdk/models/changed-line-item-action.js +15 -0
- package/esm/sdk/models/changed-line-item-action.js.map +1 -0
- package/esm/sdk/models/changed-line-item.d.ts +19 -0
- package/esm/sdk/models/changed-line-item.d.ts.map +1 -0
- package/esm/sdk/models/changed-line-item.js +28 -0
- package/esm/sdk/models/changed-line-item.js.map +1 -0
- package/esm/sdk/models/changed-resources.d.ts +15 -0
- package/esm/sdk/models/changed-resources.d.ts.map +1 -0
- package/esm/sdk/models/changed-resources.js +24 -0
- package/esm/sdk/models/changed-resources.js.map +1 -0
- package/esm/sdk/models/changed-subscription-action.d.ts +16 -0
- package/esm/sdk/models/changed-subscription-action.d.ts.map +1 -0
- package/esm/sdk/models/changed-subscription-action.js +14 -0
- package/esm/sdk/models/changed-subscription-action.js.map +1 -0
- package/esm/sdk/models/changed-subscription.d.ts +17 -0
- package/esm/sdk/models/changed-subscription.d.ts.map +1 -0
- package/esm/sdk/models/changed-subscription.js +18 -0
- package/esm/sdk/models/changed-subscription.js.map +1 -0
- package/esm/sdk/models/clone-environment-op.d.ts +21 -0
- package/esm/sdk/models/clone-environment-op.d.ts.map +1 -0
- package/esm/sdk/models/clone-environment-op.js +14 -0
- package/esm/sdk/models/clone-environment-op.js.map +1 -0
- package/esm/sdk/models/clone-environment-request.d.ts +26 -0
- package/esm/sdk/models/clone-environment-request.d.ts.map +1 -0
- package/esm/sdk/models/clone-environment-request.js +20 -0
- package/esm/sdk/models/clone-environment-request.js.map +1 -0
- package/esm/sdk/models/clone-feature-op.d.ts +21 -0
- package/esm/sdk/models/clone-feature-op.d.ts.map +1 -0
- package/esm/sdk/models/clone-feature-op.js +14 -0
- package/esm/sdk/models/clone-feature-op.js.map +1 -0
- package/esm/sdk/models/clone-feature-request.d.ts +31 -0
- package/esm/sdk/models/clone-feature-request.d.ts.map +1 -0
- package/esm/sdk/models/clone-feature-request.js +20 -0
- package/esm/sdk/models/clone-feature-request.js.map +1 -0
- package/esm/sdk/models/clone-plan-op.d.ts +21 -0
- package/esm/sdk/models/clone-plan-op.d.ts.map +1 -0
- package/esm/sdk/models/{post-plans-id-clone-op.js → clone-plan-op.js} +4 -4
- package/esm/sdk/models/clone-plan-op.js.map +1 -0
- package/esm/sdk/models/create-price-request.d.ts +0 -3
- package/esm/sdk/models/create-price-request.d.ts.map +1 -1
- package/esm/sdk/models/create-price-request.js +0 -3
- package/esm/sdk/models/create-price-request.js.map +1 -1
- package/esm/sdk/models/create-subscription-request.d.ts +10 -3
- package/esm/sdk/models/create-subscription-request.d.ts.map +1 -1
- package/esm/sdk/models/create-subscription-request.js +2 -3
- package/esm/sdk/models/create-subscription-request.js.map +1 -1
- package/esm/sdk/models/environment-type.d.ts +10 -0
- package/esm/sdk/models/environment-type.d.ts.map +1 -0
- package/esm/sdk/models/environment-type.js +11 -0
- package/esm/sdk/models/environment-type.js.map +1 -0
- package/esm/sdk/models/execute-subscription-modify-op.d.ts +8 -8
- package/esm/sdk/models/execute-subscription-modify-op.d.ts.map +1 -1
- package/esm/sdk/models/execute-subscription-modify-op.js +5 -5
- package/esm/sdk/models/execute-subscription-modify-op.js.map +1 -1
- package/esm/sdk/models/execute-subscription-modify-request.d.ts +19 -0
- package/esm/sdk/models/execute-subscription-modify-request.d.ts.map +1 -0
- package/esm/sdk/models/execute-subscription-modify-request.js +23 -0
- package/esm/sdk/models/execute-subscription-modify-request.js.map +1 -0
- package/esm/sdk/models/index.d.ts +26 -2
- package/esm/sdk/models/index.d.ts.map +1 -1
- package/esm/sdk/models/index.js +26 -2
- package/esm/sdk/models/index.js.map +1 -1
- package/esm/sdk/models/invoice-filter.d.ts +5 -0
- package/esm/sdk/models/invoice-filter.d.ts.map +1 -1
- package/esm/sdk/models/invoice-filter.js +2 -0
- package/esm/sdk/models/invoice-filter.js.map +1 -1
- package/esm/sdk/models/invoice-response.d.ts +7 -0
- package/esm/sdk/models/invoice-response.d.ts.map +1 -1
- package/esm/sdk/models/invoice-response.js +2 -0
- package/esm/sdk/models/invoice-response.js.map +1 -1
- package/esm/sdk/models/line-item-quantity-change.d.ts +22 -0
- package/esm/sdk/models/line-item-quantity-change.d.ts.map +1 -0
- package/esm/sdk/models/line-item-quantity-change.js +19 -0
- package/esm/sdk/models/line-item-quantity-change.js.map +1 -0
- package/esm/sdk/models/meter-usage-analytics-request.d.ts +26 -0
- package/esm/sdk/models/meter-usage-analytics-request.d.ts.map +1 -0
- package/esm/sdk/models/meter-usage-analytics-request.js +31 -0
- package/esm/sdk/models/meter-usage-analytics-request.js.map +1 -0
- package/esm/sdk/models/meter-usage-analytics-response.d.ts +11 -0
- package/esm/sdk/models/meter-usage-analytics-response.d.ts.map +1 -0
- package/esm/sdk/models/meter-usage-analytics-response.js +15 -0
- package/esm/sdk/models/meter-usage-analytics-response.js.map +1 -0
- package/esm/sdk/models/meter-usage-point.d.ts +12 -0
- package/esm/sdk/models/meter-usage-point.d.ts.map +1 -0
- package/esm/sdk/models/meter-usage-point.js +21 -0
- package/esm/sdk/models/meter-usage-point.js.map +1 -0
- package/esm/sdk/models/meter-usage-query-request.d.ts +26 -0
- package/esm/sdk/models/meter-usage-query-request.d.ts.map +1 -0
- package/esm/sdk/models/meter-usage-query-request.js +31 -0
- package/esm/sdk/models/meter-usage-query-request.js.map +1 -0
- package/esm/sdk/models/meter-usage-query-response.d.ts +16 -0
- package/esm/sdk/models/meter-usage-query-response.d.ts.map +1 -0
- package/esm/sdk/models/meter-usage-query-response.js +28 -0
- package/esm/sdk/models/meter-usage-query-response.js.map +1 -0
- package/esm/sdk/models/preview-subscription-modify-op.d.ts +21 -0
- package/esm/sdk/models/preview-subscription-modify-op.d.ts.map +1 -0
- package/esm/sdk/models/preview-subscription-modify-op.js +14 -0
- package/esm/sdk/models/preview-subscription-modify-op.js.map +1 -0
- package/esm/sdk/models/secret-provider.d.ts +1 -0
- package/esm/sdk/models/secret-provider.d.ts.map +1 -1
- package/esm/sdk/models/secret-provider.js +1 -0
- package/esm/sdk/models/secret-provider.js.map +1 -1
- package/esm/sdk/models/sub-modify-inheritance-request.d.ts +12 -0
- package/esm/sdk/models/sub-modify-inheritance-request.d.ts.map +1 -0
- package/esm/sdk/models/{execute-subscription-inheritance-request.js → sub-modify-inheritance-request.js} +4 -4
- package/esm/sdk/models/sub-modify-inheritance-request.js.map +1 -0
- package/esm/sdk/models/sub-modify-quantity-change-request.d.ts +13 -0
- package/esm/sdk/models/sub-modify-quantity-change-request.d.ts.map +1 -0
- package/esm/sdk/models/sub-modify-quantity-change-request.js +18 -0
- package/esm/sdk/models/sub-modify-quantity-change-request.js.map +1 -0
- package/esm/sdk/models/subscription-modify-response.d.ts +13 -0
- package/esm/sdk/models/subscription-modify-response.d.ts.map +1 -0
- package/esm/sdk/models/subscription-modify-response.js +22 -0
- package/esm/sdk/models/subscription-modify-response.js.map +1 -0
- package/esm/sdk/models/subscription-modify-type.d.ts +10 -0
- package/esm/sdk/models/subscription-modify-type.d.ts.map +1 -0
- package/esm/sdk/models/subscription-modify-type.js +11 -0
- package/esm/sdk/models/subscription-modify-type.js.map +1 -0
- package/esm/sdk/models/subscription-phase-create-request.d.ts +9 -0
- 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-price-create-request.d.ts +0 -3
- package/esm/sdk/models/subscription-price-create-request.d.ts.map +1 -1
- package/esm/sdk/models/subscription-price-create-request.js +0 -3
- package/esm/sdk/models/subscription-price-create-request.js.map +1 -1
- package/esm/sdk/plans.d.ts +1 -1
- package/esm/sdk/plans.d.ts.map +1 -1
- package/esm/sdk/plans.js +3 -3
- package/esm/sdk/plans.js.map +1 -1
- package/esm/sdk/sdk.d.ts +6 -0
- package/esm/sdk/sdk.d.ts.map +1 -1
- package/esm/sdk/sdk.js +10 -0
- package/esm/sdk/sdk.js.map +1 -1
- package/esm/sdk/subscriptions.d.ts +10 -3
- package/esm/sdk/subscriptions.d.ts.map +1 -1
- package/esm/sdk/subscriptions.js +12 -2
- package/esm/sdk/subscriptions.js.map +1 -1
- package/jsr.json +1 -1
- package/package.json +3 -3
- package/src/funcs/environments-clone-environment.ts +185 -0
- package/src/funcs/features-clone-feature.ts +184 -0
- package/src/funcs/invoices-get-meter-usage-preview-invoice.ts +170 -0
- package/src/funcs/meter-usage-get-meter-usage-analytics.ts +170 -0
- package/src/funcs/meter-usage-query-meter-usage.ts +170 -0
- package/src/funcs/{plans-post-plans-id-clone.ts → plans-clone-plan.ts} +4 -4
- package/src/funcs/subscriptions-execute-subscription-modify.ts +13 -10
- package/src/funcs/subscriptions-preview-subscription-modify.ts +185 -0
- package/src/lib/config.ts +3 -3
- package/src/lib/encodings.ts +9 -0
- package/src/sdk/environments.ts +29 -0
- package/src/sdk/features.ts +20 -0
- package/src/sdk/invoices.ts +18 -0
- package/src/sdk/meter-usage.ts +45 -0
- package/src/sdk/models/billing-cadence.ts +8 -12
- package/src/sdk/models/billing-period.ts +1 -0
- package/src/sdk/models/changed-invoice-action.ts +25 -0
- package/src/sdk/models/changed-invoice-status.ts +25 -0
- package/src/sdk/models/changed-invoice.ts +69 -0
- package/src/sdk/models/changed-line-item-action.ts +26 -0
- package/src/sdk/models/changed-line-item.ts +59 -0
- package/src/sdk/models/changed-resources.ts +55 -0
- package/src/sdk/models/changed-subscription-action.ts +27 -0
- package/src/sdk/models/changed-subscription.ts +46 -0
- package/src/sdk/models/clone-environment-op.ts +46 -0
- package/src/sdk/models/clone-environment-request.ts +57 -0
- package/src/sdk/models/clone-feature-op.ts +44 -0
- package/src/sdk/models/clone-feature-request.ts +56 -0
- package/src/sdk/models/{post-plans-id-clone-op.ts → clone-plan-op.ts} +8 -8
- package/src/sdk/models/create-price-request.ts +0 -8
- package/src/sdk/models/create-subscription-request.ts +14 -8
- package/src/sdk/models/environment-type.ts +17 -0
- package/src/sdk/models/execute-subscription-modify-op.ts +22 -20
- package/src/sdk/models/execute-subscription-modify-request.ts +63 -0
- package/src/sdk/models/index.ts +26 -2
- package/src/sdk/models/invoice-filter.ts +7 -0
- package/src/sdk/models/invoice-response.ts +9 -0
- package/src/sdk/models/line-item-quantity-change.ts +52 -0
- package/src/sdk/models/meter-usage-analytics-request.ts +69 -0
- package/src/sdk/models/meter-usage-analytics-response.ts +35 -0
- package/src/sdk/models/meter-usage-point.ts +43 -0
- package/src/sdk/models/meter-usage-query-request.ts +69 -0
- package/src/sdk/models/meter-usage-query-response.ts +58 -0
- package/src/sdk/models/preview-subscription-modify-op.ts +46 -0
- package/src/sdk/models/secret-provider.ts +1 -0
- package/src/sdk/models/sub-modify-inheritance-request.ts +41 -0
- package/src/sdk/models/sub-modify-quantity-change-request.ts +45 -0
- package/src/sdk/models/subscription-modify-response.ts +49 -0
- package/src/sdk/models/subscription-modify-type.ts +17 -0
- package/src/sdk/models/subscription-phase-create-request.ts +17 -0
- package/src/sdk/models/subscription-price-create-request.ts +0 -8
- package/src/sdk/plans.ts +3 -3
- package/src/sdk/sdk.ts +12 -0
- package/src/sdk/subscriptions.ts +24 -4
- package/esm/funcs/plans-post-plans-id-clone.d.ts.map +0 -1
- package/esm/funcs/plans-post-plans-id-clone.js.map +0 -1
- package/esm/sdk/models/execute-subscription-inheritance-request.d.ts +0 -12
- package/esm/sdk/models/execute-subscription-inheritance-request.d.ts.map +0 -1
- package/esm/sdk/models/execute-subscription-inheritance-request.js.map +0 -1
- package/esm/sdk/models/post-plans-id-clone-op.d.ts +0 -21
- package/esm/sdk/models/post-plans-id-clone-op.d.ts.map +0 -1
- package/esm/sdk/models/post-plans-id-clone-op.js.map +0 -1
- package/src/sdk/models/execute-subscription-inheritance-request.ts +0 -42
|
@@ -0,0 +1,182 @@
|
|
|
1
|
+
# MeterUsage
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
### Available Operations
|
|
6
|
+
|
|
7
|
+
* [getMeterUsageAnalytics](#getmeterusageanalytics) - Get meter usage analytics
|
|
8
|
+
* [queryMeterUsage](#querymeterusage) - Query meter usage
|
|
9
|
+
|
|
10
|
+
## getMeterUsageAnalytics
|
|
11
|
+
|
|
12
|
+
Query aggregated usage from meter_usage table for multiple meters
|
|
13
|
+
|
|
14
|
+
### Example Usage
|
|
15
|
+
|
|
16
|
+
<!-- UsageSnippet language="typescript" operationID="getMeterUsageAnalytics" method="post" path="/meter-usage/analytics" -->
|
|
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.meterUsage.getMeterUsageAnalytics({
|
|
26
|
+
aggregationType: "COUNT",
|
|
27
|
+
endTime: new Date("2024-02-01T00:00:00Z"),
|
|
28
|
+
externalCustomerId: "cust_123",
|
|
29
|
+
meterIds: [
|
|
30
|
+
"mtr_abc",
|
|
31
|
+
"mtr_def",
|
|
32
|
+
],
|
|
33
|
+
startTime: new Date("2024-01-01T00:00:00Z"),
|
|
34
|
+
});
|
|
35
|
+
|
|
36
|
+
console.log(result);
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
run();
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### Standalone function
|
|
43
|
+
|
|
44
|
+
The standalone function version of this method:
|
|
45
|
+
|
|
46
|
+
```typescript
|
|
47
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
48
|
+
import { meterUsageGetMeterUsageAnalytics } from "@flexprice/sdk/funcs/meter-usage-get-meter-usage-analytics.js";
|
|
49
|
+
|
|
50
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
51
|
+
// You can create one instance of it to use across an application.
|
|
52
|
+
const flexprice = new FlexpriceCore({
|
|
53
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
54
|
+
});
|
|
55
|
+
|
|
56
|
+
async function run() {
|
|
57
|
+
const res = await meterUsageGetMeterUsageAnalytics(flexprice, {
|
|
58
|
+
aggregationType: "COUNT",
|
|
59
|
+
endTime: new Date("2024-02-01T00:00:00Z"),
|
|
60
|
+
externalCustomerId: "cust_123",
|
|
61
|
+
meterIds: [
|
|
62
|
+
"mtr_abc",
|
|
63
|
+
"mtr_def",
|
|
64
|
+
],
|
|
65
|
+
startTime: new Date("2024-01-01T00:00:00Z"),
|
|
66
|
+
});
|
|
67
|
+
if (res.ok) {
|
|
68
|
+
const { value: result } = res;
|
|
69
|
+
console.log(result);
|
|
70
|
+
} else {
|
|
71
|
+
console.log("meterUsageGetMeterUsageAnalytics failed:", res.error);
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
run();
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Parameters
|
|
79
|
+
|
|
80
|
+
| Parameter | Type | Required | Description |
|
|
81
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
82
|
+
| `request` | [models.MeterUsageAnalyticsRequest](../../sdk/models/meter-usage-analytics-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
83
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
84
|
+
| `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. |
|
|
85
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
86
|
+
|
|
87
|
+
### Response
|
|
88
|
+
|
|
89
|
+
**Promise\<[models.MeterUsageAnalyticsResponse](../../sdk/models/meter-usage-analytics-response.md)\>**
|
|
90
|
+
|
|
91
|
+
### Errors
|
|
92
|
+
|
|
93
|
+
| Error Type | Status Code | Content Type |
|
|
94
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
95
|
+
| models.ErrorsErrorResponse | 400 | application/json |
|
|
96
|
+
| models.ErrorsErrorResponse | 500 | application/json |
|
|
97
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
98
|
+
|
|
99
|
+
## queryMeterUsage
|
|
100
|
+
|
|
101
|
+
Query aggregated usage from meter_usage table for a single meter with optional time-window bucketing
|
|
102
|
+
|
|
103
|
+
### Example Usage
|
|
104
|
+
|
|
105
|
+
<!-- UsageSnippet language="typescript" operationID="queryMeterUsage" method="post" path="/meter-usage/query" -->
|
|
106
|
+
```typescript
|
|
107
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
108
|
+
|
|
109
|
+
const flexprice = new Flexprice({
|
|
110
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
111
|
+
});
|
|
112
|
+
|
|
113
|
+
async function run() {
|
|
114
|
+
const result = await flexprice.meterUsage.queryMeterUsage({
|
|
115
|
+
aggregationType: "WEIGHTED_SUM",
|
|
116
|
+
billingAnchor: new Date("2024-01-15T00:00:00Z"),
|
|
117
|
+
endTime: new Date("2024-02-01T00:00:00Z"),
|
|
118
|
+
externalCustomerId: "cust_123",
|
|
119
|
+
meterId: "mtr_abc",
|
|
120
|
+
startTime: new Date("2024-01-01T00:00:00Z"),
|
|
121
|
+
});
|
|
122
|
+
|
|
123
|
+
console.log(result);
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
run();
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### Standalone function
|
|
130
|
+
|
|
131
|
+
The standalone function version of this method:
|
|
132
|
+
|
|
133
|
+
```typescript
|
|
134
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
135
|
+
import { meterUsageQueryMeterUsage } from "@flexprice/sdk/funcs/meter-usage-query-meter-usage.js";
|
|
136
|
+
|
|
137
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
138
|
+
// You can create one instance of it to use across an application.
|
|
139
|
+
const flexprice = new FlexpriceCore({
|
|
140
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
141
|
+
});
|
|
142
|
+
|
|
143
|
+
async function run() {
|
|
144
|
+
const res = await meterUsageQueryMeterUsage(flexprice, {
|
|
145
|
+
aggregationType: "WEIGHTED_SUM",
|
|
146
|
+
billingAnchor: new Date("2024-01-15T00:00:00Z"),
|
|
147
|
+
endTime: new Date("2024-02-01T00:00:00Z"),
|
|
148
|
+
externalCustomerId: "cust_123",
|
|
149
|
+
meterId: "mtr_abc",
|
|
150
|
+
startTime: new Date("2024-01-01T00:00:00Z"),
|
|
151
|
+
});
|
|
152
|
+
if (res.ok) {
|
|
153
|
+
const { value: result } = res;
|
|
154
|
+
console.log(result);
|
|
155
|
+
} else {
|
|
156
|
+
console.log("meterUsageQueryMeterUsage failed:", res.error);
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
run();
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
### Parameters
|
|
164
|
+
|
|
165
|
+
| Parameter | Type | Required | Description |
|
|
166
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
167
|
+
| `request` | [models.MeterUsageQueryRequest](../../sdk/models/meter-usage-query-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
168
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
169
|
+
| `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. |
|
|
170
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
171
|
+
|
|
172
|
+
### Response
|
|
173
|
+
|
|
174
|
+
**Promise\<[models.MeterUsageQueryResponse](../../sdk/models/meter-usage-query-response.md)\>**
|
|
175
|
+
|
|
176
|
+
### Errors
|
|
177
|
+
|
|
178
|
+
| Error Type | Status Code | Content Type |
|
|
179
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
180
|
+
| models.ErrorsErrorResponse | 400 | application/json |
|
|
181
|
+
| models.ErrorsErrorResponse | 500 | application/json |
|
|
182
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* [getPlan](#getplan) - Get plan
|
|
10
10
|
* [updatePlan](#updateplan) - Update plan
|
|
11
11
|
* [deletePlan](#deleteplan) - Delete plan
|
|
12
|
-
* [
|
|
12
|
+
* [clonePlan](#cloneplan) - Clone a plan
|
|
13
13
|
* [syncPlanPrices](#syncplanprices) - Synchronize plan prices
|
|
14
14
|
|
|
15
15
|
## createPlan
|
|
@@ -372,13 +372,13 @@ run();
|
|
|
372
372
|
| models.ErrorsErrorResponse | 500 | application/json |
|
|
373
373
|
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
374
374
|
|
|
375
|
-
##
|
|
375
|
+
## clonePlan
|
|
376
376
|
|
|
377
377
|
Clone an existing plan, copying its active prices, published entitlements, and published credit grants
|
|
378
378
|
|
|
379
379
|
### Example Usage
|
|
380
380
|
|
|
381
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
381
|
+
<!-- UsageSnippet language="typescript" operationID="clonePlan" method="post" path="/plans/{id}/clone" -->
|
|
382
382
|
```typescript
|
|
383
383
|
import { Flexprice } from "@flexprice/sdk";
|
|
384
384
|
|
|
@@ -387,7 +387,7 @@ const flexprice = new Flexprice({
|
|
|
387
387
|
});
|
|
388
388
|
|
|
389
389
|
async function run() {
|
|
390
|
-
const result = await flexprice.plans.
|
|
390
|
+
const result = await flexprice.plans.clonePlan("<id>", {});
|
|
391
391
|
|
|
392
392
|
console.log(result);
|
|
393
393
|
}
|
|
@@ -401,7 +401,7 @@ The standalone function version of this method:
|
|
|
401
401
|
|
|
402
402
|
```typescript
|
|
403
403
|
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
404
|
-
import {
|
|
404
|
+
import { plansClonePlan } from "@flexprice/sdk/funcs/plans-clone-plan.js";
|
|
405
405
|
|
|
406
406
|
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
407
407
|
// You can create one instance of it to use across an application.
|
|
@@ -410,12 +410,12 @@ const flexprice = new FlexpriceCore({
|
|
|
410
410
|
});
|
|
411
411
|
|
|
412
412
|
async function run() {
|
|
413
|
-
const res = await
|
|
413
|
+
const res = await plansClonePlan(flexprice, "<id>", {});
|
|
414
414
|
if (res.ok) {
|
|
415
415
|
const { value: result } = res;
|
|
416
416
|
console.log(result);
|
|
417
417
|
} else {
|
|
418
|
-
console.log("
|
|
418
|
+
console.log("plansClonePlan failed:", res.error);
|
|
419
419
|
}
|
|
420
420
|
}
|
|
421
421
|
|
|
@@ -28,15 +28,14 @@ const flexprice = new Flexprice({
|
|
|
28
28
|
|
|
29
29
|
async function run() {
|
|
30
30
|
const result = await flexprice.prices.createPrice({
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
currency: "Serbian Dinar",
|
|
31
|
+
billingModel: "FLAT_FEE",
|
|
32
|
+
billingPeriod: "DAILY",
|
|
33
|
+
currency: "Dong",
|
|
35
34
|
entityId: "<id>",
|
|
36
35
|
entityType: "PRICE",
|
|
37
|
-
invoiceCadence: "
|
|
38
|
-
priceUnitType: "
|
|
39
|
-
type: "
|
|
36
|
+
invoiceCadence: "ADVANCE",
|
|
37
|
+
priceUnitType: "FIAT",
|
|
38
|
+
type: "FIXED",
|
|
40
39
|
});
|
|
41
40
|
|
|
42
41
|
console.log(result);
|
|
@@ -61,15 +60,14 @@ const flexprice = new FlexpriceCore({
|
|
|
61
60
|
|
|
62
61
|
async function run() {
|
|
63
62
|
const res = await pricesCreatePrice(flexprice, {
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
currency: "Serbian Dinar",
|
|
63
|
+
billingModel: "FLAT_FEE",
|
|
64
|
+
billingPeriod: "DAILY",
|
|
65
|
+
currency: "Dong",
|
|
68
66
|
entityId: "<id>",
|
|
69
67
|
entityType: "PRICE",
|
|
70
|
-
invoiceCadence: "
|
|
71
|
-
priceUnitType: "
|
|
72
|
-
type: "
|
|
68
|
+
invoiceCadence: "ADVANCE",
|
|
69
|
+
priceUnitType: "FIAT",
|
|
70
|
+
type: "FIXED",
|
|
73
71
|
});
|
|
74
72
|
if (res.ok) {
|
|
75
73
|
const { value: result } = res;
|
|
@@ -21,7 +21,8 @@
|
|
|
21
21
|
* [getSubscriptionEntitlements](#getsubscriptionentitlements) - Get subscription entitlements
|
|
22
22
|
* [getSubscriptionUpcomingGrants](#getsubscriptionupcominggrants) - Get upcoming credit grant applications
|
|
23
23
|
* [createSubscriptionLineItem](#createsubscriptionlineitem) - Create subscription line item
|
|
24
|
-
* [executeSubscriptionModify](#executesubscriptionmodify) -
|
|
24
|
+
* [executeSubscriptionModify](#executesubscriptionmodify) - Execute subscription modification
|
|
25
|
+
* [previewSubscriptionModify](#previewsubscriptionmodify) - Preview subscription modification
|
|
25
26
|
* [pauseSubscription](#pausesubscription) - Pause a subscription
|
|
26
27
|
* [listSubscriptionPauses](#listsubscriptionpauses) - List all pauses for a subscription
|
|
27
28
|
* [resumeSubscription](#resumesubscription) - Resume a paused subscription
|
|
@@ -47,9 +48,8 @@ const flexprice = new Flexprice({
|
|
|
47
48
|
|
|
48
49
|
async function run() {
|
|
49
50
|
const result = await flexprice.subscriptions.createSubscription({
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
currency: "New Leu",
|
|
51
|
+
billingPeriod: "ONETIME",
|
|
52
|
+
currency: "Kwacha",
|
|
53
53
|
planId: "<id>",
|
|
54
54
|
});
|
|
55
55
|
|
|
@@ -75,9 +75,8 @@ const flexprice = new FlexpriceCore({
|
|
|
75
75
|
|
|
76
76
|
async function run() {
|
|
77
77
|
const res = await subscriptionsCreateSubscription(flexprice, {
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
currency: "New Leu",
|
|
78
|
+
billingPeriod: "ONETIME",
|
|
79
|
+
currency: "Kwacha",
|
|
81
80
|
planId: "<id>",
|
|
82
81
|
});
|
|
83
82
|
if (res.ok) {
|
|
@@ -944,8 +943,8 @@ async function run() {
|
|
|
944
943
|
const result = await flexprice.subscriptions.executeSubscriptionChange("<id>", {
|
|
945
944
|
billingCadence: "RECURRING",
|
|
946
945
|
billingCycle: "anniversary",
|
|
947
|
-
billingPeriod: "
|
|
948
|
-
prorationBehavior: "
|
|
946
|
+
billingPeriod: "ANNUAL",
|
|
947
|
+
prorationBehavior: "none",
|
|
949
948
|
targetPlanId: "<id>",
|
|
950
949
|
});
|
|
951
950
|
|
|
@@ -973,8 +972,8 @@ async function run() {
|
|
|
973
972
|
const res = await subscriptionsExecuteSubscriptionChange(flexprice, "<id>", {
|
|
974
973
|
billingCadence: "RECURRING",
|
|
975
974
|
billingCycle: "anniversary",
|
|
976
|
-
billingPeriod: "
|
|
977
|
-
prorationBehavior: "
|
|
975
|
+
billingPeriod: "ANNUAL",
|
|
976
|
+
prorationBehavior: "none",
|
|
978
977
|
targetPlanId: "<id>",
|
|
979
978
|
});
|
|
980
979
|
if (res.ok) {
|
|
@@ -1027,9 +1026,9 @@ const flexprice = new Flexprice({
|
|
|
1027
1026
|
async function run() {
|
|
1028
1027
|
const result = await flexprice.subscriptions.previewSubscriptionChange("<id>", {
|
|
1029
1028
|
billingCadence: "RECURRING",
|
|
1030
|
-
billingCycle: "
|
|
1031
|
-
billingPeriod: "
|
|
1032
|
-
prorationBehavior: "
|
|
1029
|
+
billingCycle: "anniversary",
|
|
1030
|
+
billingPeriod: "ONETIME",
|
|
1031
|
+
prorationBehavior: "none",
|
|
1033
1032
|
targetPlanId: "<id>",
|
|
1034
1033
|
});
|
|
1035
1034
|
|
|
@@ -1056,9 +1055,9 @@ const flexprice = new FlexpriceCore({
|
|
|
1056
1055
|
async function run() {
|
|
1057
1056
|
const res = await subscriptionsPreviewSubscriptionChange(flexprice, "<id>", {
|
|
1058
1057
|
billingCadence: "RECURRING",
|
|
1059
|
-
billingCycle: "
|
|
1060
|
-
billingPeriod: "
|
|
1061
|
-
prorationBehavior: "
|
|
1058
|
+
billingCycle: "anniversary",
|
|
1059
|
+
billingPeriod: "ONETIME",
|
|
1060
|
+
prorationBehavior: "none",
|
|
1062
1061
|
targetPlanId: "<id>",
|
|
1063
1062
|
});
|
|
1064
1063
|
if (res.ok) {
|
|
@@ -1311,7 +1310,7 @@ run();
|
|
|
1311
1310
|
|
|
1312
1311
|
## executeSubscriptionModify
|
|
1313
1312
|
|
|
1314
|
-
|
|
1313
|
+
Execute a mid-cycle subscription modification (inheritance or quantity change).
|
|
1315
1314
|
|
|
1316
1315
|
### Example Usage
|
|
1317
1316
|
|
|
@@ -1324,7 +1323,9 @@ const flexprice = new Flexprice({
|
|
|
1324
1323
|
});
|
|
1325
1324
|
|
|
1326
1325
|
async function run() {
|
|
1327
|
-
const result = await flexprice.subscriptions.executeSubscriptionModify("<id>", {
|
|
1326
|
+
const result = await flexprice.subscriptions.executeSubscriptionModify("<id>", {
|
|
1327
|
+
type: "inheritance",
|
|
1328
|
+
});
|
|
1328
1329
|
|
|
1329
1330
|
console.log(result);
|
|
1330
1331
|
}
|
|
@@ -1347,7 +1348,9 @@ const flexprice = new FlexpriceCore({
|
|
|
1347
1348
|
});
|
|
1348
1349
|
|
|
1349
1350
|
async function run() {
|
|
1350
|
-
const res = await subscriptionsExecuteSubscriptionModify(flexprice, "<id>", {
|
|
1351
|
+
const res = await subscriptionsExecuteSubscriptionModify(flexprice, "<id>", {
|
|
1352
|
+
type: "inheritance",
|
|
1353
|
+
});
|
|
1351
1354
|
if (res.ok) {
|
|
1352
1355
|
const { value: result } = res;
|
|
1353
1356
|
console.log(result);
|
|
@@ -1364,14 +1367,90 @@ run();
|
|
|
1364
1367
|
| Parameter | Type | Required | Description |
|
|
1365
1368
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1366
1369
|
| `id` | *string* | :heavy_check_mark: | Subscription ID |
|
|
1367
|
-
| `body` | [models.
|
|
1370
|
+
| `body` | [models.ExecuteSubscriptionModifyRequest](../../sdk/models/execute-subscription-modify-request.md) | :heavy_check_mark: | Modification request |
|
|
1368
1371
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1369
1372
|
| `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. |
|
|
1370
1373
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1371
1374
|
|
|
1372
1375
|
### Response
|
|
1373
1376
|
|
|
1374
|
-
**Promise\<[models.
|
|
1377
|
+
**Promise\<[models.SubscriptionModifyResponse](../../sdk/models/subscription-modify-response.md)\>**
|
|
1378
|
+
|
|
1379
|
+
### Errors
|
|
1380
|
+
|
|
1381
|
+
| Error Type | Status Code | Content Type |
|
|
1382
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
1383
|
+
| models.ErrorsErrorResponse | 400, 404 | application/json |
|
|
1384
|
+
| models.ErrorsErrorResponse | 500 | application/json |
|
|
1385
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
1386
|
+
|
|
1387
|
+
## previewSubscriptionModify
|
|
1388
|
+
|
|
1389
|
+
Preview the impact of a mid-cycle subscription modification without committing changes.
|
|
1390
|
+
|
|
1391
|
+
### Example Usage
|
|
1392
|
+
|
|
1393
|
+
<!-- UsageSnippet language="typescript" operationID="previewSubscriptionModify" method="post" path="/subscriptions/{id}/modify/preview" -->
|
|
1394
|
+
```typescript
|
|
1395
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
1396
|
+
|
|
1397
|
+
const flexprice = new Flexprice({
|
|
1398
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1399
|
+
});
|
|
1400
|
+
|
|
1401
|
+
async function run() {
|
|
1402
|
+
const result = await flexprice.subscriptions.previewSubscriptionModify("<id>", {
|
|
1403
|
+
type: "quantity_change",
|
|
1404
|
+
});
|
|
1405
|
+
|
|
1406
|
+
console.log(result);
|
|
1407
|
+
}
|
|
1408
|
+
|
|
1409
|
+
run();
|
|
1410
|
+
```
|
|
1411
|
+
|
|
1412
|
+
### Standalone function
|
|
1413
|
+
|
|
1414
|
+
The standalone function version of this method:
|
|
1415
|
+
|
|
1416
|
+
```typescript
|
|
1417
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
1418
|
+
import { subscriptionsPreviewSubscriptionModify } from "@flexprice/sdk/funcs/subscriptions-preview-subscription-modify.js";
|
|
1419
|
+
|
|
1420
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
1421
|
+
// You can create one instance of it to use across an application.
|
|
1422
|
+
const flexprice = new FlexpriceCore({
|
|
1423
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1424
|
+
});
|
|
1425
|
+
|
|
1426
|
+
async function run() {
|
|
1427
|
+
const res = await subscriptionsPreviewSubscriptionModify(flexprice, "<id>", {
|
|
1428
|
+
type: "quantity_change",
|
|
1429
|
+
});
|
|
1430
|
+
if (res.ok) {
|
|
1431
|
+
const { value: result } = res;
|
|
1432
|
+
console.log(result);
|
|
1433
|
+
} else {
|
|
1434
|
+
console.log("subscriptionsPreviewSubscriptionModify failed:", res.error);
|
|
1435
|
+
}
|
|
1436
|
+
}
|
|
1437
|
+
|
|
1438
|
+
run();
|
|
1439
|
+
```
|
|
1440
|
+
|
|
1441
|
+
### Parameters
|
|
1442
|
+
|
|
1443
|
+
| Parameter | Type | Required | Description |
|
|
1444
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1445
|
+
| `id` | *string* | :heavy_check_mark: | Subscription ID |
|
|
1446
|
+
| `body` | [models.ExecuteSubscriptionModifyRequest](../../sdk/models/execute-subscription-modify-request.md) | :heavy_check_mark: | Modification preview request |
|
|
1447
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1448
|
+
| `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. |
|
|
1449
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1450
|
+
|
|
1451
|
+
### Response
|
|
1452
|
+
|
|
1453
|
+
**Promise\<[models.SubscriptionModifyResponse](../../sdk/models/subscription-modify-response.md)\>**
|
|
1375
1454
|
|
|
1376
1455
|
### Errors
|
|
1377
1456
|
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { FlexpriceCore } from "../core.js";
|
|
2
|
+
import { RequestOptions } from "../lib/sdks.js";
|
|
3
|
+
import { FlexPriceError } from "../sdk/models/flex-price-error.js";
|
|
4
|
+
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../sdk/models/http-client-errors.js";
|
|
5
|
+
import * as models from "../sdk/models/index.js";
|
|
6
|
+
import { ResponseValidationError } from "../sdk/models/response-validation-error.js";
|
|
7
|
+
import { SDKValidationError } from "../sdk/models/sdk-validation-error.js";
|
|
8
|
+
import { APIPromise } from "../types/async.js";
|
|
9
|
+
import { Result } from "../types/fp.js";
|
|
10
|
+
/**
|
|
11
|
+
* Clone an environment
|
|
12
|
+
*
|
|
13
|
+
* @remarks
|
|
14
|
+
* Clone all published features and plans from the source environment into a target environment. If target_environment_id is provided, entities are cloned into that existing environment. Otherwise a new environment is created from name and type first.
|
|
15
|
+
*/
|
|
16
|
+
export declare function environmentsCloneEnvironment(client: FlexpriceCore, id: string, body: models.CloneEnvironmentRequest, options?: RequestOptions): APIPromise<Result<models.ModelsTemporalWorkflowResult, models.ErrorsErrorResponse | FlexPriceError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
17
|
+
//# sourceMappingURL=environments-clone-environment.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"environments-clone-environment.d.ts","sourceRoot":"","sources":["../../src/funcs/environments-clone-environment.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAK3C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AACnE,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,KAAK,MAAM,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,uBAAuB,EAAE,MAAM,4CAA4C,CAAC;AACrF,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAC3E,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAC1C,MAAM,EAAE,aAAa,EACrB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,CAAC,uBAAuB,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,MAAM,CAAC,4BAA4B,EACjC,MAAM,CAAC,mBAAmB,GAC1B,cAAc,GACd,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAOA"}
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
import * as z from "zod/v4-mini";
|
|
5
|
+
import { encodeJSON, encodeSimple } from "../lib/encodings.js";
|
|
6
|
+
import * as M from "../lib/matchers.js";
|
|
7
|
+
import { compactMap } from "../lib/primitives.js";
|
|
8
|
+
import { safeParse } from "../lib/schemas.js";
|
|
9
|
+
import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
|
|
10
|
+
import { pathToFunc } from "../lib/url.js";
|
|
11
|
+
import * as models from "../sdk/models/index.js";
|
|
12
|
+
import { APIPromise } from "../types/async.js";
|
|
13
|
+
/**
|
|
14
|
+
* Clone an environment
|
|
15
|
+
*
|
|
16
|
+
* @remarks
|
|
17
|
+
* Clone all published features and plans from the source environment into a target environment. If target_environment_id is provided, entities are cloned into that existing environment. Otherwise a new environment is created from name and type first.
|
|
18
|
+
*/
|
|
19
|
+
export function environmentsCloneEnvironment(client, id, body, options) {
|
|
20
|
+
return new APIPromise($do(client, id, body, options));
|
|
21
|
+
}
|
|
22
|
+
async function $do(client, id, body, options) {
|
|
23
|
+
const input = {
|
|
24
|
+
id: id,
|
|
25
|
+
body: body,
|
|
26
|
+
};
|
|
27
|
+
const parsed = safeParse(input, (value) => z.parse(models.CloneEnvironmentRequestRequest$outboundSchema, value), "Input validation failed");
|
|
28
|
+
if (!parsed.ok) {
|
|
29
|
+
return [parsed, { status: "invalid" }];
|
|
30
|
+
}
|
|
31
|
+
const payload = parsed.value;
|
|
32
|
+
const body$ = encodeJSON("body", payload.body, { explode: true });
|
|
33
|
+
const pathParams = {
|
|
34
|
+
id: encodeSimple("id", payload.id, {
|
|
35
|
+
explode: false,
|
|
36
|
+
charEncoding: "percent",
|
|
37
|
+
}),
|
|
38
|
+
};
|
|
39
|
+
const path = pathToFunc("/environments/{id}/clone")(pathParams);
|
|
40
|
+
const headers = new Headers(compactMap({
|
|
41
|
+
"Content-Type": "application/json",
|
|
42
|
+
Accept: "application/json",
|
|
43
|
+
}));
|
|
44
|
+
const secConfig = await extractSecurity(client._options.apiKeyAuth);
|
|
45
|
+
const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
|
|
46
|
+
const requestSecurity = resolveGlobalSecurity(securityInput);
|
|
47
|
+
const context = {
|
|
48
|
+
options: client._options,
|
|
49
|
+
baseURL: options?.serverURL ?? client._baseURL ?? "",
|
|
50
|
+
operationID: "cloneEnvironment",
|
|
51
|
+
oAuth2Scopes: null,
|
|
52
|
+
resolvedSecurity: requestSecurity,
|
|
53
|
+
securitySource: client._options.apiKeyAuth,
|
|
54
|
+
retryConfig: options?.retries
|
|
55
|
+
|| client._options.retryConfig
|
|
56
|
+
|| { strategy: "none" },
|
|
57
|
+
retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
|
|
58
|
+
};
|
|
59
|
+
const requestRes = client._createRequest(context, {
|
|
60
|
+
security: requestSecurity,
|
|
61
|
+
method: "POST",
|
|
62
|
+
baseURL: options?.serverURL,
|
|
63
|
+
path: path,
|
|
64
|
+
headers: headers,
|
|
65
|
+
body: body$,
|
|
66
|
+
userAgent: client._options.userAgent,
|
|
67
|
+
timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
|
|
68
|
+
}, options);
|
|
69
|
+
if (!requestRes.ok) {
|
|
70
|
+
return [requestRes, { status: "invalid" }];
|
|
71
|
+
}
|
|
72
|
+
const req = requestRes.value;
|
|
73
|
+
const doResult = await client._do(req, {
|
|
74
|
+
context,
|
|
75
|
+
errorCodes: ["400", "404", "4XX", "500", "5XX"],
|
|
76
|
+
retryConfig: context.retryConfig,
|
|
77
|
+
retryCodes: context.retryCodes,
|
|
78
|
+
});
|
|
79
|
+
if (!doResult.ok) {
|
|
80
|
+
return [doResult, { status: "request-error", request: req }];
|
|
81
|
+
}
|
|
82
|
+
const response = doResult.value;
|
|
83
|
+
const responseFields = {
|
|
84
|
+
HttpMeta: { Response: response, Request: req },
|
|
85
|
+
};
|
|
86
|
+
const [result] = await M.match(M.json(202, models.ModelsTemporalWorkflowResult$inboundSchema), M.jsonErr([400, 404], models.ErrorsErrorResponse$inboundSchema), M.jsonErr(500, models.ErrorsErrorResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
|
|
87
|
+
if (!result.ok) {
|
|
88
|
+
return [result, { status: "complete", request: req, response }];
|
|
89
|
+
}
|
|
90
|
+
return [result, { status: "complete", request: req, response }];
|
|
91
|
+
}
|
|
92
|
+
//# sourceMappingURL=environments-clone-environment.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"environments-clone-environment.js","sourceRoot":"","sources":["../../src/funcs/environments-clone-environment.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,aAAa,CAAC;AAEjC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAC/D,OAAO,KAAK,CAAC,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE9C,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAS3C,OAAO,KAAK,MAAM,MAAM,wBAAwB,CAAC;AAGjD,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAGxD;;;;;GAKG;AACH,MAAM,UAAU,4BAA4B,CAC1C,MAAqB,EACrB,EAAU,EACV,IAAoC,EACpC,OAAwB,EAcxB;IACA,OAAO,IAAI,UAAU,CAAC,GAAG,CACvB,MAAM,EACN,EAAE,EACF,IAAI,EACJ,OAAO,CACR,CAAC,CAAC;AAAA,CACJ;AAED,KAAK,UAAU,GAAG,CAChB,MAAqB,EACrB,EAAU,EACV,IAAoC,EACpC,OAAwB,EAiBxB;IACA,MAAM,KAAK,GAA0C;QACnD,EAAE,EAAE,EAAE;QACN,IAAI,EAAE,IAAI;KACX,CAAC;IAEF,MAAM,MAAM,GAAG,SAAS,CACtB,KAAK,EACL,CAAC,KAAK,EAAE,EAAE,CACR,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,6CAA6C,EAAE,KAAK,CAAC,EACtE,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAElE,MAAM,UAAU,GAAG;QACjB,EAAE,EAAE,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,EAAE;YACjC,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;KACH,CAAC;IACF,MAAM,IAAI,GAAG,UAAU,CAAC,0BAA0B,CAAC,CAAC,UAAU,CAAC,CAAC;IAEhE,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,UAAU,CAAC;QACrC,cAAc,EAAE,kBAAkB;QAClC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IACpE,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;IACzE,MAAM,eAAe,GAAG,qBAAqB,CAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,MAAM,CAAC,QAAQ;QACxB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE;QACpD,WAAW,EAAE,kBAAkB;QAC/B,YAAY,EAAE,IAAI;QAElB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,UAAU;QAC1C,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACvE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE,KAAK;QACX,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;QACpC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;QAC/C,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAY5B,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,0CAA0C,CAAC,EAC9D,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,iCAAiC,CAAC,EAC/D,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,iCAAiC,CAAC,EACxD,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;AAAA,CACjE"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { FlexpriceCore } from "../core.js";
|
|
2
|
+
import { RequestOptions } from "../lib/sdks.js";
|
|
3
|
+
import { FlexPriceError } from "../sdk/models/flex-price-error.js";
|
|
4
|
+
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../sdk/models/http-client-errors.js";
|
|
5
|
+
import * as models from "../sdk/models/index.js";
|
|
6
|
+
import { ResponseValidationError } from "../sdk/models/response-validation-error.js";
|
|
7
|
+
import { SDKValidationError } from "../sdk/models/sdk-validation-error.js";
|
|
8
|
+
import { APIPromise } from "../types/async.js";
|
|
9
|
+
import { Result } from "../types/fp.js";
|
|
10
|
+
/**
|
|
11
|
+
* Clone a feature
|
|
12
|
+
*
|
|
13
|
+
* @remarks
|
|
14
|
+
* Clone an existing feature
|
|
15
|
+
*/
|
|
16
|
+
export declare function featuresCloneFeature(client: FlexpriceCore, id: string, body: models.CloneFeatureRequest, options?: RequestOptions): APIPromise<Result<models.FeatureResponse, models.ErrorsErrorResponse | FlexPriceError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
17
|
+
//# sourceMappingURL=features-clone-feature.d.ts.map
|