@paygentic/sdk 0.6.29 → 0.6.34

package/src/models/cost.ts

@@ -0,0 +1,114 @@
+/*
+ * 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 CostObject = {
+  Cost: "cost",
+} as const;
+export type CostObject = ClosedEnum<typeof CostObject>;
+
+export const CostType = {
+  Metered: "metered",
+} as const;
+export type CostType = ClosedEnum<typeof CostType>;
+
+export const CostAggregation = {
+  Sum: "SUM",
+  Count: "COUNT",
+  Avg: "AVG",
+  Min: "MIN",
+  Max: "MAX",
+  UniqueCount: "UNIQUE_COUNT",
+  Latest: "LATEST",
+} as const;
+export type CostAggregation = ClosedEnum<typeof CostAggregation>;
+
+export type Cost = {
+  /**
+   * Unique identifier for a cost
+   */
+  id: string;
+  object: CostObject;
+  type: CostType;
+  name: string;
+  currency: string;
+  /**
+   * Decimal as string to avoid floating point precision loss.
+   */
+  unitCost: string;
+  unit?: string | null | undefined;
+  aggregation?: CostAggregation | null | undefined;
+  eventType?: string | null | undefined;
+  valueProperty?: string | null | undefined;
+  groupBy?: { [k: string]: string } | null | undefined;
+  /**
+   * Unique identifier for a product
+   */
+  productId: string;
+  /**
+   * Unique identifier for an organization
+   */
+  merchantId: string;
+  createdAt: Date;
+  updatedAt: Date;
+  /**
+   * Soft-delete timestamp. Always null for active costs returned by the API.
+   */
+  deletedAt?: Date | null | undefined;
+};
+
+/** @internal */
+export const CostObject$inboundSchema: z.ZodNativeEnum<typeof CostObject> = z
+  .nativeEnum(CostObject);
+
+/** @internal */
+export const CostType$inboundSchema: z.ZodNativeEnum<typeof CostType> = z
+  .nativeEnum(CostType);
+
+/** @internal */
+export const CostAggregation$inboundSchema: z.ZodNativeEnum<
+  typeof CostAggregation
+> = z.nativeEnum(CostAggregation);
+
+/** @internal */
+export const Cost$inboundSchema: z.ZodType<Cost, z.ZodTypeDef, unknown> = z
+  .object({
+    id: z.string(),
+    object: CostObject$inboundSchema.default("cost"),
+    type: CostType$inboundSchema,
+    name: z.string(),
+    currency: z.string(),
+    unitCost: z.string(),
+    unit: z.nullable(z.string()).optional(),
+    aggregation: z.nullable(CostAggregation$inboundSchema).optional(),
+    eventType: z.nullable(z.string()).optional(),
+    valueProperty: z.nullable(z.string()).optional(),
+    groupBy: z.nullable(z.record(z.string())).optional(),
+    productId: z.string(),
+    merchantId: z.string(),
+    createdAt: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    updatedAt: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    deletedAt: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    ).optional(),
+  });
+
+export function costFromJSON(
+  jsonString: string,
+): SafeParseResult<Cost, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Cost$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Cost' from JSON`,
+  );
+}

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