@flexprice/sdk 2.1.1 → 2.1.3

package/docs/sdk/models/billing-cadence.md

@@ -6,12 +6,10 @@
 import { BillingCadence } from "@flexprice/sdk/sdk/models";
 
 let value: BillingCadence = "RECURRING";
-
-// Open enum: unrecognized values are captured as Unrecognized<string>
 ```
 
 ## Values
 
 ```typescript
-"RECURRING" | "ONETIME" | Unrecognized<string>
+"RECURRING"
 ```

package/docs/sdk/models/billing-period.md

@@ -13,5 +13,5 @@ let value: BillingPeriod = "MONTHLY";
 ## Values
 
 ```typescript
-"MONTHLY" | "ANNUAL" | "WEEKLY" | "DAILY" | "QUARTERLY" | "HALF_YEARLY" | Unrecognized<string>
+"MONTHLY" | "ANNUAL" | "WEEKLY" | "DAILY" | "QUARTERLY" | "HALF_YEARLY" | "ONETIME" | Unrecognized<string>
 ```

package/docs/sdk/models/changed-invoice-action.md

@@ -0,0 +1,19 @@
+# ChangedInvoiceAction
+
+created (proration invoice) | wallet_credit (downgrade credit)
+
+## Example Usage
+
+```typescript
+import { ChangedInvoiceAction } from "@flexprice/sdk/sdk/models";
+
+let value: ChangedInvoiceAction = "created";
+
+// Open enum: unrecognized values are captured as Unrecognized<string>
+```
+
+## Values
+
+```typescript
+"created" | "wallet_credit" | Unrecognized<string>
+```

package/docs/sdk/models/changed-invoice-status.md

@@ -0,0 +1,19 @@
+# ChangedInvoiceStatus
+
+preview | issued | INITIATED | PENDING | PROCESSING | SUCCEEDED | OVERPAID | FAILED | REFUNDED | PARTIALLY_REFUNDED
+
+## Example Usage
+
+```typescript
+import { ChangedInvoiceStatus } from "@flexprice/sdk/sdk/models";
+
+let value: ChangedInvoiceStatus = "preview";
+
+// Open enum: unrecognized values are captured as Unrecognized<string>
+```
+
+## Values
+
+```typescript
+"preview" | "issued" | Unrecognized<string>
+```

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

@@ -0,0 +1,30 @@
+# ChangedInvoice
+
+## Example Usage
+
+```typescript
+import { ChangedInvoice } from "@flexprice/sdk/sdk/models";
+
+let value: ChangedInvoice = {
+  invoice: {
+    subscription: {
+      latestInvoice: {
+        subscription: {
+          plan: {},
+        },
+      },
+      plan: {},
+    },
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                                               | Type                                                                                                                | Required                                                                                                            | Description                                                                                                         |
+| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
+| `action`                                                                                                            | [models.ChangedInvoiceAction](../../sdk/models/changed-invoice-action.md)                                           | :heavy_minus_sign:                                                                                                  | created (proration invoice) \| wallet_credit (downgrade credit)                                                     |
+| `id`                                                                                                                | *string*                                                                                                            | :heavy_minus_sign:                                                                                                  | N/A                                                                                                                 |
+| `invoice`                                                                                                           | [models.InvoiceResponse](../../sdk/models/invoice-response.md)                                                      | :heavy_minus_sign:                                                                                                  | N/A                                                                                                                 |
+| `status`                                                                                                            | [models.ChangedInvoiceStatus](../../sdk/models/changed-invoice-status.md)                                           | :heavy_minus_sign:                                                                                                  | preview \| issued \| INITIATED \| PENDING \| PROCESSING \| SUCCEEDED \| OVERPAID \| FAILED \| REFUNDED \| PARTIALLY_REFUNDED |
+| `walletTransaction`                                                                                                 | [models.WalletTransactionResponse](../../sdk/models/wallet-transaction-response.md)                                 | :heavy_minus_sign:                                                                                                  | N/A                                                                                                                 |

package/docs/sdk/models/changed-line-item-action.md

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

package/docs/sdk/models/changed-line-item.md

@@ -0,0 +1,20 @@
+# ChangedLineItem
+
+## Example Usage
+
+```typescript
+import { ChangedLineItem } from "@flexprice/sdk/sdk/models";
+
+let value: ChangedLineItem = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `changeAction`                                                                                | [models.ChangedLineItemAction](../../sdk/models/changed-line-item-action.md)                  | :heavy_minus_sign:                                                                            | created \| updated \| ended                                                                   |
+| `endDate`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `id`                                                                                          | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `priceId`                                                                                     | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `quantity`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `startDate`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/changed-resources.md

@@ -0,0 +1,32 @@
+# ChangedResources
+
+## Example Usage
+
+```typescript
+import { ChangedResources } from "@flexprice/sdk/sdk/models";
+
+let value: ChangedResources = {
+  invoices: [
+    {
+      invoice: {
+        subscription: {
+          latestInvoice: {
+            subscription: {
+              plan: {},
+            },
+          },
+          plan: {},
+        },
+      },
+    },
+  ],
+};
+```
+
+## Fields
+
+| Field                                                                    | Type                                                                     | Required                                                                 | Description                                                              |
+| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
+| `invoices`                                                               | [models.ChangedInvoice](../../sdk/models/changed-invoice.md)[]           | :heavy_minus_sign:                                                       | N/A                                                                      |
+| `lineItems`                                                              | [models.ChangedLineItem](../../sdk/models/changed-line-item.md)[]        | :heavy_minus_sign:                                                       | N/A                                                                      |
+| `subscriptions`                                                          | [models.ChangedSubscription](../../sdk/models/changed-subscription.md)[] | :heavy_minus_sign:                                                       | N/A                                                                      |

package/docs/sdk/models/changed-subscription-action.md

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

package/docs/sdk/models/changed-subscription.md

@@ -0,0 +1,17 @@
+# ChangedSubscription
+
+## Example Usage
+
+```typescript
+import { ChangedSubscription } from "@flexprice/sdk/sdk/models";
+
+let value: ChangedSubscription = {};
+```
+
+## Fields
+
+| Field                                                                               | Type                                                                                | Required                                                                            | Description                                                                         |
+| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
+| `action`                                                                            | [models.ChangedSubscriptionAction](../../sdk/models/changed-subscription-action.md) | :heavy_minus_sign:                                                                  | created \| updated                                                                  |
+| `id`                                                                                | *string*                                                                            | :heavy_minus_sign:                                                                  | N/A                                                                                 |
+| `status`                                                                            | [models.SubscriptionStatus](../../sdk/models/subscription-status.md)                | :heavy_minus_sign:                                                                  | N/A                                                                                 |

package/docs/sdk/models/clone-environment-request-request.md

@@ -0,0 +1,19 @@
+# CloneEnvironmentRequestRequest
+
+## Example Usage
+
+```typescript
+import { CloneEnvironmentRequestRequest } from "@flexprice/sdk/sdk/models";
+
+let value: CloneEnvironmentRequestRequest = {
+  id: "<id>",
+  body: {},
+};
+```
+
+## Fields
+
+| Field                                                                           | Type                                                                            | Required                                                                        | Description                                                                     |
+| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
+| `id`                                                                            | *string*                                                                        | :heavy_check_mark:                                                              | Source Environment ID                                                           |
+| `body`                                                                          | [models.CloneEnvironmentRequest](../../sdk/models/clone-environment-request.md) | :heavy_check_mark:                                                              | Clone configuration                                                             |

package/docs/sdk/models/clone-environment-request.md

@@ -0,0 +1,17 @@
+# CloneEnvironmentRequest
+
+## Example Usage
+
+```typescript
+import { CloneEnvironmentRequest } from "@flexprice/sdk/sdk/models";
+
+let value: CloneEnvironmentRequest = {};
+```
+
+## Fields
+
+| Field                                                                                                                                                                  | Type                                                                                                                                                                   | Required                                                                                                                                                               | Description                                                                                                                                                            |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `name`                                                                                                                                                                 | *string*                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                     | Name of the new environment (required when target_environment_id is not provided)                                                                                      |
+| `targetEnvironmentId`                                                                                                                                                  | *string*                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                     | TargetEnvironmentID is the ID of an existing environment to clone into (optional).<br/>When provided, Name and Type are ignored. When omitted, Name and Type are required. |
+| `type`                                                                                                                                                                 | [models.EnvironmentType](../../sdk/models/environment-type.md)                                                                                                         | :heavy_minus_sign:                                                                                                                                                     | N/A                                                                                                                                                                    |

package/docs/sdk/models/clone-feature-request-request.md

@@ -0,0 +1,19 @@
+# CloneFeatureRequestRequest
+
+## Example Usage
+
+```typescript
+import { CloneFeatureRequestRequest } from "@flexprice/sdk/sdk/models";
+
+let value: CloneFeatureRequestRequest = {
+  id: "<id>",
+  body: {},
+};
+```
+
+## Fields
+
+| Field                                                                   | Type                                                                    | Required                                                                | Description                                                             |
+| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
+| `id`                                                                    | *string*                                                                | :heavy_check_mark:                                                      | Source Feature ID                                                       |
+| `body`                                                                  | [models.CloneFeatureRequest](../../sdk/models/clone-feature-request.md) | :heavy_check_mark:                                                      | Clone configuration                                                     |

package/docs/sdk/models/clone-feature-request.md

@@ -0,0 +1,18 @@
+# CloneFeatureRequest
+
+## Example Usage
+
+```typescript
+import { CloneFeatureRequest } from "@flexprice/sdk/sdk/models";
+
+let value: CloneFeatureRequest = {};
+```
+
+## Fields
+
+| Field                                                                 | Type                                                                  | Required                                                              | Description                                                           |
+| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
+| `description`                                                         | *string*                                                              | :heavy_minus_sign:                                                    | Description overrides the source feature's description when provided  |
+| `lookupKey`                                                           | *string*                                                              | :heavy_minus_sign:                                                    | LookupKey is required and must be unique across published features    |
+| `metadata`                                                            | Record<string, *string*>                                              | :heavy_minus_sign:                                                    | N/A                                                                   |
+| `name`                                                                | *string*                                                              | :heavy_minus_sign:                                                    | Name is required and must be different from the source feature's name |

package/docs/sdk/models/{post-plans-id-clone-request.md → clone-plan-request-request.md}

@@ -1,11 +1,11 @@
-# PostPlansIdCloneRequest
+# ClonePlanRequestRequest
 
 ## Example Usage
 
 ```typescript
-import { PostPlansIdCloneRequest } from "@flexprice/sdk/sdk/models";
+import { ClonePlanRequestRequest } from "@flexprice/sdk/sdk/models";
 
-let value: PostPlansIdCloneRequest = {
+let value: ClonePlanRequestRequest = {
   id: "<id>",
   body: {},
 };

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

@@ -6,15 +6,14 @@
 import { CreatePriceRequest } from "@flexprice/sdk/sdk/models";
 
 let value: CreatePriceRequest = {
-  billingCadence: "RECURRING",
-  billingModel: "FLAT_FEE",
-  billingPeriod: "QUARTERLY",
-  currency: "Namibia Dollar",
+  billingModel: "PACKAGE",
+  billingPeriod: "ANNUAL",
+  currency: "Swedish Krona",
   entityId: "<id>",
-  entityType: "PRICE",
-  invoiceCadence: "ARREAR",
-  priceUnitType: "CUSTOM",
-  type: "USAGE",
+  entityType: "COSTSHEET",
+  invoiceCadence: "ADVANCE",
+  priceUnitType: "FIAT",
+  type: "FIXED",
 };
 ```
 
@@ -23,7 +22,6 @@ let value: CreatePriceRequest = {
 | Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
 | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
 | `amount`                                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `billingCadence`                                                                              | [models.BillingCadence](../../sdk/models/billing-cadence.md)                                  | :heavy_check_mark:                                                                            | N/A                                                                                           |
 | `billingModel`                                                                                | [models.BillingModel](../../sdk/models/billing-model.md)                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
 | `billingPeriod`                                                                               | [models.BillingPeriod](../../sdk/models/billing-period.md)                                    | :heavy_check_mark:                                                                            | N/A                                                                                           |
 | `billingPeriodCount`                                                                          | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |