@moovio/sdk 0.2.0 → 0.3.0

package/src/models/components/achdebitcollectpaymentmethod.ts

@@ -8,11 +8,11 @@ import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
-  BankAccount,
-  BankAccount$inboundSchema,
-  BankAccount$Outbound,
-  BankAccount$outboundSchema,
-} from "./bankaccount.js";
+  PaymentMethodsBankAccount,
+  PaymentMethodsBankAccount$inboundSchema,
+  PaymentMethodsBankAccount$Outbound,
+  PaymentMethodsBankAccount$outboundSchema,
+} from "./paymentmethodsbankaccount.js";
 
 export const AchDebitCollectPaymentMethodPaymentMethodType = {
   AchDebitCollect: "ach-debit-collect",
@@ -26,11 +26,11 @@ export type AchDebitCollectPaymentMethod = {
    * ID of the payment method.
    */
   paymentMethodID: string;
+  paymentMethodType: AchDebitCollectPaymentMethodPaymentMethodType;
   /**
-   * Describes a bank account linked to a Moov account.
+   * A bank account as contained within a payment method.
    */
-  bankAccount: BankAccount;
-  paymentMethodType: AchDebitCollectPaymentMethodPaymentMethodType;
+  bankAccount: PaymentMethodsBankAccount;
 };
 
 /** @internal */
@@ -63,16 +63,16 @@ export const AchDebitCollectPaymentMethod$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   paymentMethodID: z.string(),
-  bankAccount: BankAccount$inboundSchema,
   paymentMethodType:
     AchDebitCollectPaymentMethodPaymentMethodType$inboundSchema,
+  bankAccount: PaymentMethodsBankAccount$inboundSchema,
 });
 
 /** @internal */
 export type AchDebitCollectPaymentMethod$Outbound = {
   paymentMethodID: string;
-  bankAccount: BankAccount$Outbound;
   paymentMethodType: string;
+  bankAccount: PaymentMethodsBankAccount$Outbound;
 };
 
 /** @internal */
@@ -82,9 +82,9 @@ export const AchDebitCollectPaymentMethod$outboundSchema: z.ZodType<
   AchDebitCollectPaymentMethod
 > = z.object({
   paymentMethodID: z.string(),
-  bankAccount: BankAccount$outboundSchema,
   paymentMethodType:
     AchDebitCollectPaymentMethodPaymentMethodType$outboundSchema,
+  bankAccount: PaymentMethodsBankAccount$outboundSchema,
 });
 
 /**

package/src/models/components/achdebitfundpaymentmethod.ts

@@ -8,11 +8,11 @@ import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
-  BankAccount,
-  BankAccount$inboundSchema,
-  BankAccount$Outbound,
-  BankAccount$outboundSchema,
-} from "./bankaccount.js";
+  PaymentMethodsBankAccount,
+  PaymentMethodsBankAccount$inboundSchema,
+  PaymentMethodsBankAccount$Outbound,
+  PaymentMethodsBankAccount$outboundSchema,
+} from "./paymentmethodsbankaccount.js";
 
 export const AchDebitFundPaymentMethodPaymentMethodType = {
   AchDebitFund: "ach-debit-fund",
@@ -26,11 +26,11 @@ export type AchDebitFundPaymentMethod = {
    * ID of the payment method.
    */
   paymentMethodID: string;
+  paymentMethodType: AchDebitFundPaymentMethodPaymentMethodType;
   /**
-   * Describes a bank account linked to a Moov account.
+   * A bank account as contained within a payment method.
    */
-  bankAccount: BankAccount;
-  paymentMethodType: AchDebitFundPaymentMethodPaymentMethodType;
+  bankAccount: PaymentMethodsBankAccount;
 };
 
 /** @internal */
@@ -63,15 +63,15 @@ export const AchDebitFundPaymentMethod$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   paymentMethodID: z.string(),
-  bankAccount: BankAccount$inboundSchema,
   paymentMethodType: AchDebitFundPaymentMethodPaymentMethodType$inboundSchema,
+  bankAccount: PaymentMethodsBankAccount$inboundSchema,
 });
 
 /** @internal */
 export type AchDebitFundPaymentMethod$Outbound = {
   paymentMethodID: string;
-  bankAccount: BankAccount$Outbound;
   paymentMethodType: string;
+  bankAccount: PaymentMethodsBankAccount$Outbound;
 };
 
 /** @internal */
@@ -81,8 +81,8 @@ export const AchDebitFundPaymentMethod$outboundSchema: z.ZodType<
   AchDebitFundPaymentMethod
 > = z.object({
   paymentMethodID: z.string(),
-  bankAccount: BankAccount$outboundSchema,
   paymentMethodType: AchDebitFundPaymentMethodPaymentMethodType$outboundSchema,
+  bankAccount: PaymentMethodsBankAccount$outboundSchema,
 });
 
 /**

package/src/models/components/applepaypaymentmethod.ts

@@ -7,6 +7,12 @@ 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 {
+  ApplePayResponse,
+  ApplePayResponse$inboundSchema,
+  ApplePayResponse$Outbound,
+  ApplePayResponse$outboundSchema,
+} from "./applepayresponse.js";
 
 export const ApplePayPaymentMethodPaymentMethodType = {
   ApplePay: "apple-pay",
@@ -21,7 +27,10 @@ export type ApplePayPaymentMethod = {
    */
   paymentMethodID: string;
   paymentMethodType: ApplePayPaymentMethodPaymentMethodType;
-  applePay?: any | undefined;
+  /**
+   * Describes an Apple Pay token on a Moov account.
+   */
+  applePay: ApplePayResponse;
 };
 
 /** @internal */
@@ -56,14 +65,14 @@ export const ApplePayPaymentMethod$inboundSchema: z.ZodType<
 > = z.object({
   paymentMethodID: z.string(),
   paymentMethodType: ApplePayPaymentMethodPaymentMethodType$inboundSchema,
-  applePay: z.any().optional(),
+  applePay: ApplePayResponse$inboundSchema,
 });
 
 /** @internal */
 export type ApplePayPaymentMethod$Outbound = {
   paymentMethodID: string;
   paymentMethodType: string;
-  applePay?: any | undefined;
+  applePay: ApplePayResponse$Outbound;
 };
 
 /** @internal */
@@ -74,7 +83,7 @@ export const ApplePayPaymentMethod$outboundSchema: z.ZodType<
 > = z.object({
   paymentMethodID: z.string(),
   paymentMethodType: ApplePayPaymentMethodPaymentMethodType$outboundSchema,
-  applePay: z.any().optional(),
+  applePay: ApplePayResponse$outboundSchema,
 });
 
 /**

package/src/models/components/brandcolors.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  BrandColor,
+  BrandColor$inboundSchema,
+  BrandColor$Outbound,
+  BrandColor$outboundSchema,
+} from "./brandcolor.js";
+
+/**
+ * Brand colors for light and dark modes.
+ */
+export type BrandColors = {
+  dark: BrandColor;
+  light: BrandColor;
+};
+
+/** @internal */
+export const BrandColors$inboundSchema: z.ZodType<
+  BrandColors,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  dark: BrandColor$inboundSchema,
+  light: BrandColor$inboundSchema,
+});
+
+/** @internal */
+export type BrandColors$Outbound = {
+  dark: BrandColor$Outbound;
+  light: BrandColor$Outbound;
+};
+
+/** @internal */
+export const BrandColors$outboundSchema: z.ZodType<
+  BrandColors$Outbound,
+  z.ZodTypeDef,
+  BrandColors
+> = z.object({
+  dark: BrandColor$outboundSchema,
+  light: BrandColor$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BrandColors$ {
+  /** @deprecated use `BrandColors$inboundSchema` instead. */
+  export const inboundSchema = BrandColors$inboundSchema;
+  /** @deprecated use `BrandColors$outboundSchema` instead. */
+  export const outboundSchema = BrandColors$outboundSchema;
+  /** @deprecated use `BrandColors$Outbound` instead. */
+  export type Outbound = BrandColors$Outbound;
+}
+
+export function brandColorsToJSON(brandColors: BrandColors): string {
+  return JSON.stringify(BrandColors$outboundSchema.parse(brandColors));
+}
+
+export function brandColorsFromJSON(
+  jsonString: string,
+): SafeParseResult<BrandColors, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BrandColors$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BrandColors' from JSON`,
+  );
+}

package/src/models/components/brandproperties.ts

@@ -0,0 +1,73 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  BrandColors,
+  BrandColors$inboundSchema,
+  BrandColors$Outbound,
+  BrandColors$outboundSchema,
+} from "./brandcolors.js";
+
+export type BrandProperties = {
+  /**
+   * Brand colors for light and dark modes.
+   */
+  colors: BrandColors;
+};
+
+/** @internal */
+export const BrandProperties$inboundSchema: z.ZodType<
+  BrandProperties,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  colors: BrandColors$inboundSchema,
+});
+
+/** @internal */
+export type BrandProperties$Outbound = {
+  colors: BrandColors$Outbound;
+};
+
+/** @internal */
+export const BrandProperties$outboundSchema: z.ZodType<
+  BrandProperties$Outbound,
+  z.ZodTypeDef,
+  BrandProperties
+> = z.object({
+  colors: BrandColors$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BrandProperties$ {
+  /** @deprecated use `BrandProperties$inboundSchema` instead. */
+  export const inboundSchema = BrandProperties$inboundSchema;
+  /** @deprecated use `BrandProperties$outboundSchema` instead. */
+  export const outboundSchema = BrandProperties$outboundSchema;
+  /** @deprecated use `BrandProperties$Outbound` instead. */
+  export type Outbound = BrandProperties$Outbound;
+}
+
+export function brandPropertiesToJSON(
+  brandProperties: BrandProperties,
+): string {
+  return JSON.stringify(BrandProperties$outboundSchema.parse(brandProperties));
+}
+
+export function brandPropertiesFromJSON(
+  jsonString: string,
+): SafeParseResult<BrandProperties, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BrandProperties$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BrandProperties' from JSON`,
+  );
+}

package/src/models/components/cardpaymentpaymentmethod.ts

@@ -8,11 +8,11 @@ import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
-  Card,
-  Card$inboundSchema,
-  Card$Outbound,
-  Card$outboundSchema,
-} from "./card.js";
+  PaymentMethodsCard,
+  PaymentMethodsCard$inboundSchema,
+  PaymentMethodsCard$Outbound,
+  PaymentMethodsCard$outboundSchema,
+} from "./paymentmethodscard.js";
 
 export const CardPaymentPaymentMethodPaymentMethodType = {
   CardPayment: "card-payment",
@@ -26,11 +26,11 @@ export type CardPaymentPaymentMethod = {
    * ID of the payment method.
    */
   paymentMethodID: string;
+  paymentMethodType: CardPaymentPaymentMethodPaymentMethodType;
   /**
-   * Describes a card on a Moov account.
+   * A card as contained within a payment method.
    */
-  card: Card;
-  paymentMethodType: CardPaymentPaymentMethodPaymentMethodType;
+  card: PaymentMethodsCard;
 };
 
 /** @internal */
@@ -63,15 +63,15 @@ export const CardPaymentPaymentMethod$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   paymentMethodID: z.string(),
-  card: Card$inboundSchema,
   paymentMethodType: CardPaymentPaymentMethodPaymentMethodType$inboundSchema,
+  card: PaymentMethodsCard$inboundSchema,
 });
 
 /** @internal */
 export type CardPaymentPaymentMethod$Outbound = {
   paymentMethodID: string;
-  card: Card$Outbound;
   paymentMethodType: string;
+  card: PaymentMethodsCard$Outbound;
 };
 
 /** @internal */
@@ -81,8 +81,8 @@ export const CardPaymentPaymentMethod$outboundSchema: z.ZodType<
   CardPaymentPaymentMethod
 > = z.object({
   paymentMethodID: z.string(),
-  card: Card$outboundSchema,
   paymentMethodType: CardPaymentPaymentMethodPaymentMethodType$outboundSchema,
+  card: PaymentMethodsCard$outboundSchema,
 });
 
 /**

package/src/models/components/createrepresentative.ts

@@ -44,7 +44,7 @@ import {
 } from "./representativeresponsibilities.js";
 
 /**
- * The template for omitting properties.
+ * Describes a business representative to create.
  */
 export type CreateRepresentative = {
   name: IndividualName;

package/src/models/components/index.ts

@@ -61,9 +61,10 @@ export * from "./birthdate.js";
 export * from "./birthdateerror.js";
 export * from "./birthdateupdate.js";
 export * from "./birthdatevalidationerror.js";
-export * from "./brand.js";
 export * from "./brandcolor.js";
+export * from "./brandcolors.js";
 export * from "./brandcolorvalidationerror.js";
+export * from "./brandproperties.js";
 export * from "./businessprofile.js";
 export * from "./businesstype.js";
 export * from "./calltoaction.js";
@@ -99,7 +100,6 @@ export * from "./cardverificationresult.js";
 export * from "./cardvolumedistribution.js";
 export * from "./cardvolumedistributionerror.js";
 export * from "./collectionpaymentmethodtype.js";
-export * from "./colors.js";
 export * from "./colorsvalidationerror.js";
 export * from "./completebankaccountverification.js";
 export * from "./completedmicrodeposits.js";
@@ -239,6 +239,9 @@ export * from "./paymentlinkpayoutdetails.js";
 export * from "./paymentlinkpayoutdetailsupdate.js";
 export * from "./paymentlinkstatus.js";
 export * from "./paymentmethod.js";
+export * from "./paymentmethodsbankaccount.js";
+export * from "./paymentmethodscard.js";
+export * from "./paymentmethodswallet.js";
 export * from "./paymentmethodtype.js";
 export * from "./payoutdetailserror.js";
 export * from "./payoutrecipient.js";

package/src/models/components/moovwalletpaymentmethod.ts

@@ -7,6 +7,12 @@ 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 {
+  PaymentMethodsWallet,
+  PaymentMethodsWallet$inboundSchema,
+  PaymentMethodsWallet$Outbound,
+  PaymentMethodsWallet$outboundSchema,
+} from "./paymentmethodswallet.js";
 
 export const MoovWalletPaymentMethodPaymentMethodType = {
   MoovWallet: "moov-wallet",
@@ -21,7 +27,7 @@ export type MoovWalletPaymentMethod = {
    */
   paymentMethodID: string;
   paymentMethodType: MoovWalletPaymentMethodPaymentMethodType;
-  wallet?: any | undefined;
+  wallet: PaymentMethodsWallet;
 };
 
 /** @internal */
@@ -55,14 +61,14 @@ export const MoovWalletPaymentMethod$inboundSchema: z.ZodType<
 > = z.object({
   paymentMethodID: z.string(),
   paymentMethodType: MoovWalletPaymentMethodPaymentMethodType$inboundSchema,
-  wallet: z.any().optional(),
+  wallet: PaymentMethodsWallet$inboundSchema,
 });
 
 /** @internal */
 export type MoovWalletPaymentMethod$Outbound = {
   paymentMethodID: string;
   paymentMethodType: string;
-  wallet?: any | undefined;
+  wallet: PaymentMethodsWallet$Outbound;
 };
 
 /** @internal */
@@ -73,7 +79,7 @@ export const MoovWalletPaymentMethod$outboundSchema: z.ZodType<
 > = z.object({
   paymentMethodID: z.string(),
   paymentMethodType: MoovWalletPaymentMethodPaymentMethodType$outboundSchema,
-  wallet: z.any().optional(),
+  wallet: PaymentMethodsWallet$outboundSchema,
 });
 
 /**

package/src/models/components/paymentmethodsbankaccount.ts

@@ -0,0 +1,133 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 PaymentMethodsBankAccount = {
+  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 PaymentMethodsBankAccount$inboundSchema: z.ZodType<
+  PaymentMethodsBankAccount,
+  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 PaymentMethodsBankAccount$Outbound = {
+  bankAccountID: string;
+  fingerprint: string;
+  status: string;
+  holderName: string;
+  holderType: string;
+  bankName: string;
+  bankAccountType: string;
+  routingNumber: string;
+  lastFourAccountNumber: string;
+  updatedOn: string;
+};
+
+/** @internal */
+export const PaymentMethodsBankAccount$outboundSchema: z.ZodType<
+  PaymentMethodsBankAccount$Outbound,
+  z.ZodTypeDef,
+  PaymentMethodsBankAccount
+> = 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()),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PaymentMethodsBankAccount$ {
+  /** @deprecated use `PaymentMethodsBankAccount$inboundSchema` instead. */
+  export const inboundSchema = PaymentMethodsBankAccount$inboundSchema;
+  /** @deprecated use `PaymentMethodsBankAccount$outboundSchema` instead. */
+  export const outboundSchema = PaymentMethodsBankAccount$outboundSchema;
+  /** @deprecated use `PaymentMethodsBankAccount$Outbound` instead. */
+  export type Outbound = PaymentMethodsBankAccount$Outbound;
+}
+
+export function paymentMethodsBankAccountToJSON(
+  paymentMethodsBankAccount: PaymentMethodsBankAccount,
+): string {
+  return JSON.stringify(
+    PaymentMethodsBankAccount$outboundSchema.parse(paymentMethodsBankAccount),
+  );
+}
+
+export function paymentMethodsBankAccountFromJSON(
+  jsonString: string,
+): SafeParseResult<PaymentMethodsBankAccount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PaymentMethodsBankAccount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaymentMethodsBankAccount' from JSON`,
+  );
+}