@paygentic/sdk 0.6.29 → 0.6.34

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),

package/src/models/operations/createprice.ts

@@ -60,6 +60,10 @@ export type CreatePriceRequest = {
   billingCadence?: string | null | undefined;
   properties: models.PricePropertiesUnion;
   feature?: models.PriceFeatureInput | undefined;
+  /**
+   * When true, grants applied to a subscription will discount usage charged by this price. Only supported for standard metered prices.
+   */
+  grantDiscountEnabled?: boolean | undefined;
 };
 
 /** @internal */
@@ -82,6 +86,7 @@ export type CreatePriceRequest$Outbound = {
   billingCadence?: string | null | undefined;
   properties: models.PricePropertiesUnion$Outbound;
   feature?: models.PriceFeatureInput$Outbound | undefined;
+  grantDiscountEnabled: boolean;
 };
 
 /** @internal */
@@ -98,6 +103,7 @@ export const CreatePriceRequest$outboundSchema: z.ZodType<
   billingCadence: z.nullable(z.string()).optional(),
   properties: models.PricePropertiesUnion$outboundSchema,
   feature: models.PriceFeatureInput$outboundSchema.optional(),
+  grantDiscountEnabled: z.boolean().default(false),
 });
 
 export function createPriceRequestToJSON(

package/src/models/operations/deletecost.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type DeleteCostRequest = {
+  /**
+   * The unique identifier of the cost
+   */
+  id: string;
+};
+
+/** @internal */
+export type DeleteCostRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const DeleteCostRequest$outboundSchema: z.ZodType<
+  DeleteCostRequest$Outbound,
+  z.ZodTypeDef,
+  DeleteCostRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function deleteCostRequestToJSON(
+  deleteCostRequest: DeleteCostRequest,
+): string {
+  return JSON.stringify(
+    DeleteCostRequest$outboundSchema.parse(deleteCostRequest),
+  );
+}

package/src/models/operations/getbillablemetricmeter.ts

@@ -12,6 +12,7 @@ export const WindowSize = {
   Minute: "MINUTE",
   Hour: "HOUR",
   Day: "DAY",
+  Month: "MONTH",
 } as const;
 /**
  * Time bucket granularity

package/src/models/operations/getcost.ts

@@ -0,0 +1,30 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetCostRequest = {
+  /**
+   * The unique identifier of the cost
+   */
+  id: string;
+};
+
+/** @internal */
+export type GetCostRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const GetCostRequest$outboundSchema: z.ZodType<
+  GetCostRequest$Outbound,
+  z.ZodTypeDef,
+  GetCostRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function getCostRequestToJSON(getCostRequest: GetCostRequest): string {
+  return JSON.stringify(GetCostRequest$outboundSchema.parse(getCostRequest));
+}

package/src/models/operations/getcostsummary.ts

@@ -0,0 +1,88 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Time window granularity for time-series breakdown.
+ */
+export const Window = {
+  Minute: "MINUTE",
+  Hour: "HOUR",
+  Day: "DAY",
+} as const;
+/**
+ * Time window granularity for time-series breakdown.
+ */
+export type Window = ClosedEnum<typeof Window>;
+
+export type GetCostSummaryRequest = {
+  /**
+   * The unique identifier of the cost
+   */
+  id: string;
+  /**
+   * Filter usage to a specific subject (billing entity). When provided, only cost events matching this subject are included. When omitted, usage is aggregated across all subjects for the merchant.
+   */
+  subject?: string | undefined;
+  /**
+   * Start of the query window (ISO 8601). Required together with 'to'.
+   */
+  from: Date;
+  /**
+   * End of the query window (ISO 8601). Required together with 'from'.
+   */
+  to: Date;
+  /**
+   * Comma-separated dimension keys to group results by.
+   */
+  groupBy?: string | undefined;
+  /**
+   * Time window granularity for time-series breakdown.
+   */
+  window?: Window | undefined;
+  /**
+   * JSON-encoded dimension filter (e.g. {"model":"gpt-4","region":"us-east"}). Keys must match those defined in the cost's groupBy configuration. Retrieve the cost first to determine valid keys.
+   */
+  filterGroupBy?: string | undefined;
+};
+
+/** @internal */
+export const Window$outboundSchema: z.ZodNativeEnum<typeof Window> = z
+  .nativeEnum(Window);
+
+/** @internal */
+export type GetCostSummaryRequest$Outbound = {
+  id: string;
+  subject?: string | undefined;
+  from: string;
+  to: string;
+  groupBy?: string | undefined;
+  window?: string | undefined;
+  filterGroupBy?: string | undefined;
+};
+
+/** @internal */
+export const GetCostSummaryRequest$outboundSchema: z.ZodType<
+  GetCostSummaryRequest$Outbound,
+  z.ZodTypeDef,
+  GetCostSummaryRequest
+> = z.object({
+  id: z.string(),
+  subject: z.string().optional(),
+  from: z.date().transform(v => v.toISOString()),
+  to: z.date().transform(v => v.toISOString()),
+  groupBy: z.string().optional(),
+  window: Window$outboundSchema.optional(),
+  filterGroupBy: z.string().optional(),
+});
+
+export function getCostSummaryRequestToJSON(
+  getCostSummaryRequest: GetCostSummaryRequest,
+): string {
+  return JSON.stringify(
+    GetCostSummaryRequest$outboundSchema.parse(getCostSummaryRequest),
+  );
+}

package/src/models/operations/getentitlement.ts

@@ -9,11 +9,16 @@ export type GetEntitlementRequest = {
    * The unique identifier of the entitlement.
    */
   entitlementId: string;
+  /**
+   * Evaluate balance and access at this point in time (RFC 3339 datetime with any UTC offset, e.g. 2024-01-15T10:30:00Z or 2024-01-15T15:30:00+05:30). Defaults to current time.
+   */
+  at?: Date | undefined;
 };
 
 /** @internal */
 export type GetEntitlementRequest$Outbound = {
   entitlementId: string;
+  at?: string | undefined;
 };
 
 /** @internal */
@@ -23,6 +28,7 @@ export const GetEntitlementRequest$outboundSchema: z.ZodType<
   GetEntitlementRequest
 > = z.object({
   entitlementId: z.string(),
+  at: z.date().transform(v => v.toISOString()).optional(),
 });
 
 export function getEntitlementRequestToJSON(

package/src/models/operations/index.ts

@@ -8,6 +8,7 @@ export * from "./batchcreateusageevents.js";
 export * from "./bulkapprovesourceevents.js";
 export * from "./bulkrejectsourceevents.js";
 export * from "./createbillablemetric.js";
+export * from "./createcost.js";
 export * from "./createcustomer.js";
 export * from "./createentitlementgrant.js";
 export * from "./createfeature.js";
@@ -20,6 +21,7 @@ export * from "./createproduct.js";
 export * from "./createsource.js";
 export * from "./createsubscription.js";
 export * from "./createtestclock.js";
+export * from "./deletecost.js";
 export * from "./deletecustomer.js";
 export * from "./deletefeature.js";
 export * from "./deletefee.js";
@@ -30,6 +32,8 @@ export * from "./generateportallink.js";
 export * from "./getactiveentitlements.js";
 export * from "./getbillablemetric.js";
 export * from "./getbillablemetricmeter.js";
+export * from "./getcost.js";
+export * from "./getcostsummary.js";
 export * from "./getcustomer.js";
 export * from "./getentitlement.js";
 export * from "./getentitlementgrant.js";
@@ -51,7 +55,9 @@ export * from "./getusageevent.js";
 export * from "./getuser.js";
 export * from "./ingestevent.js";
 export * from "./listavailableplans.js";
+export * from "./listbillablemetricevents.js";
 export * from "./listbillablemetrics.js";
+export * from "./listcosts.js";
 export * from "./listcustomers.js";
 export * from "./listdisputes.js";
 export * from "./listentitlementgrants.js";
@@ -75,6 +81,7 @@ export * from "./refundusageevent.js";
 export * from "./rejectsourceevent.js";
 export * from "./terminatesubscription.js";
 export * from "./updatebillablemetric.js";
+export * from "./updatecost.js";
 export * from "./updatecustomer.js";
 export * from "./updatefeature.js";
 export * from "./updatefee.js";

package/src/models/operations/listbillablemetricevents.ts

@@ -0,0 +1,63 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type ListBillableMetricEventsRequest = {
+  id: string;
+  /**
+   * Start of query window (ISO 8601)
+   */
+  from: Date;
+  /**
+   * End of query window (ISO 8601)
+   */
+  to: Date;
+  /**
+   * Filter by subject (typically the customer/user ID)
+   */
+  subject?: string | undefined;
+  /**
+   * Maximum number of events to return
+   */
+  limit?: number | undefined;
+  /**
+   * Number of events to skip
+   */
+  offset?: number | undefined;
+};
+
+/** @internal */
+export type ListBillableMetricEventsRequest$Outbound = {
+  id: string;
+  from: string;
+  to: string;
+  subject?: string | undefined;
+  limit: number;
+  offset: number;
+};
+
+/** @internal */
+export const ListBillableMetricEventsRequest$outboundSchema: z.ZodType<
+  ListBillableMetricEventsRequest$Outbound,
+  z.ZodTypeDef,
+  ListBillableMetricEventsRequest
+> = z.object({
+  id: z.string(),
+  from: z.date().transform(v => v.toISOString()),
+  to: z.date().transform(v => v.toISOString()),
+  subject: z.string().optional(),
+  limit: z.number().int().default(20),
+  offset: z.number().int().default(0),
+});
+
+export function listBillableMetricEventsRequestToJSON(
+  listBillableMetricEventsRequest: ListBillableMetricEventsRequest,
+): string {
+  return JSON.stringify(
+    ListBillableMetricEventsRequest$outboundSchema.parse(
+      listBillableMetricEventsRequest,
+    ),
+  );
+}

package/src/models/operations/listcosts.ts

@@ -0,0 +1,124 @@
+/*
+ * 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 * as models from "../index.js";
+
+export type ListCostsRequest = {
+  /**
+   * Filter costs by merchant organization ID. If omitted, defaults to the merchant associated with the authenticated API key.
+   */
+  merchantId?: string | undefined;
+  /**
+   * Filter costs by product ID.
+   */
+  productId?: string | undefined;
+  /**
+   * Number of costs to return.
+   */
+  limit?: number | undefined;
+  /**
+   * Number of costs to skip.
+   */
+  offset?: number | undefined;
+};
+
+export const ListCostsObject = {
+  List: "list",
+} as const;
+export type ListCostsObject = ClosedEnum<typeof ListCostsObject>;
+
+export type ListCostsPagination = {
+  limit: number;
+  offset: number;
+  total: number;
+};
+
+/**
+ * List of costs
+ */
+export type ListCostsResponse = {
+  object: ListCostsObject;
+  data: Array<models.Cost>;
+  pagination: ListCostsPagination;
+};
+
+/** @internal */
+export type ListCostsRequest$Outbound = {
+  merchantId?: string | undefined;
+  productId?: string | undefined;
+  limit: number;
+  offset: number;
+};
+
+/** @internal */
+export const ListCostsRequest$outboundSchema: z.ZodType<
+  ListCostsRequest$Outbound,
+  z.ZodTypeDef,
+  ListCostsRequest
+> = z.object({
+  merchantId: z.string().optional(),
+  productId: z.string().optional(),
+  limit: z.number().int().default(10),
+  offset: z.number().int().default(0),
+});
+
+export function listCostsRequestToJSON(
+  listCostsRequest: ListCostsRequest,
+): string {
+  return JSON.stringify(
+    ListCostsRequest$outboundSchema.parse(listCostsRequest),
+  );
+}
+
+/** @internal */
+export const ListCostsObject$inboundSchema: z.ZodNativeEnum<
+  typeof ListCostsObject
+> = z.nativeEnum(ListCostsObject);
+
+/** @internal */
+export const ListCostsPagination$inboundSchema: z.ZodType<
+  ListCostsPagination,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  limit: z.number().int(),
+  offset: z.number().int(),
+  total: z.number().int(),
+});
+
+export function listCostsPaginationFromJSON(
+  jsonString: string,
+): SafeParseResult<ListCostsPagination, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListCostsPagination$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListCostsPagination' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListCostsResponse$inboundSchema: z.ZodType<
+  ListCostsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: ListCostsObject$inboundSchema,
+  data: z.array(models.Cost$inboundSchema),
+  pagination: z.lazy(() => ListCostsPagination$inboundSchema),
+});
+
+export function listCostsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListCostsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListCostsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListCostsResponse' from JSON`,
+  );
+}

package/src/models/operations/listentitlements.ts

@@ -34,6 +34,10 @@ export type ListEntitlementsRequest = {
    * Number of entitlements to skip. Use with `limit` for pagination through large result sets.
    */
   offset?: number | undefined;
+  /**
+   * Evaluate balance and access at this point in time (RFC 3339 datetime with any UTC offset, e.g. 2024-01-15T10:30:00Z or 2024-01-15T15:30:00+05:30). Defaults to current time.
+   */
+  at?: Date | undefined;
 };
 
 export const ListEntitlementsObject = {
@@ -64,6 +68,7 @@ export type ListEntitlementsRequest$Outbound = {
   subscriptionId?: string | undefined;
   limit: number;
   offset: number;
+  at?: string | undefined;
 };
 
 /** @internal */
@@ -78,6 +83,7 @@ export const ListEntitlementsRequest$outboundSchema: z.ZodType<
   subscriptionId: z.string().optional(),
   limit: z.number().int().default(10),
   offset: z.number().int().default(0),
+  at: z.date().transform(v => v.toISOString()).optional(),
 });
 
 export function listEntitlementsRequestToJSON(