@paygentic/sdk 0.6.19 → 0.6.21

package/src/models/index.ts

@@ -9,6 +9,7 @@ export * from "./billablemetric.js";
 export * from "./booleanentitlementdetail.js";
 export * from "./createdisputerequest.js";
 export * from "./createentitlementrequest.js";
+export * from "./creategrantrequest.js";
 export * from "./createmanuallineitemrequest.js";
 export * from "./createrulerequest.js";
 export * from "./createusageeventrequest.js";
@@ -23,9 +24,14 @@ export * from "./eventresponse.js";
 export * from "./feature.js";
 export * from "./fee.js";
 export * from "./feeprice.js";
+export * from "./grant.js";
+export * from "./groupinvoicesummary.js";
+export * from "./grouptrendentry.js";
 export * from "./invoice.js";
+export * from "./invoicecategorysummary.js";
 export * from "./invoicelineitem.js";
 export * from "./invoicelineitemsresponse.js";
+export * from "./invoicesummary.js";
 export * from "./issueentitlementrequest.js";
 export * from "./lineitem.js";
 export * from "./lineitemsresponse.js";
@@ -33,15 +39,17 @@ export * from "./lineitemssummary.js";
 export * from "./meteredentitlementdetail.js";
 export * from "./offsetpagination.js";
 export * from "./payment.js";
+export * from "./paymentsummary.js";
 export * from "./plan.js";
 export * from "./price.js";
 export * from "./pricefeature.js";
 export * from "./pricefeatureinput.js";
 export * from "./pricepropertiesunion.js";
 export * from "./product.js";
-export * from "./revenuestats.js";
-export * from "./revenuetimebucket.js";
-export * from "./revenuetimeseriesresponse.js";
+export * from "./purchasegrantrequest.js";
+export * from "./purchasegrantresponse.js";
+export * from "./revenuesummaryresponse.js";
+export * from "./revenuetrendbucket.js";
 export * from "./rulecondition.js";
 export * from "./schemasentitlement.js";
 export * from "./schemasprice.js";

package/src/models/invoicecategorysummary.ts

@@ -0,0 +1,39 @@
+/*
+ * 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 { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type InvoiceCategorySummary = {
+  /**
+   * Number of invoices in this category
+   */
+  count: number;
+  /**
+   * Total amount of invoices in this category in dollars
+   */
+  amount: string;
+};
+
+/** @internal */
+export const InvoiceCategorySummary$inboundSchema: z.ZodType<
+  InvoiceCategorySummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  count: z.number().int(),
+  amount: z.string(),
+});
+
+export function invoiceCategorySummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<InvoiceCategorySummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InvoiceCategorySummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InvoiceCategorySummary' from JSON`,
+  );
+}

package/src/models/invoicesummary.ts

@@ -0,0 +1,41 @@
+/*
+ * 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 { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  InvoiceCategorySummary,
+  InvoiceCategorySummary$inboundSchema,
+} from "./invoicecategorysummary.js";
+
+export type InvoiceSummary = {
+  issued: InvoiceCategorySummary;
+  outstanding: InvoiceCategorySummary;
+  paid: InvoiceCategorySummary;
+  writtenOff: InvoiceCategorySummary;
+};
+
+/** @internal */
+export const InvoiceSummary$inboundSchema: z.ZodType<
+  InvoiceSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  issued: InvoiceCategorySummary$inboundSchema,
+  outstanding: InvoiceCategorySummary$inboundSchema,
+  paid: InvoiceCategorySummary$inboundSchema,
+  writtenOff: InvoiceCategorySummary$inboundSchema,
+});
+
+export function invoiceSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<InvoiceSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InvoiceSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InvoiceSummary' from JSON`,
+  );
+}

package/src/models/operations/createentitlementgrant.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as models from "../index.js";
+
+export type CreateEntitlementGrantRequest = {
+  /**
+   * The unique identifier of the entitlement to grant credits to.
+   */
+  entitlementId: string;
+  createGrantRequest: models.CreateGrantRequest;
+};
+
+/** @internal */
+export type CreateEntitlementGrantRequest$Outbound = {
+  entitlementId: string;
+  CreateGrantRequest: models.CreateGrantRequest$Outbound;
+};
+
+/** @internal */
+export const CreateEntitlementGrantRequest$outboundSchema: z.ZodType<
+  CreateEntitlementGrantRequest$Outbound,
+  z.ZodTypeDef,
+  CreateEntitlementGrantRequest
+> = z.object({
+  entitlementId: z.string(),
+  createGrantRequest: models.CreateGrantRequest$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    createGrantRequest: "CreateGrantRequest",
+  });
+});
+
+export function createEntitlementGrantRequestToJSON(
+  createEntitlementGrantRequest: CreateEntitlementGrantRequest,
+): string {
+  return JSON.stringify(
+    CreateEntitlementGrantRequest$outboundSchema.parse(
+      createEntitlementGrantRequest,
+    ),
+  );
+}

package/src/models/operations/getentitlementgrant.ts

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

package/src/models/operations/getrevenue.ts

@@ -6,18 +6,29 @@ import * as z from "zod/v3";
 import { ClosedEnum } from "../../types/enums.js";
 
 /**
- * Time bucket granularity
+ * Time bucket granularity for trend data
  */
 export const BucketWidth = {
-  Minute: "minute",
   Hour: "hour",
   Day: "day",
+  Week: "week",
 } as const;
 /**
- * Time bucket granularity
+ * Time bucket granularity for trend data
  */
 export type BucketWidth = ClosedEnum<typeof BucketWidth>;
 
+/**
+ * Group invoice data by dimension. Max 5 groups (top 4 + 'other' when exceeding).
+ */
+export const GroupBy = {
+  Plan: "plan",
+} as const;
+/**
+ * Group invoice data by dimension. Max 5 groups (top 4 + 'other' when exceeding).
+ */
+export type GroupBy = ClosedEnum<typeof GroupBy>;
+
 export type GetRevenueRequest = {
   /**
    * Start of the time range (ISO 8601 format)
@@ -28,7 +39,7 @@ export type GetRevenueRequest = {
    */
   endTime: Date;
   /**
-   * Time bucket granularity
+   * Time bucket granularity for trend data
    */
   bucketWidth?: BucketWidth | undefined;
   /**
@@ -44,15 +55,19 @@ export type GetRevenueRequest = {
    */
   subscriptionIds?: Array<string> | undefined;
   /**
-   * Limit to top N subscriptions by net revenue. Remaining subscriptions are aggregated into 'other'.
+   * Group invoice data by dimension. Max 5 groups (top 4 + 'other' when exceeding).
    */
-  topN?: number | undefined;
+  groupBy?: GroupBy | undefined;
 };
 
 /** @internal */
 export const BucketWidth$outboundSchema: z.ZodNativeEnum<typeof BucketWidth> = z
   .nativeEnum(BucketWidth);
 
+/** @internal */
+export const GroupBy$outboundSchema: z.ZodNativeEnum<typeof GroupBy> = z
+  .nativeEnum(GroupBy);
+
 /** @internal */
 export type GetRevenueRequest$Outbound = {
   startTime: string;
@@ -61,7 +76,7 @@ export type GetRevenueRequest$Outbound = {
   merchantId?: string | undefined;
   customerId?: string | undefined;
   subscriptionIds?: Array<string> | undefined;
-  topN: number;
+  groupBy?: string | undefined;
 };
 
 /** @internal */
@@ -72,11 +87,11 @@ export const GetRevenueRequest$outboundSchema: z.ZodType<
 > = z.object({
   startTime: z.date().transform(v => v.toISOString()),
   endTime: z.date().transform(v => v.toISOString()),
-  bucketWidth: BucketWidth$outboundSchema.default("hour"),
+  bucketWidth: BucketWidth$outboundSchema.default("day"),
   merchantId: z.string().optional(),
   customerId: z.string().optional(),
   subscriptionIds: z.array(z.string()).optional(),
-  topN: z.number().int().default(10),
+  groupBy: GroupBy$outboundSchema.optional(),
 });
 
 export function getRevenueRequestToJSON(

package/src/models/operations/index.ts

@@ -9,6 +9,7 @@ export * from "./bulkapprovesourceevents.js";
 export * from "./bulkrejectsourceevents.js";
 export * from "./createbillablemetric.js";
 export * from "./createcustomer.js";
+export * from "./createentitlementgrant.js";
 export * from "./createfeature.js";
 export * from "./createfee.js";
 export * from "./createlineitem.js";
@@ -31,6 +32,7 @@ export * from "./getbillablemetric.js";
 export * from "./getbillablemetricmeter.js";
 export * from "./getcustomer.js";
 export * from "./getentitlement.js";
+export * from "./getentitlementgrant.js";
 export * from "./getfeature.js";
 export * from "./getfee.js";
 export * from "./getfeeprice.js";
@@ -52,6 +54,7 @@ export * from "./listavailableplans.js";
 export * from "./listbillablemetrics.js";
 export * from "./listcustomers.js";
 export * from "./listdisputes.js";
+export * from "./listentitlementgrants.js";
 export * from "./listentitlements.js";
 export * from "./listfeatures.js";
 export * from "./listfees.js";
@@ -67,6 +70,7 @@ export * from "./listsources.js";
 export * from "./listsubscriptions.js";
 export * from "./listtestclocks.js";
 export * from "./listusageevents.js";
+export * from "./purchaseentitlementgrant.js";
 export * from "./refundusageevent.js";
 export * from "./rejectsourceevent.js";
 export * from "./terminatesubscription.js";
@@ -80,3 +84,4 @@ export * from "./updateproduct.js";
 export * from "./updatesource.js";
 export * from "./updatesourcerule.js";
 export * from "./updateuser.js";
+export * from "./voidentitlementgrant.js";

package/src/models/operations/listcustomers.ts

@@ -19,11 +19,11 @@ export type ListCustomersRequest = {
    */
   offset?: number | undefined;
   /**
-   * Filter customers by consumer name (case-insensitive substring match)
+   * Filter customers by consumer name (case-insensitive substring match). Minimum 3 characters required for efficient index usage.
    */
   name?: string | undefined;
   /**
-   * Filter customers by billing email (case-insensitive substring match). Accepts partial values — e.g. a domain ("acme.com") or local part ("billing").
+   * Filter customers by billing email (case-insensitive substring match). Minimum 3 characters required for efficient index usage. Accepts partial values — e.g. a domain ("acme.com") or local part ("billing").
    */
   email?: string | undefined;
   /**

package/src/models/operations/listentitlementgrants.ts

@@ -0,0 +1,104 @@
+/*
+ * 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 ListEntitlementGrantsRequest = {
+  /**
+   * The unique identifier of the entitlement.
+   */
+  entitlementId: string;
+  /**
+   * Maximum number of grants to return per page.
+   */
+  limit?: number | undefined;
+  /**
+   * Number of grants to skip.
+   */
+  offset?: number | undefined;
+  /**
+   * When true, voided grants are included in the response.
+   */
+  includeVoided?: boolean | undefined;
+};
+
+export const ListEntitlementGrantsObject = {
+  List: "list",
+} as const;
+export type ListEntitlementGrantsObject = ClosedEnum<
+  typeof ListEntitlementGrantsObject
+>;
+
+/**
+ * Successfully retrieved the list of grants.
+ */
+export type ListEntitlementGrantsResponse = {
+  object: ListEntitlementGrantsObject;
+  data: Array<models.Grant>;
+  /**
+   * Offset-based pagination response.
+   */
+  pagination: models.OffsetPagination;
+};
+
+/** @internal */
+export type ListEntitlementGrantsRequest$Outbound = {
+  entitlementId: string;
+  limit: number;
+  offset: number;
+  includeVoided: boolean;
+};
+
+/** @internal */
+export const ListEntitlementGrantsRequest$outboundSchema: z.ZodType<
+  ListEntitlementGrantsRequest$Outbound,
+  z.ZodTypeDef,
+  ListEntitlementGrantsRequest
+> = z.object({
+  entitlementId: z.string(),
+  limit: z.number().int().default(20),
+  offset: z.number().int().default(0),
+  includeVoided: z.boolean().default(false),
+});
+
+export function listEntitlementGrantsRequestToJSON(
+  listEntitlementGrantsRequest: ListEntitlementGrantsRequest,
+): string {
+  return JSON.stringify(
+    ListEntitlementGrantsRequest$outboundSchema.parse(
+      listEntitlementGrantsRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ListEntitlementGrantsObject$inboundSchema: z.ZodNativeEnum<
+  typeof ListEntitlementGrantsObject
+> = z.nativeEnum(ListEntitlementGrantsObject);
+
+/** @internal */
+export const ListEntitlementGrantsResponse$inboundSchema: z.ZodType<
+  ListEntitlementGrantsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: ListEntitlementGrantsObject$inboundSchema.default("list"),
+  data: z.array(models.Grant$inboundSchema),
+  pagination: models.OffsetPagination$inboundSchema,
+});
+
+export function listEntitlementGrantsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntitlementGrantsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntitlementGrantsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntitlementGrantsResponse' from JSON`,
+  );
+}

package/src/models/operations/listsubscriptions.ts

@@ -12,11 +12,23 @@ import * as models from "../index.js";
 export const ListSubscriptionsStatus = {
   Active: "active",
   Terminated: "terminated",
+  PendingPayment: "pending_payment",
 } as const;
 export type ListSubscriptionsStatus = ClosedEnum<
   typeof ListSubscriptionsStatus
 >;
 
+/**
+ * Include related resources. When 'customer' is specified, each subscription includes merchant and consumer details.
+ */
+export const Include = {
+  Customer: "customer",
+} as const;
+/**
+ * Include related resources. When 'customer' is specified, each subscription includes merchant and consumer details.
+ */
+export type Include = ClosedEnum<typeof Include>;
+
 export type ListSubscriptionsRequest = {
   consumerId?: string | undefined;
   customerId?: string | undefined;
@@ -30,6 +42,14 @@ export type ListSubscriptionsRequest = {
    */
   offset?: string | undefined;
   status?: ListSubscriptionsStatus | undefined;
+  /**
+   * Filter subscriptions started at or before this ISO 8601 date-time
+   */
+  startedBefore?: Date | undefined;
+  /**
+   * Include related resources. When 'customer' is specified, each subscription includes merchant and consumer details.
+   */
+  include?: Include | undefined;
 };
 
 /**
@@ -48,6 +68,10 @@ export const ListSubscriptionsStatus$outboundSchema: z.ZodNativeEnum<
   typeof ListSubscriptionsStatus
 > = z.nativeEnum(ListSubscriptionsStatus);
 
+/** @internal */
+export const Include$outboundSchema: z.ZodNativeEnum<typeof Include> = z
+  .nativeEnum(Include);
+
 /** @internal */
 export type ListSubscriptionsRequest$Outbound = {
   consumerId?: string | undefined;
@@ -56,6 +80,8 @@ export type ListSubscriptionsRequest$Outbound = {
   merchantId?: string | undefined;
   offset: string;
   status?: string | undefined;
+  startedBefore?: string | undefined;
+  include?: string | undefined;
 };
 
 /** @internal */
@@ -70,6 +96,8 @@ export const ListSubscriptionsRequest$outboundSchema: z.ZodType<
   merchantId: z.string().optional(),
   offset: z.string().default("0"),
   status: ListSubscriptionsStatus$outboundSchema.optional(),
+  startedBefore: z.date().transform(v => v.toISOString()).optional(),
+  include: Include$outboundSchema.optional(),
 });
 
 export function listSubscriptionsRequestToJSON(

package/src/models/operations/purchaseentitlementgrant.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as models from "../index.js";
+
+export type PurchaseEntitlementGrantRequest = {
+  /**
+   * The unique identifier of the entitlement to purchase credits for.
+   */
+  entitlementId: string;
+  purchaseGrantRequest: models.PurchaseGrantRequest;
+};
+
+/** @internal */
+export type PurchaseEntitlementGrantRequest$Outbound = {
+  entitlementId: string;
+  PurchaseGrantRequest: models.PurchaseGrantRequest$Outbound;
+};
+
+/** @internal */
+export const PurchaseEntitlementGrantRequest$outboundSchema: z.ZodType<
+  PurchaseEntitlementGrantRequest$Outbound,
+  z.ZodTypeDef,
+  PurchaseEntitlementGrantRequest
+> = z.object({
+  entitlementId: z.string(),
+  purchaseGrantRequest: models.PurchaseGrantRequest$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    purchaseGrantRequest: "PurchaseGrantRequest",
+  });
+});
+
+export function purchaseEntitlementGrantRequestToJSON(
+  purchaseEntitlementGrantRequest: PurchaseEntitlementGrantRequest,
+): string {
+  return JSON.stringify(
+    PurchaseEntitlementGrantRequest$outboundSchema.parse(
+      purchaseEntitlementGrantRequest,
+    ),
+  );
+}

package/src/models/operations/voidentitlementgrant.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type VoidEntitlementGrantRequest = {
+  /**
+   * The unique identifier of the entitlement.
+   */
+  entitlementId: string;
+  /**
+   * The unique identifier of the grant to void.
+   */
+  grantId: string;
+};
+
+/** @internal */
+export type VoidEntitlementGrantRequest$Outbound = {
+  entitlementId: string;
+  grantId: string;
+};
+
+/** @internal */
+export const VoidEntitlementGrantRequest$outboundSchema: z.ZodType<
+  VoidEntitlementGrantRequest$Outbound,
+  z.ZodTypeDef,
+  VoidEntitlementGrantRequest
+> = z.object({
+  entitlementId: z.string(),
+  grantId: z.string(),
+});
+
+export function voidEntitlementGrantRequestToJSON(
+  voidEntitlementGrantRequest: VoidEntitlementGrantRequest,
+): string {
+  return JSON.stringify(
+    VoidEntitlementGrantRequest$outboundSchema.parse(
+      voidEntitlementGrantRequest,
+    ),
+  );
+}

package/src/models/paymentsummary.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 { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type PaymentSummary = {
+  /**
+   * Number of completed payment links in the period
+   */
+  completedCount: number;
+  /**
+   * Total amount of completed payment links in dollars
+   */
+  completedAmount: string;
+  /**
+   * Number of pending payment links in the period
+   */
+  pendingCount: number;
+  /**
+   * Total amount of pending payment links in dollars
+   */
+  pendingAmount: string;
+  /**
+   * Number of expired payment links in the period
+   */
+  expiredCount: number;
+  /**
+   * Total amount of expired payment links in dollars
+   */
+  expiredAmount: string;
+};
+
+/** @internal */
+export const PaymentSummary$inboundSchema: z.ZodType<
+  PaymentSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  completedCount: z.number().int(),
+  completedAmount: z.string(),
+  pendingCount: z.number().int(),
+  pendingAmount: z.string(),
+  expiredCount: z.number().int(),
+  expiredAmount: z.string(),
+});
+
+export function paymentSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<PaymentSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PaymentSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaymentSummary' from JSON`,
+  );
+}