@flexprice/sdk 2.1.30 → 2.1.34

package/docs/sdk/models/create-fx-rate-request.md

@@ -0,0 +1,27 @@
+# CreateFXRateRequest
+
+## Example Usage
+
+```typescript
+import { CreateFXRateRequest } from "@flexprice/sdk/sdk/models";
+
+let value: CreateFXRateRequest = {
+  fromCurrency: "<value>",
+  scope: "tenant",
+  toCurrency: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `endDate`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `fromCurrency`                                                                                | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `metadata`                                                                                    | Record<string, *string*>                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `rate`                                                                                        | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `scope`                                                                                       | [models.FXRateScope](../../sdk/models/fx-rate-scope.md)                                       | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `scopeId`                                                                                     | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `source`                                                                                      | [models.FXRateSource](../../sdk/models/fx-rate-source.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                                                                                           |
+| `toCurrency`                                                                                  | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |

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

@@ -22,6 +22,7 @@ let value: CreateInvoiceRequest = {
 | `amountPaid`                                                                                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | amount_paid is the amount that has been paid towards this invoice                                                                                                                                                                                                                                |
 | `billingPeriod`                                                                                                                                                                                                                                                                                  | *string*                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | billing_period is the period this invoice covers (e.g., "monthly", "yearly")                                                                                                                                                                                                                     |
 | `billingReason`                                                                                                                                                                                                                                                                                  | [models.InvoiceBillingReason](../../sdk/models/invoice-billing-reason.md)                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                              |
+| `checkout`                                                                                                                                                                                                                                                                                       | [models.CheckoutParams](../../sdk/models/checkout-params.md)                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                              |
 | `coupons`                                                                                                                                                                                                                                                                                        | *string*[]                                                                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | coupons                                                                                                                                                                                                                                                                                          |
 | `currency`                                                                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                                                                                                                                               | currency is the three-letter ISO currency code (e.g., USD, EUR) for the invoice                                                                                                                                                                                                                  |
 | `customerId`                                                                                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                                                                                                                                               | customer_id is the unique identifier of the customer this invoice belongs to                                                                                                                                                                                                                     |

package/docs/sdk/models/create-scheduled-task-request.md

@@ -7,7 +7,7 @@ import { CreateScheduledTaskRequest } from "@flexprice/sdk/sdk/models";
 
 let value: CreateScheduledTaskRequest = {
   connectionId: "<id>",
-  entityType: "credit_topups",
+  entityType: "credit_usage",
   interval: "30MIN",
   jobConfig: {},
 };

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

@@ -38,6 +38,7 @@ let value: CreateSubscriptionRequest = {
 | `inheritance`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | [models.SubscriptionInheritanceConfig](../../sdk/models/subscription-inheritance-config.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
 | `lineItemCommitments`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | LineItemCommitments sets per-line-item commitment config, keyed by price_id.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
 | `lineItemCoupons`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Record<string, *string*[]>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Deprecated: use SubscriptionCoupons instead.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| `lineItemGrouping`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | [models.LineItemGrouping](../../sdk/models/line-item-grouping.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
 | `lineItems`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [models.CreateSubscriptionLineItemRequest](../../sdk/models/create-subscription-line-item-request.md)[]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | LineItems are extra (non-plan) line items added at creation.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
 | `lookupKey`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
 | `metadata`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | Record<string, *string*>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |

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

@@ -0,0 +1,24 @@
+# CreateViewRequest
+
+## Example Usage
+
+```typescript
+import { CreateViewRequest } from "@flexprice/sdk/sdk/models";
+
+let value: CreateViewRequest = {
+  definition: {
+    metrics: [
+      "usage_quantity",
+    ],
+    shape: "breakdown",
+  },
+  name: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                           | Type                                                                            | Required                                                                        | Description                                                                     |
+| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
+| `definition`                                                                    | [models.AnalyticsViewDefinition](../../sdk/models/analytics-view-definition.md) | :heavy_check_mark:                                                              | N/A                                                                             |
+| `name`                                                                          | *string*                                                                        | :heavy_check_mark:                                                              | N/A                                                                             |

package/docs/sdk/models/delete-fx-rate-request.md

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

package/docs/sdk/models/entitlement-grant-status.md

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

package/docs/sdk/models/entity-creation-conflict-policies.md

@@ -0,0 +1,15 @@
+# EntityCreationConflictPolicies
+
+## Example Usage
+
+```typescript
+import { EntityCreationConflictPolicies } from "@flexprice/sdk/sdk/models";
+
+let value: EntityCreationConflictPolicies = {};
+```
+
+## Fields
+
+| Field                                                                          | Type                                                                           | Required                                                                       | Description                                                                    |
+| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
+| `onExistingEntity`                                                             | [models.OnExistingEntityPolicy](../../sdk/models/on-existing-entity-policy.md) | :heavy_minus_sign:                                                             | N/A                                                                            |

package/docs/sdk/models/entity-creation-options.md

@@ -0,0 +1,15 @@
+# EntityCreationOptions
+
+## Example Usage
+
+```typescript
+import { EntityCreationOptions } from "@flexprice/sdk/sdk/models";
+
+let value: EntityCreationOptions = {};
+```
+
+## Fields
+
+| Field                                                                                          | Type                                                                                           | Required                                                                                       | Description                                                                                    |
+| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
+| `entityCreationConflictPolicies`                                                               | [models.EntityCreationConflictPolicies](../../sdk/models/entity-creation-conflict-policies.md) | :heavy_minus_sign:                                                                             | N/A                                                                                            |

package/docs/sdk/models/entity-creation-result.md

@@ -0,0 +1,16 @@
+# EntityCreationResult
+
+## Example Usage
+
+```typescript
+import { EntityCreationResult } from "@flexprice/sdk/sdk/models";
+
+let value: EntityCreationResult = {};
+```
+
+## Fields
+
+| Field                                                                     | Type                                                                      | Required                                                                  | Description                                                               |
+| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| `entityId`                                                                | *string*                                                                  | :heavy_minus_sign:                                                        | N/A                                                                       |
+| `status`                                                                  | [models.EntityCreationStatus](../../sdk/models/entity-creation-status.md) | :heavy_minus_sign:                                                        | N/A                                                                       |

package/docs/sdk/models/entity-creation-status.md

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

package/docs/sdk/models/event.md

@@ -10,13 +10,14 @@ let value: Event = {};
 
 ## Fields
 
-| Field                 | Type                  | Required              | Description           |
-| --------------------- | --------------------- | --------------------- | --------------------- |
-| `customerId`          | *string*              | :heavy_minus_sign:    | N/A                   |
-| `environmentId`       | *string*              | :heavy_minus_sign:    | N/A                   |
-| `eventName`           | *string*              | :heavy_minus_sign:    | N/A                   |
-| `externalCustomerId`  | *string*              | :heavy_minus_sign:    | N/A                   |
-| `id`                  | *string*              | :heavy_minus_sign:    | N/A                   |
-| `properties`          | Record<string, *any*> | :heavy_minus_sign:    | N/A                   |
-| `source`              | *string*              | :heavy_minus_sign:    | N/A                   |
-| `timestamp`           | *string*              | :heavy_minus_sign:    | N/A                   |
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `customerId`                                                                                  | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `environmentId`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `eventName`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `externalCustomerId`                                                                          | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `id`                                                                                          | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `ingestedAt`                                                                                  | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `properties`                                                                                  | Record<string, *any*>                                                                         | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `source`                                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `timestamp`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/execute-subscription-modify-request-request.md

@@ -8,7 +8,7 @@ import { ExecuteSubscriptionModifyRequestRequest } from "@flexprice/sdk/sdk/mode
 let value: ExecuteSubscriptionModifyRequestRequest = {
   id: "<id>",
   body: {
-    type: "trial_end",
+    type: "coupon",
   },
 };
 ```

package/docs/sdk/models/execute-subscription-modify-request.md

@@ -14,11 +14,13 @@ let value: ExecuteSubscriptionModifyRequest = {
 
 | Field                                                                                             | Type                                                                                              | Required                                                                                          | Description                                                                                       |
 | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
+| `addonBulkParams`                                                                                 | [models.SubModifyBulkAddonParams](../../sdk/models/sub-modify-bulk-addon-params.md)               | :heavy_minus_sign:                                                                                | N/A                                                                                               |
 | `addonParams`                                                                                     | [models.SubModifyAddonParams](../../sdk/models/sub-modify-addon-params.md)                        | :heavy_minus_sign:                                                                                | N/A                                                                                               |
 | `checkout`                                                                                        | [models.CheckoutParams](../../sdk/models/checkout-params.md)                                      | :heavy_minus_sign:                                                                                | N/A                                                                                               |
 | `couponParams`                                                                                    | [models.SubModifyCouponParams](../../sdk/models/sub-modify-coupon-params.md)                      | :heavy_minus_sign:                                                                                | N/A                                                                                               |
 | `groupedInvoicingParams`                                                                          | [models.SubModifyGroupedInvoicingParams](../../sdk/models/sub-modify-grouped-invoicing-params.md) | :heavy_minus_sign:                                                                                | N/A                                                                                               |
 | `inheritanceParams`                                                                               | [models.SubModifyInheritanceRequest](../../sdk/models/sub-modify-inheritance-request.md)          | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `lineItemChangeParams`                                                                            | [models.SubModifyLineItemChangeRequest](../../sdk/models/sub-modify-line-item-change-request.md)  | :heavy_minus_sign:                                                                                | N/A                                                                                               |
 | `quantityChangeParams`                                                                            | [models.SubModifyQuantityChangeRequest](../../sdk/models/sub-modify-quantity-change-request.md)   | :heavy_minus_sign:                                                                                | N/A                                                                                               |
 | `taxParams`                                                                                       | [models.SubModifyTaxParams](../../sdk/models/sub-modify-tax-params.md)                            | :heavy_minus_sign:                                                                                | N/A                                                                                               |
 | `trialEndParams`                                                                                  | [models.SubModifyTrialEndRequest](../../sdk/models/sub-modify-trial-end-request.md)               | :heavy_minus_sign:                                                                                | N/A                                                                                               |

package/docs/sdk/models/execution-details.md

@@ -0,0 +1,15 @@
+# ExecutionDetails
+
+## Example Usage
+
+```typescript
+import { ExecutionDetails } from "@flexprice/sdk/sdk/models";
+
+let value: ExecutionDetails = {};
+```
+
+## Fields
+
+| Field                                                                              | Type                                                                               | Required                                                                           | Description                                                                        |
+| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| `planChange`                                                                       | [models.PlanChangeScheduleResult](../../sdk/models/plan-change-schedule-result.md) | :heavy_minus_sign:                                                                 | N/A                                                                                |

package/docs/sdk/models/fact-status.md

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

package/docs/sdk/models/feature-usage-summary.md

@@ -22,14 +22,21 @@ let value: FeatureUsageSummary = {
 
 ## Fields
 
-| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
-| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
-| `currentUsage`                                                                                | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `feature`                                                                                     | [models.FeatureResponse](../../sdk/models/feature-response.md)                                | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `isEnabled`                                                                                   | *boolean*                                                                                     | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `isSoftLimit`                                                                                 | *boolean*                                                                                     | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `isUnlimited`                                                                                 | *boolean*                                                                                     | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `nextUsageResetAt`                                                                            | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `sources`                                                                                     | [models.EntitlementSource](../../sdk/models/entitlement-source.md)[]                          | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `totalLimit`                                                                                  | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `usagePercent`                                                                                | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| Field                                                                                                                                                                                                                                                                                                               | Type                                                                                                                                                                                                                                                                                                                | Required                                                                                                                                                                                                                                                                                                            | Description                                                                                                                                                                                                                                                                                                         |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `buckets`                                                                                                                                                                                                                                                                                                           | [models.AggregatedEntitlementBucket](../../sdk/models/aggregated-entitlement-bucket.md)[]                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                  | Buckets is one entry per independent budget on a parallel feature. The scalar<br/>figures above cannot describe several budgets at once — a sum is not spendable<br/>from any one of them — so a client showing a parallel feature reads these instead.<br/>Empty for additive features, where the scalars are the whole truth. |
+| `currentUsage`                                                                                                                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                 |
+| `feature`                                                                                                                                                                                                                                                                                                           | [models.FeatureResponse](../../sdk/models/feature-response.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                                                                                                                                                                                                                                                                                                                 |
+| `grantState`                                                                                                                                                                                                                                                                                                        | [models.GrantState](../../sdk/models/grant-state.md)                                                                                                                                                                                                                                                                | :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                                                                                                                                                                                                                                                                                                                 |
+| `isUnlimited`                                                                                                                                                                                                                                                                                                       | *boolean*                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                 |
+| `nextUsageResetAt`                                                                                                                                                                                                                                                                                                  | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                 |
+| `sources`                                                                                                                                                                                                                                                                                                           | [models.EntitlementSource](../../sdk/models/entitlement-source.md)[]                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                 |
+| `totalLimit`                                                                                                                                                                                                                                                                                                        | *number*                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                 |
+| `usagePercent`                                                                                                                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                 |

package/docs/sdk/models/filter-operator-type.md

@@ -6,10 +6,12 @@
 import { FilterOperatorType } from "@flexprice/sdk/sdk/models";
 
 let value: FilterOperatorType = "gte";
+
+// Open enum: unrecognized values are captured as Unrecognized<string>
 ```
 
 ## Values
 
 ```typescript
-"eq" | "contains" | "not_contains" | "gt" | "lt" | "gte" | "in" | "not_in" | "before" | "after"
+"eq" | "contains" | "not_contains" | "gt" | "lt" | "gte" | "in" | "not_in" | "before" | "after" | Unrecognized<string>
 ```

package/docs/sdk/models/fx-rate-filter-order.md

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

package/docs/sdk/models/fx-rate-filter.md

@@ -0,0 +1,28 @@
+# FXRateFilter
+
+## Example Usage
+
+```typescript
+import { FXRateFilter } from "@flexprice/sdk/sdk/models";
+
+let value: FXRateFilter = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `endTime`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `expand`                                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `filters`                                                                                     | [models.FilterCondition](../../sdk/models/filter-condition.md)[]                              | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `fromCurrency`                                                                                | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `fxRateIds`                                                                                   | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `limit`                                                                                       | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `offset`                                                                                      | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `order`                                                                                       | [models.FXRateFilterOrder](../../sdk/models/fx-rate-filter-order.md)                          | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `scope`                                                                                       | [models.FXRateScope](../../sdk/models/fx-rate-scope.md)                                       | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `scopeId`                                                                                     | *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                                                                                           |
+| `toCurrency`                                                                                  | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/fx-rate-response.md

@@ -0,0 +1,31 @@
+# FXRateResponse
+
+## Example Usage
+
+```typescript
+import { FXRateResponse } from "@flexprice/sdk/sdk/models";
+
+let value: FXRateResponse = {};
+```
+
+## 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                                                                                           |
+| `createdBy`                                                                                   | *string*                                                                                      | :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                                                                                           |
+| `environmentId`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `fromCurrency`                                                                                | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `id`                                                                                          | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `metadata`                                                                                    | Record<string, *string*>                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `rate`                                                                                        | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `scope`                                                                                       | [models.FXRateScope](../../sdk/models/fx-rate-scope.md)                                       | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `scopeId`                                                                                     | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `source`                                                                                      | [models.FXRateSource](../../sdk/models/fx-rate-source.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                                                                                           |
+| `status`                                                                                      | [models.Status](../../sdk/models/status.md)                                                   | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `tenantId`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `toCurrency`                                                                                  | *string*                                                                                      | :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                                                                                           |
+| `updatedBy`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/fx-rate-scope.md

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

package/docs/sdk/models/fx-rate-source.md

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

package/docs/sdk/models/get-event-by-id-response.md

@@ -14,5 +14,6 @@ let value: GetEventByIDResponse = {};
 | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
 | `debugTracker`                                                                       | [models.DebugTracker](../../sdk/models/debug-tracker.md)                             | :heavy_minus_sign:                                                                   | N/A                                                                                  |
 | `event`                                                                              | [models.Event](../../sdk/models/event.md)                                            | :heavy_minus_sign:                                                                   | N/A                                                                                  |
+| `events`                                                                             | [models.Event](../../sdk/models/event.md)[]                                          | :heavy_minus_sign:                                                                   | N/A                                                                                  |
 | `processedEvents`                                                                    | [models.FeatureUsageInfo](../../sdk/models/feature-usage-info.md)[]                  | :heavy_minus_sign:                                                                   | N/A                                                                                  |
 | `status`                                                                             | [models.EventProcessingStatusType](../../sdk/models/event-processing-status-type.md) | :heavy_minus_sign:                                                                   | N/A                                                                                  |