@moovio/sdk 0.12.0 → 0.12.2

package/src/models/components/achinstitution.ts

@@ -0,0 +1,89 @@
+/*
+ * 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 {
+  Address,
+  Address$inboundSchema,
+  Address$Outbound,
+  Address$outboundSchema,
+} from "./address.js";
+import {
+  Contact,
+  Contact$inboundSchema,
+  Contact$Outbound,
+  Contact$outboundSchema,
+} from "./contact.js";
+
+export type ACHInstitution = {
+  /**
+   * Name of the financial institution.
+   */
+  name: string;
+  routingNumber: string;
+  address?: Address | undefined;
+  contact?: Contact | undefined;
+};
+
+/** @internal */
+export const ACHInstitution$inboundSchema: z.ZodType<
+  ACHInstitution,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  routingNumber: z.string(),
+  address: Address$inboundSchema.optional(),
+  contact: Contact$inboundSchema.optional(),
+});
+
+/** @internal */
+export type ACHInstitution$Outbound = {
+  name: string;
+  routingNumber: string;
+  address?: Address$Outbound | undefined;
+  contact?: Contact$Outbound | undefined;
+};
+
+/** @internal */
+export const ACHInstitution$outboundSchema: z.ZodType<
+  ACHInstitution$Outbound,
+  z.ZodTypeDef,
+  ACHInstitution
+> = z.object({
+  name: z.string(),
+  routingNumber: z.string(),
+  address: Address$outboundSchema.optional(),
+  contact: Contact$outboundSchema.optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ACHInstitution$ {
+  /** @deprecated use `ACHInstitution$inboundSchema` instead. */
+  export const inboundSchema = ACHInstitution$inboundSchema;
+  /** @deprecated use `ACHInstitution$outboundSchema` instead. */
+  export const outboundSchema = ACHInstitution$outboundSchema;
+  /** @deprecated use `ACHInstitution$Outbound` instead. */
+  export type Outbound = ACHInstitution$Outbound;
+}
+
+export function achInstitutionToJSON(achInstitution: ACHInstitution): string {
+  return JSON.stringify(ACHInstitution$outboundSchema.parse(achInstitution));
+}
+
+export function achInstitutionFromJSON(
+  jsonString: string,
+): SafeParseResult<ACHInstitution, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ACHInstitution$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ACHInstitution' from JSON`,
+  );
+}

package/src/models/components/contact.ts

@@ -0,0 +1,65 @@
+/*
+ * 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 {
+  PhoneNumber,
+  PhoneNumber$inboundSchema,
+  PhoneNumber$Outbound,
+  PhoneNumber$outboundSchema,
+} from "./phonenumber.js";
+
+export type Contact = {
+  phone?: PhoneNumber | undefined;
+};
+
+/** @internal */
+export const Contact$inboundSchema: z.ZodType<Contact, z.ZodTypeDef, unknown> =
+  z.object({
+    phone: PhoneNumber$inboundSchema.optional(),
+  });
+
+/** @internal */
+export type Contact$Outbound = {
+  phone?: PhoneNumber$Outbound | undefined;
+};
+
+/** @internal */
+export const Contact$outboundSchema: z.ZodType<
+  Contact$Outbound,
+  z.ZodTypeDef,
+  Contact
+> = z.object({
+  phone: PhoneNumber$outboundSchema.optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Contact$ {
+  /** @deprecated use `Contact$inboundSchema` instead. */
+  export const inboundSchema = Contact$inboundSchema;
+  /** @deprecated use `Contact$outboundSchema` instead. */
+  export const outboundSchema = Contact$outboundSchema;
+  /** @deprecated use `Contact$Outbound` instead. */
+  export type Outbound = Contact$Outbound;
+}
+
+export function contactToJSON(contact: Contact): string {
+  return JSON.stringify(Contact$outboundSchema.parse(contact));
+}
+
+export function contactFromJSON(
+  jsonString: string,
+): SafeParseResult<Contact, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Contact$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Contact' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -13,6 +13,7 @@ export * from "./achcreditstandardpaymentmethod.js";
 export * from "./achdebitcollectpaymentmethod.js";
 export * from "./achdebitfundpaymentmethod.js";
 export * from "./achexception.js";
+export * from "./achinstitution.js";
 export * from "./achlocation.js";
 export * from "./achparticipant.js";
 export * from "./achpaymentdetails.js";
@@ -104,6 +105,7 @@ export * from "./colorsvalidationerror.js";
 export * from "./completebankaccountverification.js";
 export * from "./completedmicrodeposits.js";
 export * from "./completemicrodeposits.js";
+export * from "./contact.js";
 export * from "./countrieserrors.js";
 export * from "./createaccount.js";
 export * from "./createaccounterror.js";
@@ -196,6 +198,7 @@ export * from "./individualnameupdate.js";
 export * from "./individualprofile.js";
 export * from "./industrycodes.js";
 export * from "./industrytaxonomy.js";
+export * from "./institutionssearchresponse.js";
 export * from "./issuedcard.js";
 export * from "./issuedcardauthorization.js";
 export * from "./issuedcardauthorizationevent.js";
@@ -301,7 +304,9 @@ export * from "./reversedwithrefund.js";
 export * from "./revoketokenrequest.js";
 export * from "./rtpcreditpaymentmethod.js";
 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";
@@ -401,3 +406,5 @@ export * from "./webhookevent.js";
 export * from "./webhookeventtype.js";
 export * from "./webhooktransferpaymentmethoddetails.js";
 export * from "./webhookwalletavailablebalance.js";
+export * from "./wireinstitution.js";
+export * from "./wireservices.js";

package/src/models/components/institutionssearchresponse.ts

@@ -0,0 +1,92 @@
+/*
+ * 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 {
+  ACHInstitution,
+  ACHInstitution$inboundSchema,
+  ACHInstitution$Outbound,
+  ACHInstitution$outboundSchema,
+} from "./achinstitution.js";
+import {
+  RTPInstitution,
+  RTPInstitution$inboundSchema,
+  RTPInstitution$Outbound,
+  RTPInstitution$outboundSchema,
+} from "./rtpinstitution.js";
+import {
+  WireInstitution,
+  WireInstitution$inboundSchema,
+  WireInstitution$Outbound,
+  WireInstitution$outboundSchema,
+} from "./wireinstitution.js";
+
+export type InstitutionsSearchResponse = {
+  ach: Array<ACHInstitution>;
+  rtp: Array<RTPInstitution>;
+  wire: Array<WireInstitution>;
+};
+
+/** @internal */
+export const InstitutionsSearchResponse$inboundSchema: z.ZodType<
+  InstitutionsSearchResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  ach: z.array(ACHInstitution$inboundSchema),
+  rtp: z.array(RTPInstitution$inboundSchema),
+  wire: z.array(WireInstitution$inboundSchema),
+});
+
+/** @internal */
+export type InstitutionsSearchResponse$Outbound = {
+  ach: Array<ACHInstitution$Outbound>;
+  rtp: Array<RTPInstitution$Outbound>;
+  wire: Array<WireInstitution$Outbound>;
+};
+
+/** @internal */
+export const InstitutionsSearchResponse$outboundSchema: z.ZodType<
+  InstitutionsSearchResponse$Outbound,
+  z.ZodTypeDef,
+  InstitutionsSearchResponse
+> = z.object({
+  ach: z.array(ACHInstitution$outboundSchema),
+  rtp: z.array(RTPInstitution$outboundSchema),
+  wire: z.array(WireInstitution$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace InstitutionsSearchResponse$ {
+  /** @deprecated use `InstitutionsSearchResponse$inboundSchema` instead. */
+  export const inboundSchema = InstitutionsSearchResponse$inboundSchema;
+  /** @deprecated use `InstitutionsSearchResponse$outboundSchema` instead. */
+  export const outboundSchema = InstitutionsSearchResponse$outboundSchema;
+  /** @deprecated use `InstitutionsSearchResponse$Outbound` instead. */
+  export type Outbound = InstitutionsSearchResponse$Outbound;
+}
+
+export function institutionsSearchResponseToJSON(
+  institutionsSearchResponse: InstitutionsSearchResponse,
+): string {
+  return JSON.stringify(
+    InstitutionsSearchResponse$outboundSchema.parse(institutionsSearchResponse),
+  );
+}
+
+export function institutionsSearchResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<InstitutionsSearchResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InstitutionsSearchResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InstitutionsSearchResponse' from JSON`,
+  );
+}

package/src/models/components/rtpinstitution.ts

@@ -0,0 +1,79 @@
+/*
+ * 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 {
+  RTPServices,
+  RTPServices$inboundSchema,
+  RTPServices$Outbound,
+  RTPServices$outboundSchema,
+} from "./rtpservices.js";
+
+export type RTPInstitution = {
+  /**
+   * Name of the financial institution.
+   */
+  name: string;
+  routingNumber: string;
+  services: RTPServices;
+};
+
+/** @internal */
+export const RTPInstitution$inboundSchema: z.ZodType<
+  RTPInstitution,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  routingNumber: z.string(),
+  services: RTPServices$inboundSchema,
+});
+
+/** @internal */
+export type RTPInstitution$Outbound = {
+  name: string;
+  routingNumber: string;
+  services: RTPServices$Outbound;
+};
+
+/** @internal */
+export const RTPInstitution$outboundSchema: z.ZodType<
+  RTPInstitution$Outbound,
+  z.ZodTypeDef,
+  RTPInstitution
+> = z.object({
+  name: z.string(),
+  routingNumber: z.string(),
+  services: RTPServices$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RTPInstitution$ {
+  /** @deprecated use `RTPInstitution$inboundSchema` instead. */
+  export const inboundSchema = RTPInstitution$inboundSchema;
+  /** @deprecated use `RTPInstitution$outboundSchema` instead. */
+  export const outboundSchema = RTPInstitution$outboundSchema;
+  /** @deprecated use `RTPInstitution$Outbound` instead. */
+  export type Outbound = RTPInstitution$Outbound;
+}
+
+export function rtpInstitutionToJSON(rtpInstitution: RTPInstitution): string {
+  return JSON.stringify(RTPInstitution$outboundSchema.parse(rtpInstitution));
+}
+
+export function rtpInstitutionFromJSON(
+  jsonString: string,
+): SafeParseResult<RTPInstitution, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RTPInstitution$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RTPInstitution' from JSON`,
+  );
+}

package/src/models/components/rtpservices.ts

@@ -0,0 +1,72 @@
+/*
+ * 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";
+
+export type RTPServices = {
+  /**
+   * Can the institution receive payments
+   */
+  receivePayments: boolean;
+  /**
+   * Can the institution receive request for payment messages
+   */
+  receiveRequestForPayment: boolean;
+};
+
+/** @internal */
+export const RTPServices$inboundSchema: z.ZodType<
+  RTPServices,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  receivePayments: z.boolean(),
+  receiveRequestForPayment: z.boolean(),
+});
+
+/** @internal */
+export type RTPServices$Outbound = {
+  receivePayments: boolean;
+  receiveRequestForPayment: boolean;
+};
+
+/** @internal */
+export const RTPServices$outboundSchema: z.ZodType<
+  RTPServices$Outbound,
+  z.ZodTypeDef,
+  RTPServices
+> = z.object({
+  receivePayments: z.boolean(),
+  receiveRequestForPayment: z.boolean(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RTPServices$ {
+  /** @deprecated use `RTPServices$inboundSchema` instead. */
+  export const inboundSchema = RTPServices$inboundSchema;
+  /** @deprecated use `RTPServices$outboundSchema` instead. */
+  export const outboundSchema = RTPServices$outboundSchema;
+  /** @deprecated use `RTPServices$Outbound` instead. */
+  export type Outbound = RTPServices$Outbound;
+}
+
+export function rtpServicesToJSON(rtpServices: RTPServices): string {
+  return JSON.stringify(RTPServices$outboundSchema.parse(rtpServices));
+}
+
+export function rtpServicesFromJSON(
+  jsonString: string,
+): SafeParseResult<RTPServices, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RTPServices$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RTPServices' from JSON`,
+  );
+}

package/src/models/components/transfer.ts

@@ -126,6 +126,7 @@ export type Transfer = {
   sweepID?: string | undefined;
   scheduleID?: string | undefined;
   occurrenceID?: string | undefined;
+  paymentLinkID?: string | undefined;
   /**
    * Optional sales tax amount. `transfer.amount.value` should be inclusive of any sales tax and represents the total amount charged.
    */
@@ -163,6 +164,7 @@ export const Transfer$inboundSchema: z.ZodType<
   sweepID: z.string().optional(),
   scheduleID: z.string().optional(),
   occurrenceID: z.string().optional(),
+  paymentLinkID: z.string().optional(),
   salesTaxAmount: Amount$inboundSchema.optional(),
 });
 
@@ -192,6 +194,7 @@ export type Transfer$Outbound = {
   sweepID?: string | undefined;
   scheduleID?: string | undefined;
   occurrenceID?: string | undefined;
+  paymentLinkID?: string | undefined;
   salesTaxAmount?: Amount$Outbound | undefined;
 };
 
@@ -225,6 +228,7 @@ export const Transfer$outboundSchema: z.ZodType<
   sweepID: z.string().optional(),
   scheduleID: z.string().optional(),
   occurrenceID: z.string().optional(),
+  paymentLinkID: z.string().optional(),
   salesTaxAmount: Amount$outboundSchema.optional(),
 });
 

package/src/models/components/wireinstitution.ts

@@ -0,0 +1,91 @@
+/*
+ * 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 {
+  Address,
+  Address$inboundSchema,
+  Address$Outbound,
+  Address$outboundSchema,
+} from "./address.js";
+import {
+  WireServices,
+  WireServices$inboundSchema,
+  WireServices$Outbound,
+  WireServices$outboundSchema,
+} from "./wireservices.js";
+
+export type WireInstitution = {
+  /**
+   * Name of the financial institution.
+   */
+  name: string;
+  routingNumber: string;
+  address?: Address | undefined;
+  services: WireServices;
+};
+
+/** @internal */
+export const WireInstitution$inboundSchema: z.ZodType<
+  WireInstitution,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  routingNumber: z.string(),
+  address: Address$inboundSchema.optional(),
+  services: WireServices$inboundSchema,
+});
+
+/** @internal */
+export type WireInstitution$Outbound = {
+  name: string;
+  routingNumber: string;
+  address?: Address$Outbound | undefined;
+  services: WireServices$Outbound;
+};
+
+/** @internal */
+export const WireInstitution$outboundSchema: z.ZodType<
+  WireInstitution$Outbound,
+  z.ZodTypeDef,
+  WireInstitution
+> = z.object({
+  name: z.string(),
+  routingNumber: z.string(),
+  address: Address$outboundSchema.optional(),
+  services: WireServices$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace WireInstitution$ {
+  /** @deprecated use `WireInstitution$inboundSchema` instead. */
+  export const inboundSchema = WireInstitution$inboundSchema;
+  /** @deprecated use `WireInstitution$outboundSchema` instead. */
+  export const outboundSchema = WireInstitution$outboundSchema;
+  /** @deprecated use `WireInstitution$Outbound` instead. */
+  export type Outbound = WireInstitution$Outbound;
+}
+
+export function wireInstitutionToJSON(
+  wireInstitution: WireInstitution,
+): string {
+  return JSON.stringify(WireInstitution$outboundSchema.parse(wireInstitution));
+}
+
+export function wireInstitutionFromJSON(
+  jsonString: string,
+): SafeParseResult<WireInstitution, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WireInstitution$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WireInstitution' from JSON`,
+  );
+}

package/src/models/components/wireservices.ts

@@ -0,0 +1,79 @@
+/*
+ * 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";
+
+export type WireServices = {
+  /**
+   * The institution's capability to process standard Fedwire funds transfers.
+   */
+  fundsTransferStatus: boolean;
+  /**
+   * The institution's capability for settlement-only transfers.
+   */
+  fundsSettlementOnlyStatus: boolean;
+  /**
+   * The institution's capability to handle transfers of securities.
+   */
+  bookEntrySecuritiesTransferStatus: boolean;
+};
+
+/** @internal */
+export const WireServices$inboundSchema: z.ZodType<
+  WireServices,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  fundsTransferStatus: z.boolean(),
+  fundsSettlementOnlyStatus: z.boolean(),
+  bookEntrySecuritiesTransferStatus: z.boolean(),
+});
+
+/** @internal */
+export type WireServices$Outbound = {
+  fundsTransferStatus: boolean;
+  fundsSettlementOnlyStatus: boolean;
+  bookEntrySecuritiesTransferStatus: boolean;
+};
+
+/** @internal */
+export const WireServices$outboundSchema: z.ZodType<
+  WireServices$Outbound,
+  z.ZodTypeDef,
+  WireServices
+> = z.object({
+  fundsTransferStatus: z.boolean(),
+  fundsSettlementOnlyStatus: z.boolean(),
+  bookEntrySecuritiesTransferStatus: z.boolean(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace WireServices$ {
+  /** @deprecated use `WireServices$inboundSchema` instead. */
+  export const inboundSchema = WireServices$inboundSchema;
+  /** @deprecated use `WireServices$outboundSchema` instead. */
+  export const outboundSchema = WireServices$outboundSchema;
+  /** @deprecated use `WireServices$Outbound` instead. */
+  export type Outbound = WireServices$Outbound;
+}
+
+export function wireServicesToJSON(wireServices: WireServices): string {
+  return JSON.stringify(WireServices$outboundSchema.parse(wireServices));
+}
+
+export function wireServicesFromJSON(
+  jsonString: string,
+): SafeParseResult<WireServices, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WireServices$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WireServices' from JSON`,
+  );
+}

package/src/models/errors/accountterminalapplicationerror.ts

@@ -3,24 +3,27 @@
  */
 
 import * as z from "zod";
+import { MoovError } from "./mooverror.js";
 
 export type AccountTerminalApplicationErrorData = {
   terminalApplicationID?: string | undefined;
 };
 
-export class AccountTerminalApplicationError extends Error {
+export class AccountTerminalApplicationError extends MoovError {
   terminalApplicationID?: string | undefined;
 
   /** The original data that was passed to this error instance. */
   data$: AccountTerminalApplicationErrorData;
 
-  constructor(err: AccountTerminalApplicationErrorData) {
+  constructor(
+    err: AccountTerminalApplicationErrorData,
+    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);
+    super(message, httpMeta);
     this.data$ = err;
-
     if (err.terminalApplicationID != null) {
       this.terminalApplicationID = err.terminalApplicationID;
     }
@@ -36,9 +39,16 @@ export const AccountTerminalApplicationError$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   terminalApplicationID: z.string().optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new AccountTerminalApplicationError(v);
+    return new AccountTerminalApplicationError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */