@flexprice/sdk 2.1.44 → 2.1.45-dev.12

package/FUNCTIONS.md

@@ -20,7 +20,7 @@ specific category of applications.
 
 ```typescript
 import { FlexpriceCore } from "@flexprice/sdk/core.js";
-import { activityListActivity } from "@flexprice/sdk/funcs/activity-list-activity.js";
+import { accountingPeriodsQueryAccountingPeriod } from "@flexprice/sdk/funcs/accounting-periods-query-accounting-period.js";
 
 // Use `FlexpriceCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -29,12 +29,12 @@ const flexprice = new FlexpriceCore({
 });
 
 async function run() {
-  const res = await activityListActivity(flexprice, {});
+  const res = await accountingPeriodsQueryAccountingPeriod(flexprice, {});
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("activityListActivity failed:", res.error);
+    console.log("accountingPeriodsQueryAccountingPeriod failed:", res.error);
   }
 }
 

package/USAGE.md

@@ -7,7 +7,7 @@ const flexprice = new Flexprice({
 });
 
 async function run() {
-  const result = await flexprice.activity.listActivity({});
+  const result = await flexprice.accountingPeriods.queryAccountingPeriod({});
 
   console.log(result);
 }

package/docs/sdk/models/accounting-period-response.md

@@ -0,0 +1,21 @@
+# AccountingPeriodResponse
+
+## Example Usage
+
+```typescript
+import { AccountingPeriodResponse } from "@flexprice/sdk/sdk/models";
+
+let value: AccountingPeriodResponse = {};
+```
+
+## 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                                                                                           |
+| `id`                                                                                          | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `periodEnd`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `periodStart`                                                                                 | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `periodStatus`                                                                                | [models.AccountingPeriodStatus](../../sdk/models/accounting-period-status.md)                 | :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/accounting-period-status.md

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

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

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

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

@@ -0,0 +1,25 @@
+# AccountingperiodFilter
+
+## Example Usage
+
+```typescript
+import { AccountingperiodFilter } from "@flexprice/sdk/sdk/models";
+
+let value: AccountingperiodFilter = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `accountingPeriodIds`                                                                         | *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.AccountingperiodFilterOrder](../../sdk/models/accountingperiod-filter-order.md)       | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `periodStatuses`                                                                              | [models.AccountingPeriodStatus](../../sdk/models/accounting-period-status.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                                                                                           |

package/docs/sdk/models/amortization-method.md

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

package/docs/sdk/models/contract-association-response.md

@@ -0,0 +1,18 @@
+# ContractAssociationResponse
+
+## Example Usage
+
+```typescript
+import { ContractAssociationResponse } from "@flexprice/sdk/sdk/models";
+
+let value: ContractAssociationResponse = {};
+```
+
+## 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/contract-filter-order.md

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

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

@@ -0,0 +1,28 @@
+# ContractFilter
+
+## Example Usage
+
+```typescript
+import { ContractFilter } from "@flexprice/sdk/sdk/models";
+
+let value: ContractFilter = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `contractIds`                                                                                 | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `contractStatuses`                                                                            | [models.ContractStatus](../../sdk/models/contract-status.md)[]                                | :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                                                                                           |
+| `endedAtGte`                                                                                  | [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.ContractFilterOrder](../../sdk/models/contract-filter-order.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                                                                                           |
+| `subscriptionIds`                                                                             | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |

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

@@ -0,0 +1,25 @@
+# ContractResponse
+
+## Example Usage
+
+```typescript
+import { ContractResponse } from "@flexprice/sdk/sdk/models";
+
+let value: ContractResponse = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `associations`                                                                                | [models.ContractAssociationResponse](../../sdk/models/contract-association-response.md)[]     | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `contractStatus`                                                                              | [models.ContractStatus](../../sdk/models/contract-status.md)                                  | :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                                                                                           |
+| `endedAt`                                                                                     | [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                                                                                           |
+| `status`                                                                                      | [models.Status](../../sdk/models/status.md)                                                   | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `termEnd`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `termStart`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :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/contract-status.md

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

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

@@ -5,34 +5,31 @@
 ```typescript
 import { CreateEntitlementRequest } from "@flexprice/sdk/sdk/models";
 
-let value: CreateEntitlementRequest = {
-  featureId: "<id>",
-  featureType: "metered",
-};
+let value: CreateEntitlementRequest = {};
 ```
 
 ## Fields
 
-| Field                                                                                                  | Type                                                                                                   | Required                                                                                               | Description                                                                                            |
-| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
-| `aggregationMode`                                                                                      | [models.EntitlementAggregationMode](../../sdk/models/entitlement-aggregation-mode.md)                  | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
-| `configValue`                                                                                          | Record<string, *any*>                                                                                  | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
-| `endDate`                                                                                              | [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.EntitlementEntityType](../../sdk/models/entitlement-entity-type.md)                            | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
-| `featureId`                                                                                            | *string*                                                                                               | :heavy_check_mark:                                                                                     | N/A                                                                                                    |
-| `featureType`                                                                                          | [models.FeatureType](../../sdk/models/feature-type.md)                                                 | :heavy_check_mark:                                                                                     | N/A                                                                                                    |
-| `grantAllocationBehavior`                                                                              | [models.EntitlementGrantAllocationBehavior](../../sdk/models/entitlement-grant-allocation-behavior.md) | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
-| `grantDurationUnit`                                                                                    | [models.EntitlementGrantDurationUnit](../../sdk/models/entitlement-grant-duration-unit.md)             | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
-| `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                                                                                                    |
-| `grantUnlimited`                                                                                       | *boolean*                                                                                              | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
-| `isEnabled`                                                                                            | *boolean*                                                                                              | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
-| `isSoftLimit`                                                                                          | *boolean*                                                                                              | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
-| `parentEntitlementId`                                                                                  | *string*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
-| `planId`                                                                                               | *string*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
-| `startDate`                                                                                            | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)          | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
-| `staticValue`                                                                                          | *string*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
-| `usageLimit`                                                                                           | *number*                                                                                               | :heavy_minus_sign:                                                                                     | Deprecated: use grant_quota; a metered usage_limit is converted to a grant on create.                  |
-| `usageResetPeriod`                                                                                     | [models.EntitlementUsageResetPeriod](../../sdk/models/entitlement-usage-reset-period.md)               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| Field                                                                                                                    | Type                                                                                                                     | Required                                                                                                                 | Description                                                                                                              |
+| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
+| `aggregationMode`                                                                                                        | [models.EntitlementAggregationMode](../../sdk/models/entitlement-aggregation-mode.md)                                    | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `configValue`                                                                                                            | Record<string, *any*>                                                                                                    | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `endDate`                                                                                                                | [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.EntitlementEntityType](../../sdk/models/entitlement-entity-type.md)                                              | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `featureId`                                                                                                              | *string*                                                                                                                 | :heavy_minus_sign:                                                                                                       | Required, except on a subscription entitlement grant (entity_type SUBSCRIPTION with grant config), which has no feature. |
+| `featureType`                                                                                                            | [models.FeatureType](../../sdk/models/feature-type.md)                                                                   | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `grantAllocationBehavior`                                                                                                | [models.EntitlementGrantAllocationBehavior](../../sdk/models/entitlement-grant-allocation-behavior.md)                   | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `grantDurationUnit`                                                                                                      | [models.EntitlementGrantDurationUnit](../../sdk/models/entitlement-grant-duration-unit.md)                               | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `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                                                                                                                      |
+| `grantUnlimited`                                                                                                         | *boolean*                                                                                                                | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `isEnabled`                                                                                                              | *boolean*                                                                                                                | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `isSoftLimit`                                                                                                            | *boolean*                                                                                                                | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `parentEntitlementId`                                                                                                    | *string*                                                                                                                 | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `planId`                                                                                                                 | *string*                                                                                                                 | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `startDate`                                                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                            | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `staticValue`                                                                                                            | *string*                                                                                                                 | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |
+| `usageLimit`                                                                                                             | *number*                                                                                                                 | :heavy_minus_sign:                                                                                                       | Deprecated: use grant_quota; a metered usage_limit is converted to a grant on create.                                    |
+| `usageResetPeriod`                                                                                                       | [models.EntitlementUsageResetPeriod](../../sdk/models/entitlement-usage-reset-period.md)                                 | :heavy_minus_sign:                                                                                                       | N/A                                                                                                                      |

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

@@ -41,6 +41,7 @@ let value: CreatePriceRequest = {
 | `minQuantity`                                                                                 | *number*                                                                                      | :heavy_minus_sign:                                                                            | MinQuantity is the minimum quantity of the price                                              |
 | `priceUnitConfig`                                                                             | [models.PriceUnitConfig](../../sdk/models/price-unit-config.md)                               | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `priceUnitType`                                                                               | [models.PriceUnitType](../../sdk/models/price-unit-type.md)                                   | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `productId`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `startDate`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `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:                                                                            | N/A                                                                                           |

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

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

package/docs/sdk/models/create-subscription-entitlement-grant-request.md

@@ -0,0 +1,24 @@
+# CreateSubscriptionEntitlementGrantRequest
+
+## Example Usage
+
+```typescript
+import { CreateSubscriptionEntitlementGrantRequest } from "@flexprice/sdk/sdk/models";
+
+let value: CreateSubscriptionEntitlementGrantRequest = {
+  grantDurationUnit: "hour",
+  grantQuota: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                                                  | Type                                                                                                   | Required                                                                                               | Description                                                                                            |
+| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
+| `aggregationMode`                                                                                      | [models.EntitlementAggregationMode](../../sdk/models/entitlement-aggregation-mode.md)                  | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `endDate`                                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)          | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `grantAllocationBehavior`                                                                              | [models.EntitlementGrantAllocationBehavior](../../sdk/models/entitlement-grant-allocation-behavior.md) | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `grantDurationUnit`                                                                                    | [models.EntitlementGrantDurationUnit](../../sdk/models/entitlement-grant-duration-unit.md)             | :heavy_check_mark:                                                                                     | N/A                                                                                                    |
+| `grantDurationValue`                                                                                   | *number*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `grantQuota`                                                                                           | *string*                                                                                               | :heavy_check_mark:                                                                                     | N/A                                                                                                    |
+| `startDate`                                                                                            | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)          | :heavy_minus_sign:                                                                                     | StartDate defaults to the subscription's start; EndDate leaves the grant open.                         |

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

@@ -54,6 +54,7 @@ let value: CreateSubscriptionRequest = {
 | `prorationBehavior`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | [models.ProrationBehavior](../../sdk/models/proration-behavior.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
 | `startDate`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | 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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
 | `subscriptionStatus`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | [models.SubscriptionStatus](../../sdk/models/subscription-status.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
 | `taxRateOverrides`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | [models.TaxRateOverride](../../sdk/models/tax-rate-override.md)[]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
 | `timezone`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |

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

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

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

@@ -10,21 +10,22 @@ let value: EntitlementFilter = {};
 
 ## 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                                                                                           |
-| `entityIds`                                                                                   | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `entityType`                                                                                  | [models.EntitlementEntityType](../../sdk/models/entitlement-entity-type.md)                   | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `expand`                                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `featureIds`                                                                                  | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `featureType`                                                                                 | [models.FeatureType](../../sdk/models/feature-type.md)                                        | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `filters`                                                                                     | [models.FilterCondition](../../sdk/models/filter-condition.md)[]                              | :heavy_minus_sign:                                                                            | Specific filters for entitlements                                                             |
-| `hasGrantConfig`                                                                              | *boolean*                                                                                     | :heavy_minus_sign:                                                                            | HasGrantConfig filters on grant-config presence (grant_quota set or not).                     |
-| `isEnabled`                                                                                   | *boolean*                                                                                     | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `limit`                                                                                       | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `offset`                                                                                      | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `order`                                                                                       | [models.EntitlementFilterOrder](../../sdk/models/entitlement-filter-order.md)                 | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `planIds`                                                                                     | *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                                                                                           |
+| Field                                                                                                                                                                  | Type                                                                                                                                                                   | Required                                                                                                                                                               | Description                                                                                                                                                            |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `endTime`                                                                                                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                          | :heavy_minus_sign:                                                                                                                                                     | N/A                                                                                                                                                                    |
+| `entityIds`                                                                                                                                                            | *string*[]                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                     | N/A                                                                                                                                                                    |
+| `entityType`                                                                                                                                                           | [models.EntitlementEntityType](../../sdk/models/entitlement-entity-type.md)                                                                                            | :heavy_minus_sign:                                                                                                                                                     | N/A                                                                                                                                                                    |
+| `expand`                                                                                                                                                               | *string*                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                     | N/A                                                                                                                                                                    |
+| `featureIds`                                                                                                                                                           | *string*[]                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                     | N/A                                                                                                                                                                    |
+| `featureType`                                                                                                                                                          | [models.FeatureType](../../sdk/models/feature-type.md)                                                                                                                 | :heavy_minus_sign:                                                                                                                                                     | N/A                                                                                                                                                                    |
+| `filters`                                                                                                                                                              | [models.FilterCondition](../../sdk/models/filter-condition.md)[]                                                                                                       | :heavy_minus_sign:                                                                                                                                                     | Specific filters for entitlements                                                                                                                                      |
+| `grantScopes`                                                                                                                                                          | [models.EntitlementGrantScopeEntityType](../../sdk/models/entitlement-grant-scope-entity-type.md)[]                                                                    | :heavy_minus_sign:                                                                                                                                                     | GrantScopes selects entitlements by grant scope. Empty means feature only, so<br/>subscription entitlement grants, which have no feature, never reach feature-based reads. |
+| `hasGrantConfig`                                                                                                                                                       | *boolean*                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                     | HasGrantConfig filters on grant-config presence (grant_quota set or not).                                                                                              |
+| `isEnabled`                                                                                                                                                            | *boolean*                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                     | N/A                                                                                                                                                                    |
+| `limit`                                                                                                                                                                | *number*                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                     | N/A                                                                                                                                                                    |
+| `offset`                                                                                                                                                               | *number*                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                     | N/A                                                                                                                                                                    |
+| `order`                                                                                                                                                                | [models.EntitlementFilterOrder](../../sdk/models/entitlement-filter-order.md)                                                                                          | :heavy_minus_sign:                                                                                                                                                     | N/A                                                                                                                                                                    |
+| `planIds`                                                                                                                                                              | *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                                                                                                                                                                    |