@flexprice/sdk 2.1.0 → 2.1.2

package/docs/sdks/coupons/README.md

@@ -79,7 +79,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Coupon](../../sdk/models/coupon.md)\>**
+**Promise\<[models.CouponResponse](../../sdk/models/coupon-response.md)\>**
 
 ### Errors
 
@@ -221,7 +221,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Coupon](../../sdk/models/coupon.md)\>**
+**Promise\<[models.CouponResponse](../../sdk/models/coupon-response.md)\>**
 
 ### Errors
 
@@ -293,7 +293,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Coupon](../../sdk/models/coupon.md)\>**
+**Promise\<[models.CouponResponse](../../sdk/models/coupon-response.md)\>**
 
 ### Errors
 

package/docs/sdks/customers/README.md

@@ -77,7 +77,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Customer1](../../sdk/models/customer1.md)\>**
+**Promise\<[models.CustomerResponse](../../sdk/models/customer-response.md)\>**
 
 ### Errors
 
@@ -152,7 +152,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Customer1](../../sdk/models/customer1.md)\>**
+**Promise\<[models.CustomerResponse](../../sdk/models/customer-response.md)\>**
 
 ### Errors
 
@@ -223,7 +223,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Customer1](../../sdk/models/customer1.md)\>**
+**Promise\<[models.CustomerResponse](../../sdk/models/customer-response.md)\>**
 
 ### Errors
 
@@ -436,7 +436,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Customer1](../../sdk/models/customer1.md)\>**
+**Promise\<[models.CustomerResponse](../../sdk/models/customer-response.md)\>**
 
 ### Errors
 

package/docs/sdks/features/README.md

@@ -88,7 +88,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Feature1](../../sdk/models/feature1.md)\>**
+**Promise\<[models.FeatureResponse](../../sdk/models/feature-response.md)\>**
 
 ### Errors
 
@@ -231,7 +231,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Feature1](../../sdk/models/feature1.md)\>**
+**Promise\<[models.FeatureResponse](../../sdk/models/feature-response.md)\>**
 
 ### Errors
 

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
@@ -163,7 +164,82 @@ run();
 
 ### Response
 
-**Promise\<[models.Invoice](../../sdk/models/invoice.md)\>**
+**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                   | \*/\*                      |
+
+## 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
 
@@ -238,7 +314,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Invoice](../../sdk/models/invoice.md)\>**
+**Promise\<[models.InvoiceResponse](../../sdk/models/invoice-response.md)\>**
 
 ### Errors
 
@@ -382,7 +458,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Invoice](../../sdk/models/invoice.md)\>**
+**Promise\<[models.InvoiceResponse](../../sdk/models/invoice-response.md)\>**
 
 ### Errors
 
@@ -454,7 +530,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Invoice](../../sdk/models/invoice.md)\>**
+**Promise\<[models.InvoiceResponse](../../sdk/models/invoice-response.md)\>**
 
 ### Errors
 
@@ -672,7 +748,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Invoice](../../sdk/models/invoice.md)\>**
+**Promise\<[models.InvoiceResponse](../../sdk/models/invoice-response.md)\>**
 
 ### Errors
 
@@ -957,7 +1033,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Invoice](../../sdk/models/invoice.md)\>**
+**Promise\<[models.InvoiceResponse](../../sdk/models/invoice-response.md)\>**
 
 ### Errors
 

package/docs/sdks/meterusage/README.md

@@ -0,0 +1,182 @@
+# MeterUsage
+
+## Overview
+
+### Available Operations
+
+* [getMeterUsageAnalytics](#getmeterusageanalytics) - Get meter usage analytics
+* [queryMeterUsage](#querymeterusage) - Query meter usage
+
+## getMeterUsageAnalytics
+
+Query aggregated usage from meter_usage table for multiple meters
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="getMeterUsageAnalytics" method="post" path="/meter-usage/analytics" -->
+```typescript
+import { Flexprice } from "@flexprice/sdk";
+
+const flexprice = new Flexprice({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await flexprice.meterUsage.getMeterUsageAnalytics({
+    aggregationType: "COUNT",
+    endTime: new Date("2024-02-01T00:00:00Z"),
+    externalCustomerId: "cust_123",
+    meterIds: [
+      "mtr_abc",
+      "mtr_def",
+    ],
+    startTime: new Date("2024-01-01T00:00:00Z"),
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FlexpriceCore } from "@flexprice/sdk/core.js";
+import { meterUsageGetMeterUsageAnalytics } from "@flexprice/sdk/funcs/meter-usage-get-meter-usage-analytics.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 meterUsageGetMeterUsageAnalytics(flexprice, {
+    aggregationType: "COUNT",
+    endTime: new Date("2024-02-01T00:00:00Z"),
+    externalCustomerId: "cust_123",
+    meterIds: [
+      "mtr_abc",
+      "mtr_def",
+    ],
+    startTime: new Date("2024-01-01T00:00:00Z"),
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("meterUsageGetMeterUsageAnalytics failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [models.MeterUsageAnalyticsRequest](../../sdk/models/meter-usage-analytics-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.MeterUsageAnalyticsResponse](../../sdk/models/meter-usage-analytics-response.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.ErrorsErrorResponse | 400                        | application/json           |
+| models.ErrorsErrorResponse | 500                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## queryMeterUsage
+
+Query aggregated usage from meter_usage table for a single meter with optional time-window bucketing
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="queryMeterUsage" method="post" path="/meter-usage/query" -->
+```typescript
+import { Flexprice } from "@flexprice/sdk";
+
+const flexprice = new Flexprice({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await flexprice.meterUsage.queryMeterUsage({
+    aggregationType: "WEIGHTED_SUM",
+    billingAnchor: new Date("2024-01-15T00:00:00Z"),
+    endTime: new Date("2024-02-01T00:00:00Z"),
+    externalCustomerId: "cust_123",
+    meterId: "mtr_abc",
+    startTime: new Date("2024-01-01T00:00:00Z"),
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FlexpriceCore } from "@flexprice/sdk/core.js";
+import { meterUsageQueryMeterUsage } from "@flexprice/sdk/funcs/meter-usage-query-meter-usage.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 meterUsageQueryMeterUsage(flexprice, {
+    aggregationType: "WEIGHTED_SUM",
+    billingAnchor: new Date("2024-01-15T00:00:00Z"),
+    endTime: new Date("2024-02-01T00:00:00Z"),
+    externalCustomerId: "cust_123",
+    meterId: "mtr_abc",
+    startTime: new Date("2024-01-01T00:00:00Z"),
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("meterUsageQueryMeterUsage failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [models.MeterUsageQueryRequest](../../sdk/models/meter-usage-query-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.MeterUsageQueryResponse](../../sdk/models/meter-usage-query-response.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.ErrorsErrorResponse | 400                        | application/json           |
+| models.ErrorsErrorResponse | 500                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |

package/docs/sdks/payments/README.md

@@ -155,7 +155,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Payment](../../sdk/models/payment.md)\>**
+**Promise\<[models.PaymentResponse](../../sdk/models/payment-response.md)\>**
 
 ### Errors
 
@@ -226,7 +226,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Payment](../../sdk/models/payment.md)\>**
+**Promise\<[models.PaymentResponse](../../sdk/models/payment-response.md)\>**
 
 ### Errors
 
@@ -298,7 +298,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Payment](../../sdk/models/payment.md)\>**
+**Promise\<[models.PaymentResponse](../../sdk/models/payment-response.md)\>**
 
 ### Errors
 
@@ -440,7 +440,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Payment](../../sdk/models/payment.md)\>**
+**Promise\<[models.PaymentResponse](../../sdk/models/payment-response.md)\>**
 
 ### Errors
 

package/docs/sdks/plans/README.md

@@ -77,7 +77,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Plan1](../../sdk/models/plan1.md)\>**
+**Promise\<[models.PlanResponse](../../sdk/models/plan-response.md)\>**
 
 ### Errors
 
@@ -219,7 +219,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Plan1](../../sdk/models/plan1.md)\>**
+**Promise\<[models.PlanResponse](../../sdk/models/plan-response.md)\>**
 
 ### Errors
 
@@ -291,7 +291,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Plan1](../../sdk/models/plan1.md)\>**
+**Promise\<[models.PlanResponse](../../sdk/models/plan-response.md)\>**
 
 ### Errors
 
@@ -434,7 +434,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Plan1](../../sdk/models/plan1.md)\>**
+**Promise\<[models.PlanResponse](../../sdk/models/plan-response.md)\>**
 
 ### Errors
 

package/docs/sdks/prices/README.md

@@ -28,15 +28,14 @@ const flexprice = new Flexprice({
 
 async function run() {
   const result = await flexprice.prices.createPrice({
-    billingCadence: "RECURRING",
-    billingModel: "PACKAGE",
-    billingPeriod: "HALF_YEARLY",
-    currency: "Serbian Dinar",
+    billingModel: "FLAT_FEE",
+    billingPeriod: "DAILY",
+    currency: "Dong",
     entityId: "<id>",
     entityType: "PRICE",
-    invoiceCadence: "ARREAR",
-    priceUnitType: "CUSTOM",
-    type: "USAGE",
+    invoiceCadence: "ADVANCE",
+    priceUnitType: "FIAT",
+    type: "FIXED",
   });
 
   console.log(result);
@@ -61,15 +60,14 @@ const flexprice = new FlexpriceCore({
 
 async function run() {
   const res = await pricesCreatePrice(flexprice, {
-    billingCadence: "RECURRING",
-    billingModel: "PACKAGE",
-    billingPeriod: "HALF_YEARLY",
-    currency: "Serbian Dinar",
+    billingModel: "FLAT_FEE",
+    billingPeriod: "DAILY",
+    currency: "Dong",
     entityId: "<id>",
     entityType: "PRICE",
-    invoiceCadence: "ARREAR",
-    priceUnitType: "CUSTOM",
-    type: "USAGE",
+    invoiceCadence: "ADVANCE",
+    priceUnitType: "FIAT",
+    type: "FIXED",
   });
   if (res.ok) {
     const { value: result } = res;
@@ -93,7 +91,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Price](../../sdk/models/price.md)\>**
+**Promise\<[models.PriceResponse](../../sdk/models/price-response.md)\>**
 
 ### Errors
 
@@ -239,7 +237,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Price](../../sdk/models/price.md)\>**
+**Promise\<[models.PriceResponse](../../sdk/models/price-response.md)\>**
 
 ### Errors
 
@@ -381,7 +379,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Price](../../sdk/models/price.md)\>**
+**Promise\<[models.PriceResponse](../../sdk/models/price-response.md)\>**
 
 ### Errors
 
@@ -453,7 +451,7 @@ run();
 
 ### Response
 
-**Promise\<[models.Price](../../sdk/models/price.md)\>**
+**Promise\<[models.PriceResponse](../../sdk/models/price-response.md)\>**
 
 ### Errors