@paygentic/sdk 0.6.29 → 0.6.33

package/src/models/costusageresponse.ts

@@ -0,0 +1,145 @@
+/*
+ * 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 CostUsageResponseObject = {
+  Cost: "cost",
+} as const;
+export type CostUsageResponseObject = ClosedEnum<
+  typeof CostUsageResponseObject
+>;
+
+export const CostUsageResponseType = {
+  Metered: "metered",
+} as const;
+export type CostUsageResponseType = ClosedEnum<typeof CostUsageResponseType>;
+
+export type Group = {
+  dimensions: { [k: string]: string };
+  quantity: number;
+  cost: number;
+};
+
+export type TimeSery = {
+  windowStart: Date;
+  windowEnd: Date;
+  quantity: number;
+  cost: number;
+};
+
+export type CostUsageResponse = {
+  object: CostUsageResponseObject;
+  /**
+   * Unique identifier for a cost
+   */
+  id: string;
+  name: string;
+  type: CostUsageResponseType;
+  currency: string;
+  /**
+   * CloudEvents type for metered costs.
+   */
+  eventType?: string | undefined;
+  /**
+   * Total cost for the query window. Null if usage data could not be computed.
+   */
+  totalCost: number | null;
+  /**
+   * Total usage quantity (metered costs only). Null when usage was not computed.
+   */
+  totalQuantity?: number | null | undefined;
+  /**
+   * Per-group breakdown (present when groupBy is specified).
+   */
+  groups?: Array<Group> | undefined;
+  /**
+   * Time-series breakdown (present when window is specified).
+   */
+  timeSeries?: Array<TimeSery> | undefined;
+};
+
+/** @internal */
+export const CostUsageResponseObject$inboundSchema: z.ZodNativeEnum<
+  typeof CostUsageResponseObject
+> = z.nativeEnum(CostUsageResponseObject);
+
+/** @internal */
+export const CostUsageResponseType$inboundSchema: z.ZodNativeEnum<
+  typeof CostUsageResponseType
+> = z.nativeEnum(CostUsageResponseType);
+
+/** @internal */
+export const Group$inboundSchema: z.ZodType<Group, z.ZodTypeDef, unknown> = z
+  .object({
+    dimensions: z.record(z.string()),
+    quantity: z.number(),
+    cost: z.number(),
+  });
+
+export function groupFromJSON(
+  jsonString: string,
+): SafeParseResult<Group, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Group$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Group' from JSON`,
+  );
+}
+
+/** @internal */
+export const TimeSery$inboundSchema: z.ZodType<
+  TimeSery,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  windowStart: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  windowEnd: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  quantity: z.number(),
+  cost: z.number(),
+});
+
+export function timeSeryFromJSON(
+  jsonString: string,
+): SafeParseResult<TimeSery, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TimeSery$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TimeSery' from JSON`,
+  );
+}
+
+/** @internal */
+export const CostUsageResponse$inboundSchema: z.ZodType<
+  CostUsageResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: CostUsageResponseObject$inboundSchema.default("cost"),
+  id: z.string(),
+  name: z.string(),
+  type: CostUsageResponseType$inboundSchema,
+  currency: z.string(),
+  eventType: z.string().optional(),
+  totalCost: z.nullable(z.number()),
+  totalQuantity: z.nullable(z.number()).optional(),
+  groups: z.array(z.lazy(() => Group$inboundSchema)).optional(),
+  timeSeries: z.array(z.lazy(() => TimeSery$inboundSchema)).optional(),
+});
+
+export function costUsageResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CostUsageResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CostUsageResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CostUsageResponse' from JSON`,
+  );
+}

package/src/models/entitlementaccessresult.ts

@@ -76,6 +76,26 @@ export type EntitlementAccessResult = {
    * Current status of the entitlement.
    */
   status: EntitlementAccessResultStatus;
+  /**
+   * Remaining grant balance. Only present for `metered` features.
+   */
+  balance?: number | null | undefined;
+  /**
+   * Total usage in the current period. Only present for `metered` features.
+   */
+  usageInPeriod?: number | null | undefined;
+  /**
+   * Amount of overage beyond granted balance. Only present for `metered` features.
+   */
+  overage?: number | null | undefined;
+  /**
+   * Start of the current usage period. Only present for `metered` features with a usage period configured.
+   */
+  currentPeriodStart?: Date | null | undefined;
+  /**
+   * End of the current usage period. Only present for `metered` features with a usage period configured.
+   */
+  currentPeriodEnd?: Date | null | undefined;
 };
 
 /** @internal */
@@ -105,6 +125,15 @@ export const EntitlementAccessResult$inboundSchema: z.ZodType<
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ).optional(),
   status: EntitlementAccessResultStatus$inboundSchema,
+  balance: z.nullable(z.number()).optional(),
+  usageInPeriod: z.nullable(z.number()).optional(),
+  overage: z.nullable(z.number()).optional(),
+  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 entitlementAccessResultFromJSON(

package/src/models/grant.ts

@@ -43,6 +43,14 @@ export type Grant = {
    * When the grant was created.
    */
   createdAt: Date;
+  /**
+   * The recurrence interval (ISO 8601 duration) if this is a recurring grant. Null for one-time grants.
+   */
+  recurrencePeriod: string | null;
+  /**
+   * The idempotency key used when creating this grant. Null if not provided.
+   */
+  idempotencyKey: string | null;
 };
 
 /** @internal */
@@ -68,6 +76,8 @@ export const Grant$inboundSchema: z.ZodType<Grant, z.ZodTypeDef, unknown> = z
     createdAt: z.string().datetime({ offset: true }).transform(v =>
       new Date(v)
     ),
+    recurrencePeriod: z.nullable(z.string()),
+    idempotencyKey: z.nullable(z.string()),
   });
 
 export function grantFromJSON(

package/src/models/index.ts

@@ -7,6 +7,8 @@ export * from "./address.js";
 export * from "./batchusageeventresponse.js";
 export * from "./billablemetric.js";
 export * from "./booleanentitlementdetail.js";
+export * from "./cost.js";
+export * from "./costusageresponse.js";
 export * from "./createdisputerequest.js";
 export * from "./createentitlementrequest.js";
 export * from "./creategrantrequest.js";
@@ -37,6 +39,8 @@ export * from "./lineitem.js";
 export * from "./lineitemsresponse.js";
 export * from "./lineitemssummary.js";
 export * from "./meteredentitlementdetail.js";
+export * from "./meterevent.js";
+export * from "./metereventlist.js";
 export * from "./offsetpagination.js";
 export * from "./payment.js";
 export * from "./paymentsummary.js";

package/src/models/invoicelineitem.ts

@@ -9,14 +9,15 @@ import { Result as SafeParseResult } from "../types/fp.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 
 /**
- * Type of event: 'usage' for billable metric events, 'fee' for fee events
+ * Type of event: 'usage' for billable metric events, 'fee' for fee events, 'discount' for grant discount line items (subtotal/total are negative, representing a credit)
  */
 export const EventType = {
   Usage: "usage",
   Fee: "fee",
+  Discount: "discount",
 } as const;
 /**
- * Type of event: 'usage' for billable metric events, 'fee' for fee events
+ * Type of event: 'usage' for billable metric events, 'fee' for fee events, 'discount' for grant discount line items (subtotal/total are negative, representing a credit)
  */
 export type EventType = ClosedEnum<typeof EventType>;
 
@@ -36,7 +37,7 @@ export type InvoiceLineItemLineItemType = ClosedEnum<
 
 export type InvoiceLineItem = {
   /**
-   * Type of event: 'usage' for billable metric events, 'fee' for fee events
+   * Type of event: 'usage' for billable metric events, 'fee' for fee events, 'discount' for grant discount line items (subtotal/total are negative, representing a credit)
    */
   eventType: EventType;
   /**

package/src/models/lineitem.ts

@@ -9,15 +9,16 @@ import { Result as SafeParseResult } from "../types/fp.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 
 /**
- * The type of line item
+ * The type of line item. 'discount' line items represent grant discounts with negative subtotal/total amounts.
  */
 export const LineItemType = {
   Fee: "fee",
   Metered: "metered",
   Manual: "manual",
+  Discount: "discount",
 } as const;
 /**
- * The type of line item
+ * The type of line item. 'discount' line items represent grant discounts with negative subtotal/total amounts.
  */
 export type LineItemType = ClosedEnum<typeof LineItemType>;
 
@@ -63,7 +64,7 @@ export type LineItem = {
    */
   invoiceId?: string | null | undefined;
   /**
-   * The type of line item
+   * The type of line item. 'discount' line items represent grant discounts with negative subtotal/total amounts.
    */
   type: LineItemType;
   /**

package/src/models/meterevent.ts

@@ -0,0 +1,77 @@
+/*
+ * 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 MeterEventObject = {
+  MeterEvent: "meterEvent",
+} as const;
+export type MeterEventObject = ClosedEnum<typeof MeterEventObject>;
+
+export type MeterEvent = {
+  /**
+   * Unique event identifier
+   */
+  id: string;
+  object: MeterEventObject;
+  /**
+   * CloudEvents event type (matches the meter's eventType)
+   */
+  type: string;
+  /**
+   * CloudEvents source that published the event
+   */
+  source: string;
+  /**
+   * Subject of the event — typically the customer ID
+   */
+  subject: string;
+  /**
+   * Time the event occurred
+   */
+  time: Date;
+  /**
+   * Caller-supplied idempotency key
+   */
+  idempotencyKey: string;
+  /**
+   * Event payload
+   */
+  data: { [k: string]: any };
+};
+
+/** @internal */
+export const MeterEventObject$inboundSchema: z.ZodNativeEnum<
+  typeof MeterEventObject
+> = z.nativeEnum(MeterEventObject);
+
+/** @internal */
+export const MeterEvent$inboundSchema: z.ZodType<
+  MeterEvent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  object: MeterEventObject$inboundSchema.default("meterEvent"),
+  type: z.string(),
+  source: z.string(),
+  subject: z.string(),
+  time: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  idempotencyKey: z.string(),
+  data: z.record(z.any()),
+});
+
+export function meterEventFromJSON(
+  jsonString: string,
+): SafeParseResult<MeterEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MeterEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MeterEvent' from JSON`,
+  );
+}

package/src/models/metereventlist.ts

@@ -0,0 +1,59 @@
+/*
+ * 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";
+import { MeterEvent, MeterEvent$inboundSchema } from "./meterevent.js";
+import {
+  OffsetPagination,
+  OffsetPagination$inboundSchema,
+} from "./offsetpagination.js";
+
+export const MeterEventListObject = {
+  List: "list",
+} as const;
+export type MeterEventListObject = ClosedEnum<typeof MeterEventListObject>;
+
+export type MeterEventList = {
+  object: MeterEventListObject;
+  /**
+   * Unique identifier for a billable metric
+   */
+  billableMetricId: string;
+  events: Array<MeterEvent>;
+  /**
+   * Offset-based pagination response.
+   */
+  pagination: OffsetPagination;
+};
+
+/** @internal */
+export const MeterEventListObject$inboundSchema: z.ZodNativeEnum<
+  typeof MeterEventListObject
+> = z.nativeEnum(MeterEventListObject);
+
+/** @internal */
+export const MeterEventList$inboundSchema: z.ZodType<
+  MeterEventList,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: MeterEventListObject$inboundSchema.default("list"),
+  billableMetricId: z.string(),
+  events: z.array(MeterEvent$inboundSchema),
+  pagination: OffsetPagination$inboundSchema,
+});
+
+export function meterEventListFromJSON(
+  jsonString: string,
+): SafeParseResult<MeterEventList, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MeterEventList$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MeterEventList' from JSON`,
+  );
+}

package/src/models/operations/createbillablemetric.ts

@@ -8,7 +8,7 @@ import { ClosedEnum } from "../../types/enums.js";
 /**
  * Aggregation calculation method for metric values.
  */
-export const Aggregation = {
+export const CreateBillableMetricAggregation = {
   Sum: "SUM",
   Count: "COUNT",
   Avg: "AVG",
@@ -20,13 +20,15 @@ export const Aggregation = {
 /**
  * Aggregation calculation method for metric values.
  */
-export type Aggregation = ClosedEnum<typeof Aggregation>;
+export type CreateBillableMetricAggregation = ClosedEnum<
+  typeof CreateBillableMetricAggregation
+>;
 
 export type CreateBillableMetricRequest = {
   /**
    * Aggregation calculation method for metric values.
    */
-  aggregation: Aggregation;
+  aggregation: CreateBillableMetricAggregation;
   /**
    * Explanatory text describing what the metric tracks and how it's used for billing. Sample values: 'Total tokens consumed by Claude language model interactions', 'Gigabytes of cloud storage utilized', 'Count of machine learning inference requests processed', 'Quantity of AI-generated images created', 'Compute hours spent training neural networks', 'Terabytes of data transferred'
    */
@@ -66,8 +68,9 @@ export type CreateBillableMetricRequest = {
 };
 
 /** @internal */
-export const Aggregation$outboundSchema: z.ZodNativeEnum<typeof Aggregation> = z
-  .nativeEnum(Aggregation);
+export const CreateBillableMetricAggregation$outboundSchema: z.ZodNativeEnum<
+  typeof CreateBillableMetricAggregation
+> = z.nativeEnum(CreateBillableMetricAggregation);
 
 /** @internal */
 export type CreateBillableMetricRequest$Outbound = {
@@ -89,7 +92,7 @@ export const CreateBillableMetricRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CreateBillableMetricRequest
 > = z.object({
-  aggregation: Aggregation$outboundSchema,
+  aggregation: CreateBillableMetricAggregation$outboundSchema,
   description: z.string(),
   merchantId: z.string(),
   name: z.string(),

package/src/models/operations/createcost.ts

@@ -0,0 +1,133 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * The cost type. Only `metered` costs are supported; they track usage via events.
+ */
+export const CreateCostType = {
+  Metered: "metered",
+} as const;
+/**
+ * The cost type. Only `metered` costs are supported; they track usage via events.
+ */
+export type CreateCostType = ClosedEnum<typeof CreateCostType>;
+
+/**
+ * Aggregation method for the metered event.
+ */
+export const CreateCostAggregation = {
+  Sum: "SUM",
+  Count: "COUNT",
+  Avg: "AVG",
+  Min: "MIN",
+  Max: "MAX",
+  UniqueCount: "UNIQUE_COUNT",
+  Latest: "LATEST",
+} as const;
+/**
+ * Aggregation method for the metered event.
+ */
+export type CreateCostAggregation = ClosedEnum<typeof CreateCostAggregation>;
+
+export type CreateCostRequest = {
+  /**
+   * The cost type. Only `metered` costs are supported; they track usage via events.
+   */
+  type: CreateCostType;
+  /**
+   * Human-readable name for the cost.
+   */
+  name: string;
+  /**
+   * Cost per unit, multiplied by measured quantity to compute total cost. Must be non-negative.
+   */
+  unitCost: number;
+  /**
+   * ISO 4217 currency code (e.g. USD, EUR).
+   */
+  currency: string;
+  /**
+   * Unique identifier for a product
+   */
+  productId: string;
+  /**
+   * Unit label for metered costs (e.g. 'token', 'request'). Only valid for metered costs.
+   */
+  unit?: string | undefined;
+  /**
+   * Aggregation method for the metered event.
+   */
+  aggregation: CreateCostAggregation;
+  /**
+   * CloudEvents type that identifies the metered event.
+   */
+  eventType: string;
+  /**
+   * JSONPath to extract numeric value from event data. Required for SUM/AVG/MIN/MAX/LATEST aggregations.
+   */
+  valueProperty?: string | undefined;
+  /**
+   * Map of dimension name to JSONPath for group-by queries. Only valid for metered costs.
+   */
+  groupBy?: { [k: string]: string } | undefined;
+  /**
+   * Unique identifier for an organization
+   */
+  merchantId?: string | undefined;
+};
+
+/** @internal */
+export const CreateCostType$outboundSchema: z.ZodNativeEnum<
+  typeof CreateCostType
+> = z.nativeEnum(CreateCostType);
+
+/** @internal */
+export const CreateCostAggregation$outboundSchema: z.ZodNativeEnum<
+  typeof CreateCostAggregation
+> = z.nativeEnum(CreateCostAggregation);
+
+/** @internal */
+export type CreateCostRequest$Outbound = {
+  type: string;
+  name: string;
+  unitCost: number;
+  currency: string;
+  productId: string;
+  unit?: string | undefined;
+  aggregation: string;
+  eventType: string;
+  valueProperty?: string | undefined;
+  groupBy?: { [k: string]: string } | undefined;
+  merchantId?: string | undefined;
+};
+
+/** @internal */
+export const CreateCostRequest$outboundSchema: z.ZodType<
+  CreateCostRequest$Outbound,
+  z.ZodTypeDef,
+  CreateCostRequest
+> = z.object({
+  type: CreateCostType$outboundSchema,
+  name: z.string(),
+  unitCost: z.number(),
+  currency: z.string(),
+  productId: z.string(),
+  unit: z.string().optional(),
+  aggregation: CreateCostAggregation$outboundSchema,
+  eventType: z.string(),
+  valueProperty: z.string().optional(),
+  groupBy: z.record(z.string()).optional(),
+  merchantId: z.string().optional(),
+});
+
+export function createCostRequestToJSON(
+  createCostRequest: CreateCostRequest,
+): string {
+  return JSON.stringify(
+    CreateCostRequest$outboundSchema.parse(createCostRequest),
+  );
+}

package/src/models/operations/createplan.ts

@@ -5,6 +5,37 @@
 import * as z from "zod/v3";
 import { ClosedEnum } from "../../types/enums.js";
 
+/**
+ * ISO 8601 duration for the billing period. Takes precedence over billingInterval when both are provided.
+ */
+export const CreatePlanBillingCadence = {
+  P1M: "P1M",
+  P3M: "P3M",
+  P1Y: "P1Y",
+} as const;
+/**
+ * ISO 8601 duration for the billing period. Takes precedence over billingInterval when both are provided.
+ */
+export type CreatePlanBillingCadence = ClosedEnum<
+  typeof CreatePlanBillingCadence
+>;
+
+/**
+ * Recurring billing period frequency. Sample values: 'monthly' for monthly billing, 'quarterly' for quarterly billing, 'yearly' for annual billing
+ */
+export const CreatePlanBillingInterval = {
+  Monthly: "monthly",
+  Quarterly: "quarterly",
+  Yearly: "yearly",
+  Annual: "annual",
+} as const;
+/**
+ * Recurring billing period frequency. Sample values: 'monthly' for monthly billing, 'quarterly' for quarterly billing, 'yearly' for annual billing
+ */
+export type CreatePlanBillingInterval = ClosedEnum<
+  typeof CreatePlanBillingInterval
+>;
+
 /**
  * Whether tax is added on top of the price (exclusive) or included in the price (inclusive)
  */
@@ -31,9 +62,13 @@ export type BillingVersion = ClosedEnum<typeof BillingVersion>;
 
 export type CreatePlanRequest = {
   /**
-   * Recurring billing period frequency. Sample values: 'monthly' for monthly billing, 'yearly' for annual billing, 'weekly' for weekly billing
+   * ISO 8601 duration for the billing period. Takes precedence over billingInterval when both are provided.
    */
-  billingInterval?: string | undefined;
+  billingCadence?: CreatePlanBillingCadence | undefined;
+  /**
+   * Recurring billing period frequency. Sample values: 'monthly' for monthly billing, 'quarterly' for quarterly billing, 'yearly' for annual billing
+   */
+  billingInterval?: CreatePlanBillingInterval | undefined;
   /**
    * Three-letter ISO 4217 currency code for plan pricing. Must be one of the merchant's supported currencies. Sample values: 'USD' for US dollars, 'EUR' for euros, 'GBP' for British pounds
    */
@@ -88,6 +123,16 @@ export type CreatePlanRequest = {
   billingVersion?: BillingVersion | undefined;
 };
 
+/** @internal */
+export const CreatePlanBillingCadence$outboundSchema: z.ZodNativeEnum<
+  typeof CreatePlanBillingCadence
+> = z.nativeEnum(CreatePlanBillingCadence);
+
+/** @internal */
+export const CreatePlanBillingInterval$outboundSchema: z.ZodNativeEnum<
+  typeof CreatePlanBillingInterval
+> = z.nativeEnum(CreatePlanBillingInterval);
+
 /** @internal */
 export const CreatePlanTaxBehavior$outboundSchema: z.ZodNativeEnum<
   typeof CreatePlanTaxBehavior
@@ -100,6 +145,7 @@ export const BillingVersion$outboundSchema: z.ZodNativeEnum<
 
 /** @internal */
 export type CreatePlanRequest$Outbound = {
+  billingCadence?: string | undefined;
   billingInterval?: string | undefined;
   currency: string;
   defaultTaxCode: string;
@@ -122,7 +168,8 @@ export const CreatePlanRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CreatePlanRequest
 > = z.object({
-  billingInterval: z.string().optional(),
+  billingCadence: CreatePlanBillingCadence$outboundSchema.optional(),
+  billingInterval: CreatePlanBillingInterval$outboundSchema.optional(),
   currency: z.string(),
   defaultTaxCode: z.string().default("eservice"),
   defaultTaxRate: z.number().default(0),