@paygentic/sdk 0.9.11 → 0.9.13

package/src/models/mintplanlineref.ts

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  MintPlanLineInput,
+  MintPlanLineInput$Outbound,
+  MintPlanLineInput$outboundSchema,
+} from "./mintplanlineinput.js";
+
+/**
+ * Either a price ID on its own, or a price ID with the key that names its line.
+ */
+export type MintPlanLineRef = MintPlanLineInput | string;
+
+/** @internal */
+export type MintPlanLineRef$Outbound = MintPlanLineInput$Outbound | string;
+
+/** @internal */
+export const MintPlanLineRef$outboundSchema: z.ZodType<
+  MintPlanLineRef$Outbound,
+  z.ZodTypeDef,
+  MintPlanLineRef
+> = z.union([MintPlanLineInput$outboundSchema, z.string()]);
+
+export function mintPlanLineRefToJSON(
+  mintPlanLineRef: MintPlanLineRef,
+): string {
+  return JSON.stringify(MintPlanLineRef$outboundSchema.parse(mintPlanLineRef));
+}

package/src/models/mintplanversionrequest.ts

@@ -3,61 +3,30 @@
  */
 
 import * as z from "zod/v3";
-
-export type ReplacePrice = {
-  /**
-   * Unique identifier for a price
-   */
-  replacesPriceId: string;
-  /**
-   * Unique identifier for a price
-   */
-  withPriceId: string;
-};
+import {
+  MintPlanLineRef,
+  MintPlanLineRef$Outbound,
+  MintPlanLineRef$outboundSchema,
+} from "./mintplanlineref.js";
 
 /**
- * A reference-by-id price diff applied to the prices of the plan's current version. Every id references an existing price created via POST /prices; inline price definitions are not accepted. A mint must carry at least one price change, so an empty body is rejected. A version must carry at least one price, so a diff that would leave none is rejected.
+ * The price set the new version is to hold. Every price ID references an existing price created via POST /prices; inline price definitions are not accepted. The change against the plan's current version follows from the keys: a key on both sides with a different price ID replaces that line and keeps its identity, a key only in this request adds a line, and a key the current version holds and this request omits removes that line. An entry with no key adds a line under a generated key; it is never matched to an existing line by price ID. A version must carry at least one price, so an empty set is rejected.
  */
 export type MintPlanVersionRequest = {
   /**
-   * Prices to add to the version. Each must not already be on the plan's current version.
-   */
-  addPrices?: Array<string> | undefined;
-  /**
-   * Prices to remove. Each must be on the plan's current version.
+   * The full price set the new version holds. To move off the previous addPrices, removePrices and replacePrices fields: a replacePrices entry becomes the same key with the new price ID, a removePrices entry becomes an omitted key, and an addPrices entry becomes a new entry.
    */
-  removePrices?: Array<string> | undefined;
+  prices: Array<MintPlanLineRef>;
   /**
-   * Prices to swap in place, preserving the slot's lineage so the price keeps its identity where the plan is configured for stable price ids. replacesPriceId must be on the plan's current version; withPriceId is the new price.
+   * The ID of the plan version you read the current price set from. Supply it to be told when the plan has moved on: the request is rejected with 409 if the plan's current version is no longer this one, so a set built from a stale read cannot drop a line another caller has just added. Omit it to write the set unconditionally.
    */
-  replacePrices?: Array<ReplacePrice> | undefined;
-};
-
-/** @internal */
-export type ReplacePrice$Outbound = {
-  replacesPriceId: string;
-  withPriceId: string;
+  basedOnVersionId?: string | undefined;
 };
 
-/** @internal */
-export const ReplacePrice$outboundSchema: z.ZodType<
-  ReplacePrice$Outbound,
-  z.ZodTypeDef,
-  ReplacePrice
-> = z.object({
-  replacesPriceId: z.string(),
-  withPriceId: z.string(),
-});
-
-export function replacePriceToJSON(replacePrice: ReplacePrice): string {
-  return JSON.stringify(ReplacePrice$outboundSchema.parse(replacePrice));
-}
-
 /** @internal */
 export type MintPlanVersionRequest$Outbound = {
-  addPrices?: Array<string> | undefined;
-  removePrices?: Array<string> | undefined;
-  replacePrices?: Array<ReplacePrice$Outbound> | undefined;
+  prices: Array<MintPlanLineRef$Outbound>;
+  basedOnVersionId?: string | undefined;
 };
 
 /** @internal */
@@ -66,9 +35,8 @@ export const MintPlanVersionRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   MintPlanVersionRequest
 > = z.object({
-  addPrices: z.array(z.string()).optional(),
-  removePrices: z.array(z.string()).optional(),
-  replacePrices: z.array(z.lazy(() => ReplacePrice$outboundSchema)).optional(),
+  prices: z.array(MintPlanLineRef$outboundSchema),
+  basedOnVersionId: z.string().optional(),
 });
 
 export function mintPlanVersionRequestToJSON(

package/src/models/operations/createbillablemetric.ts

@@ -56,9 +56,9 @@ export type CreateBillableMetricRequest = {
   /**
    * CloudEvents type for meter routing. Links this billable metric to the metering service.
    */
-  eventType?: string | undefined;
+  eventType: string;
   /**
-   * JSONPath to extract a numeric value from event data. Must start with `$.` (example: `$.amount` or `$.payload.bytes`). Required for SUM/AVG/MIN/MAX/LATEST aggregations.
+   * JSONPath to extract a numeric value from event data. Must start with `$.` (example: `$.amount` or `$.payload.bytes`). Required for SUM/AVG/MIN/MAX/LATEST aggregations. Optional for UNIQUE_COUNT, which counts distinct values of this property when set and distinct events when not. Not stored for COUNT.
    */
   valueProperty?: string | undefined;
   /**
@@ -85,7 +85,7 @@ export type CreateBillableMetricRequest$Outbound = {
   productId?: string | undefined;
   itemId?: string | undefined;
   unit: string;
-  eventType?: string | undefined;
+  eventType: string;
   valueProperty?: string | undefined;
   groupBy?: { [k: string]: string } | undefined;
   eventFrom?: string | undefined;
@@ -104,7 +104,7 @@ export const CreateBillableMetricRequest$outboundSchema: z.ZodType<
   productId: z.string().optional(),
   itemId: z.string().optional(),
   unit: z.string(),
-  eventType: z.string().optional(),
+  eventType: z.string(),
   valueProperty: z.string().optional(),
   groupBy: z.record(z.string()).optional(),
   eventFrom: z.date().transform(v => v.toISOString()).optional(),

package/src/models/operations/createexternalreference.ts

@@ -6,6 +6,9 @@ import * as z from "zod/v3";
 import * as models from "../index.js";
 
 export type CreateExternalReferenceRequest = {
+  /**
+   * Unique identifier for an organization
+   */
   merchantId: string;
   /**
    * The type of Paygentic entity this external reference points at

package/src/models/operations/createitem.ts

@@ -5,6 +5,9 @@
 import * as z from "zod/v3";
 
 export type CreateItemRequest = {
+  /**
+   * Unique identifier for an organization
+   */
   merchantId: string;
   /**
    * Canonical sellable name for the Item

package/src/models/operations/createplan.ts

@@ -99,9 +99,9 @@ export type CreatePlanRequest = {
    */
   name: string;
   /**
-   * Array of price IDs to associate with this plan
+   * The prices this plan starts with. An entry is either a price ID on its own, or an object that names a price ID and the key by which you address that line. A price ID on its own receives a generated key.
    */
-  prices?: Array<string> | undefined;
+  prices?: Array<models.PlanLineRef> | undefined;
   /**
    * Unique identifier for a product
    */
@@ -167,7 +167,7 @@ export type CreatePlanRequest$Outbound = {
   invoiceDisplayName?: string | undefined;
   merchantId: string;
   name: string;
-  prices?: Array<string> | undefined;
+  prices?: Array<models.PlanLineRef$Outbound> | undefined;
   productId: string;
   taxBehavior: string;
   renewalReminderEnabled: boolean;
@@ -193,7 +193,7 @@ export const CreatePlanRequest$outboundSchema: z.ZodType<
   invoiceDisplayName: z.string().optional(),
   merchantId: z.string(),
   name: z.string(),
-  prices: z.array(z.string()).optional(),
+  prices: z.array(models.PlanLineRef$outboundSchema).optional(),
   productId: z.string(),
   taxBehavior: CreatePlanTaxBehavior$outboundSchema.default("exclusive"),
   renewalReminderEnabled: z.boolean().default(true),

package/src/models/operations/createtestclock.ts

@@ -6,7 +6,7 @@ import * as z from "zod/v3";
 
 export type CreateTestClockRequest = {
   /**
-   * Initial time for the test clock (defaults to current time). Cannot be more than 1 hour in the past to prevent accidental backdating. The 1-hour buffer accounts for clock drift and network delays.
+   * Initial time for the test clock (defaults to current time). May be in the past, which lets a subscription on the clock start on a past date and bill its periods as the clock advances.
    */
   currentTime?: Date | undefined;
   /**

package/src/models/operations/listbillingschedules.ts

@@ -32,7 +32,7 @@ export type ListBillingSchedulesObject = ClosedEnum<
  */
 export type ListBillingSchedulesResponse = {
   object: ListBillingSchedulesObject;
-  data: Array<models.SchemasBillingSchedule>;
+  data: Array<models.BillingSchedule>;
   /**
    * Offset-based pagination response.
    */
@@ -77,7 +77,7 @@ export const ListBillingSchedulesResponse$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   object: ListBillingSchedulesObject$inboundSchema,
-  data: z.array(models.SchemasBillingSchedule$inboundSchema),
+  data: z.array(models.BillingSchedule$inboundSchema),
   pagination: models.OffsetPagination$inboundSchema,
 });
 

package/src/models/operations/listpaymentsessions.ts

@@ -84,7 +84,7 @@ export type ListPaymentSessionsObject = ClosedEnum<
  */
 export type ListPaymentSessionsResponse = {
   object: ListPaymentSessionsObject;
-  data: Array<models.SchemasPaymentSession>;
+  data: Array<models.PaymentSession>;
   /**
    * Offset-based pagination response.
    */
@@ -146,7 +146,7 @@ export const ListPaymentSessionsResponse$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   object: ListPaymentSessionsObject$inboundSchema,
-  data: z.array(models.SchemasPaymentSession$inboundSchema),
+  data: z.array(models.PaymentSession$inboundSchema),
   pagination: models.OffsetPagination$inboundSchema,
 });
 

package/src/models/operations/listprices.ts

@@ -37,7 +37,7 @@ export type ListPricesPagination = {
  * List of prices
  */
 export type ListPricesResponse = {
-  data?: Array<models.SchemasPrice> | undefined;
+  data?: Array<models.Price> | undefined;
   pagination?: ListPricesPagination | undefined;
 };
 
@@ -96,7 +96,7 @@ export const ListPricesResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  data: z.array(models.SchemasPrice$inboundSchema).optional(),
+  data: z.array(models.Price$inboundSchema).optional(),
   pagination: z.lazy(() => ListPricesPagination$inboundSchema).optional(),
 });
 

package/src/models/operations/updatebillablemetric.ts

@@ -23,11 +23,11 @@ export type UpdateBillableMetricRequestBody = {
    */
   itemId?: string | null | undefined;
   /**
-   * CloudEvents type for meter routing.
+   * CloudEvents type for meter routing. Cannot be cleared: every billable metric needs one.
    */
-  eventType?: string | null | undefined;
+  eventType?: string | undefined;
   /**
-   * JSONPath to extract a numeric value from event data. Must start with `$.` (example: `$.amount` or `$.payload.bytes`).
+   * JSONPath to extract a numeric value from event data. Must start with `$.` (example: `$.amount` or `$.payload.bytes`). Cannot be cleared on a SUM/AVG/MIN/MAX/LATEST metric. Not stored for COUNT.
    */
   valueProperty?: string | null | undefined;
   /**
@@ -51,7 +51,7 @@ export type UpdateBillableMetricRequestBody$Outbound = {
   name?: string | undefined;
   unit?: string | undefined;
   itemId?: string | null | undefined;
-  eventType?: string | null | undefined;
+  eventType?: string | undefined;
   valueProperty?: string | null | undefined;
   groupBy?: { [k: string]: string } | null | undefined;
   eventFrom?: string | null | undefined;
@@ -67,7 +67,7 @@ export const UpdateBillableMetricRequestBody$outboundSchema: z.ZodType<
   name: z.string().optional(),
   unit: z.string().optional(),
   itemId: z.nullable(z.string()).optional(),
-  eventType: z.nullable(z.string()).optional(),
+  eventType: z.string().optional(),
   valueProperty: z.nullable(z.string()).optional(),
   groupBy: z.nullable(z.record(z.string())).optional(),
   eventFrom: z.nullable(z.date().transform(v => v.toISOString())).optional(),

package/src/models/order.ts

@@ -6,11 +6,11 @@ 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 {
-  BillingSchedule,
-  BillingSchedule$inboundSchema,
-} from "./billingschedule.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  OrderBillingSchedule,
+  OrderBillingSchedule$inboundSchema,
+} from "./orderbillingschedule.js";
 import { OrderLineItem, OrderLineItem$inboundSchema } from "./orderlineitem.js";
 
 export const OrderObject = {
@@ -55,7 +55,7 @@ export type Order = {
   defaultPaymentTermDays: number;
   metadata: { [k: string]: any };
   lineItems: Array<OrderLineItem>;
-  billingSchedules: Array<BillingSchedule>;
+  billingSchedules: Array<OrderBillingSchedule>;
   createdAt: Date;
   updatedAt: Date;
 };
@@ -102,7 +102,7 @@ export const Order$inboundSchema: z.ZodType<Order, z.ZodTypeDef, unknown> = z
     defaultPaymentTermDays: z.number().int(),
     metadata: z.record(z.any()),
     lineItems: z.array(OrderLineItem$inboundSchema),
-    billingSchedules: z.array(BillingSchedule$inboundSchema),
+    billingSchedules: z.array(OrderBillingSchedule$inboundSchema),
     createdAt: z.string().datetime({ offset: true }).transform(v =>
       new Date(v)
     ),

package/src/models/orderapproval.ts

@@ -0,0 +1,81 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export const OrderApprovalObject = {
+  Approval: "approval",
+} as const;
+export type OrderApprovalObject = ClosedEnum<typeof OrderApprovalObject>;
+
+export const OrderApprovalDecision = {
+  Pending: "pending",
+  Approved: "approved",
+  Rejected: "rejected",
+  Cancelled: "cancelled",
+} as const;
+export type OrderApprovalDecision = ClosedEnum<typeof OrderApprovalDecision>;
+
+export type OrderApproval = {
+  id: string;
+  object: OrderApprovalObject;
+  merchantId: string;
+  resourceType: string;
+  resourceId: string;
+  kind: string;
+  decision: OrderApprovalDecision;
+  requester: string;
+  reviewer?: string | null | undefined;
+  note?: string | null | undefined;
+  dataSnapshotHash: string;
+  decidedAt?: Date | null | undefined;
+  createdAt: Date;
+};
+
+/** @internal */
+export const OrderApprovalObject$inboundSchema: z.ZodNativeEnum<
+  typeof OrderApprovalObject
+> = z.nativeEnum(OrderApprovalObject);
+
+/** @internal */
+export const OrderApprovalDecision$inboundSchema: z.ZodNativeEnum<
+  typeof OrderApprovalDecision
+> = z.nativeEnum(OrderApprovalDecision);
+
+/** @internal */
+export const OrderApproval$inboundSchema: z.ZodType<
+  OrderApproval,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  object: OrderApprovalObject$inboundSchema,
+  merchantId: z.string(),
+  resourceType: z.string(),
+  resourceId: z.string(),
+  kind: z.string(),
+  decision: OrderApprovalDecision$inboundSchema,
+  requester: z.string(),
+  reviewer: z.nullable(z.string()).optional(),
+  note: z.nullable(z.string()).optional(),
+  dataSnapshotHash: z.string(),
+  decidedAt: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+});
+
+export function orderApprovalFromJSON(
+  jsonString: string,
+): SafeParseResult<OrderApproval, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OrderApproval$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OrderApproval' from JSON`,
+  );
+}

package/src/models/orderbillingschedule.ts

@@ -0,0 +1,138 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export const OrderBillingScheduleObject = {
+  BillingSchedule: "billing_schedule",
+} as const;
+export type OrderBillingScheduleObject = ClosedEnum<
+  typeof OrderBillingScheduleObject
+>;
+
+export const OrderBillingScheduleStatus = {
+  Draft: "draft",
+  Active: "active",
+  Completed: "completed",
+  Cancelled: "cancelled",
+} as const;
+export type OrderBillingScheduleStatus = ClosedEnum<
+  typeof OrderBillingScheduleStatus
+>;
+
+export const OrderBillingScheduleAlignmentPolicy = {
+  Anchor: "anchor",
+  Calendar: "calendar",
+  Coterm: "coterm",
+} as const;
+export type OrderBillingScheduleAlignmentPolicy = ClosedEnum<
+  typeof OrderBillingScheduleAlignmentPolicy
+>;
+
+export const OrderBillingScheduleProrationPolicy = {
+  None: "none",
+  Daily: "daily",
+} as const;
+export type OrderBillingScheduleProrationPolicy = ClosedEnum<
+  typeof OrderBillingScheduleProrationPolicy
+>;
+
+export const OrderBillingSchedulePeriodPreset = {
+  Single: "single",
+  P1M: "P1M",
+  P3M: "P3M",
+  P6M: "P6M",
+  P1Y: "P1Y",
+  Custom: "custom",
+} as const;
+export type OrderBillingSchedulePeriodPreset = ClosedEnum<
+  typeof OrderBillingSchedulePeriodPreset
+>;
+
+/**
+ * Summary of a billing schedule owned by this order. The full schedule (with intervals + staged invoices) is served under /billingSchedules. Owner-polymorphic: a schedule belongs to exactly one Order or one Subscription (XOR); cadence lives on ScheduleIntervals, not the header.
+ */
+export type OrderBillingSchedule = {
+  id: string;
+  object: OrderBillingScheduleObject;
+  orderId?: string | null | undefined;
+  subscriptionId?: string | null | undefined;
+  merchantId: string;
+  status: OrderBillingScheduleStatus;
+  startDate: Date;
+  endDate: Date;
+  billingAnchor: Date;
+  alignmentPolicy: OrderBillingScheduleAlignmentPolicy;
+  prorationPolicy: OrderBillingScheduleProrationPolicy;
+  paymentTermDays?: number | null | undefined;
+  periodPreset: OrderBillingSchedulePeriodPreset;
+  metadata: { [k: string]: any };
+  createdAt: Date;
+  updatedAt: Date;
+};
+
+/** @internal */
+export const OrderBillingScheduleObject$inboundSchema: z.ZodNativeEnum<
+  typeof OrderBillingScheduleObject
+> = z.nativeEnum(OrderBillingScheduleObject);
+
+/** @internal */
+export const OrderBillingScheduleStatus$inboundSchema: z.ZodNativeEnum<
+  typeof OrderBillingScheduleStatus
+> = z.nativeEnum(OrderBillingScheduleStatus);
+
+/** @internal */
+export const OrderBillingScheduleAlignmentPolicy$inboundSchema: z.ZodNativeEnum<
+  typeof OrderBillingScheduleAlignmentPolicy
+> = z.nativeEnum(OrderBillingScheduleAlignmentPolicy);
+
+/** @internal */
+export const OrderBillingScheduleProrationPolicy$inboundSchema: z.ZodNativeEnum<
+  typeof OrderBillingScheduleProrationPolicy
+> = z.nativeEnum(OrderBillingScheduleProrationPolicy);
+
+/** @internal */
+export const OrderBillingSchedulePeriodPreset$inboundSchema: z.ZodNativeEnum<
+  typeof OrderBillingSchedulePeriodPreset
+> = z.nativeEnum(OrderBillingSchedulePeriodPreset);
+
+/** @internal */
+export const OrderBillingSchedule$inboundSchema: z.ZodType<
+  OrderBillingSchedule,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  object: OrderBillingScheduleObject$inboundSchema,
+  orderId: z.nullable(z.string()).optional(),
+  subscriptionId: z.nullable(z.string()).optional(),
+  merchantId: z.string(),
+  status: OrderBillingScheduleStatus$inboundSchema,
+  startDate: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  endDate: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  billingAnchor: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  alignmentPolicy: OrderBillingScheduleAlignmentPolicy$inboundSchema,
+  prorationPolicy: OrderBillingScheduleProrationPolicy$inboundSchema,
+  paymentTermDays: z.nullable(z.number().int()).optional(),
+  periodPreset: OrderBillingSchedulePeriodPreset$inboundSchema,
+  metadata: z.record(z.any()),
+  createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+});
+
+export function orderBillingScheduleFromJSON(
+  jsonString: string,
+): SafeParseResult<OrderBillingSchedule, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OrderBillingSchedule$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OrderBillingSchedule' from JSON`,
+  );
+}