@flexprice/sdk 2.1.40 → 2.1.42

package/docs/sdk/models/run-analytics-report-request.md

@@ -0,0 +1,22 @@
+# RunAnalyticsReportRequest
+
+## Example Usage
+
+```typescript
+import { RunAnalyticsReportRequest } from "@flexprice/sdk/sdk/models";
+
+let value: RunAnalyticsReportRequest = {
+  key: "<key>",
+  body: {
+    range: "2026-09-01..2026-10-01",
+    shape: "scalar",
+  },
+};
+```
+
+## Fields
+
+| Field                                                                 | Type                                                                  | Required                                                              | Description                                                           |
+| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
+| `key`                                                                 | *string*                                                              | :heavy_check_mark:                                                    | Report key                                                            |
+| `body`                                                                | [models.ReportQueryRequest](../../sdk/models/report-query-request.md) | :heavy_check_mark:                                                    | Report query request                                                  |

package/docs/sdk/models/self-billing-checkout-request.md

@@ -0,0 +1,30 @@
+# SelfBillingCheckoutRequest
+
+## Example Usage
+
+```typescript
+import { SelfBillingCheckoutRequest } from "@flexprice/sdk/sdk/models";
+
+let value: SelfBillingCheckoutRequest = {
+  addressCity: "<value>",
+  addressCountry: "<value>",
+  addressLine1: "2072 Trantow Glens",
+  addressPostalCode: "<value>",
+  email: "Desmond.Tremblay0@hotmail.com",
+  name: "<value>",
+};
+```
+
+## Fields
+
+| Field               | Type                | Required            | Description         |
+| ------------------- | ------------------- | ------------------- | ------------------- |
+| `addressCity`       | *string*            | :heavy_check_mark:  | N/A                 |
+| `addressCountry`    | *string*            | :heavy_check_mark:  | N/A                 |
+| `addressLine1`      | *string*            | :heavy_check_mark:  | N/A                 |
+| `addressLine2`      | *string*            | :heavy_minus_sign:  | N/A                 |
+| `addressPostalCode` | *string*            | :heavy_check_mark:  | N/A                 |
+| `addressState`      | *string*            | :heavy_minus_sign:  | N/A                 |
+| `email`             | *string*            | :heavy_check_mark:  | N/A                 |
+| `name`              | *string*            | :heavy_check_mark:  | N/A                 |
+| `taxId`             | *string*            | :heavy_minus_sign:  | N/A                 |

package/docs/sdk/models/self-billing-checkout-response.md

@@ -0,0 +1,19 @@
+# SelfBillingCheckoutResponse
+
+## Example Usage
+
+```typescript
+import { SelfBillingCheckoutResponse } from "@flexprice/sdk/sdk/models";
+
+let value: SelfBillingCheckoutResponse = {};
+```
+
+## Fields
+
+| Field                                                                     | Type                                                                      | Required                                                                  | Description                                                               |
+| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| `checkoutId`                                                              | *string*                                                                  | :heavy_minus_sign:                                                        | N/A                                                                       |
+| `status`                                                                  | [models.CheckoutStatus](../../sdk/models/checkout-status.md)              | :heavy_minus_sign:                                                        | N/A                                                                       |
+| `tenantStatus`                                                            | [models.TenantInternalStatus](../../sdk/models/tenant-internal-status.md) | :heavy_minus_sign:                                                        | N/A                                                                       |
+| `terminal`                                                                | *boolean*                                                                 | :heavy_minus_sign:                                                        | N/A                                                                       |
+| `url`                                                                     | *string*                                                                  | :heavy_minus_sign:                                                        | N/A                                                                       |

package/docs/sdk/models/self-billing-invoice.md

@@ -0,0 +1,22 @@
+# SelfBillingInvoice
+
+## Example Usage
+
+```typescript
+import { SelfBillingInvoice } from "@flexprice/sdk/sdk/models";
+
+let value: SelfBillingInvoice = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `currency`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `dueDate`                                                                                     | [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                                                                                           |
+| `number`                                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `paymentStatus`                                                                               | [models.PaymentStatus](../../sdk/models/payment-status.md)                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `pdfUrl`                                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `status`                                                                                      | [models.InvoiceStatus](../../sdk/models/invoice-status.md)                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `total`                                                                                       | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/self-billing-portal-response.md

@@ -0,0 +1,16 @@
+# SelfBillingPortalResponse
+
+## Example Usage
+
+```typescript
+import { SelfBillingPortalResponse } from "@flexprice/sdk/sdk/models";
+
+let value: SelfBillingPortalResponse = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `expiresAt`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `url`                                                                                         | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/self-billing-status-response.md

@@ -0,0 +1,16 @@
+# SelfBillingStatusResponse
+
+## Example Usage
+
+```typescript
+import { SelfBillingStatusResponse } from "@flexprice/sdk/sdk/models";
+
+let value: SelfBillingStatusResponse = {};
+```
+
+## Fields
+
+| Field                                                                     | Type                                                                      | Required                                                                  | Description                                                               |
+| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| `enabled`                                                                 | *boolean*                                                                 | :heavy_minus_sign:                                                        | N/A                                                                       |
+| `status`                                                                  | [models.TenantInternalStatus](../../sdk/models/tenant-internal-status.md) | :heavy_minus_sign:                                                        | N/A                                                                       |

package/docs/sdk/models/self-billing-summary-response.md

@@ -0,0 +1,37 @@
+# SelfBillingSummaryResponse
+
+## Example Usage
+
+```typescript
+import { SelfBillingSummaryResponse } from "@flexprice/sdk/sdk/models";
+
+let value: SelfBillingSummaryResponse = {
+  usage: {
+    features: [
+      {
+        feature: {
+          meter: {
+            createdAt: new Date("2024-03-20T15:04:05Z"),
+            eventName: "api_request",
+            id: "550e8400-e29b-41d4-a716-446655440000",
+            name: "API Usage Meter",
+            status: "published",
+            tenantId: "tenant123",
+            updatedAt: new Date("2024-03-20T15:04:05Z"),
+          },
+        },
+      },
+    ],
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `invoices`                                                                                    | [models.SelfBillingInvoice](../../sdk/models/self-billing-invoice.md)[]                       | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `status`                                                                                      | [models.TenantInternalStatus](../../sdk/models/tenant-internal-status.md)                     | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `subscriptionStatus`                                                                          | [models.SubscriptionStatus](../../sdk/models/subscription-status.md)                          | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `trialEndsAt`                                                                                 | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `usage`                                                                                       | [models.CustomerUsageSummaryResponse](../../sdk/models/customer-usage-summary-response.md)    | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/tenant-internal-status.md

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

package/docs/sdk/models/top-up-wallet-request.md

@@ -21,6 +21,7 @@ let value: TopUpWalletRequest = {
 | `coupons`                                                                                                                                                                                                                                                                                                                                                                                | [models.TopUpCoupon](../../sdk/models/top-up-coupon.md)[]                                                                                                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                       | N/A                                                                                                                                                                                                                                                                                                                                                                                      |
 | `creditsToAdd`                                                                                                                                                                                                                                                                                                                                                                           | *string*                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                       | credits_to_add is the number of credits to add to the wallet                                                                                                                                                                                                                                                                                                                             |
 | `description`                                                                                                                                                                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                       | description to add any specific details about the transaction                                                                                                                                                                                                                                                                                                                            |
+| `effectiveDate`                                                                                                                                                                                                                                                                                                                                                                          | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                       | effective_date is stored as the credit transaction's created_at.<br/>Omit to use the current time. Must not be in the future.                                                                                                                                                                                                                                                            |
 | `expiryDateUtc`                                                                                                                                                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                       | expiry_date_utc is the expiry date in UTC timezone<br/>ex 2025-01-01 00:00:00 UTC                                                                                                                                                                                                                                                                                                        |
 | `forceSyncInvoice`                                                                                                                                                                                                                                                                                                                                                                       | *boolean*                                                                                                                                                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                       | N/A                                                                                                                                                                                                                                                                                                                                                                                      |
 | `idempotencyKey`                                                                                                                                                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                       | idempotency_key is a unique key for the transaction                                                                                                                                                                                                                                                                                                                                      |

package/docs/sdk/models/update-analytics-view-request.md

@@ -0,0 +1,27 @@
+# UpdateAnalyticsViewRequest
+
+## Example Usage
+
+```typescript
+import { UpdateAnalyticsViewRequest } from "@flexprice/sdk/sdk/models";
+
+let value: UpdateAnalyticsViewRequest = {
+  id: "<id>",
+  body: {
+    definition: {
+      metrics: [
+        "invoice_total",
+      ],
+      shape: "breakdown",
+    },
+    name: "<value>",
+  },
+};
+```
+
+## Fields
+
+| Field                                                               | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `id`                                                                | *string*                                                            | :heavy_check_mark:                                                  | View ID                                                             |
+| `body`                                                              | [models.CreateViewRequest](../../sdk/models/create-view-request.md) | :heavy_check_mark:                                                  | View request                                                        |

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

@@ -10,9 +10,12 @@ let value: ViewResponse = {};
 
 ## Fields
 
-| Field                                                                           | Type                                                                            | Required                                                                        | Description                                                                     |
-| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
-| `definition`                                                                    | [models.AnalyticsViewDefinition](../../sdk/models/analytics-view-definition.md) | :heavy_minus_sign:                                                              | N/A                                                                             |
-| `id`                                                                            | *string*                                                                        | :heavy_minus_sign:                                                              | N/A                                                                             |
-| `name`                                                                          | *string*                                                                        | :heavy_minus_sign:                                                              | N/A                                                                             |
-| `version`                                                                       | *number*                                                                        | :heavy_minus_sign:                                                              | N/A                                                                             |
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `createdAt`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `createdBy`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `definition`                                                                                  | [models.AnalyticsViewDefinition](../../sdk/models/analytics-view-definition.md)               | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `id`                                                                                          | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `name`                                                                                        | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `updatedAt`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `version`                                                                                     | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |