@paygentic/sdk 0.7.9 → 0.7.11

package/src/models/booleanentitlementdetail.ts

@@ -6,6 +6,10 @@ import * as z from "zod/v3";
 import { safeParse } from "../lib/schemas.js";
 import { ClosedEnum } from "../types/enums.js";
 import { Result as SafeParseResult } from "../types/fp.js";
+import {
+  EntitlementStatus,
+  EntitlementStatus$inboundSchema,
+} from "./entitlementstatus.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 
 export const BooleanEntitlementDetailObject = {
@@ -15,21 +19,6 @@ export type BooleanEntitlementDetailObject = ClosedEnum<
   typeof BooleanEntitlementDetailObject
 >;
 
-/**
- * Current status of the entitlement.
- */
-export const BooleanEntitlementDetailStatus = {
-  Active: "active",
-  Canceled: "canceled",
-  Expired: "expired",
-} as const;
-/**
- * Current status of the entitlement.
- */
-export type BooleanEntitlementDetailStatus = ClosedEnum<
-  typeof BooleanEntitlementDetailStatus
->;
-
 /**
  * Common fields shared by all entitlement types.
  */
@@ -52,14 +41,18 @@ export type BooleanEntitlementDetail = {
    */
   featureKey: string;
   featureType: "boolean";
+  /**
+   * Unique identifier for a product
+   */
+  productId: string;
   /**
    * The subscription this entitlement is associated with, if any.
    */
-  subscriptionId?: string | null | undefined;
+  subscriptionId: string | null;
   /**
    * Current status of the entitlement.
    */
-  status: BooleanEntitlementDetailStatus;
+  status: EntitlementStatus;
   /**
    * When the entitlement becomes active.
    */
@@ -67,7 +60,7 @@ export type BooleanEntitlementDetail = {
   /**
    * When the entitlement expires. Null means no expiration.
    */
-  activeTo?: Date | null | undefined;
+  activeTo: Date | null;
   /**
    * Whether the customer currently has active access to this entitlement.
    */
@@ -75,7 +68,11 @@ export type BooleanEntitlementDetail = {
   /**
    * Additional metadata for the entitlement.
    */
-  metadata?: { [k: string]: string } | undefined;
+  metadata: { [k: string]: string };
+  /**
+   * Always `null` for boolean entitlements. Surfaced on every entitlement so clients can read `config` without first switching on `featureType`.
+   */
+  config: { [k: string]: any } | null;
 };
 
 /** @internal */
@@ -83,11 +80,6 @@ export const BooleanEntitlementDetailObject$inboundSchema: z.ZodNativeEnum<
   typeof BooleanEntitlementDetailObject
 > = z.nativeEnum(BooleanEntitlementDetailObject);
 
-/** @internal */
-export const BooleanEntitlementDetailStatus$inboundSchema: z.ZodNativeEnum<
-  typeof BooleanEntitlementDetailStatus
-> = z.nativeEnum(BooleanEntitlementDetailStatus);
-
 /** @internal */
 export const BooleanEntitlementDetail$inboundSchema: z.ZodType<
   BooleanEntitlementDetail,
@@ -100,14 +92,16 @@ export const BooleanEntitlementDetail$inboundSchema: z.ZodType<
   featureId: z.string(),
   featureKey: z.string(),
   featureType: z.literal("boolean"),
-  subscriptionId: z.nullable(z.string()).optional(),
-  status: BooleanEntitlementDetailStatus$inboundSchema,
+  productId: z.string(),
+  subscriptionId: z.nullable(z.string()),
+  status: EntitlementStatus$inboundSchema,
   activeFrom: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   activeTo: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
-  ).optional(),
+  ),
   hasAccess: z.boolean(),
-  metadata: z.record(z.string()).optional(),
+  metadata: z.record(z.string()),
+  config: z.nullable(z.record(z.any())),
 });
 
 export function booleanEntitlementDetailFromJSON(

package/src/models/booleanentitlementlistitem.ts

@@ -0,0 +1,100 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import {
+  EntitlementStatus,
+  EntitlementStatus$inboundSchema,
+} from "./entitlementstatus.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+/**
+ * Common fields shared by all entitlement list items. List items use `entitlementId` (not `id`) to preserve the original public field name on `/v1/entitlements`. The get-by-id endpoint returns the same object with a top-level `id` and `object: "entitlement"` instead.
+ */
+export type BooleanEntitlementListItem = {
+  /**
+   * Unique identifier for the entitlement.
+   */
+  entitlementId: string;
+  /**
+   * Unique identifier for a customer
+   */
+  customerId: string;
+  /**
+   * The feature this entitlement grants access to.
+   */
+  featureId: string;
+  /**
+   * The unique key identifying the feature.
+   */
+  featureKey: string;
+  featureType: "boolean";
+  /**
+   * Unique identifier for a product
+   */
+  productId: string;
+  /**
+   * The subscription this entitlement is associated with, if any.
+   */
+  subscriptionId: string | null;
+  /**
+   * Current status of the entitlement.
+   */
+  status: EntitlementStatus;
+  /**
+   * When the entitlement becomes active.
+   */
+  activeFrom: Date;
+  /**
+   * When the entitlement expires. Null means no expiration.
+   */
+  activeTo: Date | null;
+  /**
+   * Whether the customer currently has active access to this entitlement.
+   */
+  hasAccess: boolean;
+  /**
+   * Additional metadata for the entitlement.
+   */
+  metadata: { [k: string]: string };
+  /**
+   * Always `null` for boolean entitlements. Surfaced on every list item so clients can read `item.config` without first switching on `featureType`.
+   */
+  config: { [k: string]: any } | null;
+};
+
+/** @internal */
+export const BooleanEntitlementListItem$inboundSchema: z.ZodType<
+  BooleanEntitlementListItem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  entitlementId: z.string(),
+  customerId: z.string(),
+  featureId: z.string(),
+  featureKey: z.string(),
+  featureType: z.literal("boolean"),
+  productId: z.string(),
+  subscriptionId: z.nullable(z.string()),
+  status: EntitlementStatus$inboundSchema,
+  activeFrom: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  activeTo: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  hasAccess: z.boolean(),
+  metadata: z.record(z.string()),
+  config: z.nullable(z.record(z.any())),
+});
+
+export function booleanEntitlementListItemFromJSON(
+  jsonString: string,
+): SafeParseResult<BooleanEntitlementListItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BooleanEntitlementListItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BooleanEntitlementListItem' from JSON`,
+  );
+}

package/src/models/entitlementlistitem.ts

@@ -0,0 +1,49 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import {
+  BooleanEntitlementListItem,
+  BooleanEntitlementListItem$inboundSchema,
+} from "./booleanentitlementlistitem.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  MeteredEntitlementListItem,
+  MeteredEntitlementListItem$inboundSchema,
+} from "./meteredentitlementlistitem.js";
+import {
+  StaticEntitlementListItem,
+  StaticEntitlementListItem$inboundSchema,
+} from "./staticentitlementlistitem.js";
+
+/**
+ * An entitlement as returned by the list endpoint. The shape varies by featureType. Uses `entitlementId` (not `id`) for backwards compatibility with the original list contract.
+ */
+export type EntitlementListItem =
+  | BooleanEntitlementListItem
+  | StaticEntitlementListItem
+  | MeteredEntitlementListItem;
+
+/** @internal */
+export const EntitlementListItem$inboundSchema: z.ZodType<
+  EntitlementListItem,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  BooleanEntitlementListItem$inboundSchema,
+  StaticEntitlementListItem$inboundSchema,
+  MeteredEntitlementListItem$inboundSchema,
+]);
+
+export function entitlementListItemFromJSON(
+  jsonString: string,
+): SafeParseResult<EntitlementListItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EntitlementListItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EntitlementListItem' from JSON`,
+  );
+}

package/src/models/entitlementstatus.ts

@@ -0,0 +1,24 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Current status of the entitlement.
+ */
+export const EntitlementStatus = {
+  Active: "active",
+  Canceled: "canceled",
+  Expired: "expired",
+} as const;
+/**
+ * Current status of the entitlement.
+ */
+export type EntitlementStatus = ClosedEnum<typeof EntitlementStatus>;
+
+/** @internal */
+export const EntitlementStatus$inboundSchema: z.ZodNativeEnum<
+  typeof EntitlementStatus
+> = z.nativeEnum(EntitlementStatus);

package/src/models/index.ts

@@ -5,6 +5,7 @@
 export * from "./address.js";
 export * from "./billablemetric.js";
 export * from "./booleanentitlementdetail.js";
+export * from "./booleanentitlementlistitem.js";
 export * from "./cost.js";
 export * from "./costreportgroup.js";
 export * from "./costreportresponse.js";
@@ -15,9 +16,9 @@ export * from "./createmanuallineitemrequest.js";
 export * from "./createrulerequest.js";
 export * from "./currencybreakdownentry.js";
 export * from "./customer.js";
-export * from "./entitlement.js";
-export * from "./entitlementaccessresult.js";
 export * from "./entitlementdetail.js";
+export * from "./entitlementlistitem.js";
+export * from "./entitlementstatus.js";
 export * from "./entitlementtemplate.js";
 export * from "./eventresponse.js";
 export * from "./feature.js";
@@ -36,6 +37,7 @@ export * from "./lineitem.js";
 export * from "./lineitemsresponse.js";
 export * from "./lineitemssummary.js";
 export * from "./meteredentitlementdetail.js";
+export * from "./meteredentitlementlistitem.js";
 export * from "./meterevent.js";
 export * from "./metereventlist.js";
 export * from "./offsetpagination.js";
@@ -64,6 +66,7 @@ export * from "./source.js";
 export * from "./sourceevent.js";
 export * from "./sourcerule.js";
 export * from "./staticentitlementdetail.js";
+export * from "./staticentitlementlistitem.js";
 export * from "./subscription.js";
 export * from "./subscriptionmetadata.js";
 export * from "./subscriptionportal.js";

package/src/models/invoice.ts

@@ -129,6 +129,10 @@ export type Invoice = {
    * ISO 4217 currency code (e.g., USD, EUR)
    */
   currency: string;
+  /**
+   * Machine-readable reason code for the most recent failure (e.g. CALCULATION_FAILED). Present only when status is FAILED or PAYMENT_FAILED.
+   */
+  failureReason?: string | undefined;
   /**
    * The end of the grace period for accepting usage events
    */
@@ -297,6 +301,7 @@ export const Invoice$inboundSchema: z.ZodType<Invoice, z.ZodTypeDef, unknown> =
       new Date(v)
     ),
     currency: z.string(),
+    failureReason: z.string().optional(),
     gracePeriodEnd: z.string().datetime({ offset: true }).transform(v =>
       new Date(v)
     ),

package/src/models/meteredentitlementdetail.ts

@@ -6,6 +6,10 @@ import * as z from "zod/v3";
 import { safeParse } from "../lib/schemas.js";
 import { ClosedEnum } from "../types/enums.js";
 import { Result as SafeParseResult } from "../types/fp.js";
+import {
+  EntitlementStatus,
+  EntitlementStatus$inboundSchema,
+} from "./entitlementstatus.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 
 export const MeteredEntitlementDetailObject = {
@@ -15,21 +19,6 @@ export type MeteredEntitlementDetailObject = ClosedEnum<
   typeof MeteredEntitlementDetailObject
 >;
 
-/**
- * Current status of the entitlement.
- */
-export const MeteredEntitlementDetailStatus = {
-  Active: "active",
-  Canceled: "canceled",
-  Expired: "expired",
-} as const;
-/**
- * Current status of the entitlement.
- */
-export type MeteredEntitlementDetailStatus = ClosedEnum<
-  typeof MeteredEntitlementDetailStatus
->;
-
 /**
  * Common fields shared by all entitlement types.
  */
@@ -52,14 +41,18 @@ export type MeteredEntitlementDetail = {
    */
   featureKey: string;
   featureType: "metered";
+  /**
+   * Unique identifier for a product
+   */
+  productId: string;
   /**
    * The subscription this entitlement is associated with, if any.
    */
-  subscriptionId?: string | null | undefined;
+  subscriptionId: string | null;
   /**
    * Current status of the entitlement.
    */
-  status: MeteredEntitlementDetailStatus;
+  status: EntitlementStatus;
   /**
    * When the entitlement becomes active.
    */
@@ -67,7 +60,7 @@ export type MeteredEntitlementDetail = {
   /**
    * When the entitlement expires. Null means no expiration.
    */
-  activeTo?: Date | null | undefined;
+  activeTo: Date | null;
   /**
    * Whether the customer currently has active access to this entitlement.
    */
@@ -75,7 +68,11 @@ export type MeteredEntitlementDetail = {
   /**
    * Additional metadata for the entitlement.
    */
-  metadata?: { [k: string]: string } | undefined;
+  metadata: { [k: string]: string };
+  /**
+   * Always `null` for metered entitlements. Surfaced on every entitlement so clients can read `config` without first switching on `featureType`.
+   */
+  config: { [k: string]: any } | null;
   /**
    * When false (hard limit), access is blocked when balance is exhausted and overage is not charged on invoices. When true (soft limit), access continues past the grant and overage is charged at the per-unit rate.
    */
@@ -93,13 +90,13 @@ export type MeteredEntitlementDetail = {
    */
   overage: number;
   /**
-   * Start of the current usage period.
+   * Start of the current usage period. Before the entitlement activates (the pre-activation "dark window", when the query time is earlier than `activeFrom`) this instead describes the pre-activation `[subscription start, activation)` window and may be `null` when there is no associated subscription.
    */
-  currentPeriodStart?: Date | null | undefined;
+  currentPeriodStart: Date | null;
   /**
-   * End of the current usage period.
+   * End of the current usage period. Before the entitlement activates (the pre-activation "dark window", when the query time is earlier than `activeFrom`) this instead holds `activeFrom` — the end of the pre-activation `[subscription start, activation)` window.
    */
-  currentPeriodEnd?: Date | null | undefined;
+  currentPeriodEnd: Date | null;
 };
 
 /** @internal */
@@ -107,11 +104,6 @@ export const MeteredEntitlementDetailObject$inboundSchema: z.ZodNativeEnum<
   typeof MeteredEntitlementDetailObject
 > = z.nativeEnum(MeteredEntitlementDetailObject);
 
-/** @internal */
-export const MeteredEntitlementDetailStatus$inboundSchema: z.ZodNativeEnum<
-  typeof MeteredEntitlementDetailStatus
-> = z.nativeEnum(MeteredEntitlementDetailStatus);
-
 /** @internal */
 export const MeteredEntitlementDetail$inboundSchema: z.ZodType<
   MeteredEntitlementDetail,
@@ -124,24 +116,26 @@ export const MeteredEntitlementDetail$inboundSchema: z.ZodType<
   featureId: z.string(),
   featureKey: z.string(),
   featureType: z.literal("metered"),
-  subscriptionId: z.nullable(z.string()).optional(),
-  status: MeteredEntitlementDetailStatus$inboundSchema,
+  productId: z.string(),
+  subscriptionId: z.nullable(z.string()),
+  status: EntitlementStatus$inboundSchema,
   activeFrom: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   activeTo: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
-  ).optional(),
+  ),
   hasAccess: z.boolean(),
-  metadata: z.record(z.string()).optional(),
+  metadata: z.record(z.string()),
+  config: z.nullable(z.record(z.any())),
   isSoftLimit: z.boolean(),
   balance: z.number(),
   usageInPeriod: z.number(),
   overage: z.number(),
   currentPeriodStart: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
-  ).optional(),
+  ),
   currentPeriodEnd: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
-  ).optional(),
+  ),
 });
 
 export function meteredEntitlementDetailFromJSON(

package/src/models/meteredentitlementlistitem.ts

@@ -0,0 +1,134 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import {
+  EntitlementStatus,
+  EntitlementStatus$inboundSchema,
+} from "./entitlementstatus.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+/**
+ * Common fields shared by all entitlement list items. List items use `entitlementId` (not `id`) to preserve the original public field name on `/v1/entitlements`. The get-by-id endpoint returns the same object with a top-level `id` and `object: "entitlement"` instead.
+ */
+export type MeteredEntitlementListItem = {
+  /**
+   * Unique identifier for the entitlement.
+   */
+  entitlementId: string;
+  /**
+   * Unique identifier for a customer
+   */
+  customerId: string;
+  /**
+   * The feature this entitlement grants access to.
+   */
+  featureId: string;
+  /**
+   * The unique key identifying the feature.
+   */
+  featureKey: string;
+  featureType: "metered";
+  /**
+   * Unique identifier for a product
+   */
+  productId: string;
+  /**
+   * The subscription this entitlement is associated with, if any.
+   */
+  subscriptionId: string | null;
+  /**
+   * Current status of the entitlement.
+   */
+  status: EntitlementStatus;
+  /**
+   * When the entitlement becomes active.
+   */
+  activeFrom: Date;
+  /**
+   * When the entitlement expires. Null means no expiration.
+   */
+  activeTo: Date | null;
+  /**
+   * Whether the customer currently has active access to this entitlement.
+   */
+  hasAccess: boolean;
+  /**
+   * Additional metadata for the entitlement.
+   */
+  metadata: { [k: string]: string };
+  /**
+   * Always `null` for metered entitlements. Surfaced on every list item so clients can read `item.config` without first switching on `featureType`.
+   */
+  config: { [k: string]: any } | null;
+  /**
+   * When false (hard limit), access is blocked when balance is exhausted and overage is not charged on invoices. When true (soft limit), access continues past the grant and overage is charged at the per-unit rate.
+   */
+  isSoftLimit: boolean;
+  /**
+   * Remaining grant balance for the current period.
+   */
+  balance: number;
+  /**
+   * Total usage consumed in the current billing period.
+   */
+  usageInPeriod: number;
+  /**
+   * Amount of usage exceeding the granted balance.
+   */
+  overage: number;
+  /**
+   * Start of the current usage period. Before the entitlement activates (the pre-activation "dark window", when the query time is earlier than `activeFrom`) this instead describes the pre-activation `[subscription start, activation)` window and may be `null` when there is no associated subscription.
+   */
+  currentPeriodStart: Date | null;
+  /**
+   * End of the current usage period. Before the entitlement activates (the pre-activation "dark window", when the query time is earlier than `activeFrom`) this instead holds `activeFrom` — the end of the pre-activation `[subscription start, activation)` window.
+   */
+  currentPeriodEnd: Date | null;
+};
+
+/** @internal */
+export const MeteredEntitlementListItem$inboundSchema: z.ZodType<
+  MeteredEntitlementListItem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  entitlementId: z.string(),
+  customerId: z.string(),
+  featureId: z.string(),
+  featureKey: z.string(),
+  featureType: z.literal("metered"),
+  productId: z.string(),
+  subscriptionId: z.nullable(z.string()),
+  status: EntitlementStatus$inboundSchema,
+  activeFrom: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  activeTo: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  hasAccess: z.boolean(),
+  metadata: z.record(z.string()),
+  config: z.nullable(z.record(z.any())),
+  isSoftLimit: z.boolean(),
+  balance: z.number(),
+  usageInPeriod: z.number(),
+  overage: z.number(),
+  currentPeriodStart: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  currentPeriodEnd: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+});
+
+export function meteredEntitlementListItemFromJSON(
+  jsonString: string,
+): SafeParseResult<MeteredEntitlementListItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MeteredEntitlementListItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MeteredEntitlementListItem' from JSON`,
+  );
+}

package/src/models/operations/listentitlements.ts

@@ -51,9 +51,9 @@ export type ListEntitlementsObject = ClosedEnum<typeof ListEntitlementsObject>;
 export type ListEntitlementsResponse = {
   object: ListEntitlementsObject;
   /**
-   * Array of entitlement access results.
+   * Array of entitlement list items. The shape of each item varies by featureType.
    */
-  data: Array<models.EntitlementAccessResult>;
+  data: Array<models.EntitlementListItem>;
   /**
    * Offset-based pagination response.
    */
@@ -106,7 +106,7 @@ export const ListEntitlementsResponse$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   object: ListEntitlementsObject$inboundSchema.default("list"),
-  data: z.array(models.EntitlementAccessResult$inboundSchema),
+  data: z.array(models.EntitlementListItem$inboundSchema),
   pagination: models.OffsetPagination$inboundSchema,
 });
 

package/src/models/operations/updatesubscription.ts

@@ -17,6 +17,9 @@ export type UpdateSubscriptionStatus = ClosedEnum<
 export type UpdateSubscriptionRequestBody = {
   endingAt?: Date | undefined;
   status?: UpdateSubscriptionStatus | undefined;
+  /**
+   * Effective termination timestamp. Capped at the current effective time (future values are clamped). Must be strictly after the subscription's start date — values at or before startedAt are rejected with 400.
+   */
   terminatedAt?: Date | undefined;
   /**
    * Identifier of entity that cancelled the subscription. Sample values: 'cust_abc123' for customer-initiated cancellation, 'org_xyz789' for merchant-initiated cancellation