@moovio/sdk 26.10.0-dev.2 → 26.10.0-dev.4

package/src/models/components/wirecreditpaymentmethod.ts

@@ -0,0 +1,75 @@
+/*
+ * 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 * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PaymentMethodsBankAccount,
+  PaymentMethodsBankAccount$inboundSchema,
+  PaymentMethodsBankAccount$Outbound,
+  PaymentMethodsBankAccount$outboundSchema,
+} from "./paymentmethodsbankaccount.js";
+
+/**
+ * Send funds to a bank account by wire transfer.
+ */
+export type WireCreditPaymentMethod = {
+  /**
+   * ID of the payment method.
+   */
+  paymentMethodID: string;
+  paymentMethodType: "wire-credit";
+  /**
+   * A bank account as contained within a payment method.
+   */
+  bankAccount: PaymentMethodsBankAccount;
+};
+
+/** @internal */
+export const WireCreditPaymentMethod$inboundSchema: z.ZodType<
+  WireCreditPaymentMethod,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  paymentMethodID: types.string(),
+  paymentMethodType: types.literal("wire-credit"),
+  bankAccount: PaymentMethodsBankAccount$inboundSchema,
+});
+/** @internal */
+export type WireCreditPaymentMethod$Outbound = {
+  paymentMethodID: string;
+  paymentMethodType: "wire-credit";
+  bankAccount: PaymentMethodsBankAccount$Outbound;
+};
+
+/** @internal */
+export const WireCreditPaymentMethod$outboundSchema: z.ZodType<
+  WireCreditPaymentMethod$Outbound,
+  z.ZodTypeDef,
+  WireCreditPaymentMethod
+> = z.object({
+  paymentMethodID: z.string(),
+  paymentMethodType: z.literal("wire-credit"),
+  bankAccount: PaymentMethodsBankAccount$outboundSchema,
+});
+
+export function wireCreditPaymentMethodToJSON(
+  wireCreditPaymentMethod: WireCreditPaymentMethod,
+): string {
+  return JSON.stringify(
+    WireCreditPaymentMethod$outboundSchema.parse(wireCreditPaymentMethod),
+  );
+}
+export function wireCreditPaymentMethodFromJSON(
+  jsonString: string,
+): SafeParseResult<WireCreditPaymentMethod, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WireCreditPaymentMethod$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WireCreditPaymentMethod' from JSON`,
+  );
+}

package/src/models/components/wirecredittransferpaymentmethod.ts

@@ -0,0 +1,77 @@
+/*
+ * 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 * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  TransferPaymentMethodsBankAccount,
+  TransferPaymentMethodsBankAccount$inboundSchema,
+  TransferPaymentMethodsBankAccount$Outbound,
+  TransferPaymentMethodsBankAccount$outboundSchema,
+} from "./transferpaymentmethodsbankaccount.js";
+
+/**
+ * Send funds to a bank account by wire transfer.
+ */
+export type WireCreditTransferPaymentMethod = {
+  /**
+   * ID of the payment method.
+   */
+  paymentMethodID: string;
+  paymentMethodType: "wire-credit";
+  /**
+   * A bank account as contained within a payment method.
+   */
+  bankAccount: TransferPaymentMethodsBankAccount;
+};
+
+/** @internal */
+export const WireCreditTransferPaymentMethod$inboundSchema: z.ZodType<
+  WireCreditTransferPaymentMethod,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  paymentMethodID: types.string(),
+  paymentMethodType: types.literal("wire-credit"),
+  bankAccount: TransferPaymentMethodsBankAccount$inboundSchema,
+});
+/** @internal */
+export type WireCreditTransferPaymentMethod$Outbound = {
+  paymentMethodID: string;
+  paymentMethodType: "wire-credit";
+  bankAccount: TransferPaymentMethodsBankAccount$Outbound;
+};
+
+/** @internal */
+export const WireCreditTransferPaymentMethod$outboundSchema: z.ZodType<
+  WireCreditTransferPaymentMethod$Outbound,
+  z.ZodTypeDef,
+  WireCreditTransferPaymentMethod
+> = z.object({
+  paymentMethodID: z.string(),
+  paymentMethodType: z.literal("wire-credit"),
+  bankAccount: TransferPaymentMethodsBankAccount$outboundSchema,
+});
+
+export function wireCreditTransferPaymentMethodToJSON(
+  wireCreditTransferPaymentMethod: WireCreditTransferPaymentMethod,
+): string {
+  return JSON.stringify(
+    WireCreditTransferPaymentMethod$outboundSchema.parse(
+      wireCreditTransferPaymentMethod,
+    ),
+  );
+}
+export function wireCreditTransferPaymentMethodFromJSON(
+  jsonString: string,
+): SafeParseResult<WireCreditTransferPaymentMethod, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WireCreditTransferPaymentMethod$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WireCreditTransferPaymentMethod' from JSON`,
+  );
+}

package/src/models/components/wirefailurecode.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * Status codes for wire failures.
+ */
+export const WireFailureCode = {
+  ProcessingError: "processing-error",
+  InvalidAccount: "invalid-account",
+  AccountClosed: "account-closed",
+  AccountBlocked: "account-blocked",
+  InvalidField: "invalid-field",
+  TransactionNotSupported: "transaction-not-supported",
+  LimitExceeded: "limit-exceeded",
+  InvalidAmount: "invalid-amount",
+  Other: "other",
+} as const;
+/**
+ * Status codes for wire failures.
+ */
+export type WireFailureCode = OpenEnum<typeof WireFailureCode>;
+
+/** @internal */
+export const WireFailureCode$inboundSchema: z.ZodType<
+  WireFailureCode,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(WireFailureCode);
+/** @internal */
+export const WireFailureCode$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  WireFailureCode
+> = openEnums.outboundSchema(WireFailureCode);

package/src/models/components/wireoptions.ts

@@ -0,0 +1,54 @@
+/*
+ * 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 * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Wire-specific options returned on a transfer.
+ */
+export type WireOptions = {
+  /**
+   * Optional beneficiary reference for the wire transfer. Maximum 15 characters.
+   */
+  beneficiaryReference?: string | undefined;
+};
+
+/** @internal */
+export const WireOptions$inboundSchema: z.ZodType<
+  WireOptions,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  beneficiaryReference: types.optional(types.string()),
+});
+/** @internal */
+export type WireOptions$Outbound = {
+  beneficiaryReference?: string | undefined;
+};
+
+/** @internal */
+export const WireOptions$outboundSchema: z.ZodType<
+  WireOptions$Outbound,
+  z.ZodTypeDef,
+  WireOptions
+> = z.object({
+  beneficiaryReference: z.string().optional(),
+});
+
+export function wireOptionsToJSON(wireOptions: WireOptions): string {
+  return JSON.stringify(WireOptions$outboundSchema.parse(wireOptions));
+}
+export function wireOptionsFromJSON(
+  jsonString: string,
+): SafeParseResult<WireOptions, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WireOptions$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WireOptions' from JSON`,
+  );
+}

package/src/models/components/wiretransactionstatus.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * Status of a transaction within the wire lifecycle.
+ */
+export const WireTransactionStatus = {
+  Initiated: "initiated",
+  Completed: "completed",
+  Failed: "failed",
+  Returned: "returned",
+} as const;
+/**
+ * Status of a transaction within the wire lifecycle.
+ */
+export type WireTransactionStatus = OpenEnum<typeof WireTransactionStatus>;
+
+/** @internal */
+export const WireTransactionStatus$inboundSchema: z.ZodType<
+  WireTransactionStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(WireTransactionStatus);
+/** @internal */
+export const WireTransactionStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  WireTransactionStatus
+> = openEnums.outboundSchema(WireTransactionStatus);

package/src/models/components/wiretransferprocessingdetails.ts

@@ -0,0 +1,84 @@
+/*
+ * 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 * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  WireFailureCode,
+  WireFailureCode$inboundSchema,
+  WireFailureCode$outboundSchema,
+} from "./wirefailurecode.js";
+import {
+  WireTransactionStatus,
+  WireTransactionStatus$inboundSchema,
+  WireTransactionStatus$outboundSchema,
+} from "./wiretransactionstatus.js";
+
+/**
+ * Wire-specific processing details returned on a transfer.
+ */
+export type WireTransferProcessingDetails = {
+  /**
+   * Status of a transaction within the wire lifecycle.
+   */
+  status: WireTransactionStatus;
+  /**
+   * Response code returned by the network on failure.
+   */
+  networkResponseCode?: string | undefined;
+  /**
+   * Status codes for wire failures.
+   */
+  failureCode?: WireFailureCode | undefined;
+};
+
+/** @internal */
+export const WireTransferProcessingDetails$inboundSchema: z.ZodType<
+  WireTransferProcessingDetails,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status: WireTransactionStatus$inboundSchema,
+  networkResponseCode: types.optional(types.string()),
+  failureCode: types.optional(WireFailureCode$inboundSchema),
+});
+/** @internal */
+export type WireTransferProcessingDetails$Outbound = {
+  status: string;
+  networkResponseCode?: string | undefined;
+  failureCode?: string | undefined;
+};
+
+/** @internal */
+export const WireTransferProcessingDetails$outboundSchema: z.ZodType<
+  WireTransferProcessingDetails$Outbound,
+  z.ZodTypeDef,
+  WireTransferProcessingDetails
+> = z.object({
+  status: WireTransactionStatus$outboundSchema,
+  networkResponseCode: z.string().optional(),
+  failureCode: WireFailureCode$outboundSchema.optional(),
+});
+
+export function wireTransferProcessingDetailsToJSON(
+  wireTransferProcessingDetails: WireTransferProcessingDetails,
+): string {
+  return JSON.stringify(
+    WireTransferProcessingDetails$outboundSchema.parse(
+      wireTransferProcessingDetails,
+    ),
+  );
+}
+export function wireTransferProcessingDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<WireTransferProcessingDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WireTransferProcessingDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WireTransferProcessingDetails' from JSON`,
+  );
+}

package/src/models/errors/bankaccountattestationvalidationerror.ts

@@ -0,0 +1,91 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as types from "../../types/primitives.js";
+import { MoovError } from "./mooverror.js";
+
+/**
+ * Describes which fields of a bank account attestation request failed validation.
+ */
+export type BankAccountAttestationValidationErrorData = {
+  /**
+   * Populated when `attestedAt` is missing, malformed, before the bank account's most recent R29 return, or a future date.
+   */
+  attestedAt?: string | undefined;
+  /**
+   * Populated when `description` is missing or exceeds the maximum length.
+   */
+  description?: string | undefined;
+};
+
+/**
+ * Describes which fields of a bank account attestation request failed validation.
+ */
+export class BankAccountAttestationValidationError extends MoovError {
+  /**
+   * Populated when `attestedAt` is missing, malformed, before the bank account's most recent R29 return, or a future date.
+   */
+  attestedAt?: string | undefined;
+  /**
+   * Populated when `description` is missing or exceeds the maximum length.
+   */
+  description?: string | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: BankAccountAttestationValidationErrorData;
+
+  constructor(
+    err: BankAccountAttestationValidationErrorData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    if (err.attestedAt != null) this.attestedAt = err.attestedAt;
+    if (err.description != null) this.description = err.description;
+
+    this.name = "BankAccountAttestationValidationError";
+  }
+}
+
+/** @internal */
+export const BankAccountAttestationValidationError$inboundSchema: z.ZodType<
+  BankAccountAttestationValidationError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  attestedAt: types.optional(types.string()),
+  description: types.optional(types.string()),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new BankAccountAttestationValidationError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type BankAccountAttestationValidationError$Outbound = {
+  attestedAt?: string | undefined;
+  description?: string | undefined;
+};
+
+/** @internal */
+export const BankAccountAttestationValidationError$outboundSchema: z.ZodType<
+  BankAccountAttestationValidationError$Outbound,
+  z.ZodTypeDef,
+  BankAccountAttestationValidationError
+> = z.instanceof(BankAccountAttestationValidationError)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    attestedAt: z.string().optional(),
+    description: z.string().optional(),
+  }));

package/src/models/errors/cardacquiringrefund.ts

@@ -20,7 +20,7 @@ export type CardAcquiringRefundData = {
   status: components.RefundStatus;
   amount: components.AmountDecimal;
   /**
-   * ID of the capture this refund applies to, when applicable.
+   * ID of the capture refunded for an auth-capture `card-payment` transfer.
    */
   captureID?: string | undefined;
   amountDetails?: components.RefundAmountDetails | undefined;
@@ -40,7 +40,7 @@ export class CardAcquiringRefund extends MoovError {
   status: components.RefundStatus;
   amount: components.AmountDecimal;
   /**
-   * ID of the capture this refund applies to, when applicable.
+   * ID of the capture refunded for an auth-capture `card-payment` transfer.
    */
   captureID?: string | undefined;
   amountDetails?: components.RefundAmountDetails | undefined;

package/src/models/errors/imagemetadata.ts

@@ -0,0 +1,139 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as types from "../../types/primitives.js";
+import { MoovError } from "./mooverror.js";
+
+/**
+ * Metadata about an uploaded image.
+ */
+export type ImageMetadataData = {
+  /**
+   * Unique identifier for a image resource.
+   */
+  imageID: string;
+  /**
+   * The ID used to get an image with the public endpoint.
+   */
+  publicID: string;
+  /**
+   * Alternative text for the image.
+   */
+  altText?: string | undefined;
+  /**
+   * A public URL to access the image. An optional `size={width}x{height}`
+   *
+   * @remarks
+   * query parameter can be provided to resize the image.
+   */
+  link: string;
+  createdOn: Date;
+  updatedOn: Date;
+  disabledOn?: Date | undefined;
+};
+
+/**
+ * Metadata about an uploaded image.
+ */
+export class ImageMetadata extends MoovError {
+  /**
+   * Unique identifier for a image resource.
+   */
+  imageID: string;
+  /**
+   * The ID used to get an image with the public endpoint.
+   */
+  publicID: string;
+  /**
+   * Alternative text for the image.
+   */
+  altText?: string | undefined;
+  /**
+   * A public URL to access the image. An optional `size={width}x{height}`
+   *
+   * @remarks
+   * query parameter can be provided to resize the image.
+   */
+  link: string;
+  createdOn: Date;
+  updatedOn: Date;
+  disabledOn?: Date | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: ImageMetadataData;
+
+  constructor(
+    err: ImageMetadataData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.imageID = err.imageID;
+    this.publicID = err.publicID;
+    if (err.altText != null) this.altText = err.altText;
+    this.link = err.link;
+    this.createdOn = err.createdOn;
+    this.updatedOn = err.updatedOn;
+    if (err.disabledOn != null) this.disabledOn = err.disabledOn;
+
+    this.name = "ImageMetadata";
+  }
+}
+
+/** @internal */
+export const ImageMetadata$inboundSchema: z.ZodType<
+  ImageMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  imageID: types.string(),
+  publicID: types.string(),
+  altText: types.optional(types.string()),
+  link: types.string(),
+  createdOn: types.date(),
+  updatedOn: types.date(),
+  disabledOn: types.optional(types.date()),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new ImageMetadata(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type ImageMetadata$Outbound = {
+  imageID: string;
+  publicID: string;
+  altText?: string | undefined;
+  link: string;
+  createdOn: string;
+  updatedOn: string;
+  disabledOn?: string | undefined;
+};
+
+/** @internal */
+export const ImageMetadata$outboundSchema: z.ZodType<
+  ImageMetadata$Outbound,
+  z.ZodTypeDef,
+  ImageMetadata
+> = z.instanceof(ImageMetadata)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    imageID: z.string(),
+    publicID: z.string(),
+    altText: z.string().optional(),
+    link: z.string(),
+    createdOn: z.date().transform(v => v.toISOString()),
+    updatedOn: z.date().transform(v => v.toISOString()),
+    disabledOn: z.date().transform(v => v.toISOString()).optional(),
+  }));

package/src/models/errors/index.ts

@@ -7,6 +7,7 @@ export * from "./addcapabilitieserror.js";
 export * from "./apierror.js";
 export * from "./assigncountrieserror.js";
 export * from "./authtokenrequesterror.js";
+export * from "./bankaccountattestationvalidationerror.js";
 export * from "./bankaccountvalidationerror.js";
 export * from "./brandvalidationerror.js";
 export * from "./capturevalidationerror.js";
@@ -29,6 +30,7 @@ export * from "./fileuploadvalidationerror.js";
 export * from "./filevalidationerror.js";
 export * from "./genericerror.js";
 export * from "./httpclienterrors.js";
+export * from "./imagemetadata.js";
 export * from "./imagemetadatavalidationerror.js";
 export * from "./imagerequestvalidationerror.js";
 export * from "./linkapplepayerror.js";

package/src/models/errors/transfer.ts

@@ -28,6 +28,14 @@ export type TransferData = {
    * Reason for a transfer's failure.
    */
   failureReason?: components.TransferFailureReason | undefined;
+  /**
+   * Amount associated with this transfer.
+   *
+   * @remarks
+   * In v2026.10 and later, an auth-capture `card-payment` transfer reports the approved authorization amount until a final capture is created.
+   * For these transfers, when a final capture is created, this is updated to the cumulative captured amount.
+   * For other transfer types, this is the transfer amount.
+   */
   amount: components.AmountDecimal;
   /**
    * An optional description of the transfer that is used on receipts and for your own internal use.
@@ -79,6 +87,12 @@ export type TransferData = {
    */
   invoiceID?: string | undefined;
   amountDetails?: components.TransferAmountDetails | undefined;
+  /**
+   * Authorization amounts.
+   *
+   * @remarks
+   * This field is present only for an auth-capture `card-payment` transfer.
+   */
   authorization?: components.TransferAuthorization | undefined;
   options: components.TransferRailOptions;
   processingDetails: components.TransferProcessingDetails;
@@ -105,6 +119,14 @@ export class Transfer extends MoovError {
    * Reason for a transfer's failure.
    */
   failureReason?: components.TransferFailureReason | undefined;
+  /**
+   * Amount associated with this transfer.
+   *
+   * @remarks
+   * In v2026.10 and later, an auth-capture `card-payment` transfer reports the approved authorization amount until a final capture is created.
+   * For these transfers, when a final capture is created, this is updated to the cumulative captured amount.
+   * For other transfer types, this is the transfer amount.
+   */
   amount: components.AmountDecimal;
   /**
    * An optional description of the transfer that is used on receipts and for your own internal use.
@@ -156,6 +178,12 @@ export class Transfer extends MoovError {
    */
   invoiceID?: string | undefined;
   amountDetails?: components.TransferAmountDetails | undefined;
+  /**
+   * Authorization amounts.
+   *
+   * @remarks
+   * This field is present only for an auth-capture `card-payment` transfer.
+   */
   authorization?: components.TransferAuthorization | undefined;
   options: components.TransferRailOptions;
   processingDetails: components.TransferProcessingDetails;