npm - @flexprice/sdk - Versions diffs - 2.1.44 → 2.1.45-dev.8 - Mend

@flexprice/sdk 2.1.44 → 2.1.45-dev.8

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.

Files changed (507) hide show

package/docs/sdk/models/price-filter.md CHANGED Viewed

@@ -26,6 +26,7 @@ let value: PriceFilter = {};
 | `parentPriceId`                                                                                                                                      | *string*                                                                                                                                             | :heavy_minus_sign:                                                                                                                                   | N/A                                                                                                                                                  |
 | `planIds`                                                                                                                                            | *string*[]                                                                                                                                           | :heavy_minus_sign:                                                                                                                                   | Price override filtering fields                                                                                                                      |
 | `priceIds`                                                                                                                                           | *string*[]                                                                                                                                           | :heavy_minus_sign:                                                                                                                                   | N/A                                                                                                                                                  |
+| `productIds`                                                                                                                                         | *string*[]                                                                                                                                           | :heavy_minus_sign:                                                                                                                                   | N/A                                                                                                                                                  |
 | `sort`                                                                                                                                               | *string*                                                                                                                                             | :heavy_minus_sign:                                                                                                                                   | N/A                                                                                                                                                  |
 | `startDateLt`                                                                                                                                        | *string*                                                                                                                                             | :heavy_minus_sign:                                                                                                                                   | N/A                                                                                                                                                  |
 | `startTime`                                                                                                                                          | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                        | :heavy_minus_sign:                                                                                                                                   | N/A                                                                                                                                                  |

package/docs/sdk/models/price-price.md CHANGED Viewed

@@ -43,6 +43,7 @@ let value: PricePrice = {};
 | `priceUnitId`                                                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                   | PriceUnitID is the id of the price unit (for CUSTOM type)                                                                                                                                                                                                            |
 | `priceUnitTiers`                                                                                                                                                                                                                                                     | [models.PricePriceTier](../../sdk/models/price-price-tier.md)[]                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                   | PriceUnitTiers are the tiers for the price unit when BillingModel is TIERED                                                                                                                                                                                          |
 | `priceUnitType`                                                                                                                                                                                                                                                      | [models.PriceUnitType](../../sdk/models/price-unit-type.md)                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                   | N/A                                                                                                                                                                                                                                                                  |
+| `productId`                                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                   | N/A                                                                                                                                                                                                                                                                  |
 | `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. |
 | `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                                                                                                                                                                                                                             |
 | `status`                                                                                                                                                                                                                                                             | [models.Status](../../sdk/models/status.md)                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                   | N/A                                                                                                                                                                                                                                                                  |

package/docs/sdk/models/price-response.md CHANGED Viewed

@@ -77,6 +77,7 @@ let value: PriceResponse = {
 | `priceUnitTiers`                                                                                                                                                                                                                                                     | [models.PricePriceTier](../../sdk/models/price-price-tier.md)[]                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                   | PriceUnitTiers are the tiers for the price unit when BillingModel is TIERED                                                                                                                                                                                          |
 | `priceUnitType`                                                                                                                                                                                                                                                      | [models.PriceUnitType](../../sdk/models/price-unit-type.md)                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                   | N/A                                                                                                                                                                                                                                                                  |
 | `pricingUnit`                                                                                                                                                                                                                                                        | [models.PriceUnitResponse](../../sdk/models/price-unit-response.md)                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                   | N/A                                                                                                                                                                                                                                                                  |
+| `productId`                                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                   | N/A                                                                                                                                                                                                                                                                  |
 | `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. |
 | `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                                                                                                                                                                                                                             |
 | `status`                                                                                                                                                                                                                                                             | [models.Status](../../sdk/models/status.md)                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                   | N/A                                                                                                                                                                                                                                                                  |

package/docs/sdk/models/product-filter-order.md ADDED Viewed

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

package/docs/sdk/models/product-filter.md ADDED Viewed

@@ -0,0 +1,25 @@
+# ProductFilter
+## Example Usage
+```typescript
+import { ProductFilter } from "@flexprice/sdk/sdk/models";
+let value: ProductFilter = {};
+```
+## Fields
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `endTime`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `expand`                                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `filters`                                                                                     | [models.FilterCondition](../../sdk/models/filter-condition.md)[]                              | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `limit`                                                                                       | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `lookupKeys`                                                                                  | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `offset`                                                                                      | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `order`                                                                                       | [models.ProductFilterOrder](../../sdk/models/product-filter-order.md)                         | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `productIds`                                                                                  | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `sort`                                                                                        | [models.SortCondition](../../sdk/models/sort-condition.md)[]                                  | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `startTime`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `status`                                                                                      | [models.Status](../../sdk/models/status.md)                                                   | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/product-response.md ADDED Viewed

@@ -0,0 +1,21 @@
+# ProductResponse
+## Example Usage
+```typescript
+import { ProductResponse } from "@flexprice/sdk/sdk/models";
+let value: ProductResponse = {};
+```
+## Fields
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `createdAt`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `description`                                                                                 | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `id`                                                                                          | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `lookupKey`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `name`                                                                                        | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `status`                                                                                      | [models.Status](../../sdk/models/status.md)                                                   | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `updatedAt`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/recognition-method.md ADDED Viewed

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

package/docs/sdk/models/rev-rec-entity-type.md ADDED Viewed

@@ -0,0 +1,17 @@
+# RevRecEntityType
+## Example Usage
+```typescript
+import { RevRecEntityType } from "@flexprice/sdk/sdk/models";
+let value: RevRecEntityType = "credit_note";
+// Open enum: unrecognized values are captured as Unrecognized<string>
+```
+## Values
+```typescript
+"subscription" | "subscription_line_item" | "invoice" | "credit_note" | "payment" | "refund" | "pob" | Unrecognized<string>
+```

package/docs/sdk/models/revenue-breakdown.md ADDED Viewed

@@ -0,0 +1,18 @@
+# RevenueBreakdown
+## Example Usage
+```typescript
+import { RevenueBreakdown } from "@flexprice/sdk/sdk/models";
+let value: RevenueBreakdown = {};
+```
+## Fields
+| Field                        | Type                         | Required                     | Description                  |
+| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
+| `actual`                     | *string*                     | :heavy_minus_sign:           | N/A                          |
+| `pending`                    | *string*                     | :heavy_minus_sign:           | N/A                          |
+| `scheduled`                  | *string*                     | :heavy_minus_sign:           | N/A                          |
+| `total`                      | *string*                     | :heavy_minus_sign:           | actual + pending + scheduled |

package/docs/sdk/models/revenue-report-group-by.md ADDED Viewed

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

package/docs/sdk/models/rollforward-request.md ADDED Viewed

@@ -0,0 +1,28 @@
+# RollforwardRequest
+## Example Usage
+```typescript
+import { RollforwardRequest } from "@flexprice/sdk/sdk/models";
+let value: RollforwardRequest = {
+  currency: "Lek",
+  periodStart: new Date("2024-12-15T11:11:43.474Z"),
+};
+```
+## Fields
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `accounts`                                                                                    | [models.LedgerAccountKey](../../sdk/models/ledger-account-key.md)[]                           | :heavy_minus_sign:                                                                            | defaults to [deferred_revenue]                                                                |
+| `contractIds`                                                                                 | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `currency`                                                                                    | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `customerIds`                                                                                 | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `groupBy`                                                                                     | [models.RevenueReportGroupBy](../../sdk/models/revenue-report-group-by.md)[]                  | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `limit`                                                                                       | *number*                                                                                      | :heavy_minus_sign:                                                                            | item rows per page; totals are never paged                                                    |
+| `offset`                                                                                      | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `periodEnd`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | YYYY-MM, an ended month; defaults to period_start                                             |
+| `periodStart`                                                                                 | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark:                                                                            | YYYY-MM                                                                                       |
+| `pobIds`                                                                                      | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `postedBy`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | only entries posted at or before it: the books as they were then                              |

package/docs/sdk/models/rollforward-response.md ADDED Viewed

@@ -0,0 +1,17 @@
+# RollforwardResponse
+## Example Usage
+```typescript
+import { RollforwardResponse } from "@flexprice/sdk/sdk/models";
+let value: RollforwardResponse = {};
+```
+## Fields
+| Field                                                                | Type                                                                 | Required                                                             | Description                                                          |
+| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
+| `items`                                                              | [models.RollforwardRow](../../sdk/models/rollforward-row.md)[]       | :heavy_minus_sign:                                                   | per period, account and group; empty without group_by                |
+| `pagination`                                                         | [models.PaginationResponse](../../sdk/models/pagination-response.md) | :heavy_minus_sign:                                                   | N/A                                                                  |
+| `totals`                                                             | [models.RollforwardRow](../../sdk/models/rollforward-row.md)[]       | :heavy_minus_sign:                                                   | per period and account, all groups                                   |

package/docs/sdk/models/rollforward-row.md ADDED Viewed

@@ -0,0 +1,22 @@
+# RollforwardRow
+## Example Usage
+```typescript
+import { RollforwardRow } from "@flexprice/sdk/sdk/models";
+let value: RollforwardRow = {};
+```
+## Fields
+| Field                                                             | Type                                                              | Required                                                          | Description                                                       |
+| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
+| `account`                                                         | [models.LedgerAccountKey](../../sdk/models/ledger-account-key.md) | :heavy_minus_sign:                                                | N/A                                                               |
+| `closing`                                                         | *string*                                                          | :heavy_minus_sign:                                                | N/A                                                               |
+| `contractId`                                                      | *string*                                                          | :heavy_minus_sign:                                                | N/A                                                               |
+| `customerId`                                                      | *string*                                                          | :heavy_minus_sign:                                                | N/A                                                               |
+| `movements`                                                       | Record<string, *string*>                                          | :heavy_minus_sign:                                                | a missing category is 0                                           |
+| `opening`                                                         | *string*                                                          | :heavy_minus_sign:                                                | N/A                                                               |
+| `period`                                                          | *string*                                                          | :heavy_minus_sign:                                                | YYYY-MM                                                           |
+| `pobId`                                                           | *string*                                                          | :heavy_minus_sign:                                                | N/A                                                               |

package/docs/sdk/models/subscription-entitlement-grants-response.md ADDED Viewed

@@ -0,0 +1,50 @@
+# SubscriptionEntitlementGrantsResponse
+## Example Usage
+```typescript
+import { SubscriptionEntitlementGrantsResponse } from "@flexprice/sdk/sdk/models";
+let value: SubscriptionEntitlementGrantsResponse = {
+  entitlements: [
+    {
+      addon: {
+        prices: [
+          {
+            addon: {},
+            meter: {
+              createdAt: new Date("2024-03-20T15:04:05Z"),
+              eventName: "api_request",
+              id: "550e8400-e29b-41d4-a716-446655440000",
+              name: "API Usage Meter",
+              status: "published",
+              tenantId: "tenant123",
+              updatedAt: new Date("2024-03-20T15:04:05Z"),
+            },
+            plan: {},
+          },
+        ],
+      },
+      feature: {
+        meter: {
+          createdAt: new Date("2024-03-20T15:04:05Z"),
+          eventName: "api_request",
+          id: "550e8400-e29b-41d4-a716-446655440000",
+          name: "API Usage Meter",
+          status: "published",
+          tenantId: "tenant123",
+          updatedAt: new Date("2024-03-20T15:04:05Z"),
+        },
+      },
+      plan: {},
+    },
+  ],
+};
+```
+## Fields
+| Field                                                                    | Type                                                                     | Required                                                                 | Description                                                              |
+| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
+| `entitlements`                                                           | [models.EntitlementResponse](../../sdk/models/entitlement-response.md)[] | :heavy_minus_sign:                                                       | N/A                                                                      |
+| `grantState`                                                             | [models.GrantState](../../sdk/models/grant-state.md)                     | :heavy_minus_sign:                                                       | N/A                                                                      |

package/docs/sdk/models/subscription-entitlements-response.md CHANGED Viewed

@@ -21,13 +21,49 @@ let value: SubscriptionEntitlementsResponse = {
       },
     },
   ],
+  subscriptionEntitlementGrants: {
+    entitlements: [
+      {
+        addon: {
+          prices: [
+            {
+              addon: {},
+              meter: {
+                createdAt: new Date("2024-03-20T15:04:05Z"),
+                eventName: "api_request",
+                id: "550e8400-e29b-41d4-a716-446655440000",
+                name: "API Usage Meter",
+                status: "published",
+                tenantId: "tenant123",
+                updatedAt: new Date("2024-03-20T15:04:05Z"),
+              },
+              plan: {},
+            },
+          ],
+        },
+        feature: {
+          meter: {
+            createdAt: new Date("2024-03-20T15:04:05Z"),
+            eventName: "api_request",
+            id: "550e8400-e29b-41d4-a716-446655440000",
+            name: "API Usage Meter",
+            status: "published",
+            tenantId: "tenant123",
+            updatedAt: new Date("2024-03-20T15:04:05Z"),
+          },
+        },
+        plan: {},
+      },
+    ],
+  },
 };
 ```
 ## Fields
-| Field                                                                | Type                                                                 | Required                                                             | Description                                                          |
-| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
-| `features`                                                           | [models.AggregatedFeature](../../sdk/models/aggregated-feature.md)[] | :heavy_minus_sign:                                                   | N/A                                                                  |
-| `planId`                                                             | *string*                                                             | :heavy_minus_sign:                                                   | N/A                                                                  |
-| `subscriptionId`                                                     | *string*                                                             | :heavy_minus_sign:                                                   | N/A                                                                  |
+| Field                                                                                                        | Type                                                                                                         | Required                                                                                                     | Description                                                                                                  |
+| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
+| `features`                                                                                                   | [models.AggregatedFeature](../../sdk/models/aggregated-feature.md)[]                                         | :heavy_minus_sign:                                                                                           | N/A                                                                                                          |
+| `planId`                                                                                                     | *string*                                                                                                     | :heavy_minus_sign:                                                                                           | N/A                                                                                                          |
+| `subscriptionEntitlementGrants`                                                                              | [models.SubscriptionEntitlementGrantsResponse](../../sdk/models/subscription-entitlement-grants-response.md) | :heavy_minus_sign:                                                                                           | N/A                                                                                                          |
+| `subscriptionId`                                                                                             | *string*                                                                                                     | :heavy_minus_sign:                                                                                           | N/A                                                                                                          |

package/docs/sdk/models/update-price-request.md CHANGED Viewed

@@ -23,6 +23,7 @@ let value: UpdatePriceRequest = {};
 | `metadata`                                                                                                                                                                                                                                                                                          | Record<string, *string*>                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                 |
 | `priceUnitAmount`                                                                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                  | PriceUnitAmount is the price unit amount (for CUSTOM price unit type, FLAT_FEE/PACKAGE billing models)                                                                                                                                                                                              |
 | `priceUnitTiers`                                                                                                                                                                                                                                                                                    | [models.CreatePriceTier](../../sdk/models/create-price-tier.md)[]                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                                  | PriceUnitTiers are the price unit tiers (for CUSTOM price unit type, TIERED billing model)                                                                                                                                                                                                          |
+| `productId`                                                                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                  | ProductID sets the price's product while it has none; once set it never changes.                                                                                                                                                                                                                    |
 | `tierMode`                                                                                                                                                                                                                                                                                          | [models.BillingTier](../../sdk/models/billing-tier.md)                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                 |
 | `tiers`                                                                                                                                                                                                                                                                                             | [models.CreatePriceTier](../../sdk/models/create-price-tier.md)[]                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                                  | Tiers determines the pricing tiers for this line item                                                                                                                                                                                                                                               |
 | `transformQuantity`                                                                                                                                                                                                                                                                                 | [models.PriceTransformQuantity](../../sdk/models/price-transform-quantity.md)                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                 |

package/docs/sdk/models/update-product-request-request.md ADDED Viewed

@@ -0,0 +1,19 @@
+# UpdateProductRequestRequest
+## Example Usage
+```typescript
+import { UpdateProductRequestRequest } from "@flexprice/sdk/sdk/models";
+let value: UpdateProductRequestRequest = {
+  id: "<id>",
+  body: {},
+};
+```
+## Fields
+| Field                                                                     | Type                                                                      | Required                                                                  | Description                                                               |
+| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| `id`                                                                      | *string*                                                                  | :heavy_check_mark:                                                        | Product ID                                                                |
+| `body`                                                                    | [models.UpdateProductRequest](../../sdk/models/update-product-request.md) | :heavy_check_mark:                                                        | Update Product Request                                                    |

package/docs/sdk/models/update-product-request.md ADDED Viewed

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

package/docs/sdk/models/waterfall-cell.md ADDED Viewed

@@ -0,0 +1,18 @@
+# WaterfallCell
+## Example Usage
+```typescript
+import { WaterfallCell } from "@flexprice/sdk/sdk/models";
+let value: WaterfallCell = {};
+```
+## Fields
+| Field                                                            | Type                                                             | Required                                                         | Description                                                      |
+| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
+| `deferred`                                                       | *string*                                                         | :heavy_minus_sign:                                               | details: closing deferred_revenue, ended months only             |
+| `period`                                                         | *string*                                                         | :heavy_minus_sign:                                               | YYYY-MM                                                          |
+| `revenue`                                                        | [models.RevenueBreakdown](../../sdk/models/revenue-breakdown.md) | :heavy_minus_sign:                                               | N/A                                                              |
+| `unbilled`                                                       | *string*                                                         | :heavy_minus_sign:                                               | details: closing unbilled_receivable, ended months only          |

package/docs/sdk/models/waterfall-request.md ADDED Viewed

@@ -0,0 +1,29 @@
+# WaterfallRequest
+## Example Usage
+```typescript
+import { WaterfallRequest } from "@flexprice/sdk/sdk/models";
+let value: WaterfallRequest = {
+  currency: "Swiss Franc",
+  periodEnd: new Date("2026-06-12T15:56:05.804Z"),
+  periodStart: new Date("2024-05-28T02:35:46.087Z"),
+};
+```
+## Fields
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `asOf`                                                                                        | *string*                                                                                      | :heavy_minus_sign:                                                                            | report date: pending and scheduled split here; defaults to now                                |
+| `contractIds`                                                                                 | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `currency`                                                                                    | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `customerIds`                                                                                 | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `details`                                                                                     | *boolean*                                                                                     | :heavy_minus_sign:                                                                            | month-end deferred and unbilled balances                                                      |
+| `groupBy`                                                                                     | [models.RevenueReportGroupBy](../../sdk/models/revenue-report-group-by.md)                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `limit`                                                                                       | *number*                                                                                      | :heavy_minus_sign:                                                                            | rows per page; totals are never paged                                                         |
+| `offset`                                                                                      | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `periodEnd`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark:                                                                            | YYYY-MM, at most 36 months from period_start                                                  |
+| `periodStart`                                                                                 | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark:                                                                            | YYYY-MM                                                                                       |
+| `pobIds`                                                                                      | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/waterfall-response.md ADDED Viewed

@@ -0,0 +1,17 @@
+# WaterfallResponse
+## Example Usage
+```typescript
+import { WaterfallResponse } from "@flexprice/sdk/sdk/models";
+let value: WaterfallResponse = {};
+```
+## Fields
+| Field                                                                | Type                                                                 | Required                                                             | Description                                                          |
+| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
+| `items`                                                              | [models.WaterfallRow](../../sdk/models/waterfall-row.md)[]           | :heavy_minus_sign:                                                   | N/A                                                                  |
+| `pagination`                                                         | [models.PaginationResponse](../../sdk/models/pagination-response.md) | :heavy_minus_sign:                                                   | N/A                                                                  |
+| `totals`                                                             | [models.WaterfallCell](../../sdk/models/waterfall-cell.md)[]         | :heavy_minus_sign:                                                   | per period over all rows, never paged                                |

package/docs/sdk/models/waterfall-row.md ADDED Viewed

@@ -0,0 +1,18 @@
+# WaterfallRow
+## Example Usage
+```typescript
+import { WaterfallRow } from "@flexprice/sdk/sdk/models";
+let value: WaterfallRow = {};
+```
+## Fields
+| Field                                                        | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `cells`                                                      | [models.WaterfallCell](../../sdk/models/waterfall-cell.md)[] | :heavy_minus_sign:                                           | one per requested period, in order                           |
+| `contractId`                                                 | *string*                                                     | :heavy_minus_sign:                                           | N/A                                                          |
+| `customerId`                                                 | *string*                                                     | :heavy_minus_sign:                                           | N/A                                                          |
+| `pobId`                                                      | *string*                                                     | :heavy_minus_sign:                                           | N/A                                                          |