@flexprice/sdk 2.1.10 → 2.1.17
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/changed-subscription.md +7 -5
- package/docs/sdk/models/create-invoice-line-item-request.md +25 -22
- package/docs/sdk/models/create-invoice-request.md +1 -0
- package/docs/sdk/models/create-user-response.md +1 -0
- package/docs/sdk/models/entity-integration-mapping-response.md +1 -0
- package/docs/sdk/models/entity-sync-config.md +16 -0
- package/docs/sdk/models/error-code.md +17 -0
- package/docs/sdk/models/error-response.md +5 -6
- package/docs/sdk/models/errors-error-response.md +5 -6
- package/docs/sdk/models/execute-subscription-modify-request-request.md +1 -1
- package/docs/sdk/models/execute-subscription-modify-request.md +1 -0
- package/docs/sdk/models/get-entity-integration-mappings-request.md +19 -0
- package/docs/sdk/models/integration-config-entry.md +17 -0
- package/docs/sdk/models/integration-config-response.md +15 -0
- package/docs/sdk/models/invoice-billing-reason.md +1 -1
- package/docs/sdk/models/invoice-filter.md +2 -0
- package/docs/sdk/models/invoice-line-item-response.md +38 -36
- package/docs/sdk/models/invoice-response.md +1 -0
- package/docs/sdk/models/invoice-sync-settings.md +15 -0
- package/docs/sdk/models/list-entity-integration-mappings-response.md +16 -0
- package/docs/sdk/models/payment-gateway-type.md +1 -1
- package/docs/sdk/models/preview-subscription-modify-request.md +1 -1
- package/docs/sdk/models/price-price.md +43 -42
- package/docs/sdk/models/price-response.md +48 -47
- package/docs/sdk/models/s3-export-config.md +20 -0
- package/docs/sdk/models/secret-provider.md +1 -1
- package/docs/sdk/models/sub-modify-trial-end-request.md +18 -0
- package/docs/sdk/models/subscription-modify-type.md +2 -2
- package/docs/sdk/models/subscription-response-v2.md +2 -0
- package/docs/sdk/models/subscription-response.md +1 -0
- package/docs/sdk/models/sync-config.md +23 -0
- package/docs/sdk/models/trial-end-action.md +15 -0
- package/docs/sdk/models/update-user-request.md +15 -0
- package/docs/sdk/models/update-user-response.md +20 -0
- package/docs/sdk/models/user-response.md +1 -0
- package/docs/sdk/models/window-size.md +2 -2
- package/docs/sdks/integrations/README.md +143 -0
- package/docs/sdks/invoices/README.md +0 -76
- package/docs/sdks/subscriptions/README.md +2 -2
- package/docs/sdks/users/README.md +72 -0
- package/esm/funcs/{invoices-get-meter-usage-preview-invoice.d.ts → integrations-get-entity-integration-mappings.d.ts} +4 -4
- package/esm/funcs/integrations-get-entity-integration-mappings.d.ts.map +1 -0
- package/esm/funcs/{invoices-get-meter-usage-preview-invoice.js → integrations-get-entity-integration-mappings.js} +22 -14
- package/esm/funcs/integrations-get-entity-integration-mappings.js.map +1 -0
- package/esm/funcs/{meter-usage-get-meter-usage-analytics.d.ts → integrations-get-integration-config.d.ts} +4 -4
- package/esm/funcs/integrations-get-integration-config.d.ts.map +1 -0
- package/esm/funcs/{meter-usage-get-meter-usage-analytics.js → integrations-get-integration-config.js} +10 -21
- package/esm/funcs/integrations-get-integration-config.js.map +1 -0
- package/esm/funcs/{meter-usage-query-meter-usage.d.ts → users-update-user.d.ts} +4 -4
- package/esm/funcs/users-update-user.d.ts.map +1 -0
- package/esm/funcs/{meter-usage-query-meter-usage.js → users-update-user.js} +9 -9
- package/esm/funcs/users-update-user.js.map +1 -0
- package/esm/lib/config.d.ts +3 -3
- package/esm/lib/config.js +3 -3
- package/esm/sdk/integrations.d.ts +14 -0
- package/esm/sdk/integrations.d.ts.map +1 -1
- package/esm/sdk/integrations.js +20 -0
- package/esm/sdk/integrations.js.map +1 -1
- package/esm/sdk/invoices.d.ts +0 -7
- package/esm/sdk/invoices.d.ts.map +1 -1
- package/esm/sdk/invoices.js +0 -10
- package/esm/sdk/invoices.js.map +1 -1
- package/esm/sdk/models/changed-subscription.d.ts +2 -0
- package/esm/sdk/models/changed-subscription.d.ts.map +1 -1
- package/esm/sdk/models/changed-subscription.js +10 -2
- package/esm/sdk/models/changed-subscription.js.map +1 -1
- package/esm/sdk/models/create-invoice-line-item-request.d.ts +18 -0
- package/esm/sdk/models/create-invoice-line-item-request.d.ts.map +1 -1
- package/esm/sdk/models/create-invoice-line-item-request.js +6 -0
- package/esm/sdk/models/create-invoice-line-item-request.js.map +1 -1
- package/esm/sdk/models/create-invoice-request.d.ts +8 -0
- package/esm/sdk/models/create-invoice-request.d.ts.map +1 -1
- package/esm/sdk/models/create-invoice-request.js +2 -0
- package/esm/sdk/models/create-invoice-request.js.map +1 -1
- package/esm/sdk/models/create-user-response.d.ts +3 -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/customer-lookup-result.d.ts +1 -1
- package/esm/sdk/models/customer-lookup-result.d.ts.map +1 -1
- package/esm/sdk/models/customer-lookup-result.js +1 -1
- package/esm/sdk/models/customer-lookup-result.js.map +1 -1
- package/esm/sdk/models/entity-integration-mapping-response.d.ts +3 -0
- package/esm/sdk/models/entity-integration-mapping-response.d.ts.map +1 -1
- package/esm/sdk/models/entity-integration-mapping-response.js +1 -0
- package/esm/sdk/models/entity-integration-mapping-response.js.map +1 -1
- package/esm/sdk/models/entity-sync-config.d.ts +17 -0
- package/esm/sdk/models/entity-sync-config.d.ts.map +1 -0
- package/esm/sdk/models/entity-sync-config.js +15 -0
- package/esm/sdk/models/entity-sync-config.js.map +1 -0
- package/esm/sdk/models/error-code.d.ts +20 -0
- package/esm/sdk/models/error-code.d.ts.map +1 -0
- package/esm/sdk/models/error-code.js +21 -0
- package/esm/sdk/models/error-code.js.map +1 -0
- package/esm/sdk/models/error-response.d.ts +13 -0
- package/esm/sdk/models/error-response.d.ts.map +1 -0
- package/esm/sdk/models/error-response.js +22 -0
- package/esm/sdk/models/error-response.js.map +1 -0
- package/esm/sdk/models/errors-error-response.d.ts +3 -42
- package/esm/sdk/models/errors-error-response.d.ts.map +1 -1
- package/esm/sdk/models/errors-error-response.js +2 -42
- package/esm/sdk/models/errors-error-response.js.map +1 -1
- package/esm/sdk/models/execute-subscription-modify-request.d.ts +3 -0
- package/esm/sdk/models/execute-subscription-modify-request.d.ts.map +1 -1
- package/esm/sdk/models/execute-subscription-modify-request.js +3 -0
- package/esm/sdk/models/execute-subscription-modify-request.js.map +1 -1
- package/esm/sdk/models/failure-point.d.ts +1 -1
- package/esm/sdk/models/failure-point.d.ts.map +1 -1
- package/esm/sdk/models/failure-point.js +1 -1
- package/esm/sdk/models/failure-point.js.map +1 -1
- package/esm/sdk/models/get-entity-integration-mappings-op.d.ts +20 -0
- package/esm/sdk/models/get-entity-integration-mappings-op.d.ts.map +1 -0
- package/esm/sdk/models/get-entity-integration-mappings-op.js +19 -0
- package/esm/sdk/models/get-entity-integration-mappings-op.js.map +1 -0
- package/esm/sdk/models/index.d.ts +14 -5
- package/esm/sdk/models/index.d.ts.map +1 -1
- package/esm/sdk/models/index.js +14 -5
- package/esm/sdk/models/index.js.map +1 -1
- package/esm/sdk/models/integration-config-entry.d.ts +14 -0
- package/esm/sdk/models/integration-config-entry.d.ts.map +1 -0
- package/esm/sdk/models/integration-config-entry.js +24 -0
- package/esm/sdk/models/integration-config-entry.js.map +1 -0
- package/esm/sdk/models/integration-config-response.d.ts +11 -0
- package/esm/sdk/models/integration-config-response.d.ts.map +1 -0
- package/esm/sdk/models/integration-config-response.js +15 -0
- package/esm/sdk/models/integration-config-response.js.map +1 -0
- package/esm/sdk/models/invoice-billing-reason.d.ts +1 -0
- package/esm/sdk/models/invoice-billing-reason.d.ts.map +1 -1
- package/esm/sdk/models/invoice-billing-reason.js +1 -0
- package/esm/sdk/models/invoice-billing-reason.js.map +1 -1
- package/esm/sdk/models/invoice-filter.d.ts +11 -0
- package/esm/sdk/models/invoice-filter.d.ts.map +1 -1
- package/esm/sdk/models/invoice-filter.js +4 -0
- package/esm/sdk/models/invoice-filter.js.map +1 -1
- package/esm/sdk/models/invoice-line-item-response.d.ts +11 -0
- package/esm/sdk/models/invoice-line-item-response.d.ts.map +1 -1
- package/esm/sdk/models/invoice-line-item-response.js +4 -0
- package/esm/sdk/models/invoice-line-item-response.js.map +1 -1
- package/esm/sdk/models/invoice-response.d.ts +4 -0
- package/esm/sdk/models/invoice-response.d.ts.map +1 -1
- package/esm/sdk/models/invoice-response.js +2 -0
- package/esm/sdk/models/invoice-response.js.map +1 -1
- package/esm/sdk/models/invoice-sync-settings.d.ts +11 -0
- package/esm/sdk/models/invoice-sync-settings.d.ts.map +1 -0
- package/esm/sdk/models/invoice-sync-settings.js +20 -0
- package/esm/sdk/models/invoice-sync-settings.js.map +1 -0
- package/esm/sdk/models/list-entity-integration-mappings-response.d.ts +13 -0
- package/esm/sdk/models/list-entity-integration-mappings-response.d.ts.map +1 -0
- package/esm/sdk/models/list-entity-integration-mappings-response.js +17 -0
- package/esm/sdk/models/list-entity-integration-mappings-response.js.map +1 -0
- package/esm/sdk/models/meter-matching-result.d.ts +1 -1
- package/esm/sdk/models/meter-matching-result.d.ts.map +1 -1
- package/esm/sdk/models/meter-matching-result.js +1 -1
- package/esm/sdk/models/meter-matching-result.js.map +1 -1
- package/esm/sdk/models/payment-gateway-type.d.ts +1 -0
- package/esm/sdk/models/payment-gateway-type.d.ts.map +1 -1
- package/esm/sdk/models/payment-gateway-type.js +1 -0
- package/esm/sdk/models/payment-gateway-type.js.map +1 -1
- package/esm/sdk/models/price-lookup-result.d.ts +1 -1
- package/esm/sdk/models/price-lookup-result.d.ts.map +1 -1
- package/esm/sdk/models/price-lookup-result.js +1 -1
- package/esm/sdk/models/price-lookup-result.js.map +1 -1
- package/esm/sdk/models/price-price.d.ts +9 -0
- package/esm/sdk/models/price-price.d.ts.map +1 -1
- package/esm/sdk/models/price-price.js +1 -0
- package/esm/sdk/models/price-price.js.map +1 -1
- package/esm/sdk/models/price-response.d.ts +9 -0
- package/esm/sdk/models/price-response.d.ts.map +1 -1
- package/esm/sdk/models/price-response.js +1 -0
- package/esm/sdk/models/price-response.js.map +1 -1
- package/esm/sdk/models/s3-export-config.d.ts +29 -0
- package/esm/sdk/models/s3-export-config.d.ts.map +1 -0
- package/esm/sdk/models/s3-export-config.js +27 -0
- package/esm/sdk/models/s3-export-config.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-trial-end-request.d.ts +18 -0
- package/esm/sdk/models/sub-modify-trial-end-request.d.ts.map +1 -0
- package/esm/sdk/models/sub-modify-trial-end-request.js +19 -0
- package/esm/sdk/models/sub-modify-trial-end-request.js.map +1 -0
- package/esm/sdk/models/subscription-line-item-lookup-result.d.ts +1 -1
- package/esm/sdk/models/subscription-line-item-lookup-result.d.ts.map +1 -1
- package/esm/sdk/models/subscription-line-item-lookup-result.js +1 -1
- package/esm/sdk/models/subscription-line-item-lookup-result.js.map +1 -1
- package/esm/sdk/models/subscription-modify-type.d.ts +1 -0
- package/esm/sdk/models/subscription-modify-type.d.ts.map +1 -1
- package/esm/sdk/models/subscription-modify-type.js +1 -0
- package/esm/sdk/models/subscription-modify-type.js.map +1 -1
- package/esm/sdk/models/subscription-response-v2.d.ts +16 -0
- package/esm/sdk/models/subscription-response-v2.d.ts.map +1 -1
- package/esm/sdk/models/subscription-response-v2.js +4 -0
- package/esm/sdk/models/subscription-response-v2.js.map +1 -1
- package/esm/sdk/models/subscription-response.d.ts +8 -0
- package/esm/sdk/models/subscription-response.d.ts.map +1 -1
- package/esm/sdk/models/subscription-response.js +2 -0
- package/esm/sdk/models/subscription-response.js.map +1 -1
- package/esm/sdk/models/sync-config.d.ts +21 -0
- package/esm/sdk/models/sync-config.d.ts.map +1 -0
- package/esm/sdk/models/sync-config.js +31 -0
- package/esm/sdk/models/sync-config.js.map +1 -0
- package/esm/sdk/models/trial-end-action.d.ts +10 -0
- package/esm/sdk/models/trial-end-action.d.ts.map +1 -0
- package/esm/sdk/models/trial-end-action.js +11 -0
- package/esm/sdk/models/trial-end-action.js.map +1 -0
- package/esm/sdk/models/update-user-request.d.ts +16 -0
- package/esm/sdk/models/update-user-request.d.ts.map +1 -0
- package/esm/sdk/models/update-user-request.js +12 -0
- package/esm/sdk/models/update-user-request.js.map +1 -0
- package/esm/sdk/models/update-user-response.d.ts +22 -0
- package/esm/sdk/models/update-user-response.d.ts.map +1 -0
- package/esm/sdk/models/update-user-response.js +21 -0
- package/esm/sdk/models/update-user-response.js.map +1 -0
- package/esm/sdk/models/user-response.d.ts +3 -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 +0 -3
- package/esm/sdk/sdk.d.ts.map +1 -1
- package/esm/sdk/sdk.js +0 -5
- package/esm/sdk/sdk.js.map +1 -1
- package/esm/sdk/users.d.ts +7 -0
- package/esm/sdk/users.d.ts.map +1 -1
- package/esm/sdk/users.js +10 -0
- package/esm/sdk/users.js.map +1 -1
- package/esm/types/async.d.ts.map +1 -1
- package/esm/types/async.js +6 -6
- package/esm/types/async.js.map +1 -1
- package/esm/types/primitives.d.ts +0 -2
- package/esm/types/primitives.d.ts.map +1 -1
- package/esm/types/primitives.js +0 -22
- package/esm/types/primitives.js.map +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/{meter-usage-get-meter-usage-analytics.ts → integrations-get-entity-integration-mappings.ts} +32 -18
- package/src/funcs/{invoices-get-meter-usage-preview-invoice.ts → integrations-get-integration-config.ts} +10 -30
- package/src/funcs/{meter-usage-query-meter-usage.ts → users-update-user.ts} +13 -13
- package/src/lib/config.ts +3 -3
- package/src/sdk/integrations.ts +36 -0
- package/src/sdk/invoices.ts +0 -18
- package/src/sdk/models/changed-subscription.ts +18 -5
- package/src/sdk/models/create-invoice-line-item-request.ts +24 -0
- package/src/sdk/models/create-invoice-request.ts +10 -0
- package/src/sdk/models/create-user-response.ts +2 -0
- package/src/sdk/models/customer-lookup-result.ts +1 -1
- package/src/sdk/models/entity-integration-mapping-response.ts +2 -0
- package/src/sdk/models/entity-sync-config.ts +39 -0
- package/src/sdk/models/error-code.ts +27 -0
- package/src/sdk/models/error-response.ts +44 -0
- package/src/sdk/models/errors-error-response.ts +4 -87
- package/src/sdk/models/execute-subscription-modify-request.ts +9 -0
- package/src/sdk/models/failure-point.ts +1 -1
- package/src/sdk/models/get-entity-integration-mappings-op.ts +50 -0
- package/src/sdk/models/index.ts +14 -5
- package/src/sdk/models/integration-config-entry.ts +49 -0
- package/src/sdk/models/integration-config-response.ts +35 -0
- package/src/sdk/models/invoice-billing-reason.ts +1 -0
- package/src/sdk/models/invoice-filter.ts +17 -0
- package/src/sdk/models/invoice-line-item-response.ts +15 -0
- package/src/sdk/models/invoice-response.ts +6 -0
- package/src/sdk/models/invoice-sync-settings.ts +43 -0
- package/src/sdk/models/list-entity-integration-mappings-response.ts +44 -0
- package/src/sdk/models/meter-matching-result.ts +1 -1
- package/src/sdk/models/payment-gateway-type.ts +1 -0
- package/src/sdk/models/price-lookup-result.ts +1 -1
- package/src/sdk/models/price-price.ts +10 -0
- package/src/sdk/models/price-response.ts +10 -0
- package/src/sdk/models/s3-export-config.ts +70 -0
- package/src/sdk/models/secret-provider.ts +1 -0
- package/src/sdk/models/sub-modify-trial-end-request.ts +50 -0
- package/src/sdk/models/subscription-line-item-lookup-result.ts +1 -1
- package/src/sdk/models/subscription-modify-type.ts +1 -0
- package/src/sdk/models/subscription-response-v2.ts +20 -0
- package/src/sdk/models/subscription-response.ts +10 -0
- package/src/sdk/models/sync-config.ts +65 -0
- package/src/sdk/models/trial-end-action.ts +17 -0
- package/src/sdk/models/update-user-request.ts +30 -0
- package/src/sdk/models/update-user-response.ts +49 -0
- package/src/sdk/models/user-response.ts +2 -0
- package/src/sdk/models/window-size.ts +1 -1
- package/src/sdk/sdk.ts +0 -6
- package/src/sdk/users.ts +18 -0
- package/src/types/async.ts +8 -7
- package/src/types/primitives.ts +0 -26
- package/docs/sdk/models/code.md +0 -17
- package/docs/sdk/models/details.md +0 -14
- package/docs/sdk/models/meter-usage-analytics-request.md +0 -30
- package/docs/sdk/models/meter-usage-analytics-response.md +0 -30
- package/docs/sdk/models/meter-usage-point.md +0 -21
- package/docs/sdk/models/meter-usage-query-request.md +0 -28
- package/docs/sdk/models/meter-usage-query-response.md +0 -30
- package/docs/sdks/meterusage/README.md +0 -182
- package/esm/funcs/invoices-get-meter-usage-preview-invoice.d.ts.map +0 -1
- package/esm/funcs/invoices-get-meter-usage-preview-invoice.js.map +0 -1
- package/esm/funcs/meter-usage-get-meter-usage-analytics.d.ts.map +0 -1
- package/esm/funcs/meter-usage-get-meter-usage-analytics.js.map +0 -1
- package/esm/funcs/meter-usage-query-meter-usage.d.ts.map +0 -1
- package/esm/funcs/meter-usage-query-meter-usage.js.map +0 -1
- package/esm/sdk/meter-usage.d.ts +0 -19
- package/esm/sdk/meter-usage.d.ts.map +0 -1
- package/esm/sdk/meter-usage.js +0 -28
- package/esm/sdk/meter-usage.js.map +0 -1
- package/esm/sdk/models/meter-usage-analytics-request.d.ts +0 -26
- package/esm/sdk/models/meter-usage-analytics-request.d.ts.map +0 -1
- package/esm/sdk/models/meter-usage-analytics-request.js +0 -31
- package/esm/sdk/models/meter-usage-analytics-request.js.map +0 -1
- package/esm/sdk/models/meter-usage-analytics-response.d.ts +0 -11
- package/esm/sdk/models/meter-usage-analytics-response.d.ts.map +0 -1
- package/esm/sdk/models/meter-usage-analytics-response.js +0 -15
- package/esm/sdk/models/meter-usage-analytics-response.js.map +0 -1
- package/esm/sdk/models/meter-usage-point.d.ts +0 -12
- package/esm/sdk/models/meter-usage-point.d.ts.map +0 -1
- package/esm/sdk/models/meter-usage-point.js +0 -21
- package/esm/sdk/models/meter-usage-point.js.map +0 -1
- package/esm/sdk/models/meter-usage-query-request.d.ts +0 -26
- package/esm/sdk/models/meter-usage-query-request.d.ts.map +0 -1
- package/esm/sdk/models/meter-usage-query-request.js +0 -31
- package/esm/sdk/models/meter-usage-query-request.js.map +0 -1
- package/esm/sdk/models/meter-usage-query-response.d.ts +0 -16
- package/esm/sdk/models/meter-usage-query-response.d.ts.map +0 -1
- package/esm/sdk/models/meter-usage-query-response.js +0 -28
- package/esm/sdk/models/meter-usage-query-response.js.map +0 -1
- package/src/sdk/meter-usage.ts +0 -45
- package/src/sdk/models/meter-usage-analytics-request.ts +0 -69
- package/src/sdk/models/meter-usage-analytics-response.ts +0 -35
- package/src/sdk/models/meter-usage-point.ts +0 -43
- package/src/sdk/models/meter-usage-query-request.ts +0 -69
- package/src/sdk/models/meter-usage-query-response.ts +0 -58
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# SubModifyTrialEndRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { SubModifyTrialEndRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: SubModifyTrialEndRequest = {
|
|
9
|
+
action: "immediate",
|
|
10
|
+
};
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Fields
|
|
14
|
+
|
|
15
|
+
| Field | Type | Required | Description |
|
|
16
|
+
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
17
|
+
| `action` | [models.TrialEndAction](../../sdk/models/trial-end-action.md) | :heavy_check_mark: | N/A |
|
|
18
|
+
| `newTrialEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | NewTrialEnd is the new trial end date. Required when action is "scheduled_date". |
|
|
@@ -5,11 +5,11 @@
|
|
|
5
5
|
```typescript
|
|
6
6
|
import { SubscriptionModifyType } from "@flexprice/sdk/sdk/models";
|
|
7
7
|
|
|
8
|
-
let value: SubscriptionModifyType = "
|
|
8
|
+
let value: SubscriptionModifyType = "trial_end";
|
|
9
9
|
```
|
|
10
10
|
|
|
11
11
|
## Values
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
"inheritance" | "quantity_change" | "grouped_invoicing"
|
|
14
|
+
"inheritance" | "quantity_change" | "grouped_invoicing" | "trial_end"
|
|
15
15
|
```
|
|
@@ -88,11 +88,13 @@ let value: SubscriptionResponseV2 = {
|
|
|
88
88
|
| `phases` | [models.SubscriptionPhaseResponse](../../sdk/models/subscription-phase-response.md)[] | :heavy_minus_sign: | Phases are included when "phases" is in expand parameter |
|
|
89
89
|
| `plan` | [models.PlanResponse](../../sdk/models/plan-response.md) | :heavy_minus_sign: | N/A |
|
|
90
90
|
| `planId` | *string* | :heavy_minus_sign: | PlanID is the identifier for the plan in our system |
|
|
91
|
+
| `planPricesOutOfSync` | *boolean* | :heavy_minus_sign: | PlanPricesOutOfSync is true when the subscription's synced_price_sequence<br/>is behind the plan's current max prices.sequence — i.e. plan-price<br/>changes have not yet been reconciled into this subscription's line items. |
|
|
91
92
|
| `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
|
|
92
93
|
| `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | StartDate is the start date of the subscription |
|
|
93
94
|
| `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
|
|
94
95
|
| `subscriptionStatus` | [models.SubscriptionStatus](../../sdk/models/subscription-status.md) | :heavy_minus_sign: | N/A |
|
|
95
96
|
| `subscriptionType` | [models.SubscriptionType](../../sdk/models/subscription-type.md) | :heavy_minus_sign: | N/A |
|
|
97
|
+
| `syncedPriceSequence` | *number* | :heavy_minus_sign: | SyncedPriceSequence is the plan-price sequence up to which this<br/>subscription's line items have been reconciled. Bumped by the<br/>plan-price sync after a successful pass. |
|
|
96
98
|
| `tenantId` | *string* | :heavy_minus_sign: | N/A |
|
|
97
99
|
| `trialEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | TrialEnd is the end date of the trial period |
|
|
98
100
|
| `trialStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | TrialStart is the start date of the trial period |
|
|
@@ -66,6 +66,7 @@ let value: SubscriptionResponse = {
|
|
|
66
66
|
| `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
|
|
67
67
|
| `subscriptionStatus` | [models.SubscriptionStatus](../../sdk/models/subscription-status.md) | :heavy_minus_sign: | N/A |
|
|
68
68
|
| `subscriptionType` | [models.SubscriptionType](../../sdk/models/subscription-type.md) | :heavy_minus_sign: | N/A |
|
|
69
|
+
| `syncedPriceSequence` | *number* | :heavy_minus_sign: | SyncedPriceSequence is the plan-price sequence up to which this<br/>subscription's line items have been reconciled. Bumped by the<br/>plan-price sync after a successful pass. |
|
|
69
70
|
| `tenantId` | *string* | :heavy_minus_sign: | N/A |
|
|
70
71
|
| `trialEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | TrialEnd is the end date of the trial period |
|
|
71
72
|
| `trialStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | TrialStart is the start date of the trial period |
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# SyncConfig
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { SyncConfig } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: SyncConfig = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
|
15
|
+
| `customer` | [models.EntitySyncConfig](../../sdk/models/entity-sync-config.md) | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `deal` | [models.EntitySyncConfig](../../sdk/models/entity-sync-config.md) | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `invoice` | [models.EntitySyncConfig](../../sdk/models/entity-sync-config.md) | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `invoiceSyncSettings` | [models.InvoiceSyncSettings](../../sdk/models/invoice-sync-settings.md) | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `payment` | [models.EntitySyncConfig](../../sdk/models/entity-sync-config.md) | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `plan` | [models.EntitySyncConfig](../../sdk/models/entity-sync-config.md) | :heavy_minus_sign: | N/A |
|
|
21
|
+
| `quote` | [models.EntitySyncConfig](../../sdk/models/entity-sync-config.md) | :heavy_minus_sign: | N/A |
|
|
22
|
+
| `s3` | [models.S3ExportConfig](../../sdk/models/s3-export-config.md) | :heavy_minus_sign: | N/A |
|
|
23
|
+
| `subscription` | [models.EntitySyncConfig](../../sdk/models/entity-sync-config.md) | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# UpdateUserRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { UpdateUserRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: UpdateUserRequest = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
|
15
|
+
| `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UpdateUserResponse
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { UpdateUserResponse } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: UpdateUserResponse = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
|
15
|
+
| `email` | *string* | :heavy_minus_sign: | Empty for service accounts |
|
|
16
|
+
| `id` | *string* | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `roles` | *string*[] | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `tenant` | [models.TenantResponse](../../sdk/models/tenant-response.md) | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `type` | [models.UserType](../../sdk/models/user-type.md) | :heavy_minus_sign: | N/A |
|
|
@@ -14,6 +14,7 @@ let value: UserResponse = {};
|
|
|
14
14
|
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
|
15
15
|
| `email` | *string* | :heavy_minus_sign: | Empty for service accounts |
|
|
16
16
|
| `id` | *string* | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
|
|
17
18
|
| `roles` | *string*[] | :heavy_minus_sign: | N/A |
|
|
18
19
|
| `tenant` | [models.TenantResponse](../../sdk/models/tenant-response.md) | :heavy_minus_sign: | N/A |
|
|
19
20
|
| `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 = "6HOUR";
|
|
9
9
|
|
|
10
10
|
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
11
|
```
|
|
@@ -13,5 +13,5 @@ let value: WindowSize = "12HOUR";
|
|
|
13
13
|
## Values
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
"MINUTE" | "15MIN" | "30MIN" | "HOUR" | "3HOUR" | "6HOUR" | "12HOUR" | "DAY" | "WEEK" |
|
|
16
|
+
"MONTH" | "MINUTE" | "15MIN" | "30MIN" | "HOUR" | "3HOUR" | "6HOUR" | "12HOUR" | "DAY" | "WEEK" | Unrecognized<string>
|
|
17
17
|
```
|
|
@@ -4,7 +4,78 @@
|
|
|
4
4
|
|
|
5
5
|
### Available Operations
|
|
6
6
|
|
|
7
|
+
* [getIntegrationConfig](#getintegrationconfig) - Get integration configurations
|
|
7
8
|
* [linkIntegrationMapping](#linkintegrationmapping) - Link integration mapping
|
|
9
|
+
* [getEntityIntegrationMappings](#getentityintegrationmappings) - Get entity integration mappings
|
|
10
|
+
|
|
11
|
+
## getIntegrationConfig
|
|
12
|
+
|
|
13
|
+
Returns the base capabilities and current sync configuration for all connected providers.
|
|
14
|
+
|
|
15
|
+
### Example Usage
|
|
16
|
+
|
|
17
|
+
<!-- UsageSnippet language="typescript" operationID="getIntegrationConfig" method="get" path="/integrations/config" -->
|
|
18
|
+
```typescript
|
|
19
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
20
|
+
|
|
21
|
+
const flexprice = new Flexprice({
|
|
22
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
23
|
+
});
|
|
24
|
+
|
|
25
|
+
async function run() {
|
|
26
|
+
const result = await flexprice.integrations.getIntegrationConfig();
|
|
27
|
+
|
|
28
|
+
console.log(result);
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
run();
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Standalone function
|
|
35
|
+
|
|
36
|
+
The standalone function version of this method:
|
|
37
|
+
|
|
38
|
+
```typescript
|
|
39
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
40
|
+
import { integrationsGetIntegrationConfig } from "@flexprice/sdk/funcs/integrations-get-integration-config.js";
|
|
41
|
+
|
|
42
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
43
|
+
// You can create one instance of it to use across an application.
|
|
44
|
+
const flexprice = new FlexpriceCore({
|
|
45
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
46
|
+
});
|
|
47
|
+
|
|
48
|
+
async function run() {
|
|
49
|
+
const res = await integrationsGetIntegrationConfig(flexprice);
|
|
50
|
+
if (res.ok) {
|
|
51
|
+
const { value: result } = res;
|
|
52
|
+
console.log(result);
|
|
53
|
+
} else {
|
|
54
|
+
console.log("integrationsGetIntegrationConfig failed:", res.error);
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
run();
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Parameters
|
|
62
|
+
|
|
63
|
+
| Parameter | Type | Required | Description |
|
|
64
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
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.IntegrationConfigResponse](../../sdk/models/integration-config-response.md)\>**
|
|
72
|
+
|
|
73
|
+
### Errors
|
|
74
|
+
|
|
75
|
+
| Error Type | Status Code | Content Type |
|
|
76
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
77
|
+
| models.ErrorsErrorResponse | 500 | application/json |
|
|
78
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
8
79
|
|
|
9
80
|
## linkIntegrationMapping
|
|
10
81
|
|
|
@@ -81,6 +152,78 @@ run();
|
|
|
81
152
|
|
|
82
153
|
### Errors
|
|
83
154
|
|
|
155
|
+
| Error Type | Status Code | Content Type |
|
|
156
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
157
|
+
| models.ErrorsErrorResponse | 400 | application/json |
|
|
158
|
+
| models.ErrorsErrorResponse | 500 | application/json |
|
|
159
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
160
|
+
|
|
161
|
+
## getEntityIntegrationMappings
|
|
162
|
+
|
|
163
|
+
Get integration mappings for a specific entity by entity type and entity ID.
|
|
164
|
+
|
|
165
|
+
### Example Usage
|
|
166
|
+
|
|
167
|
+
<!-- UsageSnippet language="typescript" operationID="getEntityIntegrationMappings" method="get" path="/integrations/mappings" -->
|
|
168
|
+
```typescript
|
|
169
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
170
|
+
|
|
171
|
+
const flexprice = new Flexprice({
|
|
172
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
173
|
+
});
|
|
174
|
+
|
|
175
|
+
async function run() {
|
|
176
|
+
const result = await flexprice.integrations.getEntityIntegrationMappings("<value>", "<id>");
|
|
177
|
+
|
|
178
|
+
console.log(result);
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
run();
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
### Standalone function
|
|
185
|
+
|
|
186
|
+
The standalone function version of this method:
|
|
187
|
+
|
|
188
|
+
```typescript
|
|
189
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
190
|
+
import { integrationsGetEntityIntegrationMappings } from "@flexprice/sdk/funcs/integrations-get-entity-integration-mappings.js";
|
|
191
|
+
|
|
192
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
193
|
+
// You can create one instance of it to use across an application.
|
|
194
|
+
const flexprice = new FlexpriceCore({
|
|
195
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
196
|
+
});
|
|
197
|
+
|
|
198
|
+
async function run() {
|
|
199
|
+
const res = await integrationsGetEntityIntegrationMappings(flexprice, "<value>", "<id>");
|
|
200
|
+
if (res.ok) {
|
|
201
|
+
const { value: result } = res;
|
|
202
|
+
console.log(result);
|
|
203
|
+
} else {
|
|
204
|
+
console.log("integrationsGetEntityIntegrationMappings failed:", res.error);
|
|
205
|
+
}
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
run();
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
### Parameters
|
|
212
|
+
|
|
213
|
+
| Parameter | Type | Required | Description |
|
|
214
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
215
|
+
| `entityType` | *string* | :heavy_check_mark: | Entity type (customer, plan, invoice, subscription, payment, credit_note, addon, item, item_price, price) |
|
|
216
|
+
| `entityId` | *string* | :heavy_check_mark: | Entity ID |
|
|
217
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
218
|
+
| `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. |
|
|
219
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
220
|
+
|
|
221
|
+
### Response
|
|
222
|
+
|
|
223
|
+
**Promise\<[models.ListEntityIntegrationMappingsResponse](../../sdk/models/list-entity-integration-mappings-response.md)\>**
|
|
224
|
+
|
|
225
|
+
### Errors
|
|
226
|
+
|
|
84
227
|
| Error Type | Status Code | Content Type |
|
|
85
228
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
86
229
|
| models.ErrorsErrorResponse | 400 | application/json |
|
|
@@ -6,7 +6,6 @@
|
|
|
6
6
|
|
|
7
7
|
* [getCustomerInvoiceSummary](#getcustomerinvoicesummary) - Get customer invoice summary
|
|
8
8
|
* [createInvoice](#createinvoice) - Create one-off invoice
|
|
9
|
-
* [getMeterUsagePreviewInvoice](#getmeterusagepreviewinvoice) - Get invoice preview using meter_usage data
|
|
10
9
|
* [getInvoicePreview](#getinvoicepreview) - Get invoice preview
|
|
11
10
|
* [queryInvoice](#queryinvoice) - Query invoices
|
|
12
11
|
* [getInvoice](#getinvoice) - Get invoice
|
|
@@ -174,81 +173,6 @@ run();
|
|
|
174
173
|
| models.ErrorsErrorResponse | 500 | application/json |
|
|
175
174
|
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
176
175
|
|
|
177
|
-
## getMeterUsagePreviewInvoice
|
|
178
|
-
|
|
179
|
-
Preview invoice using the meter_usage table for usage data instead of feature_usage.
|
|
180
|
-
|
|
181
|
-
### Example Usage
|
|
182
|
-
|
|
183
|
-
<!-- UsageSnippet language="typescript" operationID="getMeterUsagePreviewInvoice" method="post" path="/invoices/meter-usage-preview" -->
|
|
184
|
-
```typescript
|
|
185
|
-
import { Flexprice } from "@flexprice/sdk";
|
|
186
|
-
|
|
187
|
-
const flexprice = new Flexprice({
|
|
188
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
189
|
-
});
|
|
190
|
-
|
|
191
|
-
async function run() {
|
|
192
|
-
const result = await flexprice.invoices.getMeterUsagePreviewInvoice({
|
|
193
|
-
subscriptionId: "<id>",
|
|
194
|
-
});
|
|
195
|
-
|
|
196
|
-
console.log(result);
|
|
197
|
-
}
|
|
198
|
-
|
|
199
|
-
run();
|
|
200
|
-
```
|
|
201
|
-
|
|
202
|
-
### Standalone function
|
|
203
|
-
|
|
204
|
-
The standalone function version of this method:
|
|
205
|
-
|
|
206
|
-
```typescript
|
|
207
|
-
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
208
|
-
import { invoicesGetMeterUsagePreviewInvoice } from "@flexprice/sdk/funcs/invoices-get-meter-usage-preview-invoice.js";
|
|
209
|
-
|
|
210
|
-
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
211
|
-
// You can create one instance of it to use across an application.
|
|
212
|
-
const flexprice = new FlexpriceCore({
|
|
213
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
214
|
-
});
|
|
215
|
-
|
|
216
|
-
async function run() {
|
|
217
|
-
const res = await invoicesGetMeterUsagePreviewInvoice(flexprice, {
|
|
218
|
-
subscriptionId: "<id>",
|
|
219
|
-
});
|
|
220
|
-
if (res.ok) {
|
|
221
|
-
const { value: result } = res;
|
|
222
|
-
console.log(result);
|
|
223
|
-
} else {
|
|
224
|
-
console.log("invoicesGetMeterUsagePreviewInvoice failed:", res.error);
|
|
225
|
-
}
|
|
226
|
-
}
|
|
227
|
-
|
|
228
|
-
run();
|
|
229
|
-
```
|
|
230
|
-
|
|
231
|
-
### Parameters
|
|
232
|
-
|
|
233
|
-
| Parameter | Type | Required | Description |
|
|
234
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
235
|
-
| `request` | [models.GetPreviewInvoiceRequest](../../sdk/models/get-preview-invoice-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
236
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
237
|
-
| `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. |
|
|
238
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
239
|
-
|
|
240
|
-
### Response
|
|
241
|
-
|
|
242
|
-
**Promise\<[models.InvoiceResponse](../../sdk/models/invoice-response.md)\>**
|
|
243
|
-
|
|
244
|
-
### Errors
|
|
245
|
-
|
|
246
|
-
| Error Type | Status Code | Content Type |
|
|
247
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
248
|
-
| models.ErrorsErrorResponse | 400 | application/json |
|
|
249
|
-
| models.ErrorsErrorResponse | 500 | application/json |
|
|
250
|
-
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
251
|
-
|
|
252
176
|
## getInvoicePreview
|
|
253
177
|
|
|
254
178
|
Use when showing a customer what they will be charged (e.g. preview before checkout or plan change). No invoice is created.
|
|
@@ -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: "trial_end",
|
|
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: "trial_end",
|
|
1498
1498
|
});
|
|
1499
1499
|
if (res.ok) {
|
|
1500
1500
|
const { value: result } = res;
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
* [createUser](#createuser) - Create user or service account
|
|
8
8
|
* [getUserInfo](#getuserinfo) - Get current user
|
|
9
|
+
* [updateUser](#updateuser) - Update current user
|
|
9
10
|
* [queryUser](#queryuser) - Query users
|
|
10
11
|
|
|
11
12
|
## createUser
|
|
@@ -153,6 +154,77 @@ run();
|
|
|
153
154
|
| models.ErrorsErrorResponse | 500 | application/json |
|
|
154
155
|
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
155
156
|
|
|
157
|
+
## updateUser
|
|
158
|
+
|
|
159
|
+
Update the current authenticated user. Only metadata updates are supported.
|
|
160
|
+
|
|
161
|
+
### Example Usage
|
|
162
|
+
|
|
163
|
+
<!-- UsageSnippet language="typescript" operationID="updateUser" method="put" path="/users/me" -->
|
|
164
|
+
```typescript
|
|
165
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
166
|
+
|
|
167
|
+
const flexprice = new Flexprice({
|
|
168
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
169
|
+
});
|
|
170
|
+
|
|
171
|
+
async function run() {
|
|
172
|
+
const result = await flexprice.users.updateUser({});
|
|
173
|
+
|
|
174
|
+
console.log(result);
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
run();
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
### Standalone function
|
|
181
|
+
|
|
182
|
+
The standalone function version of this method:
|
|
183
|
+
|
|
184
|
+
```typescript
|
|
185
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
186
|
+
import { usersUpdateUser } from "@flexprice/sdk/funcs/users-update-user.js";
|
|
187
|
+
|
|
188
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
189
|
+
// You can create one instance of it to use across an application.
|
|
190
|
+
const flexprice = new FlexpriceCore({
|
|
191
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
192
|
+
});
|
|
193
|
+
|
|
194
|
+
async function run() {
|
|
195
|
+
const res = await usersUpdateUser(flexprice, {});
|
|
196
|
+
if (res.ok) {
|
|
197
|
+
const { value: result } = res;
|
|
198
|
+
console.log(result);
|
|
199
|
+
} else {
|
|
200
|
+
console.log("usersUpdateUser failed:", res.error);
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
run();
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
### Parameters
|
|
208
|
+
|
|
209
|
+
| Parameter | Type | Required | Description |
|
|
210
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
211
|
+
| `request` | [models.UpdateUserRequest](../../sdk/models/update-user-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
212
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
213
|
+
| `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. |
|
|
214
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
215
|
+
|
|
216
|
+
### Response
|
|
217
|
+
|
|
218
|
+
**Promise\<[models.UpdateUserResponse](../../sdk/models/update-user-response.md)\>**
|
|
219
|
+
|
|
220
|
+
### Errors
|
|
221
|
+
|
|
222
|
+
| Error Type | Status Code | Content Type |
|
|
223
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
224
|
+
| models.ErrorsErrorResponse | 400 | application/json |
|
|
225
|
+
| models.ErrorsErrorResponse | 500 | application/json |
|
|
226
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
227
|
+
|
|
156
228
|
## queryUser
|
|
157
229
|
|
|
158
230
|
Use when listing or searching service accounts in an admin UI, or when auditing who has API access and which roles they have.
|
|
@@ -8,10 +8,10 @@ import { SDKValidationError } from "../sdk/models/sdk-validation-error.js";
|
|
|
8
8
|
import { APIPromise } from "../types/async.js";
|
|
9
9
|
import { Result } from "../types/fp.js";
|
|
10
10
|
/**
|
|
11
|
-
* Get
|
|
11
|
+
* Get entity integration mappings
|
|
12
12
|
*
|
|
13
13
|
* @remarks
|
|
14
|
-
*
|
|
14
|
+
* Get integration mappings for a specific entity by entity type and entity ID.
|
|
15
15
|
*/
|
|
16
|
-
export declare function
|
|
17
|
-
//# sourceMappingURL=
|
|
16
|
+
export declare function integrationsGetEntityIntegrationMappings(client: FlexpriceCore, entityType: string, entityId: string, options?: RequestOptions): APIPromise<Result<models.ListEntityIntegrationMappingsResponse, models.ErrorsErrorResponse | FlexPriceError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
17
|
+
//# sourceMappingURL=integrations-get-entity-integration-mappings.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"integrations-get-entity-integration-mappings.d.ts","sourceRoot":"","sources":["../../src/funcs/integrations-get-entity-integration-mappings.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAM3C,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,wCAAwC,CACtD,MAAM,EAAE,aAAa,EACrB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,MAAM,CAAC,qCAAqC,EAC1C,MAAM,CAAC,mBAAmB,GAC1B,cAAc,GACd,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAOA"}
|