@flexprice/sdk 2.1.40 → 2.1.41
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/analytics-query-meta.md +5 -1
- package/docs/sdk/models/analytics-query-request.md +1 -1
- package/docs/sdk/models/analytics-view-definition-compare.md +17 -0
- package/docs/sdk/models/analytics-view-definition.md +15 -12
- package/docs/sdk/models/cancel-self-billing-checkout-request.md +17 -0
- package/docs/sdk/models/create-view-request.md +1 -1
- package/docs/sdk/models/default-shape.md +17 -0
- package/docs/sdk/models/delete-analytics-view-request.md +17 -0
- package/docs/sdk/models/dir.md +15 -0
- package/docs/sdk/models/display.md +17 -0
- package/docs/sdk/models/family.md +2 -2
- package/docs/sdk/models/get-analytics-view-request.md +17 -0
- package/docs/sdk/models/improvement-direction.md +17 -0
- package/docs/sdk/models/invoice-response.md +1 -0
- package/docs/sdk/models/list-analytics-views-request.md +15 -0
- package/docs/sdk/models/list-views-response.md +15 -0
- package/docs/sdk/models/metric.md +2 -2
- package/docs/sdk/models/op.md +15 -0
- package/docs/sdk/models/poll-self-billing-checkout-request.md +17 -0
- package/docs/sdk/models/report-catalog-entry-grain.md +17 -0
- package/docs/sdk/models/report-catalog-entry-shape.md +17 -0
- package/docs/sdk/models/report-catalog-entry.md +29 -0
- package/docs/sdk/models/report-catalog-response.md +15 -0
- package/docs/sdk/models/report-category.md +17 -0
- package/docs/sdk/models/report-dimension.md +16 -0
- package/docs/sdk/models/report-filter.md +17 -0
- package/docs/sdk/models/report-kind.md +17 -0
- package/docs/sdk/models/report-query-request-compare.md +15 -0
- package/docs/sdk/models/report-query-request-grain.md +15 -0
- package/docs/sdk/models/report-query-request-shape.md +15 -0
- package/docs/sdk/models/report-query-request.md +26 -0
- package/docs/sdk/models/report-sort.md +16 -0
- package/docs/sdk/models/report-value-type.md +17 -0
- package/docs/sdk/models/run-analytics-report-request.md +22 -0
- package/docs/sdk/models/self-billing-checkout-request.md +30 -0
- package/docs/sdk/models/self-billing-checkout-response.md +19 -0
- package/docs/sdk/models/self-billing-invoice.md +22 -0
- package/docs/sdk/models/self-billing-portal-response.md +16 -0
- package/docs/sdk/models/self-billing-status-response.md +16 -0
- package/docs/sdk/models/self-billing-summary-response.md +37 -0
- package/docs/sdk/models/tenant-internal-status.md +17 -0
- package/docs/sdk/models/top-up-wallet-request.md +1 -0
- package/docs/sdk/models/update-analytics-view-request.md +27 -0
- package/docs/sdk/models/view-response.md +9 -6
- package/docs/sdks/analytics/README.md +455 -4
- package/docs/sdks/selfbilling/README.md +517 -0
- package/docs/sdks/tenants/README.md +0 -71
- package/esm/funcs/{tenants-get-tenant-billing-usage.d.ts → analytics-delete-analytics-view.d.ts} +4 -4
- package/esm/funcs/analytics-delete-analytics-view.d.ts.map +1 -0
- package/esm/funcs/analytics-delete-analytics-view.js +91 -0
- package/esm/funcs/analytics-delete-analytics-view.js.map +1 -0
- package/esm/funcs/analytics-get-analytics-view.d.ts +17 -0
- package/esm/funcs/analytics-get-analytics-view.d.ts.map +1 -0
- package/esm/funcs/analytics-get-analytics-view.js +91 -0
- package/esm/funcs/analytics-get-analytics-view.js.map +1 -0
- package/esm/funcs/analytics-list-analytics-reports.d.ts +17 -0
- package/esm/funcs/{tenants-get-tenant-billing-usage.d.ts.map → analytics-list-analytics-reports.d.ts.map} +1 -1
- package/esm/funcs/analytics-list-analytics-reports.js +72 -0
- package/esm/funcs/{tenants-get-tenant-billing-usage.js.map → analytics-list-analytics-reports.js.map} +1 -1
- package/esm/funcs/analytics-list-analytics-views.d.ts +17 -0
- package/esm/funcs/analytics-list-analytics-views.d.ts.map +1 -0
- package/esm/funcs/analytics-list-analytics-views.js +89 -0
- package/esm/funcs/analytics-list-analytics-views.js.map +1 -0
- package/esm/funcs/analytics-run-analytics-report.d.ts +17 -0
- package/esm/funcs/analytics-run-analytics-report.d.ts.map +1 -0
- package/esm/funcs/analytics-run-analytics-report.js +93 -0
- package/esm/funcs/analytics-run-analytics-report.js.map +1 -0
- package/esm/funcs/analytics-update-analytics-view.d.ts +17 -0
- package/esm/funcs/analytics-update-analytics-view.d.ts.map +1 -0
- package/esm/funcs/analytics-update-analytics-view.js +93 -0
- package/esm/funcs/analytics-update-analytics-view.js.map +1 -0
- package/esm/funcs/self-billing-cancel-self-billing-checkout.d.ts +16 -0
- package/esm/funcs/self-billing-cancel-self-billing-checkout.d.ts.map +1 -0
- package/esm/funcs/self-billing-cancel-self-billing-checkout.js +88 -0
- package/esm/funcs/self-billing-cancel-self-billing-checkout.js.map +1 -0
- package/esm/funcs/self-billing-create-self-billing-portal-session.d.ts +17 -0
- package/esm/funcs/self-billing-create-self-billing-portal-session.d.ts.map +1 -0
- package/esm/funcs/{tenants-get-tenant-billing-usage.js → self-billing-create-self-billing-portal-session.js} +8 -8
- package/esm/funcs/self-billing-create-self-billing-portal-session.js.map +1 -0
- package/esm/funcs/self-billing-get-self-billing-status.d.ts +17 -0
- package/esm/funcs/self-billing-get-self-billing-status.d.ts.map +1 -0
- package/esm/funcs/self-billing-get-self-billing-status.js +72 -0
- package/esm/funcs/self-billing-get-self-billing-status.js.map +1 -0
- package/esm/funcs/self-billing-get-self-billing-summary.d.ts +17 -0
- package/esm/funcs/self-billing-get-self-billing-summary.d.ts.map +1 -0
- package/esm/funcs/self-billing-get-self-billing-summary.js +72 -0
- package/esm/funcs/self-billing-get-self-billing-summary.js.map +1 -0
- package/esm/funcs/self-billing-get-tenant-billing-summary.d.ts +17 -0
- package/esm/funcs/self-billing-get-tenant-billing-summary.d.ts.map +1 -0
- package/esm/funcs/self-billing-get-tenant-billing-summary.js +72 -0
- package/esm/funcs/self-billing-get-tenant-billing-summary.js.map +1 -0
- package/esm/funcs/self-billing-poll-self-billing-checkout.d.ts +17 -0
- package/esm/funcs/self-billing-poll-self-billing-checkout.d.ts.map +1 -0
- package/esm/funcs/self-billing-poll-self-billing-checkout.js +91 -0
- package/esm/funcs/self-billing-poll-self-billing-checkout.js.map +1 -0
- package/esm/funcs/self-billing-start-self-billing-checkout.d.ts +17 -0
- package/esm/funcs/self-billing-start-self-billing-checkout.d.ts.map +1 -0
- package/esm/funcs/self-billing-start-self-billing-checkout.js +83 -0
- package/esm/funcs/self-billing-start-self-billing-checkout.js.map +1 -0
- package/esm/lib/config.d.ts +2 -2
- package/esm/lib/config.js +2 -2
- package/esm/sdk/analytics.d.ts +42 -0
- package/esm/sdk/analytics.d.ts.map +1 -1
- package/esm/sdk/analytics.js +60 -0
- package/esm/sdk/analytics.js.map +1 -1
- package/esm/sdk/models/analytics-query-meta.d.ts +4 -0
- package/esm/sdk/models/analytics-query-meta.d.ts.map +1 -1
- package/esm/sdk/models/analytics-query-meta.js +6 -0
- package/esm/sdk/models/analytics-query-meta.js.map +1 -1
- package/esm/sdk/models/analytics-view-definition.d.ts +25 -0
- package/esm/sdk/models/analytics-view-definition.d.ts.map +1 -1
- package/esm/sdk/models/analytics-view-definition.js +25 -0
- package/esm/sdk/models/analytics-view-definition.js.map +1 -1
- package/esm/sdk/models/cancel-self-billing-checkout-op.d.ts +15 -0
- package/esm/sdk/models/cancel-self-billing-checkout-op.d.ts.map +1 -0
- package/esm/sdk/models/cancel-self-billing-checkout-op.js +12 -0
- package/esm/sdk/models/cancel-self-billing-checkout-op.js.map +1 -0
- package/esm/sdk/models/delete-analytics-view-op.d.ts +15 -0
- package/esm/sdk/models/delete-analytics-view-op.d.ts.map +1 -0
- package/esm/sdk/models/delete-analytics-view-op.js +12 -0
- package/esm/sdk/models/delete-analytics-view-op.js.map +1 -0
- package/esm/sdk/models/family.d.ts +1 -0
- package/esm/sdk/models/family.d.ts.map +1 -1
- package/esm/sdk/models/family.js +1 -0
- package/esm/sdk/models/family.js.map +1 -1
- package/esm/sdk/models/get-analytics-view-op.d.ts +15 -0
- package/esm/sdk/models/get-analytics-view-op.d.ts.map +1 -0
- package/esm/sdk/models/get-analytics-view-op.js +12 -0
- package/esm/sdk/models/get-analytics-view-op.js.map +1 -0
- package/esm/sdk/models/improvement-direction.d.ts +10 -0
- package/esm/sdk/models/improvement-direction.d.ts.map +1 -0
- package/esm/sdk/models/improvement-direction.js +11 -0
- package/esm/sdk/models/improvement-direction.js.map +1 -0
- package/esm/sdk/models/index.d.ts +25 -1
- package/esm/sdk/models/index.d.ts.map +1 -1
- package/esm/sdk/models/index.js +25 -1
- package/esm/sdk/models/index.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/list-analytics-views-op.d.ts +15 -0
- package/esm/sdk/models/list-analytics-views-op.d.ts.map +1 -0
- package/esm/sdk/models/list-analytics-views-op.js +12 -0
- package/esm/sdk/models/list-analytics-views-op.js.map +1 -0
- package/esm/sdk/models/list-views-response.d.ts +11 -0
- package/esm/sdk/models/list-views-response.d.ts.map +1 -0
- package/esm/sdk/models/list-views-response.js +15 -0
- package/esm/sdk/models/list-views-response.js.map +1 -0
- package/esm/sdk/models/metric.d.ts +12 -0
- package/esm/sdk/models/metric.d.ts.map +1 -1
- package/esm/sdk/models/metric.js +12 -0
- package/esm/sdk/models/metric.js.map +1 -1
- package/esm/sdk/models/poll-self-billing-checkout-op.d.ts +15 -0
- package/esm/sdk/models/poll-self-billing-checkout-op.d.ts.map +1 -0
- package/esm/sdk/models/poll-self-billing-checkout-op.js +12 -0
- package/esm/sdk/models/poll-self-billing-checkout-op.js.map +1 -0
- package/esm/sdk/models/report-catalog-entry.d.ts +54 -0
- package/esm/sdk/models/report-catalog-entry.d.ts.map +1 -0
- package/esm/sdk/models/report-catalog-entry.js +65 -0
- package/esm/sdk/models/report-catalog-entry.js.map +1 -0
- package/esm/sdk/models/report-catalog-response.d.ts +11 -0
- package/esm/sdk/models/report-catalog-response.d.ts.map +1 -0
- package/esm/sdk/models/report-catalog-response.js +15 -0
- package/esm/sdk/models/report-catalog-response.js.map +1 -0
- package/esm/sdk/models/report-category.d.ts +13 -0
- package/esm/sdk/models/report-category.d.ts.map +1 -0
- package/esm/sdk/models/report-category.js +14 -0
- package/esm/sdk/models/report-category.js.map +1 -0
- package/esm/sdk/models/report-dimension.d.ts +11 -0
- package/esm/sdk/models/report-dimension.d.ts.map +1 -0
- package/esm/sdk/models/report-dimension.js +15 -0
- package/esm/sdk/models/report-dimension.js.map +1 -0
- package/esm/sdk/models/report-filter.d.ts +24 -0
- package/esm/sdk/models/report-filter.d.ts.map +1 -0
- package/esm/sdk/models/report-filter.js +20 -0
- package/esm/sdk/models/report-filter.js.map +1 -0
- package/esm/sdk/models/report-kind.d.ts +11 -0
- package/esm/sdk/models/report-kind.d.ts.map +1 -0
- package/esm/sdk/models/report-kind.js +12 -0
- package/esm/sdk/models/report-kind.js.map +1 -0
- package/esm/sdk/models/report-query-request.d.ts +54 -0
- package/esm/sdk/models/report-query-request.d.ts.map +1 -0
- package/esm/sdk/models/report-query-request.js +42 -0
- package/esm/sdk/models/report-query-request.js.map +1 -0
- package/esm/sdk/models/report-sort.d.ts +22 -0
- package/esm/sdk/models/report-sort.d.ts.map +1 -0
- package/esm/sdk/models/report-sort.js +19 -0
- package/esm/sdk/models/report-sort.js.map +1 -0
- package/esm/sdk/models/report-value-type.d.ts +11 -0
- package/esm/sdk/models/report-value-type.d.ts.map +1 -0
- package/esm/sdk/models/report-value-type.js +12 -0
- package/esm/sdk/models/report-value-type.js.map +1 -0
- package/esm/sdk/models/run-analytics-report-op.d.ts +21 -0
- package/esm/sdk/models/run-analytics-report-op.d.ts.map +1 -0
- package/esm/sdk/models/run-analytics-report-op.js +14 -0
- package/esm/sdk/models/run-analytics-report-op.js.map +1 -0
- package/esm/sdk/models/self-billing-checkout-request.d.ts +28 -0
- package/esm/sdk/models/self-billing-checkout-request.d.ts.map +1 -0
- package/esm/sdk/models/self-billing-checkout-request.js +31 -0
- package/esm/sdk/models/self-billing-checkout-request.js.map +1 -0
- package/esm/sdk/models/self-billing-checkout-response.d.ts +16 -0
- package/esm/sdk/models/self-billing-checkout-response.d.ts.map +1 -0
- package/esm/sdk/models/self-billing-checkout-response.js +26 -0
- package/esm/sdk/models/self-billing-checkout-response.js.map +1 -0
- package/esm/sdk/models/self-billing-invoice.d.ts +19 -0
- package/esm/sdk/models/self-billing-invoice.d.ts.map +1 -0
- package/esm/sdk/models/self-billing-invoice.js +30 -0
- package/esm/sdk/models/self-billing-invoice.js.map +1 -0
- package/esm/sdk/models/self-billing-portal-response.d.ts +11 -0
- package/esm/sdk/models/self-billing-portal-response.d.ts.map +1 -0
- package/esm/sdk/models/self-billing-portal-response.js +20 -0
- package/esm/sdk/models/self-billing-portal-response.js.map +1 -0
- package/esm/sdk/models/self-billing-status-response.d.ts +12 -0
- package/esm/sdk/models/self-billing-status-response.d.ts.map +1 -0
- package/esm/sdk/models/self-billing-status-response.js +16 -0
- package/esm/sdk/models/self-billing-status-response.js.map +1 -0
- package/esm/sdk/models/self-billing-summary-response.d.ts +18 -0
- package/esm/sdk/models/self-billing-summary-response.d.ts.map +1 -0
- package/esm/sdk/models/self-billing-summary-response.js +28 -0
- package/esm/sdk/models/self-billing-summary-response.js.map +1 -0
- package/esm/sdk/models/tenant-internal-status.d.ts +11 -0
- package/esm/sdk/models/tenant-internal-status.d.ts.map +1 -0
- package/esm/sdk/models/tenant-internal-status.js +12 -0
- package/esm/sdk/models/tenant-internal-status.js.map +1 -0
- package/esm/sdk/models/top-up-wallet-request.d.ts +8 -0
- package/esm/sdk/models/top-up-wallet-request.d.ts.map +1 -1
- package/esm/sdk/models/top-up-wallet-request.js +2 -0
- package/esm/sdk/models/top-up-wallet-request.js.map +1 -1
- package/esm/sdk/models/update-analytics-view-op.d.ts +21 -0
- package/esm/sdk/models/update-analytics-view-op.d.ts.map +1 -0
- package/esm/sdk/models/update-analytics-view-op.js +14 -0
- package/esm/sdk/models/update-analytics-view-op.js.map +1 -0
- package/esm/sdk/models/view-response.d.ts +3 -0
- package/esm/sdk/models/view-response.d.ts.map +1 -1
- package/esm/sdk/models/view-response.js +12 -2
- package/esm/sdk/models/view-response.js.map +1 -1
- package/esm/sdk/sdk.d.ts +3 -0
- package/esm/sdk/sdk.d.ts.map +1 -1
- package/esm/sdk/sdk.js +5 -0
- package/esm/sdk/sdk.js.map +1 -1
- package/esm/sdk/self-billing.d.ts +54 -0
- package/esm/sdk/self-billing.d.ts.map +1 -0
- package/esm/sdk/self-billing.js +78 -0
- package/esm/sdk/self-billing.js.map +1 -0
- package/esm/sdk/tenants.d.ts +0 -7
- package/esm/sdk/tenants.d.ts.map +1 -1
- package/esm/sdk/tenants.js +0 -10
- package/esm/sdk/tenants.js.map +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/analytics-delete-analytics-view.ts +181 -0
- package/src/funcs/analytics-get-analytics-view.ts +181 -0
- package/src/funcs/{tenants-get-tenant-billing-usage.ts → analytics-list-analytics-reports.ts} +10 -10
- package/src/funcs/analytics-list-analytics-views.ts +184 -0
- package/src/funcs/analytics-run-analytics-report.ts +186 -0
- package/src/funcs/analytics-update-analytics-view.ts +186 -0
- package/src/funcs/self-billing-cancel-self-billing-checkout.ts +173 -0
- package/src/funcs/self-billing-create-self-billing-portal-session.ts +153 -0
- package/src/funcs/self-billing-get-self-billing-status.ts +152 -0
- package/src/funcs/self-billing-get-self-billing-summary.ts +153 -0
- package/src/funcs/self-billing-get-tenant-billing-summary.ts +153 -0
- package/src/funcs/self-billing-poll-self-billing-checkout.ts +182 -0
- package/src/funcs/self-billing-start-self-billing-checkout.ts +172 -0
- package/src/lib/config.ts +2 -2
- package/src/sdk/analytics.ts +110 -0
- package/src/sdk/models/analytics-query-meta.ts +10 -0
- package/src/sdk/models/analytics-view-definition.ts +46 -0
- package/src/sdk/models/cancel-self-billing-checkout-op.ts +35 -0
- package/src/sdk/models/delete-analytics-view-op.ts +33 -0
- package/src/sdk/models/family.ts +1 -0
- package/src/sdk/models/get-analytics-view-op.ts +33 -0
- package/src/sdk/models/improvement-direction.ts +19 -0
- package/src/sdk/models/index.ts +25 -1
- package/src/sdk/models/invoice-response.ts +6 -0
- package/src/sdk/models/list-analytics-views-op.ts +33 -0
- package/src/sdk/models/list-views-response.ts +32 -0
- package/src/sdk/models/metric.ts +12 -0
- package/src/sdk/models/poll-self-billing-checkout-op.ts +35 -0
- package/src/sdk/models/report-catalog-entry.ts +128 -0
- package/src/sdk/models/report-catalog-response.ts +35 -0
- package/src/sdk/models/report-category.ts +22 -0
- package/src/sdk/models/report-dimension.ts +33 -0
- package/src/sdk/models/report-filter.ts +42 -0
- package/src/sdk/models/report-kind.ts +18 -0
- package/src/sdk/models/report-query-request.ts +106 -0
- package/src/sdk/models/report-sort.ts +39 -0
- package/src/sdk/models/report-value-type.ts +20 -0
- package/src/sdk/models/run-analytics-report-op.ts +44 -0
- package/src/sdk/models/self-billing-checkout-request.ts +68 -0
- package/src/sdk/models/self-billing-checkout-response.ts +56 -0
- package/src/sdk/models/self-billing-invoice.ts +63 -0
- package/src/sdk/models/self-billing-portal-response.ts +41 -0
- package/src/sdk/models/self-billing-status-response.ts +37 -0
- package/src/sdk/models/self-billing-summary-response.ts +64 -0
- package/src/sdk/models/tenant-internal-status.ts +20 -0
- package/src/sdk/models/top-up-wallet-request.ts +12 -0
- package/src/sdk/models/update-analytics-view-op.ts +44 -0
- package/src/sdk/models/view-response.ts +22 -6
- package/src/sdk/sdk.ts +6 -0
- package/src/sdk/self-billing.ts +127 -0
- package/src/sdk/tenants.ts +0 -16
- package/docs/sdk/models/tenant-billing-usage.md +0 -144
- package/esm/sdk/models/tenant-billing-usage.d.ts +0 -13
- package/esm/sdk/models/tenant-billing-usage.d.ts.map +0 -1
- package/esm/sdk/models/tenant-billing-usage.js +0 -17
- package/esm/sdk/models/tenant-billing-usage.js.map +0 -1
- package/src/sdk/models/tenant-billing-usage.ts +0 -41
|
@@ -12,4 +12,8 @@ let value: AnalyticsQueryMeta = {};
|
|
|
12
12
|
|
|
13
13
|
| Field | Type | Required | Description |
|
|
14
14
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
15
|
-
| `
|
|
15
|
+
| `from` | *string* | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `prevFrom` | *string* | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `prevTo` | *string* | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `querySource` | *string* | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `to` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# AnalyticsViewDefinitionCompare
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { AnalyticsViewDefinitionCompare } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: AnalyticsViewDefinitionCompare = "previous_year";
|
|
9
|
+
|
|
10
|
+
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Values
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
"previous_period" | "previous_year" | Unrecognized<string>
|
|
17
|
+
```
|
|
@@ -7,7 +7,7 @@ import { AnalyticsViewDefinition } from "@flexprice/sdk/sdk/models";
|
|
|
7
7
|
|
|
8
8
|
let value: AnalyticsViewDefinition = {
|
|
9
9
|
metrics: [
|
|
10
|
-
"
|
|
10
|
+
"arpu_paid",
|
|
11
11
|
],
|
|
12
12
|
shape: "breakdown",
|
|
13
13
|
};
|
|
@@ -15,14 +15,17 @@ let value: AnalyticsViewDefinition = {
|
|
|
15
15
|
|
|
16
16
|
## Fields
|
|
17
17
|
|
|
18
|
-
| Field
|
|
19
|
-
|
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
23
|
-
| `
|
|
24
|
-
| `
|
|
25
|
-
| `
|
|
26
|
-
| `
|
|
27
|
-
| `
|
|
28
|
-
| `
|
|
18
|
+
| Field | Type | Required | Description |
|
|
19
|
+
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
|
20
|
+
| `compare` | [models.AnalyticsViewDefinitionCompare](../../sdk/models/analytics-view-definition-compare.md) | :heavy_minus_sign: | N/A |
|
|
21
|
+
| `currency` | *string* | :heavy_minus_sign: | N/A |
|
|
22
|
+
| `dimensions` | *string*[] | :heavy_minus_sign: | N/A |
|
|
23
|
+
| `display` | [models.Display](../../sdk/models/display.md) | :heavy_minus_sign: | N/A |
|
|
24
|
+
| `family` | [models.Family](../../sdk/models/family.md) | :heavy_minus_sign: | N/A |
|
|
25
|
+
| `filters` | [models.AnalyticsFilter](../../sdk/models/analytics-filter.md)[] | :heavy_minus_sign: | N/A |
|
|
26
|
+
| `limit` | *number* | :heavy_minus_sign: | N/A |
|
|
27
|
+
| `metrics` | [models.Metric](../../sdk/models/metric.md)[] | :heavy_check_mark: | N/A |
|
|
28
|
+
| `shape` | [models.Shape](../../sdk/models/shape.md) | :heavy_check_mark: | N/A |
|
|
29
|
+
| `sort` | [models.AnalyticsSortSpec](../../sdk/models/analytics-sort-spec.md)[] | :heavy_minus_sign: | N/A |
|
|
30
|
+
| `time` | [models.AnalyticsTimeSpecRaw](../../sdk/models/analytics-time-spec-raw.md) | :heavy_minus_sign: | N/A |
|
|
31
|
+
| `variables` | [models.AnalyticsVariable](../../sdk/models/analytics-variable.md)[] | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# CancelSelfBillingCheckoutRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { CancelSelfBillingCheckoutRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: CancelSelfBillingCheckoutRequest = {
|
|
9
|
+
id: "<id>",
|
|
10
|
+
};
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Fields
|
|
14
|
+
|
|
15
|
+
| Field | Type | Required | Description |
|
|
16
|
+
| ------------------- | ------------------- | ------------------- | ------------------- |
|
|
17
|
+
| `id` | *string* | :heavy_check_mark: | Checkout session ID |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# DefaultShape
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { DefaultShape } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: DefaultShape = "breakdown";
|
|
9
|
+
|
|
10
|
+
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Values
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
"timeseries" | "breakdown" | "scalar" | Unrecognized<string>
|
|
17
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# DeleteAnalyticsViewRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { DeleteAnalyticsViewRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: DeleteAnalyticsViewRequest = {
|
|
9
|
+
id: "<id>",
|
|
10
|
+
};
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Fields
|
|
14
|
+
|
|
15
|
+
| Field | Type | Required | Description |
|
|
16
|
+
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
17
|
+
| `id` | *string* | :heavy_check_mark: | View ID |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Display
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { Display } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: Display = "chart";
|
|
9
|
+
|
|
10
|
+
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Values
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
"chart" | "table" | Unrecognized<string>
|
|
17
|
+
```
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
```typescript
|
|
6
6
|
import { Family } from "@flexprice/sdk/sdk/models";
|
|
7
7
|
|
|
8
|
-
let value: Family = "
|
|
8
|
+
let value: Family = "billing";
|
|
9
9
|
|
|
10
10
|
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
11
|
```
|
|
@@ -13,5 +13,5 @@ let value: Family = "usage";
|
|
|
13
13
|
## Values
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
"usage" | "billing" | Unrecognized<string>
|
|
16
|
+
"usage" | "billing" | "report" | Unrecognized<string>
|
|
17
17
|
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# GetAnalyticsViewRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { GetAnalyticsViewRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: GetAnalyticsViewRequest = {
|
|
9
|
+
id: "<id>",
|
|
10
|
+
};
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Fields
|
|
14
|
+
|
|
15
|
+
| Field | Type | Required | Description |
|
|
16
|
+
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
17
|
+
| `id` | *string* | :heavy_check_mark: | View ID |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# ImprovementDirection
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ImprovementDirection } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ImprovementDirection = "lower";
|
|
9
|
+
|
|
10
|
+
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Values
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
"higher" | "lower" | Unrecognized<string>
|
|
17
|
+
```
|
|
@@ -141,6 +141,7 @@ let value: InvoiceResponse = {
|
|
|
141
141
|
| `environmentId` | *string* | :heavy_minus_sign: | environment_id is the ID of the environment this invoice belongs to (for multi-environment setups) |
|
|
142
142
|
| `finalizedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | finalized_at is the timestamp when this invoice was finalized and made ready for payment |
|
|
143
143
|
| `fxConversion` | [models.FxConversion](../../sdk/models/fx-conversion.md) | :heavy_minus_sign: | N/A |
|
|
144
|
+
| `hostedInvoiceUrl` | *string* | :heavy_minus_sign: | hosted_invoice_url is the page where the customer can view, download and pay this invoice |
|
|
144
145
|
| `id` | *string* | :heavy_minus_sign: | id is the unique identifier for this invoice |
|
|
145
146
|
| `idempotencyKey` | *string* | :heavy_minus_sign: | idempotency_key is a unique key used to prevent duplicate invoice creation when retrying API calls |
|
|
146
147
|
| `invoiceNumber` | *string* | :heavy_minus_sign: | invoice_number is the human-readable invoice number displayed to customers (e.g., INV-2024-001) |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# ListAnalyticsViewsRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ListAnalyticsViewsRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ListAnalyticsViewsRequest = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| --------------------- | --------------------- | --------------------- | --------------------- |
|
|
15
|
+
| `family` | *string* | :heavy_minus_sign: | Filter by view family |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# ListViewsResponse
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ListViewsResponse } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ListViewsResponse = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
|
15
|
+
| `items` | [models.ViewResponse](../../sdk/models/view-response.md)[] | :heavy_minus_sign: | N/A |
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
```typescript
|
|
6
6
|
import { Metric } from "@flexprice/sdk/sdk/models";
|
|
7
7
|
|
|
8
|
-
let value: Metric = "
|
|
8
|
+
let value: Metric = "invoice_total_issued";
|
|
9
9
|
|
|
10
10
|
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
11
|
```
|
|
@@ -13,5 +13,5 @@ let value: Metric = "invoice_total";
|
|
|
13
13
|
## Values
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
"usage_quantity" | "event_count" | "invoice_total" | Unrecognized<string>
|
|
16
|
+
"usage_quantity" | "event_count" | "events_volume" | "invoice_total" | "total_receivables" | "receivables_aging" | "days_to_pay" | "arpu" | "arpu_paid" | "credit_consumption" | "credit_topups" | "net_billing" | "invoice_total_issued" | "net_billing_issued" | "active_customers" | Unrecognized<string>
|
|
17
17
|
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# PollSelfBillingCheckoutRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { PollSelfBillingCheckoutRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: PollSelfBillingCheckoutRequest = {
|
|
9
|
+
id: "<id>",
|
|
10
|
+
};
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Fields
|
|
14
|
+
|
|
15
|
+
| Field | Type | Required | Description |
|
|
16
|
+
| ------------------- | ------------------- | ------------------- | ------------------- |
|
|
17
|
+
| `id` | *string* | :heavy_check_mark: | Checkout session ID |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# ReportCatalogEntryGrain
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ReportCatalogEntryGrain } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ReportCatalogEntryGrain = "month";
|
|
9
|
+
|
|
10
|
+
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Values
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
"day" | "week" | "month" | Unrecognized<string>
|
|
17
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# ReportCatalogEntryShape
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ReportCatalogEntryShape } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ReportCatalogEntryShape = "scalar";
|
|
9
|
+
|
|
10
|
+
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Values
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
"timeseries" | "breakdown" | "scalar" | Unrecognized<string>
|
|
17
|
+
```
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# ReportCatalogEntry
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ReportCatalogEntry } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ReportCatalogEntry = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
|
15
|
+
| `category` | [models.ReportCategory](../../sdk/models/report-category.md) | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `defaultShape` | [models.DefaultShape](../../sdk/models/default-shape.md) | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `description` | *string* | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `dimensions` | [models.ReportDimension](../../sdk/models/report-dimension.md)[] | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `grains` | [models.ReportCatalogEntryGrain](../../sdk/models/report-catalog-entry-grain.md)[] | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `improvement` | [models.ImprovementDirection](../../sdk/models/improvement-direction.md) | :heavy_minus_sign: | N/A |
|
|
21
|
+
| `key` | *string* | :heavy_minus_sign: | N/A |
|
|
22
|
+
| `kind` | [models.ReportKind](../../sdk/models/report-kind.md) | :heavy_minus_sign: | N/A |
|
|
23
|
+
| `maxRangeDays` | *number* | :heavy_minus_sign: | N/A |
|
|
24
|
+
| `name` | *string* | :heavy_minus_sign: | N/A |
|
|
25
|
+
| `shapes` | [models.ReportCatalogEntryShape](../../sdk/models/report-catalog-entry-shape.md)[] | :heavy_minus_sign: | N/A |
|
|
26
|
+
| `supportsCompare` | *boolean* | :heavy_minus_sign: | N/A |
|
|
27
|
+
| `valueType` | [models.ReportValueType](../../sdk/models/report-value-type.md) | :heavy_minus_sign: | N/A |
|
|
28
|
+
| `variantLabel` | *string* | :heavy_minus_sign: | N/A |
|
|
29
|
+
| `variantOf` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# ReportCatalogResponse
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ReportCatalogResponse } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ReportCatalogResponse = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
|
15
|
+
| `items` | [models.ReportCatalogEntry](../../sdk/models/report-catalog-entry.md)[] | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# ReportCategory
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ReportCategory } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ReportCategory = "customers";
|
|
9
|
+
|
|
10
|
+
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Values
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
"billing" | "receivables" | "customers" | "credits" | "usage" | Unrecognized<string>
|
|
17
|
+
```
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# ReportDimension
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ReportDimension } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ReportDimension = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
15
|
+
| `key` | *string* | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `label` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# ReportFilter
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ReportFilter } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ReportFilter = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
|
15
|
+
| `field` | *string* | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `op` | [models.Op](../../sdk/models/op.md) | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `value` | *string*[] | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# ReportKind
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ReportKind } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ReportKind = "ratio";
|
|
9
|
+
|
|
10
|
+
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Values
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
"flow" | "ratio" | "snapshot" | Unrecognized<string>
|
|
17
|
+
```
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# ReportQueryRequestCompare
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ReportQueryRequestCompare } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ReportQueryRequestCompare = "previous_year";
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Values
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
"previous_period" | "previous_year"
|
|
15
|
+
```
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# ReportQueryRequestGrain
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ReportQueryRequestGrain } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ReportQueryRequestGrain = "week";
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Values
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
"day" | "week" | "month"
|
|
15
|
+
```
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# ReportQueryRequestShape
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ReportQueryRequestShape } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ReportQueryRequestShape = "timeseries";
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Values
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
"timeseries" | "breakdown" | "scalar"
|
|
15
|
+
```
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# ReportQueryRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ReportQueryRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ReportQueryRequest = {
|
|
9
|
+
range: "2026-09-01..2026-10-01",
|
|
10
|
+
shape: "timeseries",
|
|
11
|
+
};
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Fields
|
|
15
|
+
|
|
16
|
+
| Field | Type | Required | Description | Example |
|
|
17
|
+
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
|
18
|
+
| `compare` | [models.ReportQueryRequestCompare](../../sdk/models/report-query-request-compare.md) | :heavy_minus_sign: | N/A | |
|
|
19
|
+
| `currency` | *string* | :heavy_minus_sign: | N/A | |
|
|
20
|
+
| `dimensions` | *string*[] | :heavy_minus_sign: | N/A | |
|
|
21
|
+
| `filters` | [models.ReportFilter](../../sdk/models/report-filter.md)[] | :heavy_minus_sign: | N/A | |
|
|
22
|
+
| `grain` | [models.ReportQueryRequestGrain](../../sdk/models/report-query-request-grain.md) | :heavy_minus_sign: | N/A | |
|
|
23
|
+
| `limit` | *number* | :heavy_minus_sign: | N/A | |
|
|
24
|
+
| `range` | *string* | :heavy_check_mark: | N/A | 2026-09-01..2026-10-01 |
|
|
25
|
+
| `shape` | [models.ReportQueryRequestShape](../../sdk/models/report-query-request-shape.md) | :heavy_check_mark: | N/A | |
|
|
26
|
+
| `sort` | [models.ReportSort](../../sdk/models/report-sort.md)[] | :heavy_minus_sign: | N/A | |
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# ReportSort
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ReportSort } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ReportSort = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
|
|
15
|
+
| `dir` | [models.Dir](../../sdk/models/dir.md) | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `field` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# ReportValueType
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ReportValueType } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ReportValueType = "count";
|
|
9
|
+
|
|
10
|
+
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Values
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
"money" | "count" | "days" | Unrecognized<string>
|
|
17
|
+
```
|