@flexprice/sdk 2.1.39 → 2.1.41

package/docs/sdk/models/analytics-query-meta.md

@@ -12,4 +12,8 @@ let value: AnalyticsQueryMeta = {};
 
 | Field              | Type               | Required           | Description        |
 | ------------------ | ------------------ | ------------------ | ------------------ |
-| `querySource`      | *string*           | :heavy_minus_sign: | N/A                |
+| `from`             | *string*           | :heavy_minus_sign: | N/A                |
+| `prevFrom`         | *string*           | :heavy_minus_sign: | N/A                |
+| `prevTo`           | *string*           | :heavy_minus_sign: | N/A                |
+| `querySource`      | *string*           | :heavy_minus_sign: | N/A                |
+| `to`               | *string*           | :heavy_minus_sign: | N/A                |

package/docs/sdk/models/analytics-query-request.md

@@ -8,7 +8,7 @@ import { AnalyticsQueryRequest } from "@flexprice/sdk/sdk/models";
 let value: AnalyticsQueryRequest = {
   definition: {
     metrics: [
-      "usage_quantity",
+      "invoice_total",
     ],
     shape: "breakdown",
   },

package/docs/sdk/models/analytics-view-definition-compare.md

@@ -0,0 +1,17 @@
+# AnalyticsViewDefinitionCompare
+
+## Example Usage
+
+```typescript
+import { AnalyticsViewDefinitionCompare } from "@flexprice/sdk/sdk/models";
+
+let value: AnalyticsViewDefinitionCompare = "previous_year";
+
+// Open enum: unrecognized values are captured as Unrecognized<string>
+```
+
+## Values
+
+```typescript
+"previous_period" | "previous_year" | Unrecognized<string>
+```

package/docs/sdk/models/analytics-view-definition.md

@@ -7,7 +7,7 @@ import { AnalyticsViewDefinition } from "@flexprice/sdk/sdk/models";
 
 let value: AnalyticsViewDefinition = {
   metrics: [
-    "event_count",
+    "arpu_paid",
   ],
   shape: "breakdown",
 };
@@ -15,13 +15,17 @@ let value: AnalyticsViewDefinition = {
 
 ## Fields
 
-| Field                                                                      | Type                                                                       | Required                                                                   | Description                                                                |
-| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
-| `dimensions`                                                               | *string*[]                                                                 | :heavy_minus_sign:                                                         | N/A                                                                        |
-| `filters`                                                                  | [models.AnalyticsFilter](../../sdk/models/analytics-filter.md)[]           | :heavy_minus_sign:                                                         | N/A                                                                        |
-| `limit`                                                                    | *number*                                                                   | :heavy_minus_sign:                                                         | N/A                                                                        |
-| `metrics`                                                                  | [models.Metric](../../sdk/models/metric.md)[]                              | :heavy_check_mark:                                                         | N/A                                                                        |
-| `shape`                                                                    | [models.Shape](../../sdk/models/shape.md)                                  | :heavy_check_mark:                                                         | N/A                                                                        |
-| `sort`                                                                     | [models.AnalyticsSortSpec](../../sdk/models/analytics-sort-spec.md)[]      | :heavy_minus_sign:                                                         | N/A                                                                        |
-| `time`                                                                     | [models.AnalyticsTimeSpecRaw](../../sdk/models/analytics-time-spec-raw.md) | :heavy_minus_sign:                                                         | N/A                                                                        |
-| `variables`                                                                | [models.AnalyticsVariable](../../sdk/models/analytics-variable.md)[]       | :heavy_minus_sign:                                                         | N/A                                                                        |
+| Field                                                                                          | Type                                                                                           | Required                                                                                       | Description                                                                                    |
+| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
+| `compare`                                                                                      | [models.AnalyticsViewDefinitionCompare](../../sdk/models/analytics-view-definition-compare.md) | :heavy_minus_sign:                                                                             | N/A                                                                                            |
+| `currency`                                                                                     | *string*                                                                                       | :heavy_minus_sign:                                                                             | N/A                                                                                            |
+| `dimensions`                                                                                   | *string*[]                                                                                     | :heavy_minus_sign:                                                                             | N/A                                                                                            |
+| `display`                                                                                      | [models.Display](../../sdk/models/display.md)                                                  | :heavy_minus_sign:                                                                             | N/A                                                                                            |
+| `family`                                                                                       | [models.Family](../../sdk/models/family.md)                                                    | :heavy_minus_sign:                                                                             | N/A                                                                                            |
+| `filters`                                                                                      | [models.AnalyticsFilter](../../sdk/models/analytics-filter.md)[]                               | :heavy_minus_sign:                                                                             | N/A                                                                                            |
+| `limit`                                                                                        | *number*                                                                                       | :heavy_minus_sign:                                                                             | N/A                                                                                            |
+| `metrics`                                                                                      | [models.Metric](../../sdk/models/metric.md)[]                                                  | :heavy_check_mark:                                                                             | N/A                                                                                            |
+| `shape`                                                                                        | [models.Shape](../../sdk/models/shape.md)                                                      | :heavy_check_mark:                                                                             | N/A                                                                                            |
+| `sort`                                                                                         | [models.AnalyticsSortSpec](../../sdk/models/analytics-sort-spec.md)[]                          | :heavy_minus_sign:                                                                             | N/A                                                                                            |
+| `time`                                                                                         | [models.AnalyticsTimeSpecRaw](../../sdk/models/analytics-time-spec-raw.md)                     | :heavy_minus_sign:                                                                             | N/A                                                                                            |
+| `variables`                                                                                    | [models.AnalyticsVariable](../../sdk/models/analytics-variable.md)[]                           | :heavy_minus_sign:                                                                             | N/A                                                                                            |

package/docs/sdk/models/cancel-self-billing-checkout-request.md

@@ -0,0 +1,17 @@
+# CancelSelfBillingCheckoutRequest
+
+## Example Usage
+
+```typescript
+import { CancelSelfBillingCheckoutRequest } from "@flexprice/sdk/sdk/models";
+
+let value: CancelSelfBillingCheckoutRequest = {
+  id: "<id>",
+};
+```
+
+## Fields
+
+| Field               | Type                | Required            | Description         |
+| ------------------- | ------------------- | ------------------- | ------------------- |
+| `id`                | *string*            | :heavy_check_mark:  | Checkout session ID |

package/docs/sdk/models/create-customer-portal-session-request.md

@@ -0,0 +1,17 @@
+# CreateCustomerPortalSessionRequest
+
+## Example Usage
+
+```typescript
+import { CreateCustomerPortalSessionRequest } from "@flexprice/sdk/sdk/models";
+
+let value: CreateCustomerPortalSessionRequest = {
+  externalId: "<id>",
+};
+```
+
+## Fields
+
+| Field                | Type                 | Required             | Description          |
+| -------------------- | -------------------- | -------------------- | -------------------- |
+| `externalId`         | *string*             | :heavy_check_mark:   | Customer external ID |

package/docs/sdk/models/create-view-request.md

@@ -8,7 +8,7 @@ import { CreateViewRequest } from "@flexprice/sdk/sdk/models";
 let value: CreateViewRequest = {
   definition: {
     metrics: [
-      "usage_quantity",
+      "invoice_total",
     ],
     shape: "breakdown",
   },

package/docs/sdk/models/default-shape.md

@@ -0,0 +1,17 @@
+# DefaultShape
+
+## Example Usage
+
+```typescript
+import { DefaultShape } from "@flexprice/sdk/sdk/models";
+
+let value: DefaultShape = "breakdown";
+
+// Open enum: unrecognized values are captured as Unrecognized<string>
+```
+
+## Values
+
+```typescript
+"timeseries" | "breakdown" | "scalar" | Unrecognized<string>
+```

package/docs/sdk/models/delete-analytics-view-request.md

@@ -0,0 +1,17 @@
+# DeleteAnalyticsViewRequest
+
+## Example Usage
+
+```typescript
+import { DeleteAnalyticsViewRequest } from "@flexprice/sdk/sdk/models";
+
+let value: DeleteAnalyticsViewRequest = {
+  id: "<id>",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `id`               | *string*           | :heavy_check_mark: | View ID            |

package/docs/sdk/models/dir.md

@@ -0,0 +1,15 @@
+# Dir
+
+## Example Usage
+
+```typescript
+import { Dir } from "@flexprice/sdk/sdk/models";
+
+let value: Dir = "desc";
+```
+
+## Values
+
+```typescript
+"asc" | "desc"
+```

package/docs/sdk/models/display.md

@@ -0,0 +1,17 @@
+# Display
+
+## Example Usage
+
+```typescript
+import { Display } from "@flexprice/sdk/sdk/models";
+
+let value: Display = "chart";
+
+// Open enum: unrecognized values are captured as Unrecognized<string>
+```
+
+## Values
+
+```typescript
+"chart" | "table" | Unrecognized<string>
+```

package/docs/sdk/models/family.md

@@ -0,0 +1,17 @@
+# Family
+
+## Example Usage
+
+```typescript
+import { Family } from "@flexprice/sdk/sdk/models";
+
+let value: Family = "billing";
+
+// Open enum: unrecognized values are captured as Unrecognized<string>
+```
+
+## Values
+
+```typescript
+"usage" | "billing" | "report" | Unrecognized<string>
+```

package/docs/sdk/models/get-analytics-view-request.md

@@ -0,0 +1,17 @@
+# GetAnalyticsViewRequest
+
+## Example Usage
+
+```typescript
+import { GetAnalyticsViewRequest } from "@flexprice/sdk/sdk/models";
+
+let value: GetAnalyticsViewRequest = {
+  id: "<id>",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `id`               | *string*           | :heavy_check_mark: | View ID            |

package/docs/sdk/models/improvement-direction.md

@@ -0,0 +1,17 @@
+# ImprovementDirection
+
+## Example Usage
+
+```typescript
+import { ImprovementDirection } from "@flexprice/sdk/sdk/models";
+
+let value: ImprovementDirection = "lower";
+
+// Open enum: unrecognized values are captured as Unrecognized<string>
+```
+
+## Values
+
+```typescript
+"higher" | "lower" | Unrecognized<string>
+```

package/docs/sdk/models/invoice-response.md

@@ -141,6 +141,7 @@ let value: InvoiceResponse = {
 | `environmentId`                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | environment_id is the ID of the environment this invoice belongs to (for multi-environment setups)                                                                                                                                |
 | `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                                                                                                                                          |
 | `fxConversion`                                                                                                                                                                                                                    | [models.FxConversion](../../sdk/models/fx-conversion.md)                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                               |
+| `hostedInvoiceUrl`                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | hosted_invoice_url is the page where the customer can view, download and pay this invoice                                                                                                                                         |
 | `id`                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | id is the unique identifier for this invoice                                                                                                                                                                                      |
 | `idempotencyKey`                                                                                                                                                                                                                  | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | idempotency_key is a unique key used to prevent duplicate invoice creation when retrying API calls                                                                                                                                |
 | `invoiceNumber`                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | invoice_number is the human-readable invoice number displayed to customers (e.g., INV-2024-001)                                                                                                                                   |

package/docs/sdk/models/list-analytics-views-request.md

@@ -0,0 +1,15 @@
+# ListAnalyticsViewsRequest
+
+## Example Usage
+
+```typescript
+import { ListAnalyticsViewsRequest } from "@flexprice/sdk/sdk/models";
+
+let value: ListAnalyticsViewsRequest = {};
+```
+
+## Fields
+
+| Field                 | Type                  | Required              | Description           |
+| --------------------- | --------------------- | --------------------- | --------------------- |
+| `family`              | *string*              | :heavy_minus_sign:    | Filter by view family |

package/docs/sdk/models/list-views-response.md

@@ -0,0 +1,15 @@
+# ListViewsResponse
+
+## Example Usage
+
+```typescript
+import { ListViewsResponse } from "@flexprice/sdk/sdk/models";
+
+let value: ListViewsResponse = {};
+```
+
+## Fields
+
+| Field                                                      | Type                                                       | Required                                                   | Description                                                |
+| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
+| `items`                                                    | [models.ViewResponse](../../sdk/models/view-response.md)[] | :heavy_minus_sign:                                         | N/A                                                        |

package/docs/sdk/models/metric.md

@@ -5,7 +5,7 @@
 ```typescript
 import { Metric } from "@flexprice/sdk/sdk/models";
 
-let value: Metric = "event_count";
+let value: Metric = "invoice_total_issued";
 
 // Open enum: unrecognized values are captured as Unrecognized<string>
 ```
@@ -13,5 +13,5 @@ let value: Metric = "event_count";
 ## Values
 
 ```typescript
-"usage_quantity" | "event_count" | Unrecognized<string>
+"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>
 ```

package/docs/sdk/models/modify-subscription-params.md

@@ -10,8 +10,9 @@ let value: ModifySubscriptionParams = {};
 
 ## Fields
 
-| Field                                                                                    | Type                                                                                     | Required                                                                                 | Description                                                                              |
-| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
-| `lineItemModifications`                                                                  | [models.ModifySubscriptionLineItem](../../sdk/models/modify-subscription-line-item.md)[] | :heavy_minus_sign:                                                                       | N/A                                                                                      |
-| `modifyType`                                                                             | [models.ModifySubscriptionType](../../sdk/models/modify-subscription-type.md)            | :heavy_minus_sign:                                                                       | N/A                                                                                      |
-| `subscriptionId`                                                                         | *string*                                                                                 | :heavy_minus_sign:                                                                       | N/A                                                                                      |
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `lineItemModifications`                                                                       | [models.ModifySubscriptionLineItem](../../sdk/models/modify-subscription-line-item.md)[]      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `modifyType`                                                                                  | [models.ModifySubscriptionType](../../sdk/models/modify-subscription-type.md)                 | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `subscriptionId`                                                                              | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `trialEndAt`                                                                                  | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | TrialEndAt is where a trial_end checkout starts the first paid period.                        |

package/docs/sdk/models/modify-subscription-type.md

@@ -5,11 +5,11 @@
 ```typescript
 import { ModifySubscriptionType } from "@flexprice/sdk/sdk/models";
 
-let value: ModifySubscriptionType = "line_item_change";
+let value: ModifySubscriptionType = "trial_end";
 ```
 
 ## Values
 
 ```typescript
-"quantity_change" | "line_item_change"
+"quantity_change" | "line_item_change" | "trial_end"
 ```

package/docs/sdk/models/op.md

@@ -0,0 +1,15 @@
+# Op
+
+## Example Usage
+
+```typescript
+import { Op } from "@flexprice/sdk/sdk/models";
+
+let value: Op = "in";
+```
+
+## Values
+
+```typescript
+"eq" | "in"
+```

package/docs/sdk/models/poll-self-billing-checkout-request.md

@@ -0,0 +1,17 @@
+# PollSelfBillingCheckoutRequest
+
+## Example Usage
+
+```typescript
+import { PollSelfBillingCheckoutRequest } from "@flexprice/sdk/sdk/models";
+
+let value: PollSelfBillingCheckoutRequest = {
+  id: "<id>",
+};
+```
+
+## Fields
+
+| Field               | Type                | Required            | Description         |
+| ------------------- | ------------------- | ------------------- | ------------------- |
+| `id`                | *string*            | :heavy_check_mark:  | Checkout session ID |

package/docs/sdk/models/portal-session-response.md

@@ -0,0 +1,17 @@
+# PortalSessionResponse
+
+## Example Usage
+
+```typescript
+import { PortalSessionResponse } from "@flexprice/sdk/sdk/models";
+
+let value: PortalSessionResponse = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `expiresAt`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `token`                                                                                       | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `url`                                                                                         | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/report-catalog-entry-grain.md

@@ -0,0 +1,17 @@
+# ReportCatalogEntryGrain
+
+## Example Usage
+
+```typescript
+import { ReportCatalogEntryGrain } from "@flexprice/sdk/sdk/models";
+
+let value: ReportCatalogEntryGrain = "month";
+
+// Open enum: unrecognized values are captured as Unrecognized<string>
+```
+
+## Values
+
+```typescript
+"day" | "week" | "month" | Unrecognized<string>
+```

package/docs/sdk/models/report-catalog-entry-shape.md

@@ -0,0 +1,17 @@
+# ReportCatalogEntryShape
+
+## Example Usage
+
+```typescript
+import { ReportCatalogEntryShape } from "@flexprice/sdk/sdk/models";
+
+let value: ReportCatalogEntryShape = "scalar";
+
+// Open enum: unrecognized values are captured as Unrecognized<string>
+```
+
+## Values
+
+```typescript
+"timeseries" | "breakdown" | "scalar" | Unrecognized<string>
+```

package/docs/sdk/models/report-catalog-entry.md

@@ -0,0 +1,29 @@
+# ReportCatalogEntry
+
+## Example Usage
+
+```typescript
+import { ReportCatalogEntry } from "@flexprice/sdk/sdk/models";
+
+let value: ReportCatalogEntry = {};
+```
+
+## Fields
+
+| Field                                                                              | Type                                                                               | Required                                                                           | Description                                                                        |
+| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| `category`                                                                         | [models.ReportCategory](../../sdk/models/report-category.md)                       | :heavy_minus_sign:                                                                 | N/A                                                                                |
+| `defaultShape`                                                                     | [models.DefaultShape](../../sdk/models/default-shape.md)                           | :heavy_minus_sign:                                                                 | N/A                                                                                |
+| `description`                                                                      | *string*                                                                           | :heavy_minus_sign:                                                                 | N/A                                                                                |
+| `dimensions`                                                                       | [models.ReportDimension](../../sdk/models/report-dimension.md)[]                   | :heavy_minus_sign:                                                                 | N/A                                                                                |
+| `grains`                                                                           | [models.ReportCatalogEntryGrain](../../sdk/models/report-catalog-entry-grain.md)[] | :heavy_minus_sign:                                                                 | N/A                                                                                |
+| `improvement`                                                                      | [models.ImprovementDirection](../../sdk/models/improvement-direction.md)           | :heavy_minus_sign:                                                                 | N/A                                                                                |
+| `key`                                                                              | *string*                                                                           | :heavy_minus_sign:                                                                 | N/A                                                                                |
+| `kind`                                                                             | [models.ReportKind](../../sdk/models/report-kind.md)                               | :heavy_minus_sign:                                                                 | N/A                                                                                |
+| `maxRangeDays`                                                                     | *number*                                                                           | :heavy_minus_sign:                                                                 | N/A                                                                                |
+| `name`                                                                             | *string*                                                                           | :heavy_minus_sign:                                                                 | N/A                                                                                |
+| `shapes`                                                                           | [models.ReportCatalogEntryShape](../../sdk/models/report-catalog-entry-shape.md)[] | :heavy_minus_sign:                                                                 | N/A                                                                                |
+| `supportsCompare`                                                                  | *boolean*                                                                          | :heavy_minus_sign:                                                                 | N/A                                                                                |
+| `valueType`                                                                        | [models.ReportValueType](../../sdk/models/report-value-type.md)                    | :heavy_minus_sign:                                                                 | N/A                                                                                |
+| `variantLabel`                                                                     | *string*                                                                           | :heavy_minus_sign:                                                                 | N/A                                                                                |
+| `variantOf`                                                                        | *string*                                                                           | :heavy_minus_sign:                                                                 | N/A                                                                                |

package/docs/sdk/models/report-catalog-response.md

@@ -0,0 +1,15 @@
+# ReportCatalogResponse
+
+## Example Usage
+
+```typescript
+import { ReportCatalogResponse } from "@flexprice/sdk/sdk/models";
+
+let value: ReportCatalogResponse = {};
+```
+
+## Fields
+
+| Field                                                                   | Type                                                                    | Required                                                                | Description                                                             |
+| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
+| `items`                                                                 | [models.ReportCatalogEntry](../../sdk/models/report-catalog-entry.md)[] | :heavy_minus_sign:                                                      | N/A                                                                     |

package/docs/sdk/models/report-category.md

@@ -0,0 +1,17 @@
+# ReportCategory
+
+## Example Usage
+
+```typescript
+import { ReportCategory } from "@flexprice/sdk/sdk/models";
+
+let value: ReportCategory = "customers";
+
+// Open enum: unrecognized values are captured as Unrecognized<string>
+```
+
+## Values
+
+```typescript
+"billing" | "receivables" | "customers" | "credits" | "usage" | Unrecognized<string>
+```

package/docs/sdk/models/report-dimension.md

@@ -0,0 +1,16 @@
+# ReportDimension
+
+## Example Usage
+
+```typescript
+import { ReportDimension } from "@flexprice/sdk/sdk/models";
+
+let value: ReportDimension = {};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `key`              | *string*           | :heavy_minus_sign: | N/A                |
+| `label`            | *string*           | :heavy_minus_sign: | N/A                |

package/docs/sdk/models/report-filter.md

@@ -0,0 +1,17 @@
+# ReportFilter
+
+## Example Usage
+
+```typescript
+import { ReportFilter } from "@flexprice/sdk/sdk/models";
+
+let value: ReportFilter = {};
+```
+
+## Fields
+
+| Field                               | Type                                | Required                            | Description                         |
+| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
+| `field`                             | *string*                            | :heavy_minus_sign:                  | N/A                                 |
+| `op`                                | [models.Op](../../sdk/models/op.md) | :heavy_minus_sign:                  | N/A                                 |
+| `value`                             | *string*[]                          | :heavy_minus_sign:                  | N/A                                 |

package/docs/sdk/models/report-kind.md

@@ -0,0 +1,17 @@
+# ReportKind
+
+## Example Usage
+
+```typescript
+import { ReportKind } from "@flexprice/sdk/sdk/models";
+
+let value: ReportKind = "ratio";
+
+// Open enum: unrecognized values are captured as Unrecognized<string>
+```
+
+## Values
+
+```typescript
+"flow" | "ratio" | "snapshot" | Unrecognized<string>
+```

package/docs/sdk/models/report-query-request-compare.md

@@ -0,0 +1,15 @@
+# ReportQueryRequestCompare
+
+## Example Usage
+
+```typescript
+import { ReportQueryRequestCompare } from "@flexprice/sdk/sdk/models";
+
+let value: ReportQueryRequestCompare = "previous_year";
+```
+
+## Values
+
+```typescript
+"previous_period" | "previous_year"
+```

package/docs/sdk/models/report-query-request-grain.md

@@ -0,0 +1,15 @@
+# ReportQueryRequestGrain
+
+## Example Usage
+
+```typescript
+import { ReportQueryRequestGrain } from "@flexprice/sdk/sdk/models";
+
+let value: ReportQueryRequestGrain = "week";
+```
+
+## Values
+
+```typescript
+"day" | "week" | "month"
+```