@flexprice/sdk 2.1.44 → 2.1.45-dev.12

package/docs/sdk/models/entitlement-grant-scope-entity-type.md

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

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

@@ -60,6 +60,7 @@ let value: EntitlementResponse = {
 | `grantDurationValue`                                                                                   | *number*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
 | `grantMeasure`                                                                                         | [models.EntitlementGrantMeasure](../../sdk/models/entitlement-grant-measure.md)                        | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
 | `grantQuota`                                                                                           | *string*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `grantScope`                                                                                           | [models.EntitlementGrantScopeEntityType](../../sdk/models/entitlement-grant-scope-entity-type.md)      | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
 | `id`                                                                                                   | *string*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
 | `isEnabled`                                                                                            | *boolean*                                                                                              | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
 | `isSoftLimit`                                                                                          | *boolean*                                                                                              | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |

package/docs/sdk/models/get-contract-request.md

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

package/docs/sdk/models/get-journal-entry-request.md

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

package/docs/sdk/models/get-performance-obligation-request.md

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

package/docs/sdk/models/get-product-request.md

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

package/docs/sdk/models/grouped-invoicing-child-request.md

@@ -31,5 +31,6 @@ let value: GroupedInvoicingChildRequest = {
 | `phases`                                                                                                                                  | [models.SubscriptionPhaseCreateRequest](../../sdk/models/subscription-phase-create-request.md)[]                                          | :heavy_minus_sign:                                                                                                                        | N/A                                                                                                                                       |
 | `planId`                                                                                                                                  | *string*                                                                                                                                  | :heavy_check_mark:                                                                                                                        | N/A                                                                                                                                       |
 | `subscriptionCoupons`                                                                                                                     | [models.SubscriptionCouponInput](../../sdk/models/subscription-coupon-input.md)[]                                                         | :heavy_minus_sign:                                                                                                                        | SubscriptionCoupons is the preferred way to attach coupons at creation.<br/>Accepts coupon_code; optionally targets a line item via price_id. |
+| `subscriptionEntitlementGrants`                                                                                                           | [models.CreateSubscriptionEntitlementGrantRequest](../../sdk/models/create-subscription-entitlement-grant-request.md)[]                   | :heavy_minus_sign:                                                                                                                        | SubscriptionEntitlementGrants are dollar entitlement grants shared by every usage line, created with the subscription.                    |
 | `taxRateOverrides`                                                                                                                        | [models.TaxRateOverride](../../sdk/models/tax-rate-override.md)[]                                                                         | :heavy_minus_sign:                                                                                                                        | N/A                                                                                                                                       |
 | `trialPeriodDays`                                                                                                                         | *number*                                                                                                                                  | :heavy_minus_sign:                                                                                                                        | TrialPeriodDays: nil = inherit from plan prices, 0 = no trial, >0 = override in days.                                                     |

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

@@ -41,4 +41,5 @@ let value: InvoiceFilter = {};
 | `status`                                                                                                                                                                         | [models.Status](../../sdk/models/status.md)                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                               | N/A                                                                                                                                                                              |
 | `subscriptionCustomerId`                                                                                                                                                         | *string*[]                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                               | subscription_customer_id filters invoices by the subscription owner's customer ID                                                                                                |
 | `subscriptionId`                                                                                                                                                                 | *string*                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                               | subscription_id filters invoices generated for a specific subscription<br/>Only returns invoices that were created as part of the specified subscription's billing               |
+| `updatedAtGte`                                                                                                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                    | :heavy_minus_sign:                                                                                                                                                               | updated_at_gte filters invoices updated at or after the given instant                                                                                                            |
 | `voidedAtGte`                                                                                                                                                                    | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                    | :heavy_minus_sign:                                                                                                                                                               | voided_at_gte filters invoices voided at or after the given instant                                                                                                              |

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

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

package/docs/sdk/models/journal-entry-response.md

@@ -0,0 +1,26 @@
+# JournalEntryResponse
+
+## Example Usage
+
+```typescript
+import { JournalEntryResponse } from "@flexprice/sdk/sdk/models";
+
+let value: JournalEntryResponse = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `accountingPeriodId`                                                                          | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `businessDate`                                                                                | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `contractId`                                                                                  | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `createdAt`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `currency`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `customerId`                                                                                  | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `eventType`                                                                                   | [models.JournalEventType](../../sdk/models/journal-event-type.md)                             | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `id`                                                                                          | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `lines`                                                                                       | [models.JournalLineResponse](../../sdk/models/journal-line-response.md)[]                     | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `reversalOf`                                                                                  | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `sourceEntityId`                                                                              | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `sourceEntityType`                                                                            | [models.RevRecEntityType](../../sdk/models/rev-rec-entity-type.md)                            | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/journal-event-type.md

@@ -0,0 +1,17 @@
+# JournalEventType
+
+## Example Usage
+
+```typescript
+import { JournalEventType } from "@flexprice/sdk/sdk/models";
+
+let value: JournalEventType = "invoice_voided";
+
+// Open enum: unrecognized values are captured as Unrecognized<string>
+```
+
+## Values
+
+```typescript
+"invoice_finalized" | "invoice_voided" | "credit_note_finalized" | "credit_note_voided" | "payment_succeeded" | "payment_reversed" | "refund_succeeded" | "revenue_earned" | "revenue_offset" | Unrecognized<string>
+```

package/docs/sdk/models/journal-filter-order.md

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

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

@@ -0,0 +1,32 @@
+# JournalFilter
+
+## Example Usage
+
+```typescript
+import { JournalFilter } from "@flexprice/sdk/sdk/models";
+
+let value: JournalFilter = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `accountingPeriodIds`                                                                         | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `accounts`                                                                                    | [models.LedgerAccountKey](../../sdk/models/ledger-account-key.md)[]                           | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `contractIds`                                                                                 | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `customerIds`                                                                                 | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `endTime`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `eventTypes`                                                                                  | [models.JournalEventType](../../sdk/models/journal-event-type.md)[]                           | :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                                                                                           |
+| `journalEntryIds`                                                                             | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `limit`                                                                                       | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `offset`                                                                                      | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `order`                                                                                       | [models.JournalFilterOrder](../../sdk/models/journal-filter-order.md)                         | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `pobIds`                                                                                      | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `sort`                                                                                        | [models.SortCondition](../../sdk/models/sort-condition.md)[]                                  | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `sourceEntityIds`                                                                             | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `sourceEntityType`                                                                            | [models.RevRecEntityType](../../sdk/models/rev-rec-entity-type.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/journal-line-response.md

@@ -0,0 +1,19 @@
+# JournalLineResponse
+
+## Example Usage
+
+```typescript
+import { JournalLineResponse } from "@flexprice/sdk/sdk/models";
+
+let value: JournalLineResponse = {};
+```
+
+## Fields
+
+| Field                                                             | Type                                                              | Required                                                          | Description                                                       |
+| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
+| `account`                                                         | [models.LedgerAccountKey](../../sdk/models/ledger-account-key.md) | :heavy_minus_sign:                                                | N/A                                                               |
+| `amount`                                                          | *string*                                                          | :heavy_minus_sign:                                                | N/A                                                               |
+| `direction`                                                       | [models.JournalDirection](../../sdk/models/journal-direction.md)  | :heavy_minus_sign:                                                | N/A                                                               |
+| `id`                                                              | *string*                                                          | :heavy_minus_sign:                                                | N/A                                                               |
+| `pobId`                                                           | *string*                                                          | :heavy_minus_sign:                                                | N/A                                                               |

package/docs/sdk/models/ledger-account-key.md

@@ -0,0 +1,17 @@
+# LedgerAccountKey
+
+## Example Usage
+
+```typescript
+import { LedgerAccountKey } from "@flexprice/sdk/sdk/models";
+
+let value: LedgerAccountKey = "customer_credit";
+
+// Open enum: unrecognized values are captured as Unrecognized<string>
+```
+
+## Values
+
+```typescript
+"cash" | "accounts_receivable" | "unbilled_receivable" | "deferred_revenue" | "customer_credit" | "tax_payable" | "revenue" | "contra_revenue" | Unrecognized<string>
+```

package/docs/sdk/models/list-accounting-periods-response.md

@@ -0,0 +1,16 @@
+# ListAccountingPeriodsResponse
+
+## Example Usage
+
+```typescript
+import { ListAccountingPeriodsResponse } from "@flexprice/sdk/sdk/models";
+
+let value: ListAccountingPeriodsResponse = {};
+```
+
+## Fields
+
+| Field                                                                               | Type                                                                                | Required                                                                            | Description                                                                         |
+| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
+| `items`                                                                             | [models.AccountingPeriodResponse](../../sdk/models/accounting-period-response.md)[] | :heavy_minus_sign:                                                                  | N/A                                                                                 |
+| `pagination`                                                                        | [models.PaginationResponse](../../sdk/models/pagination-response.md)                | :heavy_minus_sign:                                                                  | N/A                                                                                 |

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

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

package/docs/sdk/models/list-journal-entries-response.md

@@ -0,0 +1,16 @@
+# ListJournalEntriesResponse
+
+## Example Usage
+
+```typescript
+import { ListJournalEntriesResponse } from "@flexprice/sdk/sdk/models";
+
+let value: ListJournalEntriesResponse = {};
+```
+
+## Fields
+
+| Field                                                                       | Type                                                                        | Required                                                                    | Description                                                                 |
+| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
+| `items`                                                                     | [models.JournalEntryResponse](../../sdk/models/journal-entry-response.md)[] | :heavy_minus_sign:                                                          | N/A                                                                         |
+| `pagination`                                                                | [models.PaginationResponse](../../sdk/models/pagination-response.md)        | :heavy_minus_sign:                                                          | N/A                                                                         |

package/docs/sdk/models/list-payments-request.md

@@ -28,4 +28,5 @@ let value: ListPaymentsRequest = {};
 | `paymentStatus`                                                       | *string*                                                              | :heavy_minus_sign:                                                    | N/A                                                                   |
 | `sort`                                                                | *string*                                                              | :heavy_minus_sign:                                                    | N/A                                                                   |
 | `startTime`                                                           | *string*                                                              | :heavy_minus_sign:                                                    | N/A                                                                   |
-| `status`                                                              | [models.ListPaymentsStatus](../../sdk/models/list-payments-status.md) | :heavy_minus_sign:                                                    | N/A                                                                   |
+| `status`                                                              | [models.ListPaymentsStatus](../../sdk/models/list-payments-status.md) | :heavy_minus_sign:                                                    | N/A                                                                   |
+| `updatedAtGte`                                                        | *string*                                                              | :heavy_minus_sign:                                                    | UpdatedAtGTE bounds updated_at, which every lifecycle change bumps.   |

package/docs/sdk/models/list-performance-obligations-response.md

@@ -0,0 +1,16 @@
+# ListPerformanceObligationsResponse
+
+## Example Usage
+
+```typescript
+import { ListPerformanceObligationsResponse } from "@flexprice/sdk/sdk/models";
+
+let value: ListPerformanceObligationsResponse = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `items`                                                                                       | [models.PerformanceObligationResponse](../../sdk/models/performance-obligation-response.md)[] | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `pagination`                                                                                  | [models.PaginationResponse](../../sdk/models/pagination-response.md)                          | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/list-products-order.md

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

package/docs/sdk/models/list-products-request.md

@@ -0,0 +1,23 @@
+# ListProductsRequest
+
+## Example Usage
+
+```typescript
+import { ListProductsRequest } from "@flexprice/sdk/sdk/models";
+
+let value: ListProductsRequest = {};
+```
+
+## Fields
+
+| Field                                                                 | Type                                                                  | Required                                                              | Description                                                           |
+| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
+| `endTime`                                                             | *string*                                                              | :heavy_minus_sign:                                                    | N/A                                                                   |
+| `expand`                                                              | *string*                                                              | :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.ListProductsOrder](../../sdk/models/list-products-order.md)   | :heavy_minus_sign:                                                    | N/A                                                                   |
+| `productIds`                                                          | *string*[]                                                            | :heavy_minus_sign:                                                    | N/A                                                                   |
+| `startTime`                                                           | *string*                                                              | :heavy_minus_sign:                                                    | N/A                                                                   |
+| `status`                                                              | [models.ListProductsStatus](../../sdk/models/list-products-status.md) | :heavy_minus_sign:                                                    | N/A                                                                   |

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

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

package/docs/sdk/models/list-products-status.md

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

package/docs/sdk/models/performance-obligation-association-response.md

@@ -0,0 +1,18 @@
+# PerformanceObligationAssociationResponse
+
+## Example Usage
+
+```typescript
+import { PerformanceObligationAssociationResponse } from "@flexprice/sdk/sdk/models";
+
+let value: PerformanceObligationAssociationResponse = {};
+```
+
+## 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                                                                                           |
+| `entityId`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `entityType`                                                                                  | [models.RevRecEntityType](../../sdk/models/rev-rec-entity-type.md)                            | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `id`                                                                                          | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/performance-obligation-response.md

@@ -0,0 +1,26 @@
+# PerformanceObligationResponse
+
+## Example Usage
+
+```typescript
+import { PerformanceObligationResponse } from "@flexprice/sdk/sdk/models";
+
+let value: PerformanceObligationResponse = {};
+```
+
+## Fields
+
+| Field                                                                                                                | Type                                                                                                                 | Required                                                                                                             | Description                                                                                                          |
+| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
+| `amortizationMethod`                                                                                                 | [models.AmortizationMethod](../../sdk/models/amortization-method.md)                                                 | :heavy_minus_sign:                                                                                                   | N/A                                                                                                                  |
+| `associations`                                                                                                       | [models.PerformanceObligationAssociationResponse](../../sdk/models/performance-obligation-association-response.md)[] | :heavy_minus_sign:                                                                                                   | N/A                                                                                                                  |
+| `contractId`                                                                                                         | *string*                                                                                                             | :heavy_minus_sign:                                                                                                   | N/A                                                                                                                  |
+| `createdAt`                                                                                                          | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                        | :heavy_minus_sign:                                                                                                   | N/A                                                                                                                  |
+| `id`                                                                                                                 | *string*                                                                                                             | :heavy_minus_sign:                                                                                                   | N/A                                                                                                                  |
+| `name`                                                                                                               | *string*                                                                                                             | :heavy_minus_sign:                                                                                                   | N/A                                                                                                                  |
+| `pobStatus`                                                                                                          | [models.PerformanceObligationStatus](../../sdk/models/performance-obligation-status.md)                              | :heavy_minus_sign:                                                                                                   | N/A                                                                                                                  |
+| `recognitionMethod`                                                                                                  | [models.RecognitionMethod](../../sdk/models/recognition-method.md)                                                   | :heavy_minus_sign:                                                                                                   | N/A                                                                                                                  |
+| `serviceEnd`                                                                                                         | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                        | :heavy_minus_sign:                                                                                                   | N/A                                                                                                                  |
+| `serviceStart`                                                                                                       | [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                                                                                                                  |
+| `updatedAt`                                                                                                          | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                        | :heavy_minus_sign:                                                                                                   | N/A                                                                                                                  |

package/docs/sdk/models/performance-obligation-status.md

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

package/docs/sdk/models/pob-filter-order.md

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

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

@@ -0,0 +1,28 @@
+# PobFilter
+
+## Example Usage
+
+```typescript
+import { PobFilter } from "@flexprice/sdk/sdk/models";
+
+let value: PobFilter = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `contractIds`                                                                                 | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `customerIds`                                                                                 | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `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                                                                                           |
+| `offset`                                                                                      | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `order`                                                                                       | [models.PobFilterOrder](../../sdk/models/pob-filter-order.md)                                 | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `performanceObligationIds`                                                                    | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `pobStatuses`                                                                                 | [models.PerformanceObligationStatus](../../sdk/models/performance-obligation-status.md)[]     | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `recognitionMethods`                                                                          | [models.RecognitionMethod](../../sdk/models/recognition-method.md)[]                          | :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                                                                                           |