@flexprice/sdk 2.1.1 → 2.1.3

package/docs/sdk/models/secret-provider.md

@@ -5,7 +5,7 @@
 ```typescript
 import { SecretProvider } from "@flexprice/sdk/sdk/models";
 
-let value: SecretProvider = "chargebee";
+let value: SecretProvider = "quickbooks";
 
 // Open enum: unrecognized values are captured as Unrecognized<string>
 ```
@@ -13,5 +13,5 @@ let value: SecretProvider = "chargebee";
 ## Values
 
 ```typescript
-"flexprice" | "stripe" | "s3" | "hubspot" | "razorpay" | "chargebee" | "quickbooks" | "nomod" | "moyasar" | "paddle" | Unrecognized<string>
+"flexprice" | "stripe" | "s3" | "hubspot" | "razorpay" | "chargebee" | "quickbooks" | "zoho_books" | "nomod" | "moyasar" | "paddle" | Unrecognized<string>
 ```

package/docs/sdk/models/{execute-subscription-inheritance-request.md → sub-modify-inheritance-request.md}

@@ -1,11 +1,11 @@
-# ExecuteSubscriptionInheritanceRequest
+# SubModifyInheritanceRequest
 
 ## Example Usage
 
 ```typescript
-import { ExecuteSubscriptionInheritanceRequest } from "@flexprice/sdk/sdk/models";
+import { SubModifyInheritanceRequest } from "@flexprice/sdk/sdk/models";
 
-let value: ExecuteSubscriptionInheritanceRequest = {};
+let value: SubModifyInheritanceRequest = {};
 ```
 
 ## Fields

package/docs/sdk/models/sub-modify-quantity-change-request.md

@@ -0,0 +1,22 @@
+# SubModifyQuantityChangeRequest
+
+## Example Usage
+
+```typescript
+import { SubModifyQuantityChangeRequest } from "@flexprice/sdk/sdk/models";
+
+let value: SubModifyQuantityChangeRequest = {
+  lineItems: [
+    {
+      id: "<id>",
+      quantity: "<value>",
+    },
+  ],
+};
+```
+
+## Fields
+
+| Field                                                                            | Type                                                                             | Required                                                                         | Description                                                                      |
+| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
+| `lineItems`                                                                      | [models.LineItemQuantityChange](../../sdk/models/line-item-quantity-change.md)[] | :heavy_check_mark:                                                               | N/A                                                                              |

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

@@ -10,7 +10,7 @@ import { SubscriptionChangeRequest } from "@flexprice/sdk/sdk/models";
 let value: SubscriptionChangeRequest = {
   billingCadence: "RECURRING",
   billingCycle: "anniversary",
-  billingPeriod: "MONTHLY",
+  billingPeriod: "ANNUAL",
   prorationBehavior: "create_prorations",
   targetPlanId: "<id>",
 };

package/docs/sdk/models/subscription-modify-response.md

@@ -0,0 +1,41 @@
+# SubscriptionModifyResponse
+
+## Example Usage
+
+```typescript
+import { SubscriptionModifyResponse } from "@flexprice/sdk/sdk/models";
+
+let value: SubscriptionModifyResponse = {
+  changedResources: {
+    invoices: [
+      {
+        invoice: {
+          subscription: {
+            latestInvoice: {
+              subscription: {
+                plan: {},
+              },
+            },
+            plan: {},
+          },
+        },
+      },
+    ],
+  },
+  subscription: {
+    latestInvoice: {
+      subscription: {
+        plan: {},
+      },
+    },
+    plan: {},
+  },
+};
+```
+
+## Fields
+
+| Field                                                                    | Type                                                                     | Required                                                                 | Description                                                              |
+| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
+| `changedResources`                                                       | [models.ChangedResources](../../sdk/models/changed-resources.md)         | :heavy_minus_sign:                                                       | N/A                                                                      |
+| `subscription`                                                           | [models.SubscriptionResponse](../../sdk/models/subscription-response.md) | :heavy_minus_sign:                                                       | N/A                                                                      |

package/docs/sdk/models/subscription-modify-type.md

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

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

@@ -12,11 +12,12 @@ let value: SubscriptionPhaseCreateRequest = {
 
 ## Fields
 
-| Field                                                                                                                                                     | Type                                                                                                                                                      | Required                                                                                                                                                  | Description                                                                                                                                               |
-| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `coupons`                                                                                                                                                 | *string*[]                                                                                                                                                | :heavy_minus_sign:                                                                                                                                        | Coupons represents subscription-level coupons to be applied to this phase                                                                                 |
-| `endDate`                                                                                                                                                 | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                             | :heavy_minus_sign:                                                                                                                                        | N/A                                                                                                                                                       |
-| `lineItemCoupons`                                                                                                                                         | Record<string, *string*[]>                                                                                                                                | :heavy_minus_sign:                                                                                                                                        | LineItemCoupons represents line item-level coupons (map of line_item_id to coupon IDs)                                                                    |
-| `metadata`                                                                                                                                                | Record<string, *string*>                                                                                                                                  | :heavy_minus_sign:                                                                                                                                        | N/A                                                                                                                                                       |
-| `overrideLineItems`                                                                                                                                       | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[]                                                                        | :heavy_minus_sign:                                                                                                                                        | OverrideLineItems allows customizing specific prices for this phase<br/>If not provided, phase will use the same line items as the subscription (plan prices) |
-| `startDate`                                                                                                                                               | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                             | :heavy_check_mark:                                                                                                                                        | N/A                                                                                                                                                       |
+| Field                                                                                                                                                             | Type                                                                                                                                                              | Required                                                                                                                                                          | Description                                                                                                                                                       |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `coupons`                                                                                                                                                         | *string*[]                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                | Coupons represents subscription-level coupons to be applied to this phase                                                                                         |
+| `endDate`                                                                                                                                                         | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                     | :heavy_minus_sign:                                                                                                                                                | N/A                                                                                                                                                               |
+| `lineItemCoupons`                                                                                                                                                 | Record<string, *string*[]>                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                | LineItemCoupons represents line item-level coupons (map of line_item_id to coupon IDs)                                                                            |
+| `lineItems`                                                                                                                                                       | [models.CreateSubscriptionLineItemRequest](../../sdk/models/create-subscription-line-item-request.md)[]                                                           | :heavy_minus_sign:                                                                                                                                                | LineItems are extra line items to add during this phase, primarily one-time charges.<br/>Each item's start_date defaults to the phase's start_date when not provided. |
+| `metadata`                                                                                                                                                        | Record<string, *string*>                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                | N/A                                                                                                                                                               |
+| `overrideLineItems`                                                                                                                                               | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[]                                                                                | :heavy_minus_sign:                                                                                                                                                | OverrideLineItems allows customizing specific prices for this phase<br/>If not provided, phase will use the same line items as the subscription (plan prices)     |
+| `startDate`                                                                                                                                                       | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                     | :heavy_check_mark:                                                                                                                                                | N/A                                                                                                                                                               |

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

@@ -6,10 +6,9 @@
 import { SubscriptionPriceCreateRequest } from "@flexprice/sdk/sdk/models";
 
 let value: SubscriptionPriceCreateRequest = {
-  billingCadence: "ONETIME",
-  billingModel: "FLAT_FEE",
-  billingPeriod: "MONTHLY",
-  invoiceCadence: "ADVANCE",
+  billingModel: "PACKAGE",
+  billingPeriod: "ANNUAL",
+  invoiceCadence: "ARREAR",
   priceUnitType: "CUSTOM",
   type: "FIXED",
 };
@@ -20,7 +19,6 @@ let value: SubscriptionPriceCreateRequest = {
 | 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                                                                                           |

package/docs/sdks/environments/README.md

@@ -0,0 +1,79 @@
+# Environments
+
+## Overview
+
+### Available Operations
+
+* [cloneEnvironment](#cloneenvironment) - Clone an environment
+
+## cloneEnvironment
+
+Clone all published features and plans from the source environment into a target environment. If target_environment_id is provided, entities are cloned into that existing environment. Otherwise a new environment is created from name and type first.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="cloneEnvironment" method="post" path="/environments/{id}/clone" -->
+```typescript
+import { Flexprice } from "@flexprice/sdk";
+
+const flexprice = new Flexprice({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await flexprice.environments.cloneEnvironment("<id>", {});
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FlexpriceCore } from "@flexprice/sdk/core.js";
+import { environmentsCloneEnvironment } from "@flexprice/sdk/funcs/environments-clone-environment.js";
+
+// Use `FlexpriceCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const flexprice = new FlexpriceCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await environmentsCloneEnvironment(flexprice, "<id>", {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("environmentsCloneEnvironment failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | 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                                                                                                                                                            |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[models.ModelsTemporalWorkflowResult](../../sdk/models/models-temporal-workflow-result.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.ErrorsErrorResponse | 400, 404                   | application/json           |
+| models.ErrorsErrorResponse | 500                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |

package/docs/sdks/features/README.md

@@ -8,6 +8,7 @@
 * [queryFeature](#queryfeature) - Query features
 * [updateFeature](#updatefeature) - Update feature
 * [deleteFeature](#deletefeature) - Delete feature
+* [cloneFeature](#clonefeature) - Clone a feature
 
 ## createFeature
 
@@ -310,4 +311,76 @@ run();
 | -------------------------- | -------------------------- | -------------------------- |
 | models.ErrorsErrorResponse | 400, 404                   | application/json           |
 | models.ErrorsErrorResponse | 500                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## cloneFeature
+
+Clone an existing feature
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="cloneFeature" method="post" path="/features/{id}/clone" -->
+```typescript
+import { Flexprice } from "@flexprice/sdk";
+
+const flexprice = new Flexprice({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await flexprice.features.cloneFeature("<id>", {});
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FlexpriceCore } from "@flexprice/sdk/core.js";
+import { featuresCloneFeature } from "@flexprice/sdk/funcs/features-clone-feature.js";
+
+// Use `FlexpriceCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const flexprice = new FlexpriceCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await featuresCloneFeature(flexprice, "<id>", {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("featuresCloneFeature failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | 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                                                                                                                                                            |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[models.FeatureResponse](../../sdk/models/feature-response.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.ErrorsErrorResponse | 400, 404, 409              | application/json           |
+| models.ErrorsErrorResponse | 500                        | application/json           |
 | models.SDKError            | 4XX, 5XX                   | \*/\*                      |

package/docs/sdks/invoices/README.md

@@ -6,6 +6,7 @@
 
 * [getCustomerInvoiceSummary](#getcustomerinvoicesummary) - Get customer invoice summary
 * [createInvoice](#createinvoice) - Create one-off invoice
+* [getMeterUsagePreviewInvoice](#getmeterusagepreviewinvoice) - Get invoice preview using meter_usage data
 * [getInvoicePreview](#getinvoicepreview) - Get invoice preview
 * [queryInvoice](#queryinvoice) - Query invoices
 * [getInvoice](#getinvoice) - Get invoice
@@ -173,6 +174,81 @@ run();
 | models.ErrorsErrorResponse | 500                        | application/json           |
 | models.SDKError            | 4XX, 5XX                   | \*/\*                      |
 
+## getMeterUsagePreviewInvoice
+
+Preview invoice using the meter_usage table for usage data instead of feature_usage.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="getMeterUsagePreviewInvoice" method="post" path="/invoices/meter-usage-preview" -->
+```typescript
+import { Flexprice } from "@flexprice/sdk";
+
+const flexprice = new Flexprice({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await flexprice.invoices.getMeterUsagePreviewInvoice({
+    subscriptionId: "<id>",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FlexpriceCore } from "@flexprice/sdk/core.js";
+import { invoicesGetMeterUsagePreviewInvoice } from "@flexprice/sdk/funcs/invoices-get-meter-usage-preview-invoice.js";
+
+// Use `FlexpriceCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const flexprice = new FlexpriceCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await invoicesGetMeterUsagePreviewInvoice(flexprice, {
+    subscriptionId: "<id>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("invoicesGetMeterUsagePreviewInvoice failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [models.GetPreviewInvoiceRequest](../../sdk/models/get-preview-invoice-request.md)                                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[models.InvoiceResponse](../../sdk/models/invoice-response.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.ErrorsErrorResponse | 400                        | application/json           |
+| models.ErrorsErrorResponse | 500                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
 ## getInvoicePreview
 
 Use when showing a customer what they will be charged (e.g. preview before checkout or plan change). No invoice is created.