@paygentic/sdk 0.7.17 → 0.7.19

package/src/funcs/invoicesV2CreateInvoiceRefund.ts

@@ -0,0 +1,182 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { PaygenticCore } from "../core.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { PaygenticError } from "../models/errors/paygenticerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * 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.
+ */
+export function invoicesV2CreateInvoiceRefund(
+  client: PaygenticCore,
+  request: operations.CreateInvoiceRefundRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.InvoiceRefund,
+    | errors.BadRequest
+    | errors.ErrorT
+    | PaygenticError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: PaygenticCore,
+  request: operations.CreateInvoiceRefundRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.InvoiceRefund,
+      | errors.BadRequest
+      | errors.ErrorT
+      | PaygenticError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.CreateInvoiceRefundRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.RequestBody, { explode: true });
+
+  const pathParams = {
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/v2/invoices/{id}/refunds")(pathParams);
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.bearerAuth);
+  const securityInput = secConfig == null ? {} : { bearerAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "createInvoiceRefund",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.bearerAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["400", "403", "404", "4XX", "500", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    models.InvoiceRefund,
+    | errors.BadRequest
+    | errors.ErrorT
+    | PaygenticError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(201, models.InvoiceRefund$inboundSchema),
+    M.jsonErr(400, errors.BadRequest$inboundSchema),
+    M.jsonErr([403, 404], errors.ErrorT$inboundSchema),
+    M.jsonErr(500, errors.ErrorT$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/invoicesV2ListInvoiceRefunds.ts

@@ -0,0 +1,176 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { PaygenticCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { PaygenticError } from "../models/errors/paygenticerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * List Invoice Refunds
+ *
+ * @remarks
+ * List the credit notes (refunds) recorded against an invoice. Accessible to the owning merchant or platform operators.
+ */
+export function invoicesV2ListInvoiceRefunds(
+  client: PaygenticCore,
+  request: operations.ListInvoiceRefundsRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.InvoiceRefundList,
+    | errors.ErrorT
+    | PaygenticError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: PaygenticCore,
+  request: operations.ListInvoiceRefundsRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.InvoiceRefundList,
+      | errors.ErrorT
+      | PaygenticError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.ListInvoiceRefundsRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/v2/invoices/{id}/refunds")(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.bearerAuth);
+  const securityInput = secConfig == null ? {} : { bearerAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "listInvoiceRefunds",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.bearerAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["403", "404", "4XX", "500", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    models.InvoiceRefundList,
+    | errors.ErrorT
+    | PaygenticError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.InvoiceRefundList$inboundSchema),
+    M.jsonErr([403, 404], errors.ErrorT$inboundSchema),
+    M.jsonErr(500, errors.ErrorT$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/invoicesV2VoidInvoiceRefund.ts

@@ -0,0 +1,187 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { PaygenticCore } from "../core.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { PaygenticError } from "../models/errors/paygenticerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * 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.
+ */
+export function invoicesV2VoidInvoiceRefund(
+  client: PaygenticCore,
+  request: operations.VoidInvoiceRefundRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.InvoiceRefund,
+    | errors.BadRequest
+    | errors.ErrorT
+    | PaygenticError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: PaygenticCore,
+  request: operations.VoidInvoiceRefundRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.InvoiceRefund,
+      | errors.BadRequest
+      | errors.ErrorT
+      | PaygenticError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.VoidInvoiceRefundRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.RequestBody, { explode: true });
+
+  const pathParams = {
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    refundId: encodeSimple("refundId", payload.refundId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/v2/invoices/{id}/refunds/{refundId}/void")(
+    pathParams,
+  );
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.bearerAuth);
+  const securityInput = secConfig == null ? {} : { bearerAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "voidInvoiceRefund",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.bearerAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["400", "403", "404", "4XX", "500", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    models.InvoiceRefund,
+    | errors.BadRequest
+    | errors.ErrorT
+    | PaygenticError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.InvoiceRefund$inboundSchema),
+    M.jsonErr(400, errors.BadRequest$inboundSchema),
+    M.jsonErr([403, 404], errors.ErrorT$inboundSchema),
+    M.jsonErr(500, errors.ErrorT$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -65,7 +65,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.1.0",
-  sdkVersion: "0.7.17",
+  sdkVersion: "0.7.19",
   genVersion: "2.879.13",
-  userAgent: "speakeasy-sdk/typescript 0.7.17 2.879.13 0.1.0 @paygentic/sdk",
+  userAgent: "speakeasy-sdk/typescript 0.7.19 2.879.13 0.1.0 @paygentic/sdk",
 } as const;

package/src/models/index.ts

@@ -33,6 +33,8 @@ export * from "./invoice.js";
 export * from "./invoicecategorysummary.js";
 export * from "./invoicelineitem.js";
 export * from "./invoicelineitemsresponse.js";
+export * from "./invoicerefund.js";
+export * from "./invoicerefundlist.js";
 export * from "./invoicesummary.js";
 export * from "./issueentitlementrequest.js";
 export * from "./item.js";

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`,
+  );
+}