@moovio/sdk 26.2.3 → 26.2.6

package/src/models/components/fileuploadmetadata.ts

@@ -0,0 +1,73 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Additional metadata to be stored with the file.
+ */
+export type FileUploadMetadata = {
+  /**
+   * The representative ID that the file is for. Required when filePurpose is `representativeVerification`.
+   */
+  representativeId?: string | undefined;
+  /**
+   * Comments or notes about the file.
+   */
+  comment?: string | undefined;
+};
+
+/** @internal */
+export const FileUploadMetadata$inboundSchema: z.ZodType<
+  FileUploadMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  representative_id: z.string().optional(),
+  comment: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "representative_id": "representativeId",
+  });
+});
+/** @internal */
+export type FileUploadMetadata$Outbound = {
+  representative_id?: string | undefined;
+  comment?: string | undefined;
+};
+
+/** @internal */
+export const FileUploadMetadata$outboundSchema: z.ZodType<
+  FileUploadMetadata$Outbound,
+  z.ZodTypeDef,
+  FileUploadMetadata
+> = z.object({
+  representativeId: z.string().optional(),
+  comment: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    representativeId: "representative_id",
+  });
+});
+
+export function fileUploadMetadataToJSON(
+  fileUploadMetadata: FileUploadMetadata,
+): string {
+  return JSON.stringify(
+    FileUploadMetadata$outboundSchema.parse(fileUploadMetadata),
+  );
+}
+export function fileUploadMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<FileUploadMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FileUploadMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FileUploadMetadata' from JSON`,
+  );
+}

package/src/models/components/fileuploadrequestmultipart.ts

@@ -12,6 +12,12 @@ import {
   FilePurpose$inboundSchema,
   FilePurpose$outboundSchema,
 } from "./filepurpose.js";
+import {
+  FileUploadMetadata,
+  FileUploadMetadata$inboundSchema,
+  FileUploadMetadata$Outbound,
+  FileUploadMetadata$outboundSchema,
+} from "./fileuploadmetadata.js";
 
 export type FileUploadRequestMultiPartFile = {
   fileName: string;
@@ -20,7 +26,7 @@ export type FileUploadRequestMultiPartFile = {
 
 export type FileUploadRequestMultiPart = {
   /**
-   * The file to be added. Valid types are `csv`, `png`, `jpeg`, `pdf`.
+   * The file to upload. Valid types are `csv`, `png`, `jpeg`, `pdf`.
    */
   file: FileUploadRequestMultiPartFile | Blob;
   /**
@@ -28,13 +34,9 @@ export type FileUploadRequestMultiPart = {
    */
   filePurpose: FilePurpose;
   /**
-   * Additional metadata to be stored with the file, formatted as a JSON string.
-   *
-   * @remarks
-   *
-   * Valid keys are `representative_id`, `comment`, `requirement_id`, `error_code`.
+   * Additional metadata to be stored with the file.
    */
-  metadata?: string | undefined;
+  metadata?: FileUploadMetadata | undefined;
 };
 
 /** @internal */
@@ -99,13 +101,13 @@ export const FileUploadRequestMultiPart$inboundSchema: z.ZodType<
 > = z.object({
   file: z.lazy(() => FileUploadRequestMultiPartFile$inboundSchema),
   filePurpose: FilePurpose$inboundSchema,
-  metadata: z.string().optional(),
+  metadata: FileUploadMetadata$inboundSchema.optional(),
 });
 /** @internal */
 export type FileUploadRequestMultiPart$Outbound = {
   file: FileUploadRequestMultiPartFile$Outbound | Blob;
   filePurpose: string;
-  metadata?: string | undefined;
+  metadata?: FileUploadMetadata$Outbound | undefined;
 };
 
 /** @internal */
@@ -118,7 +120,7 @@ export const FileUploadRequestMultiPart$outboundSchema: z.ZodType<
     blobLikeSchema,
   ),
   filePurpose: FilePurpose$outboundSchema,
-  metadata: z.string().optional(),
+  metadata: FileUploadMetadata$outboundSchema.optional(),
 });
 
 export function fileUploadRequestMultiPartToJSON(

package/src/models/components/index.ts

@@ -232,6 +232,7 @@ export * from "./feeproperties.js";
 export * from "./filedetails.js";
 export * from "./filepurpose.js";
 export * from "./filestatus.js";
+export * from "./fileuploadmetadata.js";
 export * from "./fileuploadrequestmultipart.js";
 export * from "./financialinstitutions.js";
 export * from "./fulfillment.js";
@@ -405,6 +406,7 @@ export * from "./rtpfailurecode.js";
 export * from "./rtpinstitution.js";
 export * from "./rtprejectioncode.js";
 export * from "./rtpservices.js";
+export * from "./rtptransactiondetails.js";
 export * from "./rtptransactionstatus.js";
 export * from "./runtransfer.js";
 export * from "./scheduledtransferimagemetadata.js";

package/src/models/components/paymentlink.ts

@@ -134,7 +134,7 @@ export type PaymentLink = {
    * An optional collection of line items for a payment link.
    *
    * @remarks
-   * When line items are provided, their total plus sales tax must equal the payment link amount.
+   * When line items are provided, their total plus tax must equal the payment link amount.
    */
   lineItems?: PaymentLinkLineItems | undefined;
   createdOn: Date;

package/src/models/components/paymentlinklineitems.ts

@@ -17,7 +17,7 @@ import {
  * An optional collection of line items for a payment link.
  *
  * @remarks
- * When line items are provided, their total plus sales tax must equal the payment link amount.
+ * When line items are provided, their total plus tax must equal the payment link amount.
  */
 export type PaymentLinkLineItems = {
   /**

package/src/models/components/rtptransactiondetails.ts

@@ -0,0 +1,104 @@
+/*
+ * 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  RTPFailureCode,
+  RTPFailureCode$inboundSchema,
+  RTPFailureCode$outboundSchema,
+} from "./rtpfailurecode.js";
+import {
+  RTPTransactionStatus,
+  RTPTransactionStatus$inboundSchema,
+  RTPTransactionStatus$outboundSchema,
+} from "./rtptransactionstatus.js";
+
+/**
+ * DEPRECATED: use `InstantBankTransactionDetails` instead (v2026.04.00 or later). RTP specific details about the transaction.
+ *
+ * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
+ */
+export type RTPTransactionDetails = {
+  /**
+   * Status of a transaction within the RTP lifecycle.
+   */
+  status?: RTPTransactionStatus | undefined;
+  /**
+   * Response code returned by network on failure.
+   */
+  networkResponseCode?: string | undefined;
+  /**
+   * Status codes for RTP failures.
+   */
+  failureCode?: RTPFailureCode | undefined;
+  initiatedOn?: Date | undefined;
+  completedOn?: Date | undefined;
+  failedOn?: Date | undefined;
+  acceptedWithoutPostingOn?: Date | undefined;
+};
+
+/** @internal */
+export const RTPTransactionDetails$inboundSchema: z.ZodType<
+  RTPTransactionDetails,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status: RTPTransactionStatus$inboundSchema.optional(),
+  networkResponseCode: z.string().optional(),
+  failureCode: RTPFailureCode$inboundSchema.optional(),
+  initiatedOn: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  completedOn: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  failedOn: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  acceptedWithoutPostingOn: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+});
+/** @internal */
+export type RTPTransactionDetails$Outbound = {
+  status?: string | undefined;
+  networkResponseCode?: string | undefined;
+  failureCode?: string | undefined;
+  initiatedOn?: string | undefined;
+  completedOn?: string | undefined;
+  failedOn?: string | undefined;
+  acceptedWithoutPostingOn?: string | undefined;
+};
+
+/** @internal */
+export const RTPTransactionDetails$outboundSchema: z.ZodType<
+  RTPTransactionDetails$Outbound,
+  z.ZodTypeDef,
+  RTPTransactionDetails
+> = z.object({
+  status: RTPTransactionStatus$outboundSchema.optional(),
+  networkResponseCode: z.string().optional(),
+  failureCode: RTPFailureCode$outboundSchema.optional(),
+  initiatedOn: z.date().transform(v => v.toISOString()).optional(),
+  completedOn: z.date().transform(v => v.toISOString()).optional(),
+  failedOn: z.date().transform(v => v.toISOString()).optional(),
+  acceptedWithoutPostingOn: z.date().transform(v => v.toISOString()).optional(),
+});
+
+export function rtpTransactionDetailsToJSON(
+  rtpTransactionDetails: RTPTransactionDetails,
+): string {
+  return JSON.stringify(
+    RTPTransactionDetails$outboundSchema.parse(rtpTransactionDetails),
+  );
+}
+export function rtpTransactionDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<RTPTransactionDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RTPTransactionDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RTPTransactionDetails' from JSON`,
+  );
+}

package/src/models/components/transfer.ts

@@ -145,7 +145,7 @@ export type Transfer = {
    * An optional collection of line items for a transfer.
    *
    * @remarks
-   * When line items are provided, their total plus sales tax must equal the transfer amount.
+   * When line items are provided, their total plus tax must equal the transfer amount.
    */
   lineItems?: TransferLineItems | undefined;
 };

package/src/models/components/transferdestination.ts

@@ -31,15 +31,11 @@ import {
   InstantBankTransactionDetails$outboundSchema,
 } from "./instantbanktransactiondetails.js";
 import {
-  RTPFailureCode,
-  RTPFailureCode$inboundSchema,
-  RTPFailureCode$outboundSchema,
-} from "./rtpfailurecode.js";
-import {
-  RTPTransactionStatus,
-  RTPTransactionStatus$inboundSchema,
-  RTPTransactionStatus$outboundSchema,
-} from "./rtptransactionstatus.js";
+  RTPTransactionDetails,
+  RTPTransactionDetails$inboundSchema,
+  RTPTransactionDetails$Outbound,
+  RTPTransactionDetails$outboundSchema,
+} from "./rtptransactiondetails.js";
 import {
   TransferAccount,
   TransferAccount$inboundSchema,
@@ -70,30 +66,6 @@ import {
   TransferPaymentMethodType$outboundSchema,
 } from "./transferpaymentmethodtype.js";
 
-/**
- * DEPRECATED: use `InstantBankTransactionDetails` instead (v2026.04.00 or later). RTP specific details about the transaction.
- *
- * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
- */
-export type RtpDetails = {
-  /**
-   * Status of a transaction within the RTP lifecycle.
-   */
-  status?: RTPTransactionStatus | undefined;
-  /**
-   * Response code returned by network on failure.
-   */
-  networkResponseCode?: string | undefined;
-  /**
-   * Status codes for RTP failures.
-   */
-  failureCode?: RTPFailureCode | undefined;
-  initiatedOn?: Date | undefined;
-  completedOn?: Date | undefined;
-  failedOn?: Date | undefined;
-  acceptedWithoutPostingOn?: Date | undefined;
-};
-
 export type TransferDestination = {
   paymentMethodID: string;
   /**
@@ -123,73 +95,17 @@ export type TransferDestination = {
    */
   cardDetails?: CardTransactionDetails | undefined;
   /**
+   * DEPRECATED: use `InstantBankTransactionDetails` instead (v2026.04.00 or later). RTP specific details about the transaction.
+   *
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
-  rtpDetails?: RtpDetails | undefined;
+  rtpDetails?: RTPTransactionDetails | undefined;
   /**
    * Instant-bank specific details about the transaction.
    */
   instantBankDetails?: InstantBankTransactionDetails | undefined;
 };
 
-/** @internal */
-export const RtpDetails$inboundSchema: z.ZodType<
-  RtpDetails,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  status: RTPTransactionStatus$inboundSchema.optional(),
-  networkResponseCode: z.string().optional(),
-  failureCode: RTPFailureCode$inboundSchema.optional(),
-  initiatedOn: z.string().datetime({ offset: true }).transform(v => new Date(v))
-    .optional(),
-  completedOn: z.string().datetime({ offset: true }).transform(v => new Date(v))
-    .optional(),
-  failedOn: z.string().datetime({ offset: true }).transform(v => new Date(v))
-    .optional(),
-  acceptedWithoutPostingOn: z.string().datetime({ offset: true }).transform(v =>
-    new Date(v)
-  ).optional(),
-});
-/** @internal */
-export type RtpDetails$Outbound = {
-  status?: string | undefined;
-  networkResponseCode?: string | undefined;
-  failureCode?: string | undefined;
-  initiatedOn?: string | undefined;
-  completedOn?: string | undefined;
-  failedOn?: string | undefined;
-  acceptedWithoutPostingOn?: string | undefined;
-};
-
-/** @internal */
-export const RtpDetails$outboundSchema: z.ZodType<
-  RtpDetails$Outbound,
-  z.ZodTypeDef,
-  RtpDetails
-> = z.object({
-  status: RTPTransactionStatus$outboundSchema.optional(),
-  networkResponseCode: z.string().optional(),
-  failureCode: RTPFailureCode$outboundSchema.optional(),
-  initiatedOn: z.date().transform(v => v.toISOString()).optional(),
-  completedOn: z.date().transform(v => v.toISOString()).optional(),
-  failedOn: z.date().transform(v => v.toISOString()).optional(),
-  acceptedWithoutPostingOn: z.date().transform(v => v.toISOString()).optional(),
-});
-
-export function rtpDetailsToJSON(rtpDetails: RtpDetails): string {
-  return JSON.stringify(RtpDetails$outboundSchema.parse(rtpDetails));
-}
-export function rtpDetailsFromJSON(
-  jsonString: string,
-): SafeParseResult<RtpDetails, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => RtpDetails$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'RtpDetails' from JSON`,
-  );
-}
-
 /** @internal */
 export const TransferDestination$inboundSchema: z.ZodType<
   TransferDestination,
@@ -205,7 +121,7 @@ export const TransferDestination$inboundSchema: z.ZodType<
   achDetails: ACHTransactionDetails$inboundSchema.optional(),
   applePay: ApplePayResponse$inboundSchema.optional(),
   cardDetails: CardTransactionDetails$inboundSchema.optional(),
-  rtpDetails: z.lazy(() => RtpDetails$inboundSchema).optional(),
+  rtpDetails: RTPTransactionDetails$inboundSchema.optional(),
   instantBankDetails: InstantBankTransactionDetails$inboundSchema.optional(),
 });
 /** @internal */
@@ -219,7 +135,7 @@ export type TransferDestination$Outbound = {
   achDetails?: ACHTransactionDetails$Outbound | undefined;
   applePay?: ApplePayResponse$Outbound | undefined;
   cardDetails?: CardTransactionDetails$Outbound | undefined;
-  rtpDetails?: RtpDetails$Outbound | undefined;
+  rtpDetails?: RTPTransactionDetails$Outbound | undefined;
   instantBankDetails?: InstantBankTransactionDetails$Outbound | undefined;
 };
 
@@ -238,7 +154,7 @@ export const TransferDestination$outboundSchema: z.ZodType<
   achDetails: ACHTransactionDetails$outboundSchema.optional(),
   applePay: ApplePayResponse$outboundSchema.optional(),
   cardDetails: CardTransactionDetails$outboundSchema.optional(),
-  rtpDetails: z.lazy(() => RtpDetails$outboundSchema).optional(),
+  rtpDetails: RTPTransactionDetails$outboundSchema.optional(),
   instantBankDetails: InstantBankTransactionDetails$outboundSchema.optional(),
 });
 

package/src/models/components/transferlineitems.ts

@@ -17,7 +17,7 @@ import {
  * An optional collection of line items for a transfer.
  *
  * @remarks
- * When line items are provided, their total plus sales tax must equal the transfer amount.
+ * When line items are provided, their total plus tax must equal the transfer amount.
  */
 export type TransferLineItems = {
   /**

package/src/models/components/updatepaymentlink.ts

@@ -61,7 +61,7 @@ export type UpdatePaymentLink = {
    * An optional collection of line items for a payment link.
    *
    * @remarks
-   * When line items are provided, their total plus sales tax must equal the payment link amount.
+   * When line items are provided, their total plus tax must equal the payment link amount.
    */
   lineItems?: CreatePaymentLinkLineItemsUpdate | undefined;
 };

package/src/models/components/webhookdata.ts

@@ -239,6 +239,7 @@ export type WebhookData =
   | WebhookDataBankAccountUpdated
   | WebhookDataRefundUpdated
   | WebhookDataWalletTransactionUpdated
+  | WebhookDataBankAccountCreated
   | WebhookDataCancellationCreated
   | WebhookDataCancellationUpdated
   | WebhookDataCardAutoUpdated
@@ -252,7 +253,6 @@ export type WebhookData =
   | WebhookDataTransferCreated
   | WebhookDataWalletUpdated
   | WebhookDataBalanceUpdated
-  | WebhookDataBankAccountCreated
   | WebhookDataBankAccountDeleted
   | WebhookDataCapabilityRequested
   | WebhookDataInvoiceCreated
@@ -283,6 +283,7 @@ export const WebhookData$inboundSchema: z.ZodType<
   WebhookDataBankAccountUpdated$inboundSchema,
   WebhookDataRefundUpdated$inboundSchema,
   WebhookDataWalletTransactionUpdated$inboundSchema,
+  WebhookDataBankAccountCreated$inboundSchema,
   WebhookDataCancellationCreated$inboundSchema,
   WebhookDataCancellationUpdated$inboundSchema,
   WebhookDataCardAutoUpdated$inboundSchema,
@@ -296,7 +297,6 @@ export const WebhookData$inboundSchema: z.ZodType<
   WebhookDataTransferCreated$inboundSchema,
   WebhookDataWalletUpdated$inboundSchema,
   WebhookDataBalanceUpdated$inboundSchema,
-  WebhookDataBankAccountCreated$inboundSchema,
   WebhookDataBankAccountDeleted$inboundSchema,
   WebhookDataCapabilityRequested$inboundSchema,
   WebhookDataInvoiceCreated$inboundSchema,
@@ -323,6 +323,7 @@ export type WebhookData$Outbound =
   | WebhookDataBankAccountUpdated$Outbound
   | WebhookDataRefundUpdated$Outbound
   | WebhookDataWalletTransactionUpdated$Outbound
+  | WebhookDataBankAccountCreated$Outbound
   | WebhookDataCancellationCreated$Outbound
   | WebhookDataCancellationUpdated$Outbound
   | WebhookDataCardAutoUpdated$Outbound
@@ -336,7 +337,6 @@ export type WebhookData$Outbound =
   | WebhookDataTransferCreated$Outbound
   | WebhookDataWalletUpdated$Outbound
   | WebhookDataBalanceUpdated$Outbound
-  | WebhookDataBankAccountCreated$Outbound
   | WebhookDataBankAccountDeleted$Outbound
   | WebhookDataCapabilityRequested$Outbound
   | WebhookDataInvoiceCreated$Outbound
@@ -367,6 +367,7 @@ export const WebhookData$outboundSchema: z.ZodType<
   WebhookDataBankAccountUpdated$outboundSchema,
   WebhookDataRefundUpdated$outboundSchema,
   WebhookDataWalletTransactionUpdated$outboundSchema,
+  WebhookDataBankAccountCreated$outboundSchema,
   WebhookDataCancellationCreated$outboundSchema,
   WebhookDataCancellationUpdated$outboundSchema,
   WebhookDataCardAutoUpdated$outboundSchema,
@@ -380,7 +381,6 @@ export const WebhookData$outboundSchema: z.ZodType<
   WebhookDataTransferCreated$outboundSchema,
   WebhookDataWalletUpdated$outboundSchema,
   WebhookDataBalanceUpdated$outboundSchema,
-  WebhookDataBankAccountCreated$outboundSchema,
   WebhookDataBankAccountDeleted$outboundSchema,
   WebhookDataCapabilityRequested$outboundSchema,
   WebhookDataInvoiceCreated$outboundSchema,

package/src/models/components/webhookdatabankaccountcreated.ts

@@ -6,10 +6,16 @@ import * as z from "zod/v3";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  BankAccountStatus,
+  BankAccountStatus$inboundSchema,
+  BankAccountStatus$outboundSchema,
+} from "./bankaccountstatus.js";
 
 export type WebhookDataBankAccountCreated = {
   bankAccountID: string;
   accountID: string;
+  status: BankAccountStatus;
 };
 
 /** @internal */
@@ -20,11 +26,13 @@ export const WebhookDataBankAccountCreated$inboundSchema: z.ZodType<
 > = z.object({
   bankAccountID: z.string(),
   accountID: z.string(),
+  status: BankAccountStatus$inboundSchema,
 });
 /** @internal */
 export type WebhookDataBankAccountCreated$Outbound = {
   bankAccountID: string;
   accountID: string;
+  status: string;
 };
 
 /** @internal */
@@ -35,6 +43,7 @@ export const WebhookDataBankAccountCreated$outboundSchema: z.ZodType<
 > = z.object({
   bankAccountID: z.string(),
   accountID: z.string(),
+  status: BankAccountStatus$outboundSchema,
 });
 
 export function webhookDataBankAccountCreatedToJSON(

package/src/models/errors/transfer.ts

@@ -74,7 +74,7 @@ export type TransferData = {
    * An optional collection of line items for a transfer.
    *
    * @remarks
-   * When line items are provided, their total plus sales tax must equal the transfer amount.
+   * When line items are provided, their total plus tax must equal the transfer amount.
    */
   lineItems?: components.TransferLineItems | undefined;
 };
@@ -147,7 +147,7 @@ export class Transfer extends MoovError {
    * An optional collection of line items for a transfer.
    *
    * @remarks
-   * When line items are provided, their total plus sales tax must equal the transfer amount.
+   * When line items are provided, their total plus tax must equal the transfer amount.
    */
   lineItems?: components.TransferLineItems | undefined;