integrateledger 0.0.0-stage → 0.1.0

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

@@ -0,0 +1,17 @@
+# CreatePlanBadRequestError
+
+Invalid request
+
+## Example Usage
+
+```typescript
+import { CreatePlanBadRequestError } 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-plan-conflict-error.md

@@ -0,0 +1,17 @@
+# CreatePlanConflictError
+
+Item ID already exists or add-on Checkout is pending
+
+## Example Usage
+
+```typescript
+import { CreatePlanConflictError } 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-plan-unauthorized-error.md

@@ -0,0 +1,17 @@
+# CreatePlanUnauthorizedError
+
+Invalid Ledger API key
+
+## Example Usage
+
+```typescript
+import { CreatePlanUnauthorizedError } 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/customer-error.md

@@ -0,0 +1,15 @@
+# CustomerError
+
+## Example Usage
+
+```typescript
+import { CustomerError } 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/get-add-on-bad-request-error.md

@@ -0,0 +1,17 @@
+# GetAddOnBadRequestError
+
+Invalid request
+
+## Example Usage
+
+```typescript
+import { GetAddOnBadRequestError } 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/get-add-on-not-found-error.md

@@ -0,0 +1,17 @@
+# GetAddOnNotFoundError
+
+Item not found
+
+## Example Usage
+
+```typescript
+import { GetAddOnNotFoundError } 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/get-add-on-unauthorized-error.md

@@ -0,0 +1,17 @@
+# GetAddOnUnauthorizedError
+
+Invalid Ledger API key
+
+## Example Usage
+
+```typescript
+import { GetAddOnUnauthorizedError } 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/get-feature-bad-request-error.md

@@ -0,0 +1,17 @@
+# GetFeatureBadRequestError
+
+Invalid request
+
+## Example Usage
+
+```typescript
+import { GetFeatureBadRequestError } 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/get-feature-not-found-error.md

@@ -0,0 +1,17 @@
+# GetFeatureNotFoundError
+
+Item not found
+
+## Example Usage
+
+```typescript
+import { GetFeatureNotFoundError } 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/get-feature-unauthorized-error.md

@@ -0,0 +1,17 @@
+# GetFeatureUnauthorizedError
+
+Invalid Ledger API key
+
+## Example Usage
+
+```typescript
+import { GetFeatureUnauthorizedError } 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/get-plan-bad-request-error.md

@@ -0,0 +1,17 @@
+# GetPlanBadRequestError
+
+Invalid request
+
+## Example Usage
+
+```typescript
+import { GetPlanBadRequestError } 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/get-plan-not-found-error.md

@@ -0,0 +1,17 @@
+# GetPlanNotFoundError
+
+Item not found
+
+## Example Usage
+
+```typescript
+import { GetPlanNotFoundError } 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/get-plan-unauthorized-error.md

@@ -0,0 +1,17 @@
+# GetPlanUnauthorizedError
+
+Invalid Ledger API key
+
+## Example Usage
+
+```typescript
+import { GetPlanUnauthorizedError } 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/list-add-ons-unauthorized-error.md

@@ -0,0 +1,17 @@
+# ListAddOnsUnauthorizedError
+
+Invalid Ledger API key
+
+## Example Usage
+
+```typescript
+import { ListAddOnsUnauthorizedError } 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/list-features-unauthorized-error.md

@@ -0,0 +1,17 @@
+# ListFeaturesUnauthorizedError
+
+Invalid Ledger API key
+
+## Example Usage
+
+```typescript
+import { ListFeaturesUnauthorizedError } 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/list-plans-unauthorized-error.md

@@ -0,0 +1,17 @@
+# ListPlansUnauthorizedError
+
+Invalid Ledger API key
+
+## Example Usage
+
+```typescript
+import { ListPlansUnauthorizedError } 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/service-unavailable-error.md

@@ -0,0 +1,18 @@
+# ServiceUnavailableError
+
+Upgrade requires Stripe reconciliation or payment action
+
+## Example Usage
+
+```typescript
+import { ServiceUnavailableError } from "integrateledger/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `error`            | *string*           | :heavy_check_mark: | N/A                |
+| `upgradeId`        | *number*           | :heavy_minus_sign: | N/A                |

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

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

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

@@ -0,0 +1,17 @@
+# UpdateAddOnBadRequestError
+
+Invalid request
+
+## Example Usage
+
+```typescript
+import { UpdateAddOnBadRequestError } 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/update-add-on-conflict-error.md

@@ -0,0 +1,17 @@
+# UpdateAddOnConflictError
+
+Item ID already exists or add-on Checkout is pending
+
+## Example Usage
+
+```typescript
+import { UpdateAddOnConflictError } 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/update-add-on-not-found-error.md

@@ -0,0 +1,17 @@
+# UpdateAddOnNotFoundError
+
+Item not found
+
+## Example Usage
+
+```typescript
+import { UpdateAddOnNotFoundError } 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/update-add-on-unauthorized-error.md

@@ -0,0 +1,17 @@
+# UpdateAddOnUnauthorizedError
+
+Invalid Ledger API key
+
+## Example Usage
+
+```typescript
+import { UpdateAddOnUnauthorizedError } 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/update-feature-bad-request-error.md

@@ -0,0 +1,17 @@
+# UpdateFeatureBadRequestError
+
+Invalid request
+
+## Example Usage
+
+```typescript
+import { UpdateFeatureBadRequestError } 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/update-feature-conflict-error.md

@@ -0,0 +1,17 @@
+# UpdateFeatureConflictError
+
+Item ID already exists or add-on Checkout is pending
+
+## Example Usage
+
+```typescript
+import { UpdateFeatureConflictError } 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/update-feature-not-found-error.md

@@ -0,0 +1,17 @@
+# UpdateFeatureNotFoundError
+
+Item not found
+
+## Example Usage
+
+```typescript
+import { UpdateFeatureNotFoundError } 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/update-feature-unauthorized-error.md

@@ -0,0 +1,17 @@
+# UpdateFeatureUnauthorizedError
+
+Invalid Ledger API key
+
+## Example Usage
+
+```typescript
+import { UpdateFeatureUnauthorizedError } 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/update-plan-bad-request-error.md

@@ -0,0 +1,17 @@
+# UpdatePlanBadRequestError
+
+Invalid request
+
+## Example Usage
+
+```typescript
+import { UpdatePlanBadRequestError } 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/update-plan-conflict-error.md

@@ -0,0 +1,17 @@
+# UpdatePlanConflictError
+
+Item ID already exists or add-on Checkout is pending
+
+## Example Usage
+
+```typescript
+import { UpdatePlanConflictError } 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/update-plan-not-found-error.md

@@ -0,0 +1,17 @@
+# UpdatePlanNotFoundError
+
+Item not found
+
+## Example Usage
+
+```typescript
+import { UpdatePlanNotFoundError } 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/update-plan-unauthorized-error.md

@@ -0,0 +1,17 @@
+# UpdatePlanUnauthorizedError
+
+Invalid Ledger API key
+
+## Example Usage
+
+```typescript
+import { UpdatePlanUnauthorizedError } 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/upgrade-error.md

@@ -0,0 +1,15 @@
+# UpgradeError
+
+## Example Usage
+
+```typescript
+import { UpgradeError } 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/upgrade-paid-plan-conflict-error.md

@@ -0,0 +1,17 @@
+# UpgradePaidPlanConflictError
+
+Idempotency key mismatch or pending upgrade
+
+## Example Usage
+
+```typescript
+import { UpgradePaidPlanConflictError } 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/upgrade-paid-plan-not-found-error.md

@@ -0,0 +1,17 @@
+# UpgradePaidPlanNotFoundError
+
+Unknown customer or target plan
+
+## Example Usage
+
+```typescript
+import { UpgradePaidPlanNotFoundError } 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/upgrade-paid-plan-unauthorized-error.md

@@ -0,0 +1,17 @@
+# UpgradePaidPlanUnauthorizedError
+
+Invalid Ledger API key
+
+## Example Usage
+
+```typescript
+import { UpgradePaidPlanUnauthorizedError } 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/feature-archived.md

@@ -0,0 +1,17 @@
+# FeatureArchived
+
+## Example Usage
+
+```typescript
+import { FeatureArchived } from "integrateledger/models";
+
+let value: FeatureArchived = {
+  archived: true,
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `archived`         | *boolean*          | :heavy_check_mark: | N/A                |

package/docs/models/feature-item.md

@@ -0,0 +1,21 @@
+# FeatureItem
+
+## Example Usage
+
+```typescript
+import { FeatureItem } from "integrateledger/models";
+
+let value: FeatureItem = {
+  id: "<id>",
+  name: "<value>",
+  creditCost: 197165,
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `id`               | *string*           | :heavy_check_mark: | N/A                |
+| `name`             | *string*           | :heavy_check_mark: | N/A                |
+| `creditCost`       | *number*           | :heavy_check_mark: | N/A                |