integrateledger 0.1.0 → 0.1.2

package/docs/sdks/ledger/README.md

@@ -24,6 +24,8 @@
 * [listCustomerSubscriptions](#listcustomersubscriptions) - List a customer's subscriptions
 * [listCustomerPurchases](#listcustomerpurchases) - List a customer's credit-pack purchases
 * [setSubscriptionCancellation](#setsubscriptioncancellation) - Stop or resume a paid subscription's renewal
+* [setCustomerOverageCap](#setcustomeroveragecap) - Set or clear a customer's overage cap
+* [setCustomerOverageOverride](#setcustomeroverageoverride) - Set or clear a customer's negotiated overage rate
 * [getCustomer](#getcustomer) - Get a customer and current balance
 * [createOrGetCustomer](#createorgetcustomer) - Create or get a customer
 * [trackUsage](#trackusage) - Record feature usage
@@ -36,7 +38,7 @@ Publish an organization's catalog
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="publishCatalog" method="put" path="/v1/catalog" -->
+<!-- UsageSnippet language="typescript" operationID="publishCatalog" method="post" path="/v1/catalog" -->
 ```typescript
 import ledger from "integrateledger";
 
@@ -393,7 +395,7 @@ Update a feature
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="updateFeature" method="put" path="/v1/features/{id}" -->
+<!-- UsageSnippet language="typescript" operationID="updateFeature" method="post" path="/v1/features/{id}" -->
 ```typescript
 import ledger from "integrateledger";
 
@@ -781,7 +783,7 @@ Update a plan
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="updatePlan" method="put" path="/v1/plans/{id}" -->
+<!-- UsageSnippet language="typescript" operationID="updatePlan" method="post" path="/v1/plans/{id}" -->
 ```typescript
 import ledger from "integrateledger";
 
@@ -1173,7 +1175,7 @@ Update an add-on
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="updateAddOn" method="put" path="/v1/add-ons/{id}" -->
+<!-- UsageSnippet language="typescript" operationID="updateAddOn" method="post" path="/v1/add-ons/{id}" -->
 ```typescript
 import ledger from "integrateledger";
 
@@ -1562,7 +1564,7 @@ Stop or resume a paid subscription's renewal
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="setSubscriptionCancellation" method="put" path="/v1/customers/subscriptions/{subscriptionId}/cancellation" -->
+<!-- UsageSnippet language="typescript" operationID="setSubscriptionCancellation" method="post" path="/v1/customers/subscriptions/{subscriptionId}/cancellation" -->
 ```typescript
 import ledger from "integrateledger";
 
@@ -1639,6 +1641,166 @@ run();
 | errors.CustomerError      | 502                       | application/json          |
 | errors.LedgerDefaultError | 4XX, 5XX                  | \*/\*                     |
 
+## setCustomerOverageCap
+
+Set or clear a customer's overage cap
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="setCustomerOverageCap" method="post" path="/v1/customers/overage-cap" -->
+```typescript
+import ledger from "integrateledger";
+
+const client = new ledger({
+  apiKey: process.env["LEDGER_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await client.setCustomerOverageCap({
+    customerId: "<id>",
+    body: {
+      capCents: 597713,
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { LedgerCore } from "integrateledger/core.js";
+import { setCustomerOverageCap } from "integrateledger/funcs/set-customer-overage-cap.js";
+
+// Use `LedgerCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const ledger = new LedgerCore({
+  apiKey: process.env["LEDGER_API_KEY"] ?? "",
+});
+
+async function run() {
+  const res = await setCustomerOverageCap(ledger, {
+    customerId: "<id>",
+    body: {
+      capCents: 597713,
+    },
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("setCustomerOverageCap failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.SetCustomerOverageCapRequest](../../models/operations/set-customer-overage-cap-request.md)                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[models.CustomerOverageCap](../../models/customer-overage-cap.md)\>**
+
+### Errors
+
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.CustomerError      | 400, 401, 404             | application/json          |
+| errors.LedgerDefaultError | 4XX, 5XX                  | \*/\*                     |
+
+## setCustomerOverageOverride
+
+Set or clear a customer's negotiated overage rate
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="setCustomerOverageOverride" method="post" path="/v1/customers/overage-override" -->
+```typescript
+import ledger from "integrateledger";
+
+const client = new ledger({
+  apiKey: process.env["LEDGER_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await client.setCustomerOverageOverride({
+    customerId: "<id>",
+    body: {
+      unitAmountCents: 844704,
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { LedgerCore } from "integrateledger/core.js";
+import { setCustomerOverageOverride } from "integrateledger/funcs/set-customer-overage-override.js";
+
+// Use `LedgerCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const ledger = new LedgerCore({
+  apiKey: process.env["LEDGER_API_KEY"] ?? "",
+});
+
+async function run() {
+  const res = await setCustomerOverageOverride(ledger, {
+    customerId: "<id>",
+    body: {
+      unitAmountCents: 844704,
+    },
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("setCustomerOverageOverride failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.SetCustomerOverageOverrideRequest](../../models/operations/set-customer-overage-override-request.md)                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[models.CustomerOverageOverrideResult](../../models/customer-overage-override-result.md)\>**
+
+### Errors
+
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.CustomerError      | 400, 401, 404, 409        | application/json          |
+| errors.LedgerDefaultError | 4XX, 5XX                  | \*/\*                     |
+
 ## getCustomer
 
 Get a customer and current balance

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "integrateledger",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "author": "Ledger",
   "description": "Server-side TypeScript client for the Ledger billing and usage API",
-  "homepage": "https://docs.integrateledger.com/sdk",
+  "homepage": "https://docs.integrateledger.com/quickstart",
   "keywords": [
     "ledger",
     "billing",

package/src/funcs/publish-catalog.ts

@@ -115,7 +115,7 @@ async function $do(
 
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
-    method: "PUT",
+    method: "POST",
     baseURL: options?.serverURL,
     path: path,
     headers: headers,

package/src/funcs/set-customer-overage-cap.ts

@@ -0,0 +1,176 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { LedgerCore } from "../core.js";
+import { encodeFormQuery, encodeJSON } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/http-client-errors.js";
+import * as errors from "../models/errors/index.js";
+import { LedgerError } from "../models/errors/ledger-error.js";
+import { ResponseValidationError } from "../models/errors/response-validation-error.js";
+import { SDKValidationError } from "../models/errors/sdk-validation-error.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Set or clear a customer's overage cap
+ */
+export function setCustomerOverageCap(
+  client: LedgerCore,
+  request: operations.SetCustomerOverageCapRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.CustomerOverageCap,
+    | errors.CustomerError
+    | LedgerError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: LedgerCore,
+  request: operations.SetCustomerOverageCapRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.CustomerOverageCap,
+      | errors.CustomerError
+      | LedgerError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      z.parse(operations.SetCustomerOverageCapRequest$outboundSchema, value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.body, { explode: true });
+
+  const path = pathToFunc("/v1/customers/overage-cap")();
+
+  const query = encodeFormQuery({
+    "customerId": payload.customerId,
+  });
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "setCustomerOverageCap",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    models.CustomerOverageCap,
+    | errors.CustomerError
+    | LedgerError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.CustomerOverageCap$inboundSchema),
+    M.jsonErr([400, 401, 404], errors.CustomerError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/set-customer-overage-override.ts

@@ -0,0 +1,179 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { LedgerCore } from "../core.js";
+import { encodeFormQuery, encodeJSON } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/http-client-errors.js";
+import * as errors from "../models/errors/index.js";
+import { LedgerError } from "../models/errors/ledger-error.js";
+import { ResponseValidationError } from "../models/errors/response-validation-error.js";
+import { SDKValidationError } from "../models/errors/sdk-validation-error.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Set or clear a customer's negotiated overage rate
+ */
+export function setCustomerOverageOverride(
+  client: LedgerCore,
+  request: operations.SetCustomerOverageOverrideRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.CustomerOverageOverrideResult,
+    | errors.CustomerError
+    | LedgerError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: LedgerCore,
+  request: operations.SetCustomerOverageOverrideRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.CustomerOverageOverrideResult,
+      | errors.CustomerError
+      | LedgerError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      z.parse(
+        operations.SetCustomerOverageOverrideRequest$outboundSchema,
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.body, { explode: true });
+
+  const path = pathToFunc("/v1/customers/overage-override")();
+
+  const query = encodeFormQuery({
+    "customerId": payload.customerId,
+  });
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "setCustomerOverageOverride",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    models.CustomerOverageOverrideResult,
+    | errors.CustomerError
+    | LedgerError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.CustomerOverageOverrideResult$inboundSchema),
+    M.jsonErr([400, 401, 404, 409], errors.CustomerError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/set-subscription-cancellation.ts

@@ -132,7 +132,7 @@ async function $do(
 
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
-    method: "PUT",
+    method: "POST",
     baseURL: options?.serverURL,
     path: path,
     headers: headers,

package/src/funcs/update-add-on.ts

@@ -128,7 +128,7 @@ async function $do(
 
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
-    method: "PUT",
+    method: "POST",
     baseURL: options?.serverURL,
     path: path,
     headers: headers,

package/src/funcs/update-feature.ts

@@ -128,7 +128,7 @@ async function $do(
 
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
-    method: "PUT",
+    method: "POST",
     baseURL: options?.serverURL,
     path: path,
     headers: headers,

package/src/funcs/update-plan.ts

@@ -128,7 +128,7 @@ async function $do(
 
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
-    method: "PUT",
+    method: "POST",
     baseURL: options?.serverURL,
     path: path,
     headers: headers,

package/src/lib/config.ts

@@ -65,7 +65,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.1.0",
-  sdkVersion: "0.1.0",
+  sdkVersion: "0.1.2",
   genVersion: "2.954.8",
-  userAgent: "speakeasy-sdk/typescript 0.1.0 2.954.8 0.1.0 integrateledger",
+  userAgent: "speakeasy-sdk/typescript 0.1.2 2.954.8 0.1.0 integrateledger",
 } as const;