@paygentic/sdk 0.7.1 → 0.7.3

package/src/models/operations/createcustomerpaymentmethod.ts

@@ -0,0 +1,90 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type CreateCustomerPaymentMethodRequestBody = {
+  /**
+   * URL the customer is redirected to on success. When the page is iframed, success is reported via `postMessage` instead.
+   */
+  successRedirectUrl?: string | undefined;
+  /**
+   * URL the customer is redirected to on failure. When the page is iframed, failure is reported via `postMessage` instead.
+   */
+  failureRedirectUrl?: string | undefined;
+  /**
+   * Arbitrary key/value pairs to attach to the session.
+   */
+  metadata?: { [k: string]: any } | undefined;
+};
+
+export type CreateCustomerPaymentMethodRequest = {
+  /**
+   * The unique identifier of the customer.
+   */
+  id: string;
+  requestBody?: CreateCustomerPaymentMethodRequestBody | undefined;
+};
+
+/** @internal */
+export type CreateCustomerPaymentMethodRequestBody$Outbound = {
+  successRedirectUrl?: string | undefined;
+  failureRedirectUrl?: string | undefined;
+  metadata?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const CreateCustomerPaymentMethodRequestBody$outboundSchema: z.ZodType<
+  CreateCustomerPaymentMethodRequestBody$Outbound,
+  z.ZodTypeDef,
+  CreateCustomerPaymentMethodRequestBody
+> = z.object({
+  successRedirectUrl: z.string().optional(),
+  failureRedirectUrl: z.string().optional(),
+  metadata: z.record(z.any()).optional(),
+});
+
+export function createCustomerPaymentMethodRequestBodyToJSON(
+  createCustomerPaymentMethodRequestBody:
+    CreateCustomerPaymentMethodRequestBody,
+): string {
+  return JSON.stringify(
+    CreateCustomerPaymentMethodRequestBody$outboundSchema.parse(
+      createCustomerPaymentMethodRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateCustomerPaymentMethodRequest$Outbound = {
+  id: string;
+  RequestBody?: CreateCustomerPaymentMethodRequestBody$Outbound | undefined;
+};
+
+/** @internal */
+export const CreateCustomerPaymentMethodRequest$outboundSchema: z.ZodType<
+  CreateCustomerPaymentMethodRequest$Outbound,
+  z.ZodTypeDef,
+  CreateCustomerPaymentMethodRequest
+> = z.object({
+  id: z.string(),
+  requestBody: z.lazy(() =>
+    CreateCustomerPaymentMethodRequestBody$outboundSchema
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    requestBody: "RequestBody",
+  });
+});
+
+export function createCustomerPaymentMethodRequestToJSON(
+  createCustomerPaymentMethodRequest: CreateCustomerPaymentMethodRequest,
+): string {
+  return JSON.stringify(
+    CreateCustomerPaymentMethodRequest$outboundSchema.parse(
+      createCustomerPaymentMethodRequest,
+    ),
+  );
+}

package/src/models/operations/createplan.ts

@@ -121,6 +121,10 @@ export type CreatePlanRequest = {
    * Billing engine version. 0 = legacy fee-schedule billing (Legacy), 1 = line-item billing with metered usage support (Standard).
    */
   billingVersion?: BillingVersion | undefined;
+  /**
+   * ISO 8601 datetime reference point for billing period alignment. Must be in the past or present. When set, subscriptions created under this plan align their first billing period to the next recurrence of this anchor.
+   */
+  billingAnchor?: Date | null | undefined;
 };
 
 /** @internal */
@@ -160,6 +164,7 @@ export type CreatePlanRequest$Outbound = {
   renewalReminderEnabled: boolean;
   renewalReminderDays: number;
   billingVersion: number;
+  billingAnchor?: string | null | undefined;
 };
 
 /** @internal */
@@ -183,6 +188,8 @@ export const CreatePlanRequest$outboundSchema: z.ZodType<
   renewalReminderEnabled: z.boolean().default(true),
   renewalReminderDays: z.number().int().default(3),
   billingVersion: BillingVersion$outboundSchema.default(0),
+  billingAnchor: z.nullable(z.date().transform(v => v.toISOString()))
+    .optional(),
 });
 
 export function createPlanRequestToJSON(

package/src/models/operations/getprofitability.ts

@@ -0,0 +1,85 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Time bucket granularity for the per-customer revenue trend. When omitted, the server picks a reasonable bucket from the window length.
+ */
+export const GetProfitabilityBucketWidth = {
+  Hour: "hour",
+  Day: "day",
+  Week: "week",
+} as const;
+/**
+ * Time bucket granularity for the per-customer revenue trend. When omitted, the server picks a reasonable bucket from the window length.
+ */
+export type GetProfitabilityBucketWidth = ClosedEnum<
+  typeof GetProfitabilityBucketWidth
+>;
+
+export type GetProfitabilityRequest = {
+  /**
+   * Merchant whose customers to summarize
+   */
+  merchantId: string;
+  /**
+   * Start of the time range (ISO 8601 format)
+   */
+  from: Date;
+  /**
+   * End of the time range (ISO 8601 format)
+   */
+  to: Date;
+  /**
+   * Number of top customers (by profit) to return individually. The rest are rolled into a single 'Other' row.
+   */
+  topN?: number | undefined;
+  /**
+   * ISO 4217 currency code to scope the summary. Defaults to the merchant's primary currency.
+   */
+  currency?: string | undefined;
+  /**
+   * Time bucket granularity for the per-customer revenue trend. When omitted, the server picks a reasonable bucket from the window length.
+   */
+  bucketWidth?: GetProfitabilityBucketWidth | undefined;
+};
+
+/** @internal */
+export const GetProfitabilityBucketWidth$outboundSchema: z.ZodNativeEnum<
+  typeof GetProfitabilityBucketWidth
+> = z.nativeEnum(GetProfitabilityBucketWidth);
+
+/** @internal */
+export type GetProfitabilityRequest$Outbound = {
+  merchantId: string;
+  from: string;
+  to: string;
+  topN: number;
+  currency?: string | undefined;
+  bucketWidth: string;
+};
+
+/** @internal */
+export const GetProfitabilityRequest$outboundSchema: z.ZodType<
+  GetProfitabilityRequest$Outbound,
+  z.ZodTypeDef,
+  GetProfitabilityRequest
+> = z.object({
+  merchantId: z.string(),
+  from: z.date().transform(v => v.toISOString()),
+  to: z.date().transform(v => v.toISOString()),
+  topN: z.number().int().default(10),
+  currency: z.string().optional(),
+  bucketWidth: GetProfitabilityBucketWidth$outboundSchema.default("day"),
+});
+
+export function getProfitabilityRequestToJSON(
+  getProfitabilityRequest: GetProfitabilityRequest,
+): string {
+  return JSON.stringify(
+    GetProfitabilityRequest$outboundSchema.parse(getProfitabilityRequest),
+  );
+}

package/src/models/operations/getrevenue.ts

@@ -8,7 +8,7 @@ import { ClosedEnum } from "../../types/enums.js";
 /**
  * Time bucket granularity for trend data
  */
-export const BucketWidth = {
+export const GetRevenueBucketWidth = {
   Hour: "hour",
   Day: "day",
   Week: "week",
@@ -16,7 +16,7 @@ export const BucketWidth = {
 /**
  * Time bucket granularity for trend data
  */
-export type BucketWidth = ClosedEnum<typeof BucketWidth>;
+export type GetRevenueBucketWidth = ClosedEnum<typeof GetRevenueBucketWidth>;
 
 /**
  * Group invoice data by dimension. Allowed values: 'plan' (max 5 groups, top 4 + 'other' when exceeding), 'customer' (max 25 groups, top 24 + 'other' when exceeding, sorted by revenue descending), 'currency' (one entry per currency, primary currency first then alphabetical). Note: groupBy values are mutually exclusive — combining them returns a 400 error. When groupBy=currency is active, top-level netRevenue, invoices, and payments fields are omitted; currencyBreakdown is the sole data source.
@@ -43,7 +43,7 @@ export type GetRevenueRequest = {
   /**
    * Time bucket granularity for trend data
    */
-  bucketWidth?: BucketWidth | undefined;
+  bucketWidth?: GetRevenueBucketWidth | undefined;
   /**
    * Filter by merchant ID. At least one of merchantId, subscriptionIds, or customerId must be provided.
    */
@@ -67,8 +67,9 @@ export type GetRevenueRequest = {
 };
 
 /** @internal */
-export const BucketWidth$outboundSchema: z.ZodNativeEnum<typeof BucketWidth> = z
-  .nativeEnum(BucketWidth);
+export const GetRevenueBucketWidth$outboundSchema: z.ZodNativeEnum<
+  typeof GetRevenueBucketWidth
+> = z.nativeEnum(GetRevenueBucketWidth);
 
 /** @internal */
 export const GroupBy$outboundSchema: z.ZodNativeEnum<typeof GroupBy> = z
@@ -94,7 +95,7 @@ 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("day"),
+  bucketWidth: GetRevenueBucketWidth$outboundSchema.default("day"),
   merchantId: z.string().optional(),
   customerId: z.string().optional(),
   subscriptionIds: z.array(z.string()).optional(),

package/src/models/operations/index.ts

@@ -9,6 +9,7 @@ export * from "./bulkrejectsourceevents.js";
 export * from "./createbillablemetric.js";
 export * from "./createcost.js";
 export * from "./createcustomer.js";
+export * from "./createcustomerpaymentmethod.js";
 export * from "./createentitlementgrant.js";
 export * from "./createfeature.js";
 export * from "./createfee.js";
@@ -45,6 +46,7 @@ export * from "./getpayment.js";
 export * from "./getplan.js";
 export * from "./getprice.js";
 export * from "./getproduct.js";
+export * from "./getprofitability.js";
 export * from "./getrevenue.js";
 export * from "./getsource.js";
 export * from "./getsourcerule.js";
@@ -56,6 +58,7 @@ export * from "./listavailableplans.js";
 export * from "./listbillablemetricevents.js";
 export * from "./listbillablemetrics.js";
 export * from "./listcosts.js";
+export * from "./listcustomerpaymentmethods.js";
 export * from "./listcustomers.js";
 export * from "./listentitlementgrants.js";
 export * from "./listentitlements.js";
@@ -64,6 +67,7 @@ export * from "./listfees.js";
 export * from "./listinvoices.js";
 export * from "./listlineitems.js";
 export * from "./listpayments.js";
+export * from "./listpaymentsessions.js";
 export * from "./listplans.js";
 export * from "./listprices.js";
 export * from "./listproducts.js";

package/src/models/operations/listcustomerpaymentmethods.ts

@@ -0,0 +1,82 @@
+/*
+ * 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 ListCustomerPaymentMethodsRequest = {
+  /**
+   * The unique identifier of the customer.
+   */
+  id: string;
+};
+
+export const ListCustomerPaymentMethodsObject = {
+  List: "list",
+} as const;
+export type ListCustomerPaymentMethodsObject = ClosedEnum<
+  typeof ListCustomerPaymentMethodsObject
+>;
+
+/**
+ * List of payment methods
+ */
+export type ListCustomerPaymentMethodsResponse = {
+  object: ListCustomerPaymentMethodsObject;
+  data: Array<models.PaymentMethod>;
+};
+
+/** @internal */
+export type ListCustomerPaymentMethodsRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const ListCustomerPaymentMethodsRequest$outboundSchema: z.ZodType<
+  ListCustomerPaymentMethodsRequest$Outbound,
+  z.ZodTypeDef,
+  ListCustomerPaymentMethodsRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function listCustomerPaymentMethodsRequestToJSON(
+  listCustomerPaymentMethodsRequest: ListCustomerPaymentMethodsRequest,
+): string {
+  return JSON.stringify(
+    ListCustomerPaymentMethodsRequest$outboundSchema.parse(
+      listCustomerPaymentMethodsRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ListCustomerPaymentMethodsObject$inboundSchema: z.ZodNativeEnum<
+  typeof ListCustomerPaymentMethodsObject
+> = z.nativeEnum(ListCustomerPaymentMethodsObject);
+
+/** @internal */
+export const ListCustomerPaymentMethodsResponse$inboundSchema: z.ZodType<
+  ListCustomerPaymentMethodsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: ListCustomerPaymentMethodsObject$inboundSchema,
+  data: z.array(models.PaymentMethod$inboundSchema),
+});
+
+export function listCustomerPaymentMethodsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListCustomerPaymentMethodsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListCustomerPaymentMethodsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListCustomerPaymentMethodsResponse' from JSON`,
+  );
+}

package/src/models/operations/listinvoices.ts

@@ -46,6 +46,10 @@ export type ListInvoicesRequest = {
    * Maximum number of invoices to return
    */
   limit?: number | undefined;
+  /**
+   * Number of invoices to skip for pagination
+   */
+  offset?: number | undefined;
   /**
    * Filter for invoices ready for processing (platform only)
    */
@@ -75,6 +79,10 @@ export type ListInvoicesObject = ClosedEnum<typeof ListInvoicesObject>;
 export type ListInvoicesResponse = {
   object: ListInvoicesObject;
   data: Array<models.Invoice>;
+  /**
+   * Offset-based pagination response.
+   */
+  pagination: models.OffsetPagination;
 };
 
 /** @internal */
@@ -89,6 +97,7 @@ export const ListInvoicesStatus$outboundSchema: z.ZodNativeEnum<
 /** @internal */
 export type ListInvoicesRequest$Outbound = {
   limit: number;
+  offset: number;
   nextActionAt?: string | undefined;
   status?: string | undefined;
   subscriptionId?: string | undefined;
@@ -102,6 +111,7 @@ export const ListInvoicesRequest$outboundSchema: z.ZodType<
   ListInvoicesRequest
 > = z.object({
   limit: z.number().int().default(10),
+  offset: z.number().int().default(0),
   nextActionAt: NextActionAt$outboundSchema.optional(),
   status: ListInvoicesStatus$outboundSchema.optional(),
   subscriptionId: z.string().optional(),
@@ -129,6 +139,7 @@ export const ListInvoicesResponse$inboundSchema: z.ZodType<
 > = z.object({
   object: ListInvoicesObject$inboundSchema,
   data: z.array(models.Invoice$inboundSchema),
+  pagination: models.OffsetPagination$inboundSchema,
 });
 
 export function listInvoicesResponseFromJSON(

package/src/models/operations/listpaymentsessions.ts

@@ -10,41 +10,64 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import * as models from "../index.js";
 
 /**
- * Filter by payment status.
+ * Filter by payment session status.
  */
 export const ListPaymentSessionsStatus = {
   Pending: "pending",
   Processing: "processing",
   Completed: "completed",
+  Failed: "failed",
   Expired: "expired",
   Cancelled: "cancelled",
 } as const;
 /**
- * Filter by payment status.
+ * Filter by payment session status.
  */
 export type ListPaymentSessionsStatus = ClosedEnum<
   typeof ListPaymentSessionsStatus
 >;
 
+/**
+ * Filter by the kind of entity the session pays for.
+ */
+export const EntityType = {
+  Invoice: "invoice",
+  Subscription: "subscription",
+  Payment: "payment",
+  Topup: "topup",
+} as const;
+/**
+ * Filter by the kind of entity the session pays for.
+ */
+export type EntityType = ClosedEnum<typeof EntityType>;
+
 export type ListPaymentSessionsRequest = {
   /**
    * Merchant organization ID. Required when using an API key that is not scoped to a single merchant.
    */
   merchantId?: string | undefined;
   /**
-   * Filter by payment status.
+   * Filter to sessions linked to this subscription (its own activation session plus all of its invoices' sessions).
    */
-  status?: ListPaymentSessionsStatus | undefined;
+  subscriptionId?: string | undefined;
   /**
-   * Filter by customer ID.
+   * Filter to sessions linked to a payment for this customer.
    */
   customerId?: string | undefined;
   /**
-   * Number of payments to return.
+   * Filter by payment session status.
+   */
+  status?: ListPaymentSessionsStatus | undefined;
+  /**
+   * Filter by the kind of entity the session pays for.
+   */
+  entityType?: EntityType | undefined;
+  /**
+   * Number of sessions to return.
    */
   limit?: number | undefined;
   /**
-   * Number of payments to skip.
+   * Number of sessions to skip.
    */
   offset?: number | undefined;
 };
@@ -57,11 +80,11 @@ export type ListPaymentSessionsObject = ClosedEnum<
 >;
 
 /**
- * List of payments
+ * List of payment sessions
  */
 export type ListPaymentSessionsResponse = {
   object: ListPaymentSessionsObject;
-  data: Array<models.Payment>;
+  data: Array<models.SchemasPaymentSession>;
   /**
    * Offset-based pagination response.
    */
@@ -73,11 +96,17 @@ export const ListPaymentSessionsStatus$outboundSchema: z.ZodNativeEnum<
   typeof ListPaymentSessionsStatus
 > = z.nativeEnum(ListPaymentSessionsStatus);
 
+/** @internal */
+export const EntityType$outboundSchema: z.ZodNativeEnum<typeof EntityType> = z
+  .nativeEnum(EntityType);
+
 /** @internal */
 export type ListPaymentSessionsRequest$Outbound = {
   merchantId?: string | undefined;
-  status?: string | undefined;
+  subscriptionId?: string | undefined;
   customerId?: string | undefined;
+  status?: string | undefined;
+  entityType?: string | undefined;
   limit: number;
   offset: number;
 };
@@ -89,8 +118,10 @@ export const ListPaymentSessionsRequest$outboundSchema: z.ZodType<
   ListPaymentSessionsRequest
 > = z.object({
   merchantId: z.string().optional(),
-  status: ListPaymentSessionsStatus$outboundSchema.optional(),
+  subscriptionId: z.string().optional(),
   customerId: z.string().optional(),
+  status: ListPaymentSessionsStatus$outboundSchema.optional(),
+  entityType: EntityType$outboundSchema.optional(),
   limit: z.number().int().default(10),
   offset: z.number().int().default(0),
 });
@@ -115,7 +146,7 @@ export const ListPaymentSessionsResponse$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   object: ListPaymentSessionsObject$inboundSchema,
-  data: z.array(models.Payment$inboundSchema),
+  data: z.array(models.SchemasPaymentSession$inboundSchema),
   pagination: models.OffsetPagination$inboundSchema,
 });
 

package/src/models/operations/updateplan.ts

@@ -94,6 +94,10 @@ export type UpdatePlanRequestBody = {
    * Number of days before renewal to send the reminder email
    */
   renewalReminderDays?: number | undefined;
+  /**
+   * ISO 8601 datetime reference point for billing period alignment. Must be in the past or present. Set to null to clear the anchor and revert to start-time-based anchoring.
+   */
+  billingAnchor?: Date | null | undefined;
 };
 
 export type UpdatePlanRequest = {
@@ -132,6 +136,7 @@ export type UpdatePlanRequestBody$Outbound = {
   taxBehavior?: string | undefined;
   renewalReminderEnabled?: boolean | undefined;
   renewalReminderDays?: number | undefined;
+  billingAnchor?: string | null | undefined;
 };
 
 /** @internal */
@@ -151,6 +156,8 @@ export const UpdatePlanRequestBody$outboundSchema: z.ZodType<
   taxBehavior: UpdatePlanTaxBehavior$outboundSchema.optional(),
   renewalReminderEnabled: z.boolean().optional(),
   renewalReminderDays: z.number().int().optional(),
+  billingAnchor: z.nullable(z.date().transform(v => v.toISOString()))
+    .optional(),
 });
 
 export function updatePlanRequestBodyToJSON(

package/src/models/paymentmethod.ts

@@ -0,0 +1,62 @@
+/*
+ * 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 PaymentMethodObject = {
+  PaymentMethod: "paymentMethod",
+} as const;
+export type PaymentMethodObject = ClosedEnum<typeof PaymentMethodObject>;
+
+export type PaymentMethod = {
+  object: PaymentMethodObject;
+  /**
+   * Payment method identifier.
+   */
+  id: string;
+  /**
+   * Payment method type (e.g. `card`, `sepa_debit`).
+   */
+  type?: string | null | undefined;
+  brand?: string | null | undefined;
+  last4?: string | null | undefined;
+  expMonth?: number | null | undefined;
+  expYear?: number | null | undefined;
+  createdAt: Date;
+};
+
+/** @internal */
+export const PaymentMethodObject$inboundSchema: z.ZodNativeEnum<
+  typeof PaymentMethodObject
+> = z.nativeEnum(PaymentMethodObject);
+
+/** @internal */
+export const PaymentMethod$inboundSchema: z.ZodType<
+  PaymentMethod,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: PaymentMethodObject$inboundSchema,
+  id: z.string(),
+  type: z.nullable(z.string()).optional(),
+  brand: z.nullable(z.string()).optional(),
+  last4: z.nullable(z.string()).optional(),
+  expMonth: z.nullable(z.number().int()).optional(),
+  expYear: z.nullable(z.number().int()).optional(),
+  createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+});
+
+export function paymentMethodFromJSON(
+  jsonString: string,
+): SafeParseResult<PaymentMethod, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PaymentMethod$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaymentMethod' from JSON`,
+  );
+}