@paygentic/sdk 0.7.18 → 0.7.19

package/src/models/invoicerefund.ts

@@ -0,0 +1,140 @@
+/*
+ * 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";
+
+/**
+ * The object type
+ */
+export const InvoiceRefundObject = {
+  InvoiceRefund: "invoice_refund",
+} as const;
+/**
+ * The object type
+ */
+export type InvoiceRefundObject = ClosedEnum<typeof InvoiceRefundObject>;
+
+/**
+ * Credit note status
+ */
+export const InvoiceRefundStatus = {
+  Issued: "ISSUED",
+  Voided: "VOIDED",
+} as const;
+/**
+ * Credit note status
+ */
+export type InvoiceRefundStatus = ClosedEnum<typeof InvoiceRefundStatus>;
+
+export type InvoiceRefund = {
+  /**
+   * The object type
+   */
+  object: InvoiceRefundObject;
+  /**
+   * The credit note ID (crn_*)
+   */
+  id: string;
+  /**
+   * The invoice this refund credits
+   */
+  invoiceId: string;
+  /**
+   * The merchant that owns the invoice
+   */
+  merchantId: string;
+  /**
+   * Refunded subtotal (pre-tax) in decimal dollars
+   */
+  amount: string;
+  /**
+   * Reversed tax in decimal dollars
+   */
+  taxAmount: string;
+  /**
+   * Total refunded (amount + taxAmount) in decimal dollars
+   */
+  total: string;
+  /**
+   * ISO 4217 currency code
+   */
+  currency: string;
+  /**
+   * Credit note status
+   */
+  status: InvoiceRefundStatus;
+  /**
+   * Credit note id in the tax provider
+   */
+  externalCreditNoteId: string;
+  /**
+   * Public URL to view the credit note document
+   */
+  permalink?: string | null | undefined;
+  /**
+   * Direct PDF download link
+   */
+  pdfUrl?: string | null | undefined;
+  /**
+   * Optional refund reason
+   */
+  reason?: string | null | undefined;
+  /**
+   * When the refund was issued
+   */
+  createdAt: Date;
+  /**
+   * When the refund was voided, if applicable
+   */
+  voidedAt?: Date | null | undefined;
+};
+
+/** @internal */
+export const InvoiceRefundObject$inboundSchema: z.ZodNativeEnum<
+  typeof InvoiceRefundObject
+> = z.nativeEnum(InvoiceRefundObject);
+
+/** @internal */
+export const InvoiceRefundStatus$inboundSchema: z.ZodNativeEnum<
+  typeof InvoiceRefundStatus
+> = z.nativeEnum(InvoiceRefundStatus);
+
+/** @internal */
+export const InvoiceRefund$inboundSchema: z.ZodType<
+  InvoiceRefund,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: InvoiceRefundObject$inboundSchema,
+  id: z.string(),
+  invoiceId: z.string(),
+  merchantId: z.string(),
+  amount: z.string(),
+  taxAmount: z.string(),
+  total: z.string(),
+  currency: z.string(),
+  status: InvoiceRefundStatus$inboundSchema,
+  externalCreditNoteId: z.string(),
+  permalink: z.nullable(z.string()).optional(),
+  pdfUrl: z.nullable(z.string()).optional(),
+  reason: z.nullable(z.string()).optional(),
+  createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  voidedAt: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+});
+
+export function invoiceRefundFromJSON(
+  jsonString: string,
+): SafeParseResult<InvoiceRefund, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InvoiceRefund$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InvoiceRefund' from JSON`,
+  );
+}

package/src/models/invoicerefundlist.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 { InvoiceRefund, InvoiceRefund$inboundSchema } from "./invoicerefund.js";
+
+/**
+ * The object type
+ */
+export const InvoiceRefundListObject = {
+  List: "list",
+} as const;
+/**
+ * The object type
+ */
+export type InvoiceRefundListObject = ClosedEnum<
+  typeof InvoiceRefundListObject
+>;
+
+export type InvoiceRefundList = {
+  /**
+   * The object type
+   */
+  object: InvoiceRefundListObject;
+  /**
+   * The refunds for this invoice
+   */
+  data: Array<InvoiceRefund>;
+};
+
+/** @internal */
+export const InvoiceRefundListObject$inboundSchema: z.ZodNativeEnum<
+  typeof InvoiceRefundListObject
+> = z.nativeEnum(InvoiceRefundListObject);
+
+/** @internal */
+export const InvoiceRefundList$inboundSchema: z.ZodType<
+  InvoiceRefundList,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: InvoiceRefundListObject$inboundSchema,
+  data: z.array(InvoiceRefund$inboundSchema),
+});
+
+export function invoiceRefundListFromJSON(
+  jsonString: string,
+): SafeParseResult<InvoiceRefundList, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InvoiceRefundList$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InvoiceRefundList' from JSON`,
+  );
+}

package/src/models/operations/createinvoicerefund.ts

@@ -0,0 +1,74 @@
+/*
+ * 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 CreateInvoiceRefundRequestBody = {
+  /**
+   * Optional reason for the refund (recorded on the credit note)
+   */
+  reason?: string | undefined;
+};
+
+export type CreateInvoiceRefundRequest = {
+  /**
+   * The invoice ID
+   */
+  id: string;
+  requestBody?: CreateInvoiceRefundRequestBody | undefined;
+};
+
+/** @internal */
+export type CreateInvoiceRefundRequestBody$Outbound = {
+  reason?: string | undefined;
+};
+
+/** @internal */
+export const CreateInvoiceRefundRequestBody$outboundSchema: z.ZodType<
+  CreateInvoiceRefundRequestBody$Outbound,
+  z.ZodTypeDef,
+  CreateInvoiceRefundRequestBody
+> = z.object({
+  reason: z.string().optional(),
+});
+
+export function createInvoiceRefundRequestBodyToJSON(
+  createInvoiceRefundRequestBody: CreateInvoiceRefundRequestBody,
+): string {
+  return JSON.stringify(
+    CreateInvoiceRefundRequestBody$outboundSchema.parse(
+      createInvoiceRefundRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateInvoiceRefundRequest$Outbound = {
+  id: string;
+  RequestBody?: CreateInvoiceRefundRequestBody$Outbound | undefined;
+};
+
+/** @internal */
+export const CreateInvoiceRefundRequest$outboundSchema: z.ZodType<
+  CreateInvoiceRefundRequest$Outbound,
+  z.ZodTypeDef,
+  CreateInvoiceRefundRequest
+> = z.object({
+  id: z.string(),
+  requestBody: z.lazy(() => CreateInvoiceRefundRequestBody$outboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    requestBody: "RequestBody",
+  });
+});
+
+export function createInvoiceRefundRequestToJSON(
+  createInvoiceRefundRequest: CreateInvoiceRefundRequest,
+): string {
+  return JSON.stringify(
+    CreateInvoiceRefundRequest$outboundSchema.parse(createInvoiceRefundRequest),
+  );
+}

package/src/models/operations/index.ts

@@ -14,6 +14,7 @@ export * from "./createentitlementgrant.js";
 export * from "./createexternalreference.js";
 export * from "./createfeature.js";
 export * from "./createfee.js";
+export * from "./createinvoicerefund.js";
 export * from "./createitem.js";
 export * from "./createlineitem.js";
 export * from "./createpayment.js";
@@ -73,6 +74,7 @@ export * from "./listentitlements.js";
 export * from "./listexternalreferences.js";
 export * from "./listfeatures.js";
 export * from "./listfees.js";
+export * from "./listinvoicerefunds.js";
 export * from "./listinvoices.js";
 export * from "./listitems.js";
 export * from "./listlineitems.js";
@@ -107,3 +109,4 @@ export * from "./updatesubscription.js";
 export * from "./updateuser.js";
 export * from "./upsertmerchantintegration.js";
 export * from "./voidentitlementgrant.js";
+export * from "./voidinvoicerefund.js";

package/src/models/operations/listinvoicerefunds.ts

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

package/src/models/operations/voidinvoicerefund.ts

@@ -0,0 +1,80 @@
+/*
+ * 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 VoidInvoiceRefundRequestBody = {
+  /**
+   * Optional reason for voiding the refund (recorded on the credit note)
+   */
+  reason?: string | undefined;
+};
+
+export type VoidInvoiceRefundRequest = {
+  /**
+   * The invoice ID
+   */
+  id: string;
+  /**
+   * The refund (credit note) ID
+   */
+  refundId: string;
+  requestBody?: VoidInvoiceRefundRequestBody | undefined;
+};
+
+/** @internal */
+export type VoidInvoiceRefundRequestBody$Outbound = {
+  reason?: string | undefined;
+};
+
+/** @internal */
+export const VoidInvoiceRefundRequestBody$outboundSchema: z.ZodType<
+  VoidInvoiceRefundRequestBody$Outbound,
+  z.ZodTypeDef,
+  VoidInvoiceRefundRequestBody
+> = z.object({
+  reason: z.string().optional(),
+});
+
+export function voidInvoiceRefundRequestBodyToJSON(
+  voidInvoiceRefundRequestBody: VoidInvoiceRefundRequestBody,
+): string {
+  return JSON.stringify(
+    VoidInvoiceRefundRequestBody$outboundSchema.parse(
+      voidInvoiceRefundRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export type VoidInvoiceRefundRequest$Outbound = {
+  id: string;
+  refundId: string;
+  RequestBody?: VoidInvoiceRefundRequestBody$Outbound | undefined;
+};
+
+/** @internal */
+export const VoidInvoiceRefundRequest$outboundSchema: z.ZodType<
+  VoidInvoiceRefundRequest$Outbound,
+  z.ZodTypeDef,
+  VoidInvoiceRefundRequest
+> = z.object({
+  id: z.string(),
+  refundId: z.string(),
+  requestBody: z.lazy(() => VoidInvoiceRefundRequestBody$outboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    requestBody: "RequestBody",
+  });
+});
+
+export function voidInvoiceRefundRequestToJSON(
+  voidInvoiceRefundRequest: VoidInvoiceRefundRequest,
+): string {
+  return JSON.stringify(
+    VoidInvoiceRefundRequest$outboundSchema.parse(voidInvoiceRefundRequest),
+  );
+}

package/src/models/revenuesummaryresponse.ts

@@ -33,9 +33,17 @@ export type RevenueSummaryResponse = {
    */
   object: "revenue_summary";
   /**
-   * Net collected revenue in dollars (paid invoices + completed payments). Omitted when groupBy=currency is active.
+   * Net collected revenue in dollars (paid invoices + completed payments), already net of non-voided refunds. Omitted when groupBy=currency is active.
    */
   netRevenue?: string | undefined;
+  /**
+   * Gross total of non-voided refunds (credit notes) issued in the period, in dollars. Already subtracted from netRevenue and invoice totals. Omitted when groupBy=currency is active.
+   */
+  totalRefunds?: string | undefined;
+  /**
+   * Number of non-voided refunds (credit notes) issued in the period. Omitted when groupBy=currency is active.
+   */
+  refundCount?: number | undefined;
   invoices?: InvoiceSummary | undefined;
   payments?: PaymentSummary | undefined;
   /**
@@ -60,6 +68,8 @@ export const RevenueSummaryResponse$inboundSchema: z.ZodType<
 > = z.object({
   object: z.literal("revenue_summary"),
   netRevenue: z.string().optional(),
+  totalRefunds: z.string().optional(),
+  refundCount: z.number().optional(),
   invoices: InvoiceSummary$inboundSchema.optional(),
   payments: PaymentSummary$inboundSchema.optional(),
   trend: z.array(RevenueTrendBucket$inboundSchema).optional(),

package/src/sdk/invoicesv2.ts

@@ -2,11 +2,14 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { invoicesV2CreateInvoiceRefund } from "../funcs/invoicesV2CreateInvoiceRefund.js";
 import { invoicesV2CreateLineItem } from "../funcs/invoicesV2CreateLineItem.js";
 import { invoicesV2Get } from "../funcs/invoicesV2Get.js";
 import { invoicesV2GetLineItems } from "../funcs/invoicesV2GetLineItems.js";
 import { invoicesV2List } from "../funcs/invoicesV2List.js";
+import { invoicesV2ListInvoiceRefunds } from "../funcs/invoicesV2ListInvoiceRefunds.js";
 import { invoicesV2ListLineItems } from "../funcs/invoicesV2ListLineItems.js";
+import { invoicesV2VoidInvoiceRefund } from "../funcs/invoicesV2VoidInvoiceRefund.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as models from "../models/index.js";
 import * as operations from "../models/operations/index.js";
@@ -97,4 +100,55 @@ export class InvoicesV2 extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Refund Invoice
+   *
+   * @remarks
+   * Issue a full refund against a paid invoice by creating a credit note. The invoice stays PAID; the refund is recorded as a child credit note. Accessible to the owning merchant or platform operators. Only works for invoices in PAID status that have not already been refunded. Full refund only — the entire invoice (subtotal + tax) is credited.
+   */
+  async createInvoiceRefund(
+    request: operations.CreateInvoiceRefundRequest,
+    options?: RequestOptions,
+  ): Promise<models.InvoiceRefund> {
+    return unwrapAsync(invoicesV2CreateInvoiceRefund(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List Invoice Refunds
+   *
+   * @remarks
+   * List the credit notes (refunds) recorded against an invoice. Accessible to the owning merchant or platform operators.
+   */
+  async listInvoiceRefunds(
+    request: operations.ListInvoiceRefundsRequest,
+    options?: RequestOptions,
+  ): Promise<models.InvoiceRefundList> {
+    return unwrapAsync(invoicesV2ListInvoiceRefunds(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Void Invoice Refund
+   *
+   * @remarks
+   * Void a previously-issued refund (credit note). Reverses the credit note in the tax provider and excludes it from revenue. Accessible to the owning merchant or platform operators.
+   */
+  async voidInvoiceRefund(
+    request: operations.VoidInvoiceRefundRequest,
+    options?: RequestOptions,
+  ): Promise<models.InvoiceRefund> {
+    return unwrapAsync(invoicesV2VoidInvoiceRefund(
+      this,
+      request,
+      options,
+    ));
+  }
 }