@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,16 @@
|
|
|
1
|
+
# ListEntityIntegrationMappingsResponse
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ListEntityIntegrationMappingsResponse } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ListEntityIntegrationMappingsResponse = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
|
15
|
+
| `items` | [models.EntityIntegrationMappingResponse](../../sdk/models/entity-integration-mapping-response.md)[] | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `pagination` | [models.PaginationResponse](../../sdk/models/pagination-response.md) | :heavy_minus_sign: | N/A |
|
|
@@ -10,45 +10,46 @@ let value: PricePrice = {};
|
|
|
10
10
|
|
|
11
11
|
## Fields
|
|
12
12
|
|
|
13
|
-
| Field
|
|
14
|
-
|
|
|
15
|
-
| `amount`
|
|
16
|
-
| `billingCadence`
|
|
17
|
-
| `billingModel`
|
|
18
|
-
| `billingPeriod`
|
|
19
|
-
| `billingPeriodCount`
|
|
20
|
-
| `conversionRate`
|
|
21
|
-
| `createdAt`
|
|
22
|
-
| `createdBy`
|
|
23
|
-
| `currency`
|
|
24
|
-
| `description`
|
|
25
|
-
| `displayAmount`
|
|
26
|
-
| `displayName`
|
|
27
|
-
| `displayPriceUnitAmount`
|
|
28
|
-
| `endDate`
|
|
29
|
-
| `entityId`
|
|
30
|
-
| `entityType`
|
|
31
|
-
| `environmentId`
|
|
32
|
-
| `groupId`
|
|
33
|
-
| `id`
|
|
34
|
-
| `invoiceCadence`
|
|
35
|
-
| `lookupKey`
|
|
36
|
-
| `metadata`
|
|
37
|
-
| `meterId`
|
|
38
|
-
| `minQuantity`
|
|
39
|
-
| `parentPriceId`
|
|
40
|
-
| `priceUnit`
|
|
41
|
-
| `priceUnitAmount`
|
|
42
|
-
| `priceUnitId`
|
|
43
|
-
| `priceUnitTiers`
|
|
44
|
-
| `priceUnitType`
|
|
45
|
-
| `
|
|
46
|
-
| `
|
|
47
|
-
| `
|
|
48
|
-
| `
|
|
49
|
-
| `
|
|
50
|
-
| `
|
|
51
|
-
| `
|
|
52
|
-
| `
|
|
53
|
-
| `
|
|
54
|
-
| `
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
15
|
+
| `amount` | *string* | :heavy_minus_sign: | Amount stored in main currency units (e.g., dollars, not cents)<br/>For USD: 12.50 means $12.50 |
|
|
16
|
+
| `billingCadence` | [models.BillingCadence](../../sdk/models/billing-cadence.md) | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `billingModel` | [models.BillingModel](../../sdk/models/billing-model.md) | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `billingPeriod` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `billingPeriodCount` | *number* | :heavy_minus_sign: | BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12 |
|
|
20
|
+
| `conversionRate` | *string* | :heavy_minus_sign: | ConversionRate is the conversion rate of the price unit to the fiat currency |
|
|
21
|
+
| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
22
|
+
| `createdBy` | *string* | :heavy_minus_sign: | N/A |
|
|
23
|
+
| `currency` | *string* | :heavy_minus_sign: | Currency 3 digit ISO currency code in lowercase ex usd, eur, gbp |
|
|
24
|
+
| `description` | *string* | :heavy_minus_sign: | Description of the price |
|
|
25
|
+
| `displayAmount` | *string* | :heavy_minus_sign: | DisplayAmount is the formatted amount with currency symbol<br/>For USD: $12.50 |
|
|
26
|
+
| `displayName` | *string* | :heavy_minus_sign: | DisplayName is the name of the price |
|
|
27
|
+
| `displayPriceUnitAmount` | *string* | :heavy_minus_sign: | DisplayPriceUnitAmount is the formatted amount of the price unit |
|
|
28
|
+
| `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | EndDate is the end date of the price |
|
|
29
|
+
| `entityId` | *string* | :heavy_minus_sign: | EntityID holds the value of the "entity_id" field. |
|
|
30
|
+
| `entityType` | [models.PriceEntityType](../../sdk/models/price-entity-type.md) | :heavy_minus_sign: | N/A |
|
|
31
|
+
| `environmentId` | *string* | :heavy_minus_sign: | EnvironmentID is the environment identifier for the price |
|
|
32
|
+
| `groupId` | *string* | :heavy_minus_sign: | GroupID references the group this price belongs to |
|
|
33
|
+
| `id` | *string* | :heavy_minus_sign: | ID uuid identifier for the price |
|
|
34
|
+
| `invoiceCadence` | [models.InvoiceCadence](../../sdk/models/invoice-cadence.md) | :heavy_minus_sign: | N/A |
|
|
35
|
+
| `lookupKey` | *string* | :heavy_minus_sign: | LookupKey used for looking up the price in the database |
|
|
36
|
+
| `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
|
|
37
|
+
| `meterId` | *string* | :heavy_minus_sign: | MeterID is the id of the meter for usage based pricing |
|
|
38
|
+
| `minQuantity` | *string* | :heavy_minus_sign: | MinQuantity is the minimum quantity of the price |
|
|
39
|
+
| `parentPriceId` | *string* | :heavy_minus_sign: | ParentPriceID references the root price (always set for price lineage tracking) |
|
|
40
|
+
| `priceUnit` | *string* | :heavy_minus_sign: | PriceUnit is the code of the price unit (e.g., 'btc', 'eth') |
|
|
41
|
+
| `priceUnitAmount` | *string* | :heavy_minus_sign: | PriceUnitAmount is the amount of the price unit |
|
|
42
|
+
| `priceUnitId` | *string* | :heavy_minus_sign: | PriceUnitID is the id of the price unit (for CUSTOM type) |
|
|
43
|
+
| `priceUnitTiers` | [models.PricePriceTier](../../sdk/models/price-price-tier.md)[] | :heavy_minus_sign: | PriceUnitTiers are the tiers for the price unit when BillingModel is TIERED |
|
|
44
|
+
| `priceUnitType` | [models.PriceUnitType](../../sdk/models/price-unit-type.md) | :heavy_minus_sign: | N/A |
|
|
45
|
+
| `sequence` | *number* | :heavy_minus_sign: | Sequence is the monotonic stamp bumped on every state change that<br/>subscription line items need to react to. Read by the plan-price sync;<br/>set by the database (DEFAULT nextval) on create and by the price<br/>repository on termination / compatibility-affecting edits. |
|
|
46
|
+
| `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 price |
|
|
47
|
+
| `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
|
|
48
|
+
| `tenantId` | *string* | :heavy_minus_sign: | N/A |
|
|
49
|
+
| `tierMode` | [models.BillingTier](../../sdk/models/billing-tier.md) | :heavy_minus_sign: | N/A |
|
|
50
|
+
| `tiers` | [models.PricePriceTier](../../sdk/models/price-price-tier.md)[] | :heavy_minus_sign: | N/A |
|
|
51
|
+
| `transformQuantity` | [models.PriceJSONBTransformQuantity](../../sdk/models/price-jsonb-transform-quantity.md) | :heavy_minus_sign: | N/A |
|
|
52
|
+
| `trialPeriodDays` | *number* | :heavy_minus_sign: | TrialPeriodDays is the number of days for the trial period<br/>Note: This is only applicable for recurring prices (BILLING_CADENCE_RECURRING) |
|
|
53
|
+
| `type` | [models.PriceType](../../sdk/models/price-type.md) | :heavy_minus_sign: | N/A |
|
|
54
|
+
| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
55
|
+
| `updatedBy` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -38,50 +38,51 @@ let value: PriceResponse = {
|
|
|
38
38
|
|
|
39
39
|
## Fields
|
|
40
40
|
|
|
41
|
-
| Field
|
|
42
|
-
|
|
|
43
|
-
| `addon`
|
|
44
|
-
| `amount`
|
|
45
|
-
| `billingCadence`
|
|
46
|
-
| `billingModel`
|
|
47
|
-
| `billingPeriod`
|
|
48
|
-
| `billingPeriodCount`
|
|
49
|
-
| `conversionRate`
|
|
50
|
-
| `createdAt`
|
|
51
|
-
| `createdBy`
|
|
52
|
-
| `currency`
|
|
53
|
-
| `description`
|
|
54
|
-
| `displayAmount`
|
|
55
|
-
| `displayName`
|
|
56
|
-
| `displayPriceUnitAmount`
|
|
57
|
-
| `endDate`
|
|
58
|
-
| `entityId`
|
|
59
|
-
| `entityType`
|
|
60
|
-
| `environmentId`
|
|
61
|
-
| `group`
|
|
62
|
-
| `groupId`
|
|
63
|
-
| `id`
|
|
64
|
-
| `invoiceCadence`
|
|
65
|
-
| `lookupKey`
|
|
66
|
-
| `metadata`
|
|
67
|
-
| `meter`
|
|
68
|
-
| `meterId`
|
|
69
|
-
| `minQuantity`
|
|
70
|
-
| `parentPriceId`
|
|
71
|
-
| `plan`
|
|
72
|
-
| `priceUnit`
|
|
73
|
-
| `priceUnitAmount`
|
|
74
|
-
| `priceUnitId`
|
|
75
|
-
| `priceUnitTiers`
|
|
76
|
-
| `priceUnitType`
|
|
77
|
-
| `pricingUnit`
|
|
78
|
-
| `
|
|
79
|
-
| `
|
|
80
|
-
| `
|
|
81
|
-
| `
|
|
82
|
-
| `
|
|
83
|
-
| `
|
|
84
|
-
| `
|
|
85
|
-
| `
|
|
86
|
-
| `
|
|
87
|
-
| `
|
|
41
|
+
| Field | Type | Required | Description |
|
|
42
|
+
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
43
|
+
| `addon` | [models.AddonResponse](../../sdk/models/addon-response.md) | :heavy_minus_sign: | N/A |
|
|
44
|
+
| `amount` | *string* | :heavy_minus_sign: | Amount stored in main currency units (e.g., dollars, not cents)<br/>For USD: 12.50 means $12.50 |
|
|
45
|
+
| `billingCadence` | [models.BillingCadence](../../sdk/models/billing-cadence.md) | :heavy_minus_sign: | N/A |
|
|
46
|
+
| `billingModel` | [models.BillingModel](../../sdk/models/billing-model.md) | :heavy_minus_sign: | N/A |
|
|
47
|
+
| `billingPeriod` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
|
|
48
|
+
| `billingPeriodCount` | *number* | :heavy_minus_sign: | BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12 |
|
|
49
|
+
| `conversionRate` | *string* | :heavy_minus_sign: | ConversionRate is the conversion rate of the price unit to the fiat currency |
|
|
50
|
+
| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
51
|
+
| `createdBy` | *string* | :heavy_minus_sign: | N/A |
|
|
52
|
+
| `currency` | *string* | :heavy_minus_sign: | Currency 3 digit ISO currency code in lowercase ex usd, eur, gbp |
|
|
53
|
+
| `description` | *string* | :heavy_minus_sign: | Description of the price |
|
|
54
|
+
| `displayAmount` | *string* | :heavy_minus_sign: | DisplayAmount is the formatted amount with currency symbol<br/>For USD: $12.50 |
|
|
55
|
+
| `displayName` | *string* | :heavy_minus_sign: | DisplayName is the name of the price |
|
|
56
|
+
| `displayPriceUnitAmount` | *string* | :heavy_minus_sign: | DisplayPriceUnitAmount is the formatted amount of the price unit |
|
|
57
|
+
| `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | EndDate is the end date of the price |
|
|
58
|
+
| `entityId` | *string* | :heavy_minus_sign: | EntityID holds the value of the "entity_id" field. |
|
|
59
|
+
| `entityType` | [models.PriceEntityType](../../sdk/models/price-entity-type.md) | :heavy_minus_sign: | N/A |
|
|
60
|
+
| `environmentId` | *string* | :heavy_minus_sign: | EnvironmentID is the environment identifier for the price |
|
|
61
|
+
| `group` | [models.GroupResponse](../../sdk/models/group-response.md) | :heavy_minus_sign: | N/A |
|
|
62
|
+
| `groupId` | *string* | :heavy_minus_sign: | GroupID references the group this price belongs to |
|
|
63
|
+
| `id` | *string* | :heavy_minus_sign: | ID uuid identifier for the price |
|
|
64
|
+
| `invoiceCadence` | [models.InvoiceCadence](../../sdk/models/invoice-cadence.md) | :heavy_minus_sign: | N/A |
|
|
65
|
+
| `lookupKey` | *string* | :heavy_minus_sign: | LookupKey used for looking up the price in the database |
|
|
66
|
+
| `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
|
|
67
|
+
| `meter` | [models.MeterResponse](../../sdk/models/meter-response.md) | :heavy_minus_sign: | N/A |
|
|
68
|
+
| `meterId` | *string* | :heavy_minus_sign: | MeterID is the id of the meter for usage based pricing |
|
|
69
|
+
| `minQuantity` | *string* | :heavy_minus_sign: | MinQuantity is the minimum quantity of the price |
|
|
70
|
+
| `parentPriceId` | *string* | :heavy_minus_sign: | ParentPriceID references the root price (always set for price lineage tracking) |
|
|
71
|
+
| `plan` | [models.PlanResponse](../../sdk/models/plan-response.md) | :heavy_minus_sign: | N/A |
|
|
72
|
+
| `priceUnit` | *string* | :heavy_minus_sign: | PriceUnit is the code of the price unit (e.g., 'btc', 'eth') |
|
|
73
|
+
| `priceUnitAmount` | *string* | :heavy_minus_sign: | PriceUnitAmount is the amount of the price unit |
|
|
74
|
+
| `priceUnitId` | *string* | :heavy_minus_sign: | PriceUnitID is the id of the price unit (for CUSTOM type) |
|
|
75
|
+
| `priceUnitTiers` | [models.PricePriceTier](../../sdk/models/price-price-tier.md)[] | :heavy_minus_sign: | PriceUnitTiers are the tiers for the price unit when BillingModel is TIERED |
|
|
76
|
+
| `priceUnitType` | [models.PriceUnitType](../../sdk/models/price-unit-type.md) | :heavy_minus_sign: | N/A |
|
|
77
|
+
| `pricingUnit` | [models.PriceUnitResponse](../../sdk/models/price-unit-response.md) | :heavy_minus_sign: | N/A |
|
|
78
|
+
| `sequence` | *number* | :heavy_minus_sign: | Sequence is the monotonic stamp bumped on every state change that<br/>subscription line items need to react to. Read by the plan-price sync;<br/>set by the database (DEFAULT nextval) on create and by the price<br/>repository on termination / compatibility-affecting edits. |
|
|
79
|
+
| `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 price |
|
|
80
|
+
| `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
|
|
81
|
+
| `tenantId` | *string* | :heavy_minus_sign: | N/A |
|
|
82
|
+
| `tierMode` | [models.BillingTier](../../sdk/models/billing-tier.md) | :heavy_minus_sign: | N/A |
|
|
83
|
+
| `tiers` | [models.PricePriceTier](../../sdk/models/price-price-tier.md)[] | :heavy_minus_sign: | N/A |
|
|
84
|
+
| `transformQuantity` | [models.PriceJSONBTransformQuantity](../../sdk/models/price-jsonb-transform-quantity.md) | :heavy_minus_sign: | N/A |
|
|
85
|
+
| `trialPeriodDays` | *number* | :heavy_minus_sign: | TrialPeriodDays is the number of days for the trial period<br/>Note: This is only applicable for recurring prices (BILLING_CADENCE_RECURRING) |
|
|
86
|
+
| `type` | [models.PriceType](../../sdk/models/price-type.md) | :heavy_minus_sign: | N/A |
|
|
87
|
+
| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
88
|
+
| `updatedBy` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# S3ExportConfig
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { S3ExportConfig } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: S3ExportConfig = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
|
15
|
+
| `bucket` | *string* | :heavy_minus_sign: | S3 bucket name |
|
|
16
|
+
| `compression` | [models.S3CompressionType](../../sdk/models/s3-compression-type.md) | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `encryption` | [models.S3EncryptionType](../../sdk/models/s3-encryption-type.md) | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `isFlexpriceManaged` | *boolean* | :heavy_minus_sign: | If true, use Flexprice-managed S3 credentials instead of user-provided |
|
|
19
|
+
| `keyPrefix` | *string* | :heavy_minus_sign: | Optional prefix for S3 keys (e.g., "flexprice-exports/") |
|
|
20
|
+
| `region` | *string* | :heavy_minus_sign: | AWS region (e.g., "us-west-2") |
|
|
@@ -13,5 +13,5 @@ let value: SecretProvider = "quickbooks";
|
|
|
13
13
|
## Values
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
"flexprice" | "stripe" | "s3" | "hubspot" | "razorpay" | "chargebee" | "quickbooks" | "zoho_books" | "nomod" | "moyasar" | "paddle" | Unrecognized<string>
|
|
16
|
+
"flexprice" | "stripe" | "s3" | "hubspot" | "razorpay" | "chargebee" | "quickbooks" | "zoho_books" | "nomod" | "moyasar" | "paddle" | "whop" | Unrecognized<string>
|
|
17
17
|
```
|