integrateledger 0.1.1 → 0.1.2

package/src/models/customer-overage.ts

@@ -0,0 +1,108 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { safeParse } from "../lib/schemas.js";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import * as types from "../types/primitives.js";
+import {
+  CustomerOverageOverride,
+  CustomerOverageOverride$inboundSchema,
+} from "./customer-overage-override.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+
+/**
+ * customer: the customer's own cap; override: the customer's overage override; plan: the plan default; null: no cap.
+ */
+export const CapSource = {
+  Customer: "customer",
+  Override: "override",
+  Plan: "plan",
+} as const;
+/**
+ * customer: the customer's own cap; override: the customer's overage override; plan: the plan default; null: no cap.
+ */
+export type CapSource = OpenEnum<typeof CapSource>;
+
+/**
+ * Where the overage rate comes from: the plan, or an override set with setCustomerOverageOverride.
+ */
+export const Source = {
+  Plan: "plan",
+  Override: "override",
+} as const;
+/**
+ * Where the overage rate comes from: the plan, or an override set with setCustomerOverageOverride.
+ */
+export type Source = OpenEnum<typeof Source>;
+
+export type CustomerOverage = {
+  /**
+   * Overage credits recorded in the current billing period.
+   */
+  credits: number;
+  /**
+   * This period's overage cost: ceil(credits / billingUnits) × unitAmountCents per recorded rate.
+   */
+  costCents: number;
+  unitAmountCents: number;
+  billingUnits: number;
+  /**
+   * Effective monthly overage cap. Null: no cap.
+   */
+  capCents: number | null;
+  /**
+   * customer: the customer's own cap; override: the customer's overage override; plan: the plan default; null: no cap.
+   */
+  capSource: CapSource | null;
+  remainingCents: number | null;
+  /**
+   * Where the overage rate comes from: the plan, or an override set with setCustomerOverageOverride.
+   */
+  source: Source;
+  /**
+   * The override behind the rate when source is override. Null otherwise.
+   */
+  override: CustomerOverageOverride | null;
+  periodStart: Date;
+  periodEnd: Date;
+};
+
+/** @internal */
+export const CapSource$inboundSchema: z.ZodMiniType<CapSource, unknown> =
+  openEnums.inboundSchema(CapSource);
+
+/** @internal */
+export const Source$inboundSchema: z.ZodMiniType<Source, unknown> = openEnums
+  .inboundSchema(Source);
+
+/** @internal */
+export const CustomerOverage$inboundSchema: z.ZodMiniType<
+  CustomerOverage,
+  unknown
+> = z.object({
+  credits: types.number(),
+  costCents: types.number(),
+  unitAmountCents: types.number(),
+  billingUnits: types.number(),
+  capCents: types.nullable(types.number()),
+  capSource: types.nullable(CapSource$inboundSchema),
+  remainingCents: types.nullable(types.number()),
+  source: Source$inboundSchema,
+  override: types.nullable(CustomerOverageOverride$inboundSchema),
+  periodStart: types.date(),
+  periodEnd: types.date(),
+});
+
+export function customerOverageFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomerOverage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomerOverage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomerOverage' from JSON`,
+  );
+}

package/src/models/errors/track-error.ts

@@ -10,12 +10,14 @@ export type TrackErrorData = {
   error: string;
   availableCredits?: number | undefined;
   creditCost?: number | undefined;
+  overageRemainingCents?: number | null | undefined;
 };
 
 export class TrackError extends LedgerError {
   error: string;
   availableCredits?: number | undefined;
   creditCost?: number | undefined;
+  overageRemainingCents?: number | null | undefined;
 
   /** The original data that was passed to this error instance. */
   data$: TrackErrorData;
@@ -34,6 +36,9 @@ export class TrackError extends LedgerError {
       this.availableCredits = err.availableCredits;
     }
     if (err.creditCost != null) this.creditCost = err.creditCost;
+    if (err.overageRemainingCents != null) {
+      this.overageRemainingCents = err.overageRemainingCents;
+    }
 
     this.name = "TrackError";
   }
@@ -46,6 +51,7 @@ export const TrackError$inboundSchema: z.ZodMiniType<TrackError, unknown> = z
       error: types.string(),
       availableCredits: types.optional(types.number()),
       creditCost: types.optional(types.number()),
+      overageRemainingCents: z.optional(z.nullable(types.number())),
       request$: z.custom<Request>(x => x instanceof Request),
       response$: z.custom<Response>(x => x instanceof Response),
       body$: z.string(),

package/src/models/index.ts

@@ -20,6 +20,10 @@ export * from "./create-customer-input.js";
 export * from "./create-feature-input.js";
 export * from "./create-plan-input.js";
 export * from "./customer-detail.js";
+export * from "./customer-overage-cap.js";
+export * from "./customer-overage-override-result.js";
+export * from "./customer-overage-override.js";
+export * from "./customer-overage.js";
 export * from "./customer-purchase-item.js";
 export * from "./customer-purchase-page.js";
 export * from "./customer-response.js";
@@ -38,6 +42,8 @@ export * from "./plan-item.js";
 export * from "./plan-list.js";
 export * from "./plan-mutation.js";
 export * from "./security.js";
+export * from "./set-customer-overage-cap-input.js";
+export * from "./set-customer-overage-override-input.js";
 export * from "./track-input.js";
 export * from "./track-response.js";
 export * from "./update-add-on-input.js";

package/src/models/operations/index.ts

@@ -11,6 +11,8 @@ export * from "./get-feature.js";
 export * from "./get-plan.js";
 export * from "./list-customer-purchases.js";
 export * from "./list-customer-subscriptions.js";
+export * from "./set-customer-overage-cap.js";
+export * from "./set-customer-overage-override.js";
 export * from "./set-subscription-cancellation.js";
 export * from "./update-add-on.js";
 export * from "./update-feature.js";

package/src/models/operations/set-customer-overage-cap.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import * as models from "../index.js";
+
+export type SetCustomerOverageCapRequest = {
+  customerId: string;
+  body: models.SetCustomerOverageCapInput;
+};
+
+/** @internal */
+export type SetCustomerOverageCapRequest$Outbound = {
+  customerId: string;
+  body: models.SetCustomerOverageCapInput$Outbound;
+};
+
+/** @internal */
+export const SetCustomerOverageCapRequest$outboundSchema: z.ZodMiniType<
+  SetCustomerOverageCapRequest$Outbound,
+  SetCustomerOverageCapRequest
+> = z.object({
+  customerId: z.string(),
+  body: models.SetCustomerOverageCapInput$outboundSchema,
+});
+
+export function setCustomerOverageCapRequestToJSON(
+  setCustomerOverageCapRequest: SetCustomerOverageCapRequest,
+): string {
+  return JSON.stringify(
+    SetCustomerOverageCapRequest$outboundSchema.parse(
+      setCustomerOverageCapRequest,
+    ),
+  );
+}

package/src/models/operations/set-customer-overage-override.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import * as models from "../index.js";
+
+export type SetCustomerOverageOverrideRequest = {
+  customerId: string;
+  body: models.SetCustomerOverageOverrideInput;
+};
+
+/** @internal */
+export type SetCustomerOverageOverrideRequest$Outbound = {
+  customerId: string;
+  body: models.SetCustomerOverageOverrideInput$Outbound;
+};
+
+/** @internal */
+export const SetCustomerOverageOverrideRequest$outboundSchema: z.ZodMiniType<
+  SetCustomerOverageOverrideRequest$Outbound,
+  SetCustomerOverageOverrideRequest
+> = z.object({
+  customerId: z.string(),
+  body: models.SetCustomerOverageOverrideInput$outboundSchema,
+});
+
+export function setCustomerOverageOverrideRequestToJSON(
+  setCustomerOverageOverrideRequest: SetCustomerOverageOverrideRequest,
+): string {
+  return JSON.stringify(
+    SetCustomerOverageOverrideRequest$outboundSchema.parse(
+      setCustomerOverageOverrideRequest,
+    ),
+  );
+}

package/src/models/plan-item.ts

@@ -22,6 +22,18 @@ export type PlanItem = {
   name: string;
   monthlyCredits: number;
   monthlyPriceCents: number;
+  /**
+   * Price in cents per overageBillingUnits credits used after the plan's credits and packs run out. Null or omitted: no overage.
+   */
+  overageUnitAmountCents?: number | null | undefined;
+  /**
+   * Credits billed per overageUnitAmountCents. Defaults to 1.
+   */
+  overageBillingUnits?: number | undefined;
+  /**
+   * Default monthly overage spend cap in cents. A customer's own cap replaces it. Null or omitted: no cap.
+   */
+  overageCapCents?: number | null | undefined;
   stripeSyncStatus?: StripeSyncStatus | null | undefined;
 };
 
@@ -38,6 +50,9 @@ export const PlanItem$inboundSchema: z.ZodMiniType<PlanItem, unknown> = z
     name: types.string(),
     monthlyCredits: types.number(),
     monthlyPriceCents: types.number(),
+    overageUnitAmountCents: z.optional(z.nullable(types.number())),
+    overageBillingUnits: types.optional(types.number()),
+    overageCapCents: z.optional(z.nullable(types.number())),
     stripeSyncStatus: z.optional(z.nullable(StripeSyncStatus$inboundSchema)),
   });
 

package/src/models/set-customer-overage-cap-input.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+
+export type SetCustomerOverageCapInput = {
+  /**
+   * The customer's monthly overage cap in cents. It replaces the plan default, higher or lower. Null clears it and restores the plan default.
+   */
+  capCents: number | null;
+};
+
+/** @internal */
+export type SetCustomerOverageCapInput$Outbound = {
+  capCents: number | null;
+};
+
+/** @internal */
+export const SetCustomerOverageCapInput$outboundSchema: z.ZodMiniType<
+  SetCustomerOverageCapInput$Outbound,
+  SetCustomerOverageCapInput
+> = z.object({
+  capCents: z.nullable(z.int()),
+});
+
+export function setCustomerOverageCapInputToJSON(
+  setCustomerOverageCapInput: SetCustomerOverageCapInput,
+): string {
+  return JSON.stringify(
+    SetCustomerOverageCapInput$outboundSchema.parse(setCustomerOverageCapInput),
+  );
+}

package/src/models/set-customer-overage-override-input.ts

@@ -0,0 +1,53 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+
+export type SetCustomerOverageOverrideInput = {
+  /**
+   * The plan this override applies to. Omit or null to apply it to any plan; a plan-specific override beats one for any plan.
+   */
+  planId?: string | null | undefined;
+  /**
+   * Negotiated price in cents per billingUnits overage credits. Null clears the override for this planId and restores the plan rate.
+   */
+  unitAmountCents: number | null;
+  /**
+   * Credits billed per unitAmountCents. Defaults to 1. Omit when clearing.
+   */
+  billingUnits?: number | undefined;
+  /**
+   * Monthly overage cap in cents for this override. Omit or null to keep the plan default. The customer's own cap (setCustomerOverageCap) still wins. Omit when clearing.
+   */
+  capCents?: number | null | undefined;
+};
+
+/** @internal */
+export type SetCustomerOverageOverrideInput$Outbound = {
+  planId?: string | null | undefined;
+  unitAmountCents: number | null;
+  billingUnits?: number | undefined;
+  capCents?: number | null | undefined;
+};
+
+/** @internal */
+export const SetCustomerOverageOverrideInput$outboundSchema: z.ZodMiniType<
+  SetCustomerOverageOverrideInput$Outbound,
+  SetCustomerOverageOverrideInput
+> = z.object({
+  planId: z.optional(z.nullable(z.string())),
+  unitAmountCents: z.nullable(z.int()),
+  billingUnits: z.optional(z.int()),
+  capCents: z.optional(z.nullable(z.int())),
+});
+
+export function setCustomerOverageOverrideInputToJSON(
+  setCustomerOverageOverrideInput: SetCustomerOverageOverrideInput,
+): string {
+  return JSON.stringify(
+    SetCustomerOverageOverrideInput$outboundSchema.parse(
+      setCustomerOverageOverrideInput,
+    ),
+  );
+}

package/src/models/track-response.ts

@@ -11,8 +11,19 @@ import { SDKValidationError } from "./errors/sdk-validation-error.js";
 
 export type TrackResponse = {
   allowed: true;
+  /**
+   * Prepaid credits left in plan and credit-pack grants. Overage never makes this negative.
+   */
   availableCredits: number;
   chargedCredits: number;
+  /**
+   * Overage credits recorded in the current billing period, including this request.
+   */
+  overageCredits: number;
+  /**
+   * Overage spend left under the effective cap this period. Null when there is no cap or no overage.
+   */
+  overageRemainingCents: number | null;
   requestId: string;
   idempotent: boolean;
 };
@@ -26,6 +37,8 @@ export const TrackResponse$inboundSchema: z.ZodMiniType<
     allowed: types.literal(true),
     availableCredits: types.number(),
     chargedCredits: types.number(),
+    overageCredits: types.number(),
+    overageRemainingCents: types.nullable(types.number()),
     request_id: types.string(),
     idempotent: types.boolean(),
   }),

package/src/models/update-plan-input.ts

@@ -8,6 +8,18 @@ export type UpdatePlanInput = {
   name: string;
   monthlyCredits: number;
   monthlyPriceCents: number;
+  /**
+   * Price in cents per overageBillingUnits credits used after the plan's credits and packs run out. Null or omitted: no overage.
+   */
+  overageUnitAmountCents?: number | null | undefined;
+  /**
+   * Credits billed per overageUnitAmountCents. Defaults to 1.
+   */
+  overageBillingUnits?: number | undefined;
+  /**
+   * Default monthly overage spend cap in cents. A customer's own cap replaces it. Null or omitted: no cap.
+   */
+  overageCapCents?: number | null | undefined;
 };
 
 /** @internal */
@@ -15,6 +27,9 @@ export type UpdatePlanInput$Outbound = {
   name: string;
   monthlyCredits: number;
   monthlyPriceCents: number;
+  overageUnitAmountCents?: number | null | undefined;
+  overageBillingUnits?: number | undefined;
+  overageCapCents?: number | null | undefined;
 };
 
 /** @internal */
@@ -25,6 +40,9 @@ export const UpdatePlanInput$outboundSchema: z.ZodMiniType<
   name: z.string(),
   monthlyCredits: z.int(),
   monthlyPriceCents: z.int(),
+  overageUnitAmountCents: z.optional(z.nullable(z.int())),
+  overageBillingUnits: z.optional(z.int()),
+  overageCapCents: z.optional(z.nullable(z.int())),
 });
 
 export function updatePlanInputToJSON(

package/src/sdk/sdk.ts

@@ -21,6 +21,8 @@ import { listCustomerSubscriptions } from "../funcs/list-customer-subscriptions.
 import { listFeatures } from "../funcs/list-features.js";
 import { listPlans } from "../funcs/list-plans.js";
 import { publishCatalog } from "../funcs/publish-catalog.js";
+import { setCustomerOverageCap } from "../funcs/set-customer-overage-cap.js";
+import { setCustomerOverageOverride } from "../funcs/set-customer-overage-override.js";
 import { setSubscriptionCancellation } from "../funcs/set-subscription-cancellation.js";
 import { trackUsage } from "../funcs/track-usage.js";
 import { updateAddOn } from "../funcs/update-add-on.js";
@@ -307,6 +309,34 @@ export class Ledger extends ClientSDK {
     ));
   }
 
+  /**
+   * Set or clear a customer's overage cap
+   */
+  async setCustomerOverageCap(
+    request: operations.SetCustomerOverageCapRequest,
+    options?: RequestOptions,
+  ): Promise<models.CustomerOverageCap> {
+    return unwrapAsync(setCustomerOverageCap(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Set or clear a customer's negotiated overage rate
+   */
+  async setCustomerOverageOverride(
+    request: operations.SetCustomerOverageOverrideRequest,
+    options?: RequestOptions,
+  ): Promise<models.CustomerOverageOverrideResult> {
+    return unwrapAsync(setCustomerOverageOverride(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Get a customer and current balance
    */