@moovio/sdk 0.12.0 → 0.12.1

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/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/apierror.ts

@@ -3,22 +3,37 @@
  */
 
 export class APIError extends Error {
+  /**
+   * HTTP status code
+   */
   public readonly statusCode: number;
+  /**
+   * HTTP content type
+   */
   public readonly contentType: string;
+  /**
+   * HTTP body
+   */
+  public readonly body: string;
+  /**
+   * Raw response
+   */
+  public readonly rawResponse: Response;
 
   constructor(
     message: string,
-    public readonly rawResponse: Response,
-    public readonly body: string = "",
+    rawResponse: Response,
+    body: string = "",
   ) {
     const statusCode = rawResponse.status;
     const contentType = rawResponse.headers.get("content-type") || "";
     const bodyString = body.length > 0 ? `\n${body}` : "";
-
     super(
       `${message}: Status ${statusCode} Content-Type ${contentType} Body ${bodyString}`,
     );
 
+    this.body = body;
+    this.rawResponse = rawResponse;
     this.statusCode = statusCode;
     this.contentType = contentType;
 

package/src/models/operations/index.ts

@@ -119,6 +119,7 @@ export * from "./requestcard.js";
 export * from "./retrievefees.js";
 export * from "./revokeaccesstoken.js";
 export * from "./revokeonboardinginvite.js";
+export * from "./searchinstitutions.js";
 export * from "./submitdisputeevidence.js";
 export * from "./testendtoendtoken.js";
 export * from "./updateaccount.js";

package/src/models/operations/searchinstitutions.ts

@@ -0,0 +1,236 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type SearchInstitutionsGlobals = {
+  /**
+   * Specify an API version.
+   *
+   * @remarks
+   *
+   * API versioning follows the format `vYYYY.QQ.BB`, where
+   *   - `YYYY` is the year
+   *   - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
+   *   - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter.
+   *     - For example, `v2024.01.00` is the initial release of the first quarter of 2024.
+   *
+   * The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
+   */
+  xMoovVersion?: string | undefined;
+};
+
+export type SearchInstitutionsRequest = {
+  /**
+   * Name of the financial institution. Either `name` or `routingNumber` is required.
+   */
+  name?: string | undefined;
+  /**
+   * Routing number for a financial institution. Either `routingNumber` or `name` is required.
+   */
+  routingNumber?: string | undefined;
+  /**
+   * Maximum results returned by a search.
+   */
+  limit?: number | undefined;
+};
+
+export type SearchInstitutionsResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.InstitutionsSearchResponse;
+};
+
+/** @internal */
+export const SearchInstitutionsGlobals$inboundSchema: z.ZodType<
+  SearchInstitutionsGlobals,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "x-moov-version": z.string().default("v2024.01.00"),
+}).transform((v) => {
+  return remap$(v, {
+    "x-moov-version": "xMoovVersion",
+  });
+});
+
+/** @internal */
+export type SearchInstitutionsGlobals$Outbound = {
+  "x-moov-version": string;
+};
+
+/** @internal */
+export const SearchInstitutionsGlobals$outboundSchema: z.ZodType<
+  SearchInstitutionsGlobals$Outbound,
+  z.ZodTypeDef,
+  SearchInstitutionsGlobals
+> = z.object({
+  xMoovVersion: z.string().default("v2024.01.00"),
+}).transform((v) => {
+  return remap$(v, {
+    xMoovVersion: "x-moov-version",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SearchInstitutionsGlobals$ {
+  /** @deprecated use `SearchInstitutionsGlobals$inboundSchema` instead. */
+  export const inboundSchema = SearchInstitutionsGlobals$inboundSchema;
+  /** @deprecated use `SearchInstitutionsGlobals$outboundSchema` instead. */
+  export const outboundSchema = SearchInstitutionsGlobals$outboundSchema;
+  /** @deprecated use `SearchInstitutionsGlobals$Outbound` instead. */
+  export type Outbound = SearchInstitutionsGlobals$Outbound;
+}
+
+export function searchInstitutionsGlobalsToJSON(
+  searchInstitutionsGlobals: SearchInstitutionsGlobals,
+): string {
+  return JSON.stringify(
+    SearchInstitutionsGlobals$outboundSchema.parse(searchInstitutionsGlobals),
+  );
+}
+
+export function searchInstitutionsGlobalsFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchInstitutionsGlobals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchInstitutionsGlobals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchInstitutionsGlobals' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchInstitutionsRequest$inboundSchema: z.ZodType<
+  SearchInstitutionsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string().optional(),
+  routingNumber: z.string().optional(),
+  limit: z.number().int().optional(),
+});
+
+/** @internal */
+export type SearchInstitutionsRequest$Outbound = {
+  name?: string | undefined;
+  routingNumber?: string | undefined;
+  limit?: number | undefined;
+};
+
+/** @internal */
+export const SearchInstitutionsRequest$outboundSchema: z.ZodType<
+  SearchInstitutionsRequest$Outbound,
+  z.ZodTypeDef,
+  SearchInstitutionsRequest
+> = z.object({
+  name: z.string().optional(),
+  routingNumber: z.string().optional(),
+  limit: z.number().int().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SearchInstitutionsRequest$ {
+  /** @deprecated use `SearchInstitutionsRequest$inboundSchema` instead. */
+  export const inboundSchema = SearchInstitutionsRequest$inboundSchema;
+  /** @deprecated use `SearchInstitutionsRequest$outboundSchema` instead. */
+  export const outboundSchema = SearchInstitutionsRequest$outboundSchema;
+  /** @deprecated use `SearchInstitutionsRequest$Outbound` instead. */
+  export type Outbound = SearchInstitutionsRequest$Outbound;
+}
+
+export function searchInstitutionsRequestToJSON(
+  searchInstitutionsRequest: SearchInstitutionsRequest,
+): string {
+  return JSON.stringify(
+    SearchInstitutionsRequest$outboundSchema.parse(searchInstitutionsRequest),
+  );
+}
+
+export function searchInstitutionsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchInstitutionsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchInstitutionsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchInstitutionsRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchInstitutionsResponse$inboundSchema: z.ZodType<
+  SearchInstitutionsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())),
+  Result: components.InstitutionsSearchResponse$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type SearchInstitutionsResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: components.InstitutionsSearchResponse$Outbound;
+};
+
+/** @internal */
+export const SearchInstitutionsResponse$outboundSchema: z.ZodType<
+  SearchInstitutionsResponse$Outbound,
+  z.ZodTypeDef,
+  SearchInstitutionsResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: components.InstitutionsSearchResponse$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+    result: "Result",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SearchInstitutionsResponse$ {
+  /** @deprecated use `SearchInstitutionsResponse$inboundSchema` instead. */
+  export const inboundSchema = SearchInstitutionsResponse$inboundSchema;
+  /** @deprecated use `SearchInstitutionsResponse$outboundSchema` instead. */
+  export const outboundSchema = SearchInstitutionsResponse$outboundSchema;
+  /** @deprecated use `SearchInstitutionsResponse$Outbound` instead. */
+  export type Outbound = SearchInstitutionsResponse$Outbound;
+}
+
+export function searchInstitutionsResponseToJSON(
+  searchInstitutionsResponse: SearchInstitutionsResponse,
+): string {
+  return JSON.stringify(
+    SearchInstitutionsResponse$outboundSchema.parse(searchInstitutionsResponse),
+  );
+}
+
+export function searchInstitutionsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchInstitutionsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchInstitutionsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchInstitutionsResponse' from JSON`,
+  );
+}

package/src/sdk/institutions.ts

@@ -3,11 +3,33 @@
  */
 
 import { institutionsSearch } from "../funcs/institutionsSearch.js";
+import { institutionsSearchInstitutions } from "../funcs/institutionsSearchInstitutions.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Institutions extends ClientSDK {
+  /**
+   * Search for financial institutions by name or routing number.
+   *
+   * This endpoint returns metadata about each matched institution, including basic identifying details (such as name, routing number, and address) and information about which payment services they support (e.g., ACH, RTP, and Wire).
+   *
+   * This can be used to validate a financial institution before initiating payment activity, or to check which payment rails are available for a given routing number.
+   *
+   * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
+   * you'll need to specify the `/institutions.read` scope.
+   */
+  async searchInstitutions(
+    request: operations.SearchInstitutionsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.SearchInstitutionsResponse> {
+    return unwrapAsync(institutionsSearchInstitutions(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Search for institutions by either their name or routing number.
    *