integrateledger 0.0.0-stage → 0.1.0

package/docs/models/current-plan.md

@@ -0,0 +1,25 @@
+# CurrentPlan
+
+## Example Usage
+
+```typescript
+import { CurrentPlan } from "integrateledger/models";
+
+let value: CurrentPlan = {
+  id: "<id>",
+  name: "<value>",
+  status: "active",
+  currentPeriodStart: new Date("2024-07-22T15:02:40.191Z"),
+  currentPeriodEnd: new Date("2024-09-20T06:05:14.726Z"),
+};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `id`                                                                                          | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `name`                                                                                        | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `status`                                                                                      | [models.CustomerDetailStatus](../models/customer-detail-status.md)                            | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `currentPeriodStart`                                                                          | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `currentPeriodEnd`                                                                            | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark:                                                                            | N/A                                                                                           |

package/docs/models/customer-detail-status.md

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

package/docs/models/customer-detail.md

@@ -0,0 +1,29 @@
+# CustomerDetail
+
+## Example Usage
+
+```typescript
+import { CustomerDetail } from "integrateledger/models";
+
+let value: CustomerDetail = {
+  customerId: "<id>",
+  createdAt: new Date("2025-06-11T03:17:27.568Z"),
+  availableCredits: 507896,
+  currentPlan: {
+    id: "<id>",
+    name: "<value>",
+    status: "pending_checkout",
+    currentPeriodStart: new Date("2025-03-05T01:25:55.596Z"),
+    currentPeriodEnd: new Date("2026-10-21T23:46:33.359Z"),
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `customerId`                                                                                  | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `createdAt`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `availableCredits`                                                                            | *number*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `currentPlan`                                                                                 | [models.CurrentPlan](../models/current-plan.md)                                               | :heavy_check_mark:                                                                            | N/A                                                                                           |

package/docs/models/customer-purchase-item.md

@@ -0,0 +1,27 @@
+# CustomerPurchaseItem
+
+## Example Usage
+
+```typescript
+import { CustomerPurchaseItem } from "integrateledger/models";
+
+let value: CustomerPurchaseItem = {
+  id: 229122,
+  addOnId: "<id>",
+  name: "<value>",
+  creditAmount: 767755,
+  status: "<value>",
+  createdAt: new Date("2025-11-03T17:12:24.012Z"),
+};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `id`                                                                                          | *number*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `addOnId`                                                                                     | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `name`                                                                                        | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `creditAmount`                                                                                | *number*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `status`                                                                                      | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `createdAt`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark:                                                                            | N/A                                                                                           |

package/docs/models/customer-purchase-page.md

@@ -0,0 +1,30 @@
+# CustomerPurchasePage
+
+## Example Usage
+
+```typescript
+import { CustomerPurchasePage } from "integrateledger/models";
+
+let value: CustomerPurchasePage = {
+  items: [
+    {
+      id: 85203,
+      addOnId: "<id>",
+      name: "<value>",
+      creditAmount: 446404,
+      status: "<value>",
+      createdAt: new Date("2026-10-23T20:07:34.924Z"),
+    },
+  ],
+  hasMore: true,
+  nextCursor: 739239,
+};
+```
+
+## Fields
+
+| Field                                                                | Type                                                                 | Required                                                             | Description                                                          |
+| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
+| `items`                                                              | [models.CustomerPurchaseItem](../models/customer-purchase-item.md)[] | :heavy_check_mark:                                                   | N/A                                                                  |
+| `hasMore`                                                            | *boolean*                                                            | :heavy_check_mark:                                                   | N/A                                                                  |
+| `nextCursor`                                                         | *number*                                                             | :heavy_check_mark:                                                   | N/A                                                                  |

package/docs/models/customer-response.md

@@ -0,0 +1,19 @@
+# CustomerResponse
+
+## Example Usage
+
+```typescript
+import { CustomerResponse } from "integrateledger/models";
+
+let value: CustomerResponse = {
+  customerId: "<id>",
+  created: true,
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `customerId`       | *string*           | :heavy_check_mark: | N/A                |
+| `created`          | *boolean*          | :heavy_check_mark: | N/A                |

package/docs/models/customer-subscription-cancellation.md

@@ -0,0 +1,23 @@
+# CustomerSubscriptionCancellation
+
+## Example Usage
+
+```typescript
+import { CustomerSubscriptionCancellation } from "integrateledger/models";
+
+let value: CustomerSubscriptionCancellation = {
+  cancelAtPeriodEnd: false,
+  scheduledEnd: true,
+  manageable: true,
+  cancelsAt: new Date("2024-03-01T10:25:15.244Z"),
+};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `cancelAtPeriodEnd`                                                                           | *boolean*                                                                                     | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `scheduledEnd`                                                                                | *boolean*                                                                                     | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `manageable`                                                                                  | *boolean*                                                                                     | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `cancelsAt`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark:                                                                            | N/A                                                                                           |

package/docs/models/customer-subscription-item.md

@@ -0,0 +1,38 @@
+# CustomerSubscriptionItem
+
+## Example Usage
+
+```typescript
+import { CustomerSubscriptionItem } from "integrateledger/models";
+
+let value: CustomerSubscriptionItem = {
+  id: 826875,
+  planId: "<id>",
+  planName: "<value>",
+  monthlyPriceCents: 144689,
+  status: "<value>",
+  createdAt: new Date("2025-05-18T14:18:52.797Z"),
+  currentPeriodStart: new Date("2026-09-10T11:19:27.453Z"),
+  currentPeriodEnd: new Date("2025-10-16T15:33:04.840Z"),
+  cancellation: {
+    cancelAtPeriodEnd: true,
+    scheduledEnd: false,
+    manageable: true,
+    cancelsAt: new Date("2026-05-24T23:48:49.524Z"),
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `id`                                                                                          | *number*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `planId`                                                                                      | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `planName`                                                                                    | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `monthlyPriceCents`                                                                           | *number*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `status`                                                                                      | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `createdAt`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `currentPeriodStart`                                                                          | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `currentPeriodEnd`                                                                            | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `cancellation`                                                                                | [models.CustomerSubscriptionCancellation](../models/customer-subscription-cancellation.md)    | :heavy_check_mark:                                                                            | N/A                                                                                           |

package/docs/models/customer-subscription-page.md

@@ -0,0 +1,38 @@
+# CustomerSubscriptionPage
+
+## Example Usage
+
+```typescript
+import { CustomerSubscriptionPage } from "integrateledger/models";
+
+let value: CustomerSubscriptionPage = {
+  items: [
+    {
+      id: 161362,
+      planId: "<id>",
+      planName: "<value>",
+      monthlyPriceCents: 403669,
+      status: "<value>",
+      createdAt: new Date("2026-09-13T23:26:44.121Z"),
+      currentPeriodStart: new Date("2026-11-09T16:29:30.599Z"),
+      currentPeriodEnd: new Date("2025-08-17T13:27:19.197Z"),
+      cancellation: {
+        cancelAtPeriodEnd: true,
+        scheduledEnd: false,
+        manageable: true,
+        cancelsAt: new Date("2026-05-24T23:48:49.524Z"),
+      },
+    },
+  ],
+  hasMore: true,
+  nextCursor: 120697,
+};
+```
+
+## Fields
+
+| Field                                                                        | Type                                                                         | Required                                                                     | Description                                                                  |
+| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
+| `items`                                                                      | [models.CustomerSubscriptionItem](../models/customer-subscription-item.md)[] | :heavy_check_mark:                                                           | N/A                                                                          |
+| `hasMore`                                                                    | *boolean*                                                                    | :heavy_check_mark:                                                           | N/A                                                                          |
+| `nextCursor`                                                                 | *number*                                                                     | :heavy_check_mark:                                                           | N/A                                                                          |

package/docs/models/environment.md

@@ -0,0 +1,15 @@
+# Environment
+
+## Example Usage
+
+```typescript
+import { Environment } from "integrateledger/models";
+
+let value: Environment = "live";
+```
+
+## Values
+
+```typescript
+"sandbox" | "live"
+```

package/docs/models/errors/archive-add-on-bad-request-error.md

@@ -0,0 +1,17 @@
+# ArchiveAddOnBadRequestError
+
+Invalid request
+
+## Example Usage
+
+```typescript
+import { ArchiveAddOnBadRequestError } from "integrateledger/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `error`            | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/errors/archive-add-on-not-found-error.md

@@ -0,0 +1,17 @@
+# ArchiveAddOnNotFoundError
+
+Item not found
+
+## Example Usage
+
+```typescript
+import { ArchiveAddOnNotFoundError } from "integrateledger/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `error`            | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/errors/archive-add-on-unauthorized-error.md

@@ -0,0 +1,17 @@
+# ArchiveAddOnUnauthorizedError
+
+Invalid Ledger API key
+
+## Example Usage
+
+```typescript
+import { ArchiveAddOnUnauthorizedError } from "integrateledger/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `error`            | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/errors/archive-feature-bad-request-error.md

@@ -0,0 +1,17 @@
+# ArchiveFeatureBadRequestError
+
+Invalid request
+
+## Example Usage
+
+```typescript
+import { ArchiveFeatureBadRequestError } from "integrateledger/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `error`            | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/errors/archive-feature-not-found-error.md

@@ -0,0 +1,17 @@
+# ArchiveFeatureNotFoundError
+
+Item not found
+
+## Example Usage
+
+```typescript
+import { ArchiveFeatureNotFoundError } from "integrateledger/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `error`            | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/errors/archive-feature-unauthorized-error.md

@@ -0,0 +1,17 @@
+# ArchiveFeatureUnauthorizedError
+
+Invalid Ledger API key
+
+## Example Usage
+
+```typescript
+import { ArchiveFeatureUnauthorizedError } from "integrateledger/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `error`            | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/errors/archive-plan-bad-request-error.md

@@ -0,0 +1,17 @@
+# ArchivePlanBadRequestError
+
+Invalid request
+
+## Example Usage
+
+```typescript
+import { ArchivePlanBadRequestError } from "integrateledger/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `error`            | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/errors/archive-plan-not-found-error.md

@@ -0,0 +1,17 @@
+# ArchivePlanNotFoundError
+
+Item not found
+
+## Example Usage
+
+```typescript
+import { ArchivePlanNotFoundError } from "integrateledger/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `error`            | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/errors/archive-plan-unauthorized-error.md

@@ -0,0 +1,17 @@
+# ArchivePlanUnauthorizedError
+
+Invalid Ledger API key
+
+## Example Usage
+
+```typescript
+import { ArchivePlanUnauthorizedError } from "integrateledger/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `error`            | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/errors/attach-error.md

@@ -0,0 +1,15 @@
+# AttachError
+
+## Example Usage
+
+```typescript
+import { AttachError } from "integrateledger/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `error`            | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/errors/bad-gateway-error.md

@@ -0,0 +1,17 @@
+# BadGatewayError
+
+Stripe request failed or signed webhook endpoint unhealthy
+
+## Example Usage
+
+```typescript
+import { BadGatewayError } from "integrateledger/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `error`            | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/errors/catalog-error.md

@@ -0,0 +1,16 @@
+# CatalogError
+
+## Example Usage
+
+```typescript
+import { CatalogError } from "integrateledger/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field                                   | Type                                    | Required                                | Description                             |
+| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- |
+| `error`                                 | *string*                                | :heavy_check_mark:                      | N/A                                     |
+| `issues`                                | [models.Issue](../../models/issue.md)[] | :heavy_minus_sign:                      | N/A                                     |

package/docs/models/errors/check-error.md

@@ -0,0 +1,15 @@
+# CheckError
+
+## Example Usage
+
+```typescript
+import { CheckError } from "integrateledger/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `error`            | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/errors/create-add-on-bad-request-error.md

@@ -0,0 +1,17 @@
+# CreateAddOnBadRequestError
+
+Invalid request
+
+## Example Usage
+
+```typescript
+import { CreateAddOnBadRequestError } from "integrateledger/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `error`            | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/errors/create-add-on-conflict-error.md

@@ -0,0 +1,17 @@
+# CreateAddOnConflictError
+
+Item ID already exists or add-on Checkout is pending
+
+## Example Usage
+
+```typescript
+import { CreateAddOnConflictError } from "integrateledger/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `error`            | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/errors/create-add-on-unauthorized-error.md

@@ -0,0 +1,17 @@
+# CreateAddOnUnauthorizedError
+
+Invalid Ledger API key
+
+## Example Usage
+
+```typescript
+import { CreateAddOnUnauthorizedError } from "integrateledger/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `error`            | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/errors/create-feature-bad-request-error.md

@@ -0,0 +1,17 @@
+# CreateFeatureBadRequestError
+
+Invalid request
+
+## Example Usage
+
+```typescript
+import { CreateFeatureBadRequestError } from "integrateledger/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `error`            | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/errors/create-feature-conflict-error.md

@@ -0,0 +1,17 @@
+# CreateFeatureConflictError
+
+Item ID already exists or add-on Checkout is pending
+
+## Example Usage
+
+```typescript
+import { CreateFeatureConflictError } from "integrateledger/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `error`            | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/errors/create-feature-unauthorized-error.md

@@ -0,0 +1,17 @@
+# CreateFeatureUnauthorizedError
+
+Invalid Ledger API key
+
+## Example Usage
+
+```typescript
+import { CreateFeatureUnauthorizedError } from "integrateledger/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `error`            | *string*           | :heavy_check_mark: | N/A                |