@paygentic/sdk 0.6.11 → 0.6.13

package/src/models/operations/createpaymentsession.ts

@@ -0,0 +1,158 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * ISO 4217 currency code.
+ */
+export const Currency = {
+  Usd: "USD",
+  Eur: "EUR",
+  Gbp: "GBP",
+  Aud: "AUD",
+} as const;
+/**
+ * ISO 4217 currency code.
+ */
+export type Currency = ClosedEnum<typeof Currency>;
+
+export type LineItem = {
+  /**
+   * Line item description.
+   */
+  description: string;
+  /**
+   * Line item amount in decimal format (e.g. '5.00').
+   */
+  amount: string;
+  /**
+   * Quantity of this line item. Defaults to 1.
+   */
+  quantity?: number | undefined;
+};
+
+export type CreatePaymentSessionRequest = {
+  /**
+   * Payment amount in decimal format (e.g. '10.50'). Minimum 1.00, maximum 5,000.00. Contact support for higher limits.
+   */
+  amount: string;
+  /**
+   * ISO 4217 currency code.
+   */
+  currency: Currency;
+  /**
+   * Merchant organization ID. Required when using an API key that is not scoped to a single merchant.
+   */
+  merchantId?: string | undefined;
+  /**
+   * Optional customer ID. Must belong to this merchant.
+   */
+  customerId?: string | undefined;
+  /**
+   * Client-provided key for safe retries. If a payment with the same key already exists, the existing payment is returned.
+   */
+  idempotencyKey?: string | undefined;
+  /**
+   * Merchant-defined reference for this payment (e.g. order ID, invoice number).
+   */
+  reference?: string | undefined;
+  /**
+   * Arbitrary key-value string pairs to attach to the payment.
+   */
+  metadata?: { [k: string]: string } | undefined;
+  /**
+   * Optional breakdown of what the customer is being charged for.
+   */
+  lineItems?: Array<LineItem> | undefined;
+  /**
+   * URL to redirect the customer to after a successful payment.
+   */
+  successRedirectUrl?: string | undefined;
+  /**
+   * URL to redirect the customer to after a failed payment.
+   */
+  failureRedirectUrl?: string | undefined;
+  /**
+   * Whether to save the customer's payment method for future use. Defaults to false.
+   */
+  savePaymentMethod?: boolean | undefined;
+  /**
+   * ISO 8601 duration for the payment lifetime. Defaults to P30D (30 days). Maximum is P31D (31 days). Examples: PT1H, P1D, P7D, P30D.
+   */
+  expiresIn?: string | undefined;
+};
+
+/** @internal */
+export const Currency$outboundSchema: z.ZodNativeEnum<typeof Currency> = z
+  .nativeEnum(Currency);
+
+/** @internal */
+export type LineItem$Outbound = {
+  description: string;
+  amount: string;
+  quantity: number;
+};
+
+/** @internal */
+export const LineItem$outboundSchema: z.ZodType<
+  LineItem$Outbound,
+  z.ZodTypeDef,
+  LineItem
+> = z.object({
+  description: z.string(),
+  amount: z.string(),
+  quantity: z.number().int().default(1),
+});
+
+export function lineItemToJSON(lineItem: LineItem): string {
+  return JSON.stringify(LineItem$outboundSchema.parse(lineItem));
+}
+
+/** @internal */
+export type CreatePaymentSessionRequest$Outbound = {
+  amount: string;
+  currency: string;
+  merchantId?: string | undefined;
+  customerId?: string | undefined;
+  idempotencyKey?: string | undefined;
+  reference?: string | undefined;
+  metadata?: { [k: string]: string } | undefined;
+  lineItems?: Array<LineItem$Outbound> | undefined;
+  successRedirectUrl?: string | undefined;
+  failureRedirectUrl?: string | undefined;
+  savePaymentMethod: boolean;
+  expiresIn?: string | undefined;
+};
+
+/** @internal */
+export const CreatePaymentSessionRequest$outboundSchema: z.ZodType<
+  CreatePaymentSessionRequest$Outbound,
+  z.ZodTypeDef,
+  CreatePaymentSessionRequest
+> = z.object({
+  amount: z.string(),
+  currency: Currency$outboundSchema,
+  merchantId: z.string().optional(),
+  customerId: z.string().optional(),
+  idempotencyKey: z.string().optional(),
+  reference: z.string().optional(),
+  metadata: z.record(z.string()).optional(),
+  lineItems: z.array(z.lazy(() => LineItem$outboundSchema)).optional(),
+  successRedirectUrl: z.string().optional(),
+  failureRedirectUrl: z.string().optional(),
+  savePaymentMethod: z.boolean().default(false),
+  expiresIn: z.string().optional(),
+});
+
+export function createPaymentSessionRequestToJSON(
+  createPaymentSessionRequest: CreatePaymentSessionRequest,
+): string {
+  return JSON.stringify(
+    CreatePaymentSessionRequest$outboundSchema.parse(
+      createPaymentSessionRequest,
+    ),
+  );
+}

package/src/models/operations/createplan.ts

@@ -17,6 +17,18 @@ export const CreatePlanTaxBehavior = {
  */
 export type CreatePlanTaxBehavior = ClosedEnum<typeof CreatePlanTaxBehavior>;
 
+/**
+ * Billing engine version. 0 = legacy fee-schedule billing (Legacy), 1 = line-item billing with metered usage support (Standard).
+ */
+export const BillingVersion = {
+  Zero: 0,
+  One: 1,
+} as const;
+/**
+ * Billing engine version. 0 = legacy fee-schedule billing (Legacy), 1 = line-item billing with metered usage support (Standard).
+ */
+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
@@ -70,6 +82,10 @@ export type CreatePlanRequest = {
    * Number of days before renewal to send the reminder email
    */
   renewalReminderDays?: number | undefined;
+  /**
+   * Billing engine version. 0 = legacy fee-schedule billing (Legacy), 1 = line-item billing with metered usage support (Standard).
+   */
+  billingVersion?: BillingVersion | undefined;
 };
 
 /** @internal */
@@ -77,6 +93,11 @@ export const CreatePlanTaxBehavior$outboundSchema: z.ZodNativeEnum<
   typeof CreatePlanTaxBehavior
 > = z.nativeEnum(CreatePlanTaxBehavior);
 
+/** @internal */
+export const BillingVersion$outboundSchema: z.ZodNativeEnum<
+  typeof BillingVersion
+> = z.nativeEnum(BillingVersion);
+
 /** @internal */
 export type CreatePlanRequest$Outbound = {
   billingInterval?: string | undefined;
@@ -92,6 +113,7 @@ export type CreatePlanRequest$Outbound = {
   taxBehavior: string;
   renewalReminderEnabled: boolean;
   renewalReminderDays: number;
+  billingVersion: number;
 };
 
 /** @internal */
@@ -113,6 +135,7 @@ export const CreatePlanRequest$outboundSchema: z.ZodType<
   taxBehavior: CreatePlanTaxBehavior$outboundSchema.default("exclusive"),
   renewalReminderEnabled: z.boolean().default(true),
   renewalReminderDays: z.number().int().default(3),
+  billingVersion: BillingVersion$outboundSchema.default(0),
 });
 
 export function createPlanRequestToJSON(

package/src/models/operations/getbillablemetricmeter.ts

@@ -0,0 +1,87 @@
+/*
+ * 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
+ */
+export const WindowSize = {
+  Minute: "MINUTE",
+  Hour: "HOUR",
+  Day: "DAY",
+} as const;
+/**
+ * Time bucket granularity
+ */
+export type WindowSize = ClosedEnum<typeof WindowSize>;
+
+export type GetBillableMetricMeterRequest = {
+  id: string;
+  /**
+   * Start of query window (ISO 8601)
+   */
+  from: Date;
+  /**
+   * End of query window (ISO 8601)
+   */
+  to: Date;
+  /**
+   * Filter by customer/user ID
+   */
+  subject?: string | undefined;
+  /**
+   * Time bucket granularity
+   */
+  windowSize?: WindowSize | undefined;
+  /**
+   * JSON-encoded dimension filter (e.g. {"key":"value"})
+   */
+  filterGroupBy?: string | undefined;
+  /**
+   * Comma-separated dimension keys
+   */
+  groupBy?: string | undefined;
+};
+
+/** @internal */
+export const WindowSize$outboundSchema: z.ZodNativeEnum<typeof WindowSize> = z
+  .nativeEnum(WindowSize);
+
+/** @internal */
+export type GetBillableMetricMeterRequest$Outbound = {
+  id: string;
+  from: string;
+  to: string;
+  subject?: string | undefined;
+  windowSize?: string | undefined;
+  filterGroupBy?: string | undefined;
+  groupBy?: string | undefined;
+};
+
+/** @internal */
+export const GetBillableMetricMeterRequest$outboundSchema: z.ZodType<
+  GetBillableMetricMeterRequest$Outbound,
+  z.ZodTypeDef,
+  GetBillableMetricMeterRequest
+> = z.object({
+  id: z.string(),
+  from: z.date().transform(v => v.toISOString()),
+  to: z.date().transform(v => v.toISOString()),
+  subject: z.string().optional(),
+  windowSize: WindowSize$outboundSchema.optional(),
+  filterGroupBy: z.string().optional(),
+  groupBy: z.string().optional(),
+});
+
+export function getBillableMetricMeterRequestToJSON(
+  getBillableMetricMeterRequest: GetBillableMetricMeterRequest,
+): string {
+  return JSON.stringify(
+    GetBillableMetricMeterRequest$outboundSchema.parse(
+      getBillableMetricMeterRequest,
+    ),
+  );
+}

package/src/models/operations/getpayment.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetPaymentRequest = {
+  /**
+   * Payment session ID
+   */
+  id: string;
+};
+
+/** @internal */
+export type GetPaymentRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const GetPaymentRequest$outboundSchema: z.ZodType<
+  GetPaymentRequest$Outbound,
+  z.ZodTypeDef,
+  GetPaymentRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function getPaymentRequestToJSON(
+  getPaymentRequest: GetPaymentRequest,
+): string {
+  return JSON.stringify(
+    GetPaymentRequest$outboundSchema.parse(getPaymentRequest),
+  );
+}

package/src/models/operations/getpaymentsession.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetPaymentSessionRequest = {
+  /**
+   * Payment session ID
+   */
+  id: string;
+};
+
+/** @internal */
+export type GetPaymentSessionRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const GetPaymentSessionRequest$outboundSchema: z.ZodType<
+  GetPaymentSessionRequest$Outbound,
+  z.ZodTypeDef,
+  GetPaymentSessionRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function getPaymentSessionRequestToJSON(
+  getPaymentSessionRequest: GetPaymentSessionRequest,
+): string {
+  return JSON.stringify(
+    GetPaymentSessionRequest$outboundSchema.parse(getPaymentSessionRequest),
+  );
+}

package/src/models/operations/index.ts

@@ -11,6 +11,7 @@ export * from "./createbillablemetric.js";
 export * from "./createcustomer.js";
 export * from "./createfeature.js";
 export * from "./createfee.js";
+export * from "./createpayment.js";
 export * from "./createplan.js";
 export * from "./createprice.js";
 export * from "./createproduct.js";
@@ -26,6 +27,7 @@ export * from "./deletetestclock.js";
 export * from "./generateportallink.js";
 export * from "./getactiveentitlements.js";
 export * from "./getbillablemetric.js";
+export * from "./getbillablemetricmeter.js";
 export * from "./getcustomer.js";
 export * from "./getentitlement.js";
 export * from "./getfeature.js";
@@ -33,6 +35,7 @@ export * from "./getfee.js";
 export * from "./getfeeprice.js";
 export * from "./getinvoice.js";
 export * from "./getinvoicelineitems.js";
+export * from "./getpayment.js";
 export * from "./getplan.js";
 export * from "./getprice.js";
 export * from "./getproduct.js";
@@ -52,6 +55,7 @@ export * from "./listentitlements.js";
 export * from "./listfeatures.js";
 export * from "./listfees.js";
 export * from "./listinvoices.js";
+export * from "./listpayments.js";
 export * from "./listplans.js";
 export * from "./listprices.js";
 export * from "./listproducts.js";

package/src/models/operations/listentitlements.ts

@@ -22,6 +22,10 @@ export type ListEntitlementsRequest = {
    * Filter results to entitlements for a specific product. Required when `featureKey` is specified since feature keys are scoped to products.
    */
   productId?: string | undefined;
+  /**
+   * Filter results to entitlements for a specific subscription.
+   */
+  subscriptionId?: string | undefined;
   /**
    * Maximum number of entitlements to return per page. Use with `offset` for pagination.
    */
@@ -57,6 +61,7 @@ export type ListEntitlementsRequest$Outbound = {
   customerId: string;
   featureKey?: string | undefined;
   productId?: string | undefined;
+  subscriptionId?: string | undefined;
   limit: number;
   offset: number;
 };
@@ -70,6 +75,7 @@ export const ListEntitlementsRequest$outboundSchema: z.ZodType<
   customerId: z.string(),
   featureKey: z.string().optional(),
   productId: z.string().optional(),
+  subscriptionId: z.string().optional(),
   limit: z.number().int().default(10),
   offset: z.number().int().default(0),
 });

package/src/models/operations/listpayments.ts

@@ -0,0 +1,126 @@
+/*
+ * 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";
+
+/**
+ * Filter by payment status.
+ */
+export const ListPaymentsStatus = {
+  Pending: "pending",
+  Processing: "processing",
+  Completed: "completed",
+  Expired: "expired",
+  Cancelled: "cancelled",
+} as const;
+/**
+ * Filter by payment status.
+ */
+export type ListPaymentsStatus = ClosedEnum<typeof ListPaymentsStatus>;
+
+export type ListPaymentsRequest = {
+  /**
+   * Merchant organization ID. Required when using an API key that is not scoped to a single merchant.
+   */
+  merchantId?: string | undefined;
+  /**
+   * Filter by payment status.
+   */
+  status?: ListPaymentsStatus | undefined;
+  /**
+   * Filter by customer ID.
+   */
+  customerId?: string | undefined;
+  /**
+   * Number of payments to return.
+   */
+  limit?: number | undefined;
+  /**
+   * Number of payments to skip.
+   */
+  offset?: number | undefined;
+};
+
+export const ListPaymentsObject = {
+  List: "list",
+} as const;
+export type ListPaymentsObject = ClosedEnum<typeof ListPaymentsObject>;
+
+/**
+ * List of payments
+ */
+export type ListPaymentsResponse = {
+  object: ListPaymentsObject;
+  data: Array<models.Payment>;
+  /**
+   * Offset-based pagination response.
+   */
+  pagination: models.OffsetPagination;
+};
+
+/** @internal */
+export const ListPaymentsStatus$outboundSchema: z.ZodNativeEnum<
+  typeof ListPaymentsStatus
+> = z.nativeEnum(ListPaymentsStatus);
+
+/** @internal */
+export type ListPaymentsRequest$Outbound = {
+  merchantId?: string | undefined;
+  status?: string | undefined;
+  customerId?: string | undefined;
+  limit: number;
+  offset: number;
+};
+
+/** @internal */
+export const ListPaymentsRequest$outboundSchema: z.ZodType<
+  ListPaymentsRequest$Outbound,
+  z.ZodTypeDef,
+  ListPaymentsRequest
+> = z.object({
+  merchantId: z.string().optional(),
+  status: ListPaymentsStatus$outboundSchema.optional(),
+  customerId: z.string().optional(),
+  limit: z.number().int().default(10),
+  offset: z.number().int().default(0),
+});
+
+export function listPaymentsRequestToJSON(
+  listPaymentsRequest: ListPaymentsRequest,
+): string {
+  return JSON.stringify(
+    ListPaymentsRequest$outboundSchema.parse(listPaymentsRequest),
+  );
+}
+
+/** @internal */
+export const ListPaymentsObject$inboundSchema: z.ZodNativeEnum<
+  typeof ListPaymentsObject
+> = z.nativeEnum(ListPaymentsObject);
+
+/** @internal */
+export const ListPaymentsResponse$inboundSchema: z.ZodType<
+  ListPaymentsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: ListPaymentsObject$inboundSchema,
+  data: z.array(models.Payment$inboundSchema),
+  pagination: models.OffsetPagination$inboundSchema,
+});
+
+export function listPaymentsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListPaymentsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListPaymentsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListPaymentsResponse' from JSON`,
+  );
+}

package/src/models/operations/listpaymentsessions.ts

@@ -0,0 +1,130 @@
+/*
+ * 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";
+
+/**
+ * Filter by payment status.
+ */
+export const ListPaymentSessionsStatus = {
+  Pending: "pending",
+  Processing: "processing",
+  Completed: "completed",
+  Expired: "expired",
+  Cancelled: "cancelled",
+} as const;
+/**
+ * Filter by payment status.
+ */
+export type ListPaymentSessionsStatus = ClosedEnum<
+  typeof ListPaymentSessionsStatus
+>;
+
+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.
+   */
+  status?: ListPaymentSessionsStatus | undefined;
+  /**
+   * Filter by customer ID.
+   */
+  customerId?: string | undefined;
+  /**
+   * Number of payments to return.
+   */
+  limit?: number | undefined;
+  /**
+   * Number of payments to skip.
+   */
+  offset?: number | undefined;
+};
+
+export const ListPaymentSessionsObject = {
+  List: "list",
+} as const;
+export type ListPaymentSessionsObject = ClosedEnum<
+  typeof ListPaymentSessionsObject
+>;
+
+/**
+ * List of payments
+ */
+export type ListPaymentSessionsResponse = {
+  object: ListPaymentSessionsObject;
+  data: Array<models.Payment>;
+  /**
+   * Offset-based pagination response.
+   */
+  pagination: models.OffsetPagination;
+};
+
+/** @internal */
+export const ListPaymentSessionsStatus$outboundSchema: z.ZodNativeEnum<
+  typeof ListPaymentSessionsStatus
+> = z.nativeEnum(ListPaymentSessionsStatus);
+
+/** @internal */
+export type ListPaymentSessionsRequest$Outbound = {
+  merchantId?: string | undefined;
+  status?: string | undefined;
+  customerId?: string | undefined;
+  limit: number;
+  offset: number;
+};
+
+/** @internal */
+export const ListPaymentSessionsRequest$outboundSchema: z.ZodType<
+  ListPaymentSessionsRequest$Outbound,
+  z.ZodTypeDef,
+  ListPaymentSessionsRequest
+> = z.object({
+  merchantId: z.string().optional(),
+  status: ListPaymentSessionsStatus$outboundSchema.optional(),
+  customerId: z.string().optional(),
+  limit: z.number().int().default(10),
+  offset: z.number().int().default(0),
+});
+
+export function listPaymentSessionsRequestToJSON(
+  listPaymentSessionsRequest: ListPaymentSessionsRequest,
+): string {
+  return JSON.stringify(
+    ListPaymentSessionsRequest$outboundSchema.parse(listPaymentSessionsRequest),
+  );
+}
+
+/** @internal */
+export const ListPaymentSessionsObject$inboundSchema: z.ZodNativeEnum<
+  typeof ListPaymentSessionsObject
+> = z.nativeEnum(ListPaymentSessionsObject);
+
+/** @internal */
+export const ListPaymentSessionsResponse$inboundSchema: z.ZodType<
+  ListPaymentSessionsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: ListPaymentSessionsObject$inboundSchema,
+  data: z.array(models.Payment$inboundSchema),
+  pagination: models.OffsetPagination$inboundSchema,
+});
+
+export function listPaymentSessionsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListPaymentSessionsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListPaymentSessionsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListPaymentSessionsResponse' from JSON`,
+  );
+}