integrateledger 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +66 -68
- package/dist/commonjs/lib/config.d.ts +2 -2
- package/dist/commonjs/lib/config.js +2 -2
- package/dist/esm/lib/config.d.ts +2 -2
- package/dist/esm/lib/config.js +2 -2
- package/package.json +2 -2
- package/src/lib/config.ts +2 -2
package/README.md
CHANGED
|
@@ -12,12 +12,12 @@ Ledger API keys grant organization-wide access. Use this SDK only in trusted ser
|
|
|
12
12
|
|
|
13
13
|
|
|
14
14
|
<br /><br />
|
|
15
|
-
Install the server-side SDK from npm. See the [Ledger
|
|
15
|
+
Install the server-side SDK from npm. See the [Ledger quickstart](https://docs.integrateledger.com/quickstart) for catalog, customer, usage, and Checkout examples.
|
|
16
16
|
|
|
17
17
|
<!-- Start Summary [summary] -->
|
|
18
18
|
## Summary
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
Ledger's server-side SDK creates catalog items, manages customers and plans, records usage, and starts Stripe Checkout. The [API reference](https://docs.integrateledger.com/api-reference/plans/list) shows each operation with cURL, Python, and TypeScript examples.
|
|
21
21
|
<!-- End Summary [summary] -->
|
|
22
22
|
|
|
23
23
|
<!-- Start Table of Contents [toc] -->
|
|
@@ -183,7 +183,7 @@ console.log(features.items);
|
|
|
183
183
|
<!-- Start Error Handling [errors] -->
|
|
184
184
|
## Error Handling
|
|
185
185
|
|
|
186
|
-
[`LedgerError`](
|
|
186
|
+
[`LedgerError`](#error-handling) is the base class for all HTTP error responses. It has the following properties:
|
|
187
187
|
|
|
188
188
|
| Property | Type | Description |
|
|
189
189
|
| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
|
|
@@ -216,75 +216,75 @@ try {
|
|
|
216
216
|
|
|
217
217
|
### Error Classes
|
|
218
218
|
**Primary error:**
|
|
219
|
-
* [`LedgerError`](
|
|
219
|
+
* [`LedgerError`](#error-handling): The base class for HTTP error responses.
|
|
220
220
|
|
|
221
221
|
<details><summary>Less common errors (59)</summary>
|
|
222
222
|
|
|
223
223
|
<br />
|
|
224
224
|
|
|
225
225
|
**Network errors:**
|
|
226
|
-
* [`ConnectionError`](
|
|
227
|
-
* [`RequestTimeoutError`](
|
|
228
|
-
* [`RequestAbortedError`](
|
|
229
|
-
* [`InvalidRequestError`](
|
|
230
|
-
* [`UnexpectedClientError`](
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
**Inherit from [`LedgerError`](
|
|
234
|
-
* [`CustomerError`](./
|
|
235
|
-
* [`CreateFeatureBadRequestError`](./
|
|
236
|
-
* [`GetFeatureBadRequestError`](./
|
|
237
|
-
* [`UpdateFeatureBadRequestError`](./
|
|
238
|
-
* [`ArchiveFeatureBadRequestError`](./
|
|
239
|
-
* [`CreatePlanBadRequestError`](./
|
|
240
|
-
* [`GetPlanBadRequestError`](./
|
|
241
|
-
* [`UpdatePlanBadRequestError`](./
|
|
242
|
-
* [`ArchivePlanBadRequestError`](./
|
|
243
|
-
* [`CreateAddOnBadRequestError`](./
|
|
244
|
-
* [`GetAddOnBadRequestError`](./
|
|
245
|
-
* [`UpdateAddOnBadRequestError`](./
|
|
246
|
-
* [`ArchiveAddOnBadRequestError`](./
|
|
247
|
-
* [`UpgradeError`](./
|
|
248
|
-
* [`CheckError`](./
|
|
249
|
-
* [`TrackError`](./
|
|
250
|
-
* [`AttachError`](./
|
|
251
|
-
* [`CatalogError`](./
|
|
252
|
-
* [`ListFeaturesUnauthorizedError`](./
|
|
253
|
-
* [`CreateFeatureUnauthorizedError`](./
|
|
254
|
-
* [`GetFeatureUnauthorizedError`](./
|
|
255
|
-
* [`UpdateFeatureUnauthorizedError`](./
|
|
256
|
-
* [`ArchiveFeatureUnauthorizedError`](./
|
|
257
|
-
* [`ListPlansUnauthorizedError`](./
|
|
258
|
-
* [`CreatePlanUnauthorizedError`](./
|
|
259
|
-
* [`GetPlanUnauthorizedError`](./
|
|
260
|
-
* [`UpdatePlanUnauthorizedError`](./
|
|
261
|
-
* [`ArchivePlanUnauthorizedError`](./
|
|
262
|
-
* [`ListAddOnsUnauthorizedError`](./
|
|
263
|
-
* [`CreateAddOnUnauthorizedError`](./
|
|
264
|
-
* [`GetAddOnUnauthorizedError`](./
|
|
265
|
-
* [`UpdateAddOnUnauthorizedError`](./
|
|
266
|
-
* [`ArchiveAddOnUnauthorizedError`](./
|
|
267
|
-
* [`UpgradePaidPlanUnauthorizedError`](./
|
|
268
|
-
* [`GetFeatureNotFoundError`](./
|
|
269
|
-
* [`UpdateFeatureNotFoundError`](./
|
|
270
|
-
* [`ArchiveFeatureNotFoundError`](./
|
|
271
|
-
* [`GetPlanNotFoundError`](./
|
|
272
|
-
* [`UpdatePlanNotFoundError`](./
|
|
273
|
-
* [`ArchivePlanNotFoundError`](./
|
|
274
|
-
* [`GetAddOnNotFoundError`](./
|
|
275
|
-
* [`UpdateAddOnNotFoundError`](./
|
|
276
|
-
* [`ArchiveAddOnNotFoundError`](./
|
|
277
|
-
* [`UpgradePaidPlanNotFoundError`](./
|
|
278
|
-
* [`CreateFeatureConflictError`](./
|
|
279
|
-
* [`UpdateFeatureConflictError`](./
|
|
280
|
-
* [`CreatePlanConflictError`](./
|
|
281
|
-
* [`UpdatePlanConflictError`](./
|
|
282
|
-
* [`CreateAddOnConflictError`](./
|
|
283
|
-
* [`UpdateAddOnConflictError`](./
|
|
284
|
-
* [`UpgradePaidPlanConflictError`](./
|
|
285
|
-
* [`BadGatewayError`](./
|
|
286
|
-
* [`ServiceUnavailableError`](./
|
|
287
|
-
* [`ResponseValidationError`](
|
|
226
|
+
* [`ConnectionError`](#error-classes): HTTP client was unable to make a request to a server.
|
|
227
|
+
* [`RequestTimeoutError`](#error-classes): HTTP request timed out due to an AbortSignal signal.
|
|
228
|
+
* [`RequestAbortedError`](#error-classes): HTTP request was aborted by the client.
|
|
229
|
+
* [`InvalidRequestError`](#error-classes): Any input used to create a request is invalid.
|
|
230
|
+
* [`UnexpectedClientError`](#error-classes): Unrecognised or unexpected error.
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
**Inherit from [`LedgerError`](#error-handling)**:
|
|
234
|
+
* [`CustomerError`](./docs/models/errors/customer-error.md): Applicable to 5 of 25 methods.*
|
|
235
|
+
* [`CreateFeatureBadRequestError`](./docs/models/errors/create-feature-bad-request-error.md): Invalid request. Status code `400`. Applicable to 1 of 25 methods.*
|
|
236
|
+
* [`GetFeatureBadRequestError`](./docs/models/errors/get-feature-bad-request-error.md): Invalid request. Status code `400`. Applicable to 1 of 25 methods.*
|
|
237
|
+
* [`UpdateFeatureBadRequestError`](./docs/models/errors/update-feature-bad-request-error.md): Invalid request. Status code `400`. Applicable to 1 of 25 methods.*
|
|
238
|
+
* [`ArchiveFeatureBadRequestError`](./docs/models/errors/archive-feature-bad-request-error.md): Invalid request. Status code `400`. Applicable to 1 of 25 methods.*
|
|
239
|
+
* [`CreatePlanBadRequestError`](./docs/models/errors/create-plan-bad-request-error.md): Invalid request. Status code `400`. Applicable to 1 of 25 methods.*
|
|
240
|
+
* [`GetPlanBadRequestError`](./docs/models/errors/get-plan-bad-request-error.md): Invalid request. Status code `400`. Applicable to 1 of 25 methods.*
|
|
241
|
+
* [`UpdatePlanBadRequestError`](./docs/models/errors/update-plan-bad-request-error.md): Invalid request. Status code `400`. Applicable to 1 of 25 methods.*
|
|
242
|
+
* [`ArchivePlanBadRequestError`](./docs/models/errors/archive-plan-bad-request-error.md): Invalid request. Status code `400`. Applicable to 1 of 25 methods.*
|
|
243
|
+
* [`CreateAddOnBadRequestError`](./docs/models/errors/create-add-on-bad-request-error.md): Invalid request. Status code `400`. Applicable to 1 of 25 methods.*
|
|
244
|
+
* [`GetAddOnBadRequestError`](./docs/models/errors/get-add-on-bad-request-error.md): Invalid request. Status code `400`. Applicable to 1 of 25 methods.*
|
|
245
|
+
* [`UpdateAddOnBadRequestError`](./docs/models/errors/update-add-on-bad-request-error.md): Invalid request. Status code `400`. Applicable to 1 of 25 methods.*
|
|
246
|
+
* [`ArchiveAddOnBadRequestError`](./docs/models/errors/archive-add-on-bad-request-error.md): Invalid request. Status code `400`. Applicable to 1 of 25 methods.*
|
|
247
|
+
* [`UpgradeError`](./docs/models/errors/upgrade-error.md): Invalid or ineligible upgrade. Status code `400`. Applicable to 1 of 25 methods.*
|
|
248
|
+
* [`CheckError`](./docs/models/errors/check-error.md): Invalid input. Applicable to 1 of 25 methods.*
|
|
249
|
+
* [`TrackError`](./docs/models/errors/track-error.md): Invalid input. Applicable to 1 of 25 methods.*
|
|
250
|
+
* [`AttachError`](./docs/models/errors/attach-error.md): Invalid request. Applicable to 1 of 25 methods.*
|
|
251
|
+
* [`CatalogError`](./docs/models/errors/catalog-error.md): Invalid catalog. Applicable to 1 of 25 methods.*
|
|
252
|
+
* [`ListFeaturesUnauthorizedError`](./docs/models/errors/list-features-unauthorized-error.md): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
|
|
253
|
+
* [`CreateFeatureUnauthorizedError`](./docs/models/errors/create-feature-unauthorized-error.md): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
|
|
254
|
+
* [`GetFeatureUnauthorizedError`](./docs/models/errors/get-feature-unauthorized-error.md): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
|
|
255
|
+
* [`UpdateFeatureUnauthorizedError`](./docs/models/errors/update-feature-unauthorized-error.md): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
|
|
256
|
+
* [`ArchiveFeatureUnauthorizedError`](./docs/models/errors/archive-feature-unauthorized-error.md): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
|
|
257
|
+
* [`ListPlansUnauthorizedError`](./docs/models/errors/list-plans-unauthorized-error.md): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
|
|
258
|
+
* [`CreatePlanUnauthorizedError`](./docs/models/errors/create-plan-unauthorized-error.md): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
|
|
259
|
+
* [`GetPlanUnauthorizedError`](./docs/models/errors/get-plan-unauthorized-error.md): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
|
|
260
|
+
* [`UpdatePlanUnauthorizedError`](./docs/models/errors/update-plan-unauthorized-error.md): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
|
|
261
|
+
* [`ArchivePlanUnauthorizedError`](./docs/models/errors/archive-plan-unauthorized-error.md): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
|
|
262
|
+
* [`ListAddOnsUnauthorizedError`](./docs/models/errors/list-add-ons-unauthorized-error.md): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
|
|
263
|
+
* [`CreateAddOnUnauthorizedError`](./docs/models/errors/create-add-on-unauthorized-error.md): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
|
|
264
|
+
* [`GetAddOnUnauthorizedError`](./docs/models/errors/get-add-on-unauthorized-error.md): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
|
|
265
|
+
* [`UpdateAddOnUnauthorizedError`](./docs/models/errors/update-add-on-unauthorized-error.md): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
|
|
266
|
+
* [`ArchiveAddOnUnauthorizedError`](./docs/models/errors/archive-add-on-unauthorized-error.md): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
|
|
267
|
+
* [`UpgradePaidPlanUnauthorizedError`](./docs/models/errors/upgrade-paid-plan-unauthorized-error.md): Invalid Ledger API key. Status code `401`. Applicable to 1 of 25 methods.*
|
|
268
|
+
* [`GetFeatureNotFoundError`](./docs/models/errors/get-feature-not-found-error.md): Item not found. Status code `404`. Applicable to 1 of 25 methods.*
|
|
269
|
+
* [`UpdateFeatureNotFoundError`](./docs/models/errors/update-feature-not-found-error.md): Item not found. Status code `404`. Applicable to 1 of 25 methods.*
|
|
270
|
+
* [`ArchiveFeatureNotFoundError`](./docs/models/errors/archive-feature-not-found-error.md): Item not found. Status code `404`. Applicable to 1 of 25 methods.*
|
|
271
|
+
* [`GetPlanNotFoundError`](./docs/models/errors/get-plan-not-found-error.md): Item not found. Status code `404`. Applicable to 1 of 25 methods.*
|
|
272
|
+
* [`UpdatePlanNotFoundError`](./docs/models/errors/update-plan-not-found-error.md): Item not found. Status code `404`. Applicable to 1 of 25 methods.*
|
|
273
|
+
* [`ArchivePlanNotFoundError`](./docs/models/errors/archive-plan-not-found-error.md): Item not found. Status code `404`. Applicable to 1 of 25 methods.*
|
|
274
|
+
* [`GetAddOnNotFoundError`](./docs/models/errors/get-add-on-not-found-error.md): Item not found. Status code `404`. Applicable to 1 of 25 methods.*
|
|
275
|
+
* [`UpdateAddOnNotFoundError`](./docs/models/errors/update-add-on-not-found-error.md): Item not found. Status code `404`. Applicable to 1 of 25 methods.*
|
|
276
|
+
* [`ArchiveAddOnNotFoundError`](./docs/models/errors/archive-add-on-not-found-error.md): Item not found. Status code `404`. Applicable to 1 of 25 methods.*
|
|
277
|
+
* [`UpgradePaidPlanNotFoundError`](./docs/models/errors/upgrade-paid-plan-not-found-error.md): Unknown customer or target plan. Status code `404`. Applicable to 1 of 25 methods.*
|
|
278
|
+
* [`CreateFeatureConflictError`](./docs/models/errors/create-feature-conflict-error.md): Item ID already exists or add-on Checkout is pending. Status code `409`. Applicable to 1 of 25 methods.*
|
|
279
|
+
* [`UpdateFeatureConflictError`](./docs/models/errors/update-feature-conflict-error.md): Item ID already exists or add-on Checkout is pending. Status code `409`. Applicable to 1 of 25 methods.*
|
|
280
|
+
* [`CreatePlanConflictError`](./docs/models/errors/create-plan-conflict-error.md): Item ID already exists or add-on Checkout is pending. Status code `409`. Applicable to 1 of 25 methods.*
|
|
281
|
+
* [`UpdatePlanConflictError`](./docs/models/errors/update-plan-conflict-error.md): Item ID already exists or add-on Checkout is pending. Status code `409`. Applicable to 1 of 25 methods.*
|
|
282
|
+
* [`CreateAddOnConflictError`](./docs/models/errors/create-add-on-conflict-error.md): Item ID already exists or add-on Checkout is pending. Status code `409`. Applicable to 1 of 25 methods.*
|
|
283
|
+
* [`UpdateAddOnConflictError`](./docs/models/errors/update-add-on-conflict-error.md): Item ID already exists or add-on Checkout is pending. Status code `409`. Applicable to 1 of 25 methods.*
|
|
284
|
+
* [`UpgradePaidPlanConflictError`](./docs/models/errors/upgrade-paid-plan-conflict-error.md): Idempotency key mismatch or pending upgrade. Status code `409`. Applicable to 1 of 25 methods.*
|
|
285
|
+
* [`BadGatewayError`](./docs/models/errors/bad-gateway-error.md): Stripe request failed or signed webhook endpoint unhealthy. Status code `502`. Applicable to 1 of 25 methods.*
|
|
286
|
+
* [`ServiceUnavailableError`](./docs/models/errors/service-unavailable-error.md): Upgrade requires Stripe reconciliation or payment action. Status code `503`. Applicable to 1 of 25 methods.*
|
|
287
|
+
* [`ResponseValidationError`](#error-classes): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
|
|
288
288
|
|
|
289
289
|
</details>
|
|
290
290
|
|
|
@@ -380,8 +380,6 @@ const sdk = new ledger({ debugLogger: console });
|
|
|
380
380
|
You can also enable a default debug logger by setting an environment variable `LEDGER_DEBUG` to true.
|
|
381
381
|
<!-- End Debugging [debug] -->
|
|
382
382
|
|
|
383
|
-
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
|
384
|
-
|
|
385
383
|
# Development
|
|
386
384
|
|
|
387
385
|
## Maturity
|
|
@@ -31,8 +31,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
|
|
|
31
31
|
export declare const SDK_METADATA: {
|
|
32
32
|
readonly language: "typescript";
|
|
33
33
|
readonly openapiDocVersion: "0.1.0";
|
|
34
|
-
readonly sdkVersion: "0.1.
|
|
34
|
+
readonly sdkVersion: "0.1.1";
|
|
35
35
|
readonly genVersion: "2.954.8";
|
|
36
|
-
readonly userAgent: "speakeasy-sdk/typescript 0.1.
|
|
36
|
+
readonly userAgent: "speakeasy-sdk/typescript 0.1.1 2.954.8 0.1.0 integrateledger";
|
|
37
37
|
};
|
|
38
38
|
//# sourceMappingURL=config.d.ts.map
|
|
@@ -35,8 +35,8 @@ function serverURLFromOptions(options) {
|
|
|
35
35
|
exports.SDK_METADATA = {
|
|
36
36
|
language: "typescript",
|
|
37
37
|
openapiDocVersion: "0.1.0",
|
|
38
|
-
sdkVersion: "0.1.
|
|
38
|
+
sdkVersion: "0.1.1",
|
|
39
39
|
genVersion: "2.954.8",
|
|
40
|
-
userAgent: "speakeasy-sdk/typescript 0.1.
|
|
40
|
+
userAgent: "speakeasy-sdk/typescript 0.1.1 2.954.8 0.1.0 integrateledger",
|
|
41
41
|
};
|
|
42
42
|
//# sourceMappingURL=config.js.map
|
package/dist/esm/lib/config.d.ts
CHANGED
|
@@ -31,8 +31,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
|
|
|
31
31
|
export declare const SDK_METADATA: {
|
|
32
32
|
readonly language: "typescript";
|
|
33
33
|
readonly openapiDocVersion: "0.1.0";
|
|
34
|
-
readonly sdkVersion: "0.1.
|
|
34
|
+
readonly sdkVersion: "0.1.1";
|
|
35
35
|
readonly genVersion: "2.954.8";
|
|
36
|
-
readonly userAgent: "speakeasy-sdk/typescript 0.1.
|
|
36
|
+
readonly userAgent: "speakeasy-sdk/typescript 0.1.1 2.954.8 0.1.0 integrateledger";
|
|
37
37
|
};
|
|
38
38
|
//# sourceMappingURL=config.d.ts.map
|
package/dist/esm/lib/config.js
CHANGED
|
@@ -31,8 +31,8 @@ export function serverURLFromOptions(options) {
|
|
|
31
31
|
export const SDK_METADATA = {
|
|
32
32
|
language: "typescript",
|
|
33
33
|
openapiDocVersion: "0.1.0",
|
|
34
|
-
sdkVersion: "0.1.
|
|
34
|
+
sdkVersion: "0.1.1",
|
|
35
35
|
genVersion: "2.954.8",
|
|
36
|
-
userAgent: "speakeasy-sdk/typescript 0.1.
|
|
36
|
+
userAgent: "speakeasy-sdk/typescript 0.1.1 2.954.8 0.1.0 integrateledger",
|
|
37
37
|
};
|
|
38
38
|
//# sourceMappingURL=config.js.map
|
package/package.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "integrateledger",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"author": "Ledger",
|
|
5
5
|
"description": "Server-side TypeScript client for the Ledger billing and usage API",
|
|
6
|
-
"homepage": "https://docs.integrateledger.com/
|
|
6
|
+
"homepage": "https://docs.integrateledger.com/quickstart",
|
|
7
7
|
"keywords": [
|
|
8
8
|
"ledger",
|
|
9
9
|
"billing",
|
package/src/lib/config.ts
CHANGED
|
@@ -65,7 +65,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
|
|
|
65
65
|
export const SDK_METADATA = {
|
|
66
66
|
language: "typescript",
|
|
67
67
|
openapiDocVersion: "0.1.0",
|
|
68
|
-
sdkVersion: "0.1.
|
|
68
|
+
sdkVersion: "0.1.1",
|
|
69
69
|
genVersion: "2.954.8",
|
|
70
|
-
userAgent: "speakeasy-sdk/typescript 0.1.
|
|
70
|
+
userAgent: "speakeasy-sdk/typescript 0.1.1 2.954.8 0.1.0 integrateledger",
|
|
71
71
|
} as const;
|