@moovio/sdk 26.4.0-dev.3 → 26.4.0-dev.5

package/src/models/components/transferpaymentmethodsbankaccount.ts

@@ -0,0 +1,120 @@
+/*
+ * 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 {
+  BankAccountHolderType,
+  BankAccountHolderType$inboundSchema,
+  BankAccountHolderType$outboundSchema,
+} from "./bankaccountholdertype.js";
+import {
+  BankAccountStatus,
+  BankAccountStatus$inboundSchema,
+  BankAccountStatus$outboundSchema,
+} from "./bankaccountstatus.js";
+import {
+  BankAccountType,
+  BankAccountType$inboundSchema,
+  BankAccountType$outboundSchema,
+} from "./bankaccounttype.js";
+
+/**
+ * A bank account as contained within a payment method.
+ */
+export type TransferPaymentMethodsBankAccount = {
+  bankAccountID: string;
+  /**
+   * Once the bank account is linked, we don't reveal the full bank account number.
+   *
+   * @remarks
+   *
+   * The fingerprint acts as a way to identify whether two linked bank accounts are the same.
+   */
+  fingerprint: string;
+  status: BankAccountStatus;
+  holderName: string;
+  /**
+   * The type of holder on a funding source.
+   */
+  holderType: BankAccountHolderType;
+  bankName: string;
+  /**
+   * The bank account type.
+   */
+  bankAccountType: BankAccountType;
+  routingNumber: string;
+  lastFourAccountNumber: string;
+  updatedOn: Date;
+};
+
+/** @internal */
+export const TransferPaymentMethodsBankAccount$inboundSchema: z.ZodType<
+  TransferPaymentMethodsBankAccount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  bankAccountID: z.string(),
+  fingerprint: z.string(),
+  status: BankAccountStatus$inboundSchema,
+  holderName: z.string(),
+  holderType: BankAccountHolderType$inboundSchema,
+  bankName: z.string(),
+  bankAccountType: BankAccountType$inboundSchema,
+  routingNumber: z.string(),
+  lastFourAccountNumber: z.string(),
+  updatedOn: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+});
+/** @internal */
+export type TransferPaymentMethodsBankAccount$Outbound = {
+  bankAccountID: string;
+  fingerprint: string;
+  status: string;
+  holderName: string;
+  holderType: string;
+  bankName: string;
+  bankAccountType: string;
+  routingNumber: string;
+  lastFourAccountNumber: string;
+  updatedOn: string;
+};
+
+/** @internal */
+export const TransferPaymentMethodsBankAccount$outboundSchema: z.ZodType<
+  TransferPaymentMethodsBankAccount$Outbound,
+  z.ZodTypeDef,
+  TransferPaymentMethodsBankAccount
+> = z.object({
+  bankAccountID: z.string(),
+  fingerprint: z.string(),
+  status: BankAccountStatus$outboundSchema,
+  holderName: z.string(),
+  holderType: BankAccountHolderType$outboundSchema,
+  bankName: z.string(),
+  bankAccountType: BankAccountType$outboundSchema,
+  routingNumber: z.string(),
+  lastFourAccountNumber: z.string(),
+  updatedOn: z.date().transform(v => v.toISOString()),
+});
+
+export function transferPaymentMethodsBankAccountToJSON(
+  transferPaymentMethodsBankAccount: TransferPaymentMethodsBankAccount,
+): string {
+  return JSON.stringify(
+    TransferPaymentMethodsBankAccount$outboundSchema.parse(
+      transferPaymentMethodsBankAccount,
+    ),
+  );
+}
+export function transferPaymentMethodsBankAccountFromJSON(
+  jsonString: string,
+): SafeParseResult<TransferPaymentMethodsBankAccount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransferPaymentMethodsBankAccount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransferPaymentMethodsBankAccount' from JSON`,
+  );
+}

package/src/models/components/transferpaymentmethodscard.ts

@@ -0,0 +1,211 @@
+/*
+ * 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 {
+  CardAccountUpdater,
+  CardAccountUpdater$inboundSchema,
+  CardAccountUpdater$Outbound,
+  CardAccountUpdater$outboundSchema,
+} from "./cardaccountupdater.js";
+import {
+  CardAddress,
+  CardAddress$inboundSchema,
+  CardAddress$Outbound,
+  CardAddress$outboundSchema,
+} from "./cardaddress.js";
+import {
+  CardBrand,
+  CardBrand$inboundSchema,
+  CardBrand$outboundSchema,
+} from "./cardbrand.js";
+import {
+  CardExpiration,
+  CardExpiration$inboundSchema,
+  CardExpiration$Outbound,
+  CardExpiration$outboundSchema,
+} from "./cardexpiration.js";
+import {
+  CardType,
+  CardType$inboundSchema,
+  CardType$outboundSchema,
+} from "./cardtype.js";
+import {
+  CardVerification,
+  CardVerification$inboundSchema,
+  CardVerification$Outbound,
+  CardVerification$outboundSchema,
+} from "./cardverification.js";
+import {
+  DomesticPullFromCard,
+  DomesticPullFromCard$inboundSchema,
+  DomesticPullFromCard$outboundSchema,
+} from "./domesticpullfromcard.js";
+import {
+  DomesticPushToCard,
+  DomesticPushToCard$inboundSchema,
+  DomesticPushToCard$outboundSchema,
+} from "./domesticpushtocard.js";
+
+/**
+ * A card as contained within a payment method.
+ */
+export type TransferPaymentMethodsCard = {
+  /**
+   * ID of the card.
+   */
+  cardID: string;
+  /**
+   * Uniquely identifies a linked payment card or token.
+   *
+   * @remarks
+   * For Apple Pay, the fingerprint is based on the tokenized card number and may vary based on the user's device.
+   * This field can be used to identify specific payment methods across multiple accounts on your platform.
+   */
+  fingerprint: string;
+  /**
+   * The card brand.
+   */
+  brand: CardBrand;
+  /**
+   * The type of the card.
+   */
+  cardType: CardType;
+  /**
+   * Last four digits of the card number
+   */
+  lastFourCardNumber: string;
+  /**
+   * The first six to eight digits of the card number, which identifies the financial institution that issued the card.
+   */
+  bin: string;
+  /**
+   * The expiration date of the card or token.
+   */
+  expiration: CardExpiration;
+  /**
+   * The name of the cardholder as it appears on the card.
+   */
+  holderName?: string | undefined;
+  billingAddress: CardAddress;
+  /**
+   * The results of submitting cardholder data to a card network for verification.
+   */
+  cardVerification: CardVerification;
+  /**
+   * Financial institution that issued the card.
+   */
+  issuer?: string | undefined;
+  /**
+   * Country where the card was issued.
+   */
+  issuerCountry?: string | undefined;
+  /**
+   * Indicates cardholder has authorized card to be stored for future payments.
+   */
+  cardOnFile?: boolean | undefined;
+  merchantAccountID?: string | undefined;
+  /**
+   * The results of the most recent card update request.
+   */
+  cardAccountUpdater?: CardAccountUpdater | undefined;
+  /**
+   * Indicates which level of domestic push-to-card transfer is supported by the card, if any.
+   */
+  domesticPushToCard?: DomesticPushToCard | undefined;
+  /**
+   * Indicates if the card supports domestic pull-from-card transfer.
+   */
+  domesticPullFromCard?: DomesticPullFromCard | undefined;
+};
+
+/** @internal */
+export const TransferPaymentMethodsCard$inboundSchema: z.ZodType<
+  TransferPaymentMethodsCard,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  cardID: z.string(),
+  fingerprint: z.string(),
+  brand: CardBrand$inboundSchema,
+  cardType: CardType$inboundSchema,
+  lastFourCardNumber: z.string(),
+  bin: z.string(),
+  expiration: CardExpiration$inboundSchema,
+  holderName: z.string().optional(),
+  billingAddress: CardAddress$inboundSchema,
+  cardVerification: CardVerification$inboundSchema,
+  issuer: z.string().optional(),
+  issuerCountry: z.string().optional(),
+  cardOnFile: z.boolean().optional(),
+  merchantAccountID: z.string().optional(),
+  cardAccountUpdater: CardAccountUpdater$inboundSchema.optional(),
+  domesticPushToCard: DomesticPushToCard$inboundSchema.optional(),
+  domesticPullFromCard: DomesticPullFromCard$inboundSchema.optional(),
+});
+/** @internal */
+export type TransferPaymentMethodsCard$Outbound = {
+  cardID: string;
+  fingerprint: string;
+  brand: string;
+  cardType: string;
+  lastFourCardNumber: string;
+  bin: string;
+  expiration: CardExpiration$Outbound;
+  holderName?: string | undefined;
+  billingAddress: CardAddress$Outbound;
+  cardVerification: CardVerification$Outbound;
+  issuer?: string | undefined;
+  issuerCountry?: string | undefined;
+  cardOnFile?: boolean | undefined;
+  merchantAccountID?: string | undefined;
+  cardAccountUpdater?: CardAccountUpdater$Outbound | undefined;
+  domesticPushToCard?: string | undefined;
+  domesticPullFromCard?: string | undefined;
+};
+
+/** @internal */
+export const TransferPaymentMethodsCard$outboundSchema: z.ZodType<
+  TransferPaymentMethodsCard$Outbound,
+  z.ZodTypeDef,
+  TransferPaymentMethodsCard
+> = z.object({
+  cardID: z.string(),
+  fingerprint: z.string(),
+  brand: CardBrand$outboundSchema,
+  cardType: CardType$outboundSchema,
+  lastFourCardNumber: z.string(),
+  bin: z.string(),
+  expiration: CardExpiration$outboundSchema,
+  holderName: z.string().optional(),
+  billingAddress: CardAddress$outboundSchema,
+  cardVerification: CardVerification$outboundSchema,
+  issuer: z.string().optional(),
+  issuerCountry: z.string().optional(),
+  cardOnFile: z.boolean().optional(),
+  merchantAccountID: z.string().optional(),
+  cardAccountUpdater: CardAccountUpdater$outboundSchema.optional(),
+  domesticPushToCard: DomesticPushToCard$outboundSchema.optional(),
+  domesticPullFromCard: DomesticPullFromCard$outboundSchema.optional(),
+});
+
+export function transferPaymentMethodsCardToJSON(
+  transferPaymentMethodsCard: TransferPaymentMethodsCard,
+): string {
+  return JSON.stringify(
+    TransferPaymentMethodsCard$outboundSchema.parse(transferPaymentMethodsCard),
+  );
+}
+export function transferPaymentMethodsCardFromJSON(
+  jsonString: string,
+): SafeParseResult<TransferPaymentMethodsCard, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransferPaymentMethodsCard$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransferPaymentMethodsCard' from JSON`,
+  );
+}

package/src/models/components/transferpaymentmethodswallet.ts

@@ -0,0 +1,73 @@
+/*
+ * 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 {
+  WalletType,
+  WalletType$inboundSchema,
+  WalletType$outboundSchema,
+} from "./wallettype.js";
+
+export type TransferPaymentMethodsWallet = {
+  walletID: string;
+  partnerAccountID: string;
+  /**
+   * Type of a wallet.
+   *
+   * @remarks
+   *   - `default`: The system-generated wallet automatically created when an account is granted the wallet capability.
+   *   - `general`: An additional, user-defined wallet created via API or Dashboard.
+   */
+  walletType: WalletType;
+};
+
+/** @internal */
+export const TransferPaymentMethodsWallet$inboundSchema: z.ZodType<
+  TransferPaymentMethodsWallet,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  walletID: z.string(),
+  partnerAccountID: z.string(),
+  walletType: WalletType$inboundSchema,
+});
+/** @internal */
+export type TransferPaymentMethodsWallet$Outbound = {
+  walletID: string;
+  partnerAccountID: string;
+  walletType: string;
+};
+
+/** @internal */
+export const TransferPaymentMethodsWallet$outboundSchema: z.ZodType<
+  TransferPaymentMethodsWallet$Outbound,
+  z.ZodTypeDef,
+  TransferPaymentMethodsWallet
+> = z.object({
+  walletID: z.string(),
+  partnerAccountID: z.string(),
+  walletType: WalletType$outboundSchema,
+});
+
+export function transferPaymentMethodsWalletToJSON(
+  transferPaymentMethodsWallet: TransferPaymentMethodsWallet,
+): string {
+  return JSON.stringify(
+    TransferPaymentMethodsWallet$outboundSchema.parse(
+      transferPaymentMethodsWallet,
+    ),
+  );
+}
+export function transferPaymentMethodsWalletFromJSON(
+  jsonString: string,
+): SafeParseResult<TransferPaymentMethodsWallet, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransferPaymentMethodsWallet$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransferPaymentMethodsWallet' from JSON`,
+  );
+}

package/src/models/components/transferpaymentmethodtype.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * The payment method type that represents a payment rail and directionality
+ */
+export const TransferPaymentMethodType = {
+  MoovWallet: "moov-wallet",
+  AchDebitFund: "ach-debit-fund",
+  AchDebitCollect: "ach-debit-collect",
+  AchCreditStandard: "ach-credit-standard",
+  AchCreditSameDay: "ach-credit-same-day",
+  RtpCredit: "rtp-credit",
+  CardPayment: "card-payment",
+  PushToCard: "push-to-card",
+  PullFromCard: "pull-from-card",
+  ApplePay: "apple-pay",
+  CardPresentPayment: "card-present-payment",
+  InstantBankCredit: "instant-bank-credit",
+} as const;
+/**
+ * The payment method type that represents a payment rail and directionality
+ */
+export type TransferPaymentMethodType = ClosedEnum<
+  typeof TransferPaymentMethodType
+>;
+
+/** @internal */
+export const TransferPaymentMethodType$inboundSchema: z.ZodNativeEnum<
+  typeof TransferPaymentMethodType
+> = z.nativeEnum(TransferPaymentMethodType);
+/** @internal */
+export const TransferPaymentMethodType$outboundSchema: z.ZodNativeEnum<
+  typeof TransferPaymentMethodType
+> = TransferPaymentMethodType$inboundSchema;

package/src/models/components/transfersource.ts

@@ -24,41 +24,41 @@ import {
   CardTransactionDetails$Outbound,
   CardTransactionDetails$outboundSchema,
 } from "./cardtransactiondetails.js";
-import {
-  PaymentMethodsBankAccount,
-  PaymentMethodsBankAccount$inboundSchema,
-  PaymentMethodsBankAccount$Outbound,
-  PaymentMethodsBankAccount$outboundSchema,
-} from "./paymentmethodsbankaccount.js";
-import {
-  PaymentMethodsCard,
-  PaymentMethodsCard$inboundSchema,
-  PaymentMethodsCard$Outbound,
-  PaymentMethodsCard$outboundSchema,
-} from "./paymentmethodscard.js";
-import {
-  PaymentMethodsWallet,
-  PaymentMethodsWallet$inboundSchema,
-  PaymentMethodsWallet$Outbound,
-  PaymentMethodsWallet$outboundSchema,
-} from "./paymentmethodswallet.js";
-import {
-  PaymentMethodType,
-  PaymentMethodType$inboundSchema,
-  PaymentMethodType$outboundSchema,
-} from "./paymentmethodtype.js";
-import {
-  TerminalCard,
-  TerminalCard$inboundSchema,
-  TerminalCard$Outbound,
-  TerminalCard$outboundSchema,
-} from "./terminalcard.js";
 import {
   TransferAccount,
   TransferAccount$inboundSchema,
   TransferAccount$Outbound,
   TransferAccount$outboundSchema,
 } from "./transferaccount.js";
+import {
+  TransferPaymentMethodsBankAccount,
+  TransferPaymentMethodsBankAccount$inboundSchema,
+  TransferPaymentMethodsBankAccount$Outbound,
+  TransferPaymentMethodsBankAccount$outboundSchema,
+} from "./transferpaymentmethodsbankaccount.js";
+import {
+  TransferPaymentMethodsCard,
+  TransferPaymentMethodsCard$inboundSchema,
+  TransferPaymentMethodsCard$Outbound,
+  TransferPaymentMethodsCard$outboundSchema,
+} from "./transferpaymentmethodscard.js";
+import {
+  TransferPaymentMethodsWallet,
+  TransferPaymentMethodsWallet$inboundSchema,
+  TransferPaymentMethodsWallet$Outbound,
+  TransferPaymentMethodsWallet$outboundSchema,
+} from "./transferpaymentmethodswallet.js";
+import {
+  TransferPaymentMethodType,
+  TransferPaymentMethodType$inboundSchema,
+  TransferPaymentMethodType$outboundSchema,
+} from "./transferpaymentmethodtype.js";
+import {
+  TransferTerminalCard,
+  TransferTerminalCard$inboundSchema,
+  TransferTerminalCard$Outbound,
+  TransferTerminalCard$outboundSchema,
+} from "./transferterminalcard.js";
 
 export type TransferSource = {
   /**
@@ -69,17 +69,17 @@ export type TransferSource = {
   /**
    * The payment method type that represents a payment rail and directionality
    */
-  paymentMethodType: PaymentMethodType;
+  paymentMethodType: TransferPaymentMethodType;
   account: TransferAccount;
   /**
    * A bank account as contained within a payment method.
    */
-  bankAccount?: PaymentMethodsBankAccount | undefined;
-  wallet?: PaymentMethodsWallet | undefined;
+  bankAccount?: TransferPaymentMethodsBankAccount | undefined;
+  wallet?: TransferPaymentMethodsWallet | undefined;
   /**
    * A card as contained within a payment method.
    */
-  card?: PaymentMethodsCard | undefined;
+  card?: TransferPaymentMethodsCard | undefined;
   /**
    * Describes an Apple Pay token on a Moov account.
    */
@@ -87,7 +87,7 @@ export type TransferSource = {
   /**
    * Describes payment card details captured with tap or in-person payment.
    */
-  terminalCard?: TerminalCard | undefined;
+  terminalCard?: TransferTerminalCard | undefined;
   /**
    * Card-specific details about the transaction.
    */
@@ -106,13 +106,13 @@ export const TransferSource$inboundSchema: z.ZodType<
 > = z.object({
   transferID: z.string().optional(),
   paymentMethodID: z.string(),
-  paymentMethodType: PaymentMethodType$inboundSchema,
+  paymentMethodType: TransferPaymentMethodType$inboundSchema,
   account: TransferAccount$inboundSchema,
-  bankAccount: PaymentMethodsBankAccount$inboundSchema.optional(),
-  wallet: PaymentMethodsWallet$inboundSchema.optional(),
-  card: PaymentMethodsCard$inboundSchema.optional(),
+  bankAccount: TransferPaymentMethodsBankAccount$inboundSchema.optional(),
+  wallet: TransferPaymentMethodsWallet$inboundSchema.optional(),
+  card: TransferPaymentMethodsCard$inboundSchema.optional(),
   applePay: ApplePayResponse$inboundSchema.optional(),
-  terminalCard: TerminalCard$inboundSchema.optional(),
+  terminalCard: TransferTerminalCard$inboundSchema.optional(),
   cardDetails: CardTransactionDetails$inboundSchema.optional(),
   achDetails: ACHTransactionDetails$inboundSchema.optional(),
 });
@@ -122,11 +122,11 @@ export type TransferSource$Outbound = {
   paymentMethodID: string;
   paymentMethodType: string;
   account: TransferAccount$Outbound;
-  bankAccount?: PaymentMethodsBankAccount$Outbound | undefined;
-  wallet?: PaymentMethodsWallet$Outbound | undefined;
-  card?: PaymentMethodsCard$Outbound | undefined;
+  bankAccount?: TransferPaymentMethodsBankAccount$Outbound | undefined;
+  wallet?: TransferPaymentMethodsWallet$Outbound | undefined;
+  card?: TransferPaymentMethodsCard$Outbound | undefined;
   applePay?: ApplePayResponse$Outbound | undefined;
-  terminalCard?: TerminalCard$Outbound | undefined;
+  terminalCard?: TransferTerminalCard$Outbound | undefined;
   cardDetails?: CardTransactionDetails$Outbound | undefined;
   achDetails?: ACHTransactionDetails$Outbound | undefined;
 };
@@ -139,13 +139,13 @@ export const TransferSource$outboundSchema: z.ZodType<
 > = z.object({
   transferID: z.string().optional(),
   paymentMethodID: z.string(),
-  paymentMethodType: PaymentMethodType$outboundSchema,
+  paymentMethodType: TransferPaymentMethodType$outboundSchema,
   account: TransferAccount$outboundSchema,
-  bankAccount: PaymentMethodsBankAccount$outboundSchema.optional(),
-  wallet: PaymentMethodsWallet$outboundSchema.optional(),
-  card: PaymentMethodsCard$outboundSchema.optional(),
+  bankAccount: TransferPaymentMethodsBankAccount$outboundSchema.optional(),
+  wallet: TransferPaymentMethodsWallet$outboundSchema.optional(),
+  card: TransferPaymentMethodsCard$outboundSchema.optional(),
   applePay: ApplePayResponse$outboundSchema.optional(),
-  terminalCard: TerminalCard$outboundSchema.optional(),
+  terminalCard: TransferTerminalCard$outboundSchema.optional(),
   cardDetails: CardTransactionDetails$outboundSchema.optional(),
   achDetails: ACHTransactionDetails$outboundSchema.optional(),
 });