@moovio/sdk 0.11.5 → 0.12.1

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

@@ -9,9 +9,9 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class Industries extends ClientSDK {
   /**
-   * Returns a list of all industry titles and their corresponding MCC/SIC/NAICS codes. Results are ordered by title.
+   * Returns a list of industries relevant to merchant profile enrichment.  Results are ordered by industry name.
    *
-   * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
+   * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/),
    * you'll need to specify the `/profile-enrichment.read` scope.
    */
   async list(

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.
    *

package/test/README.md

@@ -0,0 +1,2 @@
+1. Make sure you have `bun` [installed](https://bun.sh/docs/installation)
+2. Run `bun test` or `bun test:verbose` to see all the Requests and Responses

package/test/index.ts

@@ -0,0 +1 @@
+console.log("Hello via Bun!");

package/test/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "moov-typescript-test",
+  "module": "index.ts",
+  "type": "module",
+  "scripts": {
+    "format": "prettier --write \"**/*.{ts,tsx,md,json}\"",
+    "format:check": "prettier --check \"**/*.{ts,tsx,md,json}\"",
+    "test": "bun test --timeout 20000",
+    "test:verbose": "VERBOSE=1 bun test --timeout 20000"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "@types/chance": "^1.1.6",
+    "bun-types": "^1.2.2",
+    "chance": "^1.1.12",
+    "prettier": "^3.1.0",
+    "@moovio/sdk": "link:@moovio/sdk"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "dependencies": {
+    "remeda": "^2.20.1"
+  }
+}

package/test/setup.ts

@@ -0,0 +1,119 @@
+import { beforeAll, afterAll } from "bun:test";
+import { Moov } from "@moovio/sdk";
+import secrets from "./.secrets.json";
+
+export let moov: Moov;
+
+const verbose = process.env.VERBOSE === "1";
+
+type Seen = {
+  accountID: string;
+  bankAccountID?: string;
+  cardID?: string;
+  representativeID?: string;
+};
+
+const idsSeen: Set<Seen> = new Set();
+
+export const ids = {
+  seen: (seen: Seen) => {
+    idsSeen.add(seen);
+  },
+  cleanup: async () => {
+    for (const seen of idsSeen) {
+      if (seen.representativeID) {
+        try {
+          console.log("🔄  Removing Representative", seen.representativeID);
+          await moov.representatives.delete({ accountID: seen.accountID, representativeID: seen.representativeID! });
+        } catch (e) {
+          // empty
+        }
+      } else if (seen.bankAccountID) {
+        try {
+          console.log("🔄  Removing Bank Account", seen.bankAccountID);
+          await moov.bankAccounts.disable({ accountID: seen.accountID, bankAccountID: seen.bankAccountID! });
+        } catch (e) {
+          // eslint-disable
+        }
+      } else if (seen.cardID) {
+        try {
+          console.log("🔄  Removing Card", seen.cardID);
+          await moov.cards.disable({ accountID: seen.accountID, cardID: seen.cardID! });
+        } catch (e) {
+          // empty
+        }
+      } else if (seen.accountID) {
+        try {
+          console.log("🔄  Removing Account", seen.accountID);
+          await moov.accounts.disconnect({ accountID: seen.accountID });
+        } catch (e) {
+          // eslint-disable
+        }
+      }
+    }
+  },
+};
+
+beforeAll(() => {
+  if (verbose) {
+    // Override global fetch to attach a logger
+    const originalFetch = global.fetch;
+    global.fetch = async (input: RequestInfo | URL, init?: RequestInit) => {
+      const url = input instanceof Request ? input.url : input.toString();
+      const headers = input instanceof Request ? input.headers : "";
+      const body = input instanceof Request ? input.body : "";
+      const method = init?.method || (input instanceof Request ? input.method : "");
+
+      // Log requests
+      console.log(`↗️ API Request | ${method} | URL: ${url}`);
+      console.log(`Headers:`);
+      console.log(headers);
+      console.log(`Body:`);
+      console.log(body);
+      console.log("\n");
+
+      // Make the actual request
+      const response = await originalFetch(input, init);
+
+      // Clone the response since it can only be read once
+      const responseClone = response.clone();
+
+      // Log responses
+      console.log(`↙️ API Response | ${method} | URL: ${url}`);
+      console.log(`Status: ${response.status} ${response.statusText}`);
+      console.log(`Headers:`);
+      console.log(response.headers);
+      console.log(`Body:`);
+      try {
+        const responseBody = await responseClone.json();
+        console.log(JSON.stringify(responseBody, null, 2));
+      } catch (e) {
+        console.log("<non-JSON response>");
+      }
+      console.log("\n");
+
+      return response;
+    };
+
+    afterAll(() => {
+      global.fetch = originalFetch;
+    });
+    console.log("ℹ️  Logger setup complete\n\n");
+  }
+
+  moov = new Moov({
+    security: {
+      username: secrets.username,
+      password: secrets.password,
+    },
+    serverURL: secrets.serverURL,
+  });
+
+  console.log("ℹ️  Moov SDK setup complete\n\n");
+
+  afterAll(async () => {
+    console.log("\n\n🔄  Cleaning up after tests\n\n");
+    // Cleanup if we have the IDs available
+    await ids.cleanup();
+  });
+});

package/test/tests/accounts.test.ts

@@ -0,0 +1,127 @@
+import { expect, test, describe, beforeAll } from "bun:test";
+import { Chance } from "chance";
+import { moov } from "../setup";
+import { createAccount } from "../utils/utils";
+import type { Account, AccountType } from "../../models/components";
+const chance = new Chance();
+
+let account: Account;
+
+describe("Accounts", () => {
+  describe("Account creation", () => {
+    test("should create an account", async () => {
+      const legalBusinessName = `${chance.company()} ${new Date().getTime()}`;
+      const acc = await createAccount({
+        profile: {
+          business: {
+            legalBusinessName,
+          },
+        },
+      });
+
+      expect(acc).toBeDefined();
+      expect(acc.accountID).toBeDefined();
+      expect(acc.displayName).toEqual(legalBusinessName);
+      account = acc;
+    });
+    describe("Failure cases", () => {
+      test("should fail if the account type is not supported", async () => {
+        await expect(() =>
+          createAccount({
+            accountType: "not-a-valid-account-type" as AccountType,
+          }),
+        ).toThrowError();
+      });
+    });
+
+    test("should fail if we pass an empty business profile", async () => {
+      await expect(() =>
+        createAccount({
+          profile: {},
+        }),
+      ).toThrow();
+      // @TODO: Once error hanling is 100% consistent, we should be able to narrow this assertion
+      // Right now it's throwing a Zod validation error, but it should be a custom error instead
+      // ).toThrowError('API error occurred: {"error":{"profile":"business profile is required for business account"}}');
+    });
+  });
+
+  describe("Account-dependent tests", () => {
+    beforeAll(async () => {
+      if (!account) {
+        account = await createAccount();
+      }
+    });
+
+    describe("Account listing", () => {
+      test("should be able to list accounts", async () => {
+        const { result } = await moov.accounts.list({
+          name: account.displayName,
+        });
+        expect(result).toBeDefined();
+        expect(result.length).toBeGreaterThan(0);
+        expect(result[0].accountID).toEqual(account.accountID);
+      });
+
+      test("Should be able to filter accounts by type and status", async () => {
+        const { result } = await moov.accounts.list({
+          type: "business",
+          capabilityStatus: "pending",
+        });
+        expect(result).toBeDefined();
+        expect(result.length).toBeGreaterThan(0);
+        const { result: result2 } = await moov.accounts.list({
+          type: "individual",
+          capabilityStatus: "enabled",
+        });
+        expect(result2).toBeDefined();
+        expect(result2.length).toBeGreaterThan(0);
+      });
+
+      test("should be able to filter accounts by capability", async () => {
+        const { result } = await moov.accounts.list({
+          capability: "transfers",
+        });
+        expect(result).toBeDefined();
+        expect(result.length).toBeGreaterThan(0);
+        const { result: result2 } = await moov.accounts.list({
+          capability: "collect-funds",
+        });
+        expect(result2).toBeDefined();
+        expect(result2.length).toBeGreaterThan(0);
+      });
+    });
+
+    test("should be able to get an account", async () => {
+      const { result } = await moov.accounts.get({ accountID: account.accountID });
+      expect(result).toBeDefined();
+      expect(result.accountID).toEqual(account.accountID);
+    });
+
+    test("should be able to update an account", async () => {
+      const legalBusinessName = chance.company();
+      const { result } = await moov.accounts.update({
+        accountID: account.accountID,
+        createAccountUpdate: { profile: { business: { legalBusinessName } } },
+      });
+      expect(result).toBeDefined();
+      expect(result.accountID).toEqual(account.accountID);
+      expect(result.profile?.business?.legalBusinessName).toEqual(legalBusinessName);
+    });
+
+    test("should be able to get the terms of service token for an account", async () => {
+      const { result } = await moov.accounts.getTermsOfServiceToken({
+        origin: "https://example.com",
+        referer: "https://example.com",
+      });
+      expect(result).toBeDefined();
+      expect(result.token).toEqual(expect.any(String));
+    });
+
+    test("should be able to disconnect an account", async () => {
+      const response = await moov.accounts.disconnect({ accountID: account.accountID });
+      const headers = response?.headers;
+      expect(headers).toBeDefined();
+    });
+  });
+});