@moovio/sdk 24.1.12 → 24.2.0

package/src/lib/url.ts

@@ -13,21 +13,23 @@ export function pathToFunc(
   const paramRE = /\{([a-zA-Z0-9_][a-zA-Z0-9_-]*?)\}/g;
 
   return function buildURLPath(params: Record<string, unknown> = {}): string {
-    return pathPattern.replace(paramRE, function (_, placeholder) {
-      if (!hasOwn.call(params, placeholder)) {
-        throw new Error(`Parameter '${placeholder}' is required`);
-      }
+    return pathPattern
+      .replace(paramRE, function (_, placeholder) {
+        if (!hasOwn.call(params, placeholder)) {
+          throw new Error(`Parameter '${placeholder}' is required`);
+        }
 
-      const value = params[placeholder];
-      if (typeof value !== "string" && typeof value !== "number") {
-        throw new Error(
-          `Parameter '${placeholder}' must be a string or number`,
-        );
-      }
+        const value = params[placeholder];
+        if (typeof value !== "string" && typeof value !== "number") {
+          throw new Error(
+            `Parameter '${placeholder}' must be a string or number`,
+          );
+        }
 
-      return options?.charEncoding === "percent"
-        ? encodeURIComponent(`${value}`)
-        : `${value}`;
-    });
+        return options?.charEncoding === "percent"
+          ? encodeURIComponent(`${value}`)
+          : `${value}`;
+      })
+      .replace(/^\/+/, "");
   };
 }

package/src/mcp-server/cli/start/command.ts

@@ -51,15 +51,6 @@ export const startCommand = buildCommand({
           return z.string().parse(value);
         },
       },
-      "x-moov-version": {
-        kind: "parsed",
-        brief:
-          "Allows setting the xMoovVersion parameter for all supported operations",
-        optional: true,
-        parse: (value) => {
-          return z.string().parse(value);
-        },
-      },
       "server-url": {
         kind: "parsed",
         brief: "Overrides the default server URL used by the SDK",

package/src/mcp-server/cli/start/impl.ts

@@ -20,7 +20,6 @@ interface StartCommandFlags {
   readonly tool?: string[];
   readonly username?: string | undefined;
   readonly password?: string | undefined;
-  readonly "x-moov-version"?: SDKOptions["xMoovVersion"] | undefined;
   readonly "server-url"?: string;
   readonly "server-index"?: SDKOptions["serverIdx"];
   readonly "log-level": ConsoleLoggerLevel;
@@ -54,7 +53,6 @@ async function startStdio(flags: StartCommandFlags) {
       username: flags.username ?? "",
       password: flags.password ?? "",
     }),
-    xMoovVersion: flags["x-moov-version"],
     serverURL: flags["server-url"],
     serverIdx: flags["server-index"],
   });
@@ -78,7 +76,6 @@ async function startSSE(flags: StartCommandFlags) {
       username: flags.username ?? "",
       password: flags.password ?? "",
     }),
-    xMoovVersion: flags["x-moov-version"],
     serverURL: flags["server-url"],
     serverIdx: flags["server-index"],
   });

package/src/mcp-server/mcp-server.ts

@@ -19,7 +19,7 @@ const routes = buildRouteMap({
 export const app = buildApplication(routes, {
   name: "mcp",
   versionInfo: {
-    currentVersion: "24.1.12",
+    currentVersion: "24.2.0",
   },
 });
 

package/src/mcp-server/server.ts

@@ -185,17 +185,15 @@ export function createMCPServer(deps: {
   scopes?: MCPScope[] | undefined;
   serverURL?: string | undefined;
   security?: SDKOptions["security"] | undefined;
-  xMoovVersion?: SDKOptions["xMoovVersion"] | undefined;
   serverIdx?: SDKOptions["serverIdx"] | undefined;
 }) {
   const server = new McpServer({
     name: "Moov",
-    version: "24.1.12",
+    version: "24.2.0",
   });
 
   const client = new MoovCore({
     security: deps.security,
-    xMoovVersion: deps.xMoovVersion,
     serverURL: deps.serverURL,
     serverIdx: deps.serverIdx,
   });

package/src/mcp-server/tools/endToEndEncryptionGenerateKey.ts

@@ -3,22 +3,15 @@
  */
 
 import { endToEndEncryptionGenerateKey } from "../../funcs/endToEndEncryptionGenerateKey.js";
-import * as operations from "../../models/operations/index.js";
 import { formatResult, ToolDefinition } from "../tools.js";
 
-const args = {
-  request: operations.GenerateEndToEndKeyRequest$inboundSchema,
-};
-
-export const tool$endToEndEncryptionGenerateKey: ToolDefinition<typeof args> = {
+export const tool$endToEndEncryptionGenerateKey: ToolDefinition = {
   name: "end-to-end-encryption-generate-key",
   description:
     `Generates a public key used to create a JWE token for passing secure authentication data through non-PCI compliant intermediaries.`,
-  args,
-  tool: async (client, args, ctx) => {
+  tool: async (client, ctx) => {
     const [result, apiCall] = await endToEndEncryptionGenerateKey(
       client,
-      args.request,
       { fetchOptions: { signal: ctx.signal } },
     ).$inspect();
 

package/src/mcp-server/tools/industriesList.ts

@@ -3,25 +3,18 @@
  */
 
 import { industriesList } from "../../funcs/industriesList.js";
-import * as operations from "../../models/operations/index.js";
 import { formatResult, ToolDefinition } from "../tools.js";
 
-const args = {
-  request: operations.ListIndustriesRequest$inboundSchema,
-};
-
-export const tool$industriesList: ToolDefinition<typeof args> = {
+export const tool$industriesList: ToolDefinition = {
   name: "industries-list",
   description:
     `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/),
 you'll need to specify the \`/profile-enrichment.read\` scope.`,
-  args,
-  tool: async (client, args, ctx) => {
+  tool: async (client, ctx) => {
     const [result, apiCall] = await industriesList(
       client,
-      args.request,
       { fetchOptions: { signal: ctx.signal } },
     ).$inspect();
 

package/src/mcp-server/tools/onboardingListInvites.ts

@@ -3,24 +3,17 @@
  */
 
 import { onboardingListInvites } from "../../funcs/onboardingListInvites.js";
-import * as operations from "../../models/operations/index.js";
 import { formatResult, ToolDefinition } from "../tools.js";
 
-const args = {
-  request: operations.ListOnboardingInvitesRequest$inboundSchema,
-};
-
-export const tool$onboardingListInvites: ToolDefinition<typeof args> = {
+export const tool$onboardingListInvites: ToolDefinition = {
   name: "onboarding-list-invites",
   description: `List all the onboarding invites created by the caller's account.
 
 To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 
 you'll need to specify the \`/accounts.read\` scope.`,
-  args,
-  tool: async (client, args, ctx) => {
+  tool: async (client, ctx) => {
     const [result, apiCall] = await onboardingListInvites(
       client,
-      args.request,
       { fetchOptions: { signal: ctx.signal } },
     ).$inspect();
 

package/src/mcp-server/tools/pingPing.ts

@@ -3,24 +3,17 @@
  */
 
 import { pingPing } from "../../funcs/pingPing.js";
-import * as operations from "../../models/operations/index.js";
 import { formatResult, ToolDefinition } from "../tools.js";
 
-const args = {
-  request: operations.PingRequest$inboundSchema,
-};
-
-export const tool$pingPing: ToolDefinition<typeof args> = {
+export const tool$pingPing: ToolDefinition = {
   name: "ping-ping",
   description: `A simple endpoint to check auth.
 
 To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 
 you'll need to specify the \`/ping.read\` scope.`,
-  args,
-  tool: async (client, args, ctx) => {
+  tool: async (client, ctx) => {
     const [result, apiCall] = await pingPing(
       client,
-      args.request,
       { fetchOptions: { signal: ctx.signal } },
     ).$inspect();
 

package/src/mcp-server/tools/terminalApplicationsList.ts

@@ -3,24 +3,17 @@
  */
 
 import { terminalApplicationsList } from "../../funcs/terminalApplicationsList.js";
-import * as operations from "../../models/operations/index.js";
 import { formatResult, ToolDefinition } from "../tools.js";
 
-const args = {
-  request: operations.ListTerminalApplicationsRequest$inboundSchema,
-};
-
-export const tool$terminalApplicationsList: ToolDefinition<typeof args> = {
+export const tool$terminalApplicationsList: ToolDefinition = {
   name: "terminal-applications-list",
   description: `List all the terminal applications for a Moov Account.
 
 To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 
 you'll need to specify the \`/terminal-applications.read\` scope.`,
-  args,
-  tool: async (client, args, ctx) => {
+  tool: async (client, ctx) => {
     const [result, apiCall] = await terminalApplicationsList(
       client,
-      args.request,
       { fetchOptions: { signal: ctx.signal } },
     ).$inspect();
 

package/src/mcp-server/tools/webhooksList.ts

@@ -3,21 +3,14 @@
  */
 
 import { webhooksList } from "../../funcs/webhooksList.js";
-import * as operations from "../../models/operations/index.js";
 import { formatResult, ToolDefinition } from "../tools.js";
 
-const args = {
-  request: operations.ListWebhooksRequest$inboundSchema,
-};
-
-export const tool$webhooksList: ToolDefinition<typeof args> = {
+export const tool$webhooksList: ToolDefinition = {
   name: "webhooks-list",
   description: `List all webhooks configured for the account.`,
-  args,
-  tool: async (client, args, ctx) => {
+  tool: async (client, ctx) => {
     const [result, apiCall] = await webhooksList(
       client,
-      args.request,
       { fetchOptions: { signal: ctx.signal } },
     ).$inspect();
 

package/src/mcp-server/tools/webhooksListEventTypes.ts

@@ -3,21 +3,14 @@
  */
 
 import { webhooksListEventTypes } from "../../funcs/webhooksListEventTypes.js";
-import * as operations from "../../models/operations/index.js";
 import { formatResult, ToolDefinition } from "../tools.js";
 
-const args = {
-  request: operations.ListEventTypesRequest$inboundSchema,
-};
-
-export const tool$webhooksListEventTypes: ToolDefinition<typeof args> = {
+export const tool$webhooksListEventTypes: ToolDefinition = {
   name: "webhooks-list-event-types",
   description: `List all available event types that can be subscribed to.`,
-  args,
-  tool: async (client, args, ctx) => {
+  tool: async (client, ctx) => {
     const [result, apiCall] = await webhooksListEventTypes(
       client,
-      args.request,
       { fetchOptions: { signal: ctx.signal } },
     ).$inspect();
 

package/src/models/components/accountnameverification.ts

@@ -16,9 +16,21 @@ import {
  * The results of submitting cardholder name to a card network for verification.
  */
 export type AccountNameVerification = {
+  /**
+   * Verification result of the cardholder's first name.
+   */
   firstName?: CardVerificationResult | undefined;
+  /**
+   * Verification result of the cardholder's last name.
+   */
   lastName?: CardVerificationResult | undefined;
+  /**
+   * Verification result of the cardholder's middle name.
+   */
   middleName?: CardVerificationResult | undefined;
+  /**
+   * Verification result of the cardholder's full name.
+   */
   fullName?: CardVerificationResult | undefined;
 };
 

package/src/models/components/card.ts

@@ -104,6 +104,9 @@ export type Card = {
    * The name of the cardholder as it appears on the card.
    */
   holderName?: string | undefined;
+  /**
+   * The billing address associated with the card.
+   */
   billingAddress: CardAddress;
   /**
    * The results of submitting cardholder data to a card network for verification.
@@ -143,6 +146,12 @@ export type Card = {
    * Indicates cardholder has authorized card to be stored for future payments.
    */
   cardOnFile?: boolean | undefined;
+  /**
+   * Merchant account whose details (statement descriptor, address, etc.) are used for the card verification authorization.
+   *
+   * @remarks
+   * If omitted, the partner account's details are used instead.
+   */
   merchantAccountID?: string | undefined;
   /**
    * The results of the most recent card update request.

package/src/models/components/cardaccountupdater.ts

@@ -16,6 +16,9 @@ import {
  * The results of the most recent card update request.
  */
 export type CardAccountUpdater = {
+  /**
+   * Timestamp from the card network indicating when the card update was processed.
+   */
   updatedOn?: Date | undefined;
   /**
    * The results of the card update request.

package/src/models/components/cardaddress.ts

@@ -8,11 +8,29 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type CardAddress = {
+  /**
+   * Street address line 1.
+   */
   addressLine1?: string | undefined;
+  /**
+   * Street address line 2 (e.g., apartment or suite number).
+   */
   addressLine2?: string | undefined;
+  /**
+   * City name.
+   */
   city?: string | undefined;
+  /**
+   * Two-letter state or province code.
+   */
   stateOrProvince?: string | undefined;
+  /**
+   * Postal or ZIP code.
+   */
   postalCode: string;
+  /**
+   * Two-letter ISO 3166-1 country code.
+   */
   country?: string | undefined;
 };
 

package/src/models/components/cardexpiration.ts

@@ -11,7 +11,13 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  * The expiration date of the card or token.
  */
 export type CardExpiration = {
+  /**
+   * Two-digit month the card expires.
+   */
   month: string;
+  /**
+   * Two-digit year the card expires.
+   */
   year: string;
 };
 

package/src/models/components/cardverification.ts

@@ -22,11 +22,26 @@ import {
  * The results of submitting cardholder data to a card network for verification.
  */
 export type CardVerification = {
+  /**
+   * Verification result of the card's CVV.
+   */
   cvv: CardVerificationResult;
+  /**
+   * Verification result of the billing address line 1.
+   *
+   * @remarks
+   * Derived from the same AVS code as `postalCode`; the card network returns a single code covering both address fields.
+   */
   addressLine1: CardVerificationResult;
+  /**
+   * Verification result of the billing address postal code.
+   *
+   * @remarks
+   * Derived from the same AVS code as `addressLine1`; the card network returns a single code covering both address fields.
+   */
   postalCode: CardVerificationResult;
   /**
-   * The results of submitting cardholder name to a card network for verification.
+   * Verification results of the cardholder's name, broken down by name component.
    */
   accountName?: AccountNameVerification | undefined;
 };

package/src/models/components/cardverificationresult.ts

@@ -5,6 +5,9 @@
 import * as z from "zod/v3";
 import { ClosedEnum } from "../../types/enums.js";
 
+/**
+ * The result of a card verification check.
+ */
 export const CardVerificationResult = {
   NoMatch: "noMatch",
   Match: "match",
@@ -12,6 +15,9 @@ export const CardVerificationResult = {
   Unavailable: "unavailable",
   PartialMatch: "partialMatch",
 } as const;
+/**
+ * The result of a card verification check.
+ */
 export type CardVerificationResult = ClosedEnum<typeof CardVerificationResult>;
 
 /** @internal */

package/src/models/components/linkcard.ts

@@ -34,16 +34,46 @@ export type LinkCard = {
    * [GitHub repository](https://github.com/moovfinancial/moov-go/blob/main/examples/e2ee/e2ee_test.go).
    */
   e2ee?: E2EEToken | undefined;
+  /**
+   * The full card number (PAN).
+   */
   cardNumber: string;
+  /**
+   * The card's 3- or 4-digit card verification value.
+   */
   cardCvv: 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;
+  /**
+   * The billing address associated with the card.
+   */
   billingAddress: CardAddress;
+  /**
+   * Indicates cardholder has authorized card to be stored for future payments. (e.g., recurring payments).
+   *
+   * @remarks
+   * If true and no `merchantAccountID` is provided, the partner account's ID is used as the merchant account for verification.
+   */
   cardOnFile?: boolean | undefined;
+  /**
+   * Merchant account whose details (statement descriptor, address, etc.) are used for the card verification authorization.
+   *
+   * @remarks
+   * If omitted, the partner account's details are used instead.
+   */
   merchantAccountID?: string | undefined;
+  /**
+   * If true, submits the cardholder's name to the card network for verification as part of the $0 authorization.
+   *
+   * @remarks
+   * Only supported for Visa and Mastercard; requesting name verification for American Express or Discover will return an error.
+   */
   verifyName?: boolean | undefined;
 };
 

package/src/models/components/paymentmethodscard.ts

@@ -91,6 +91,9 @@ export type PaymentMethodsCard = {
    * The name of the cardholder as it appears on the card.
    */
   holderName?: string | undefined;
+  /**
+   * The billing address associated with the card.
+   */
   billingAddress: CardAddress;
   /**
    * The results of submitting cardholder data to a card network for verification.
@@ -108,6 +111,12 @@ export type PaymentMethodsCard = {
    * Indicates cardholder has authorized card to be stored for future payments.
    */
   cardOnFile?: boolean | undefined;
+  /**
+   * Merchant account whose details (statement descriptor, address, etc.) are used for the card verification authorization.
+   *
+   * @remarks
+   * If omitted, the partner account's details are used instead.
+   */
   merchantAccountID?: string | undefined;
   /**
    * The results of the most recent card update request.

package/src/models/components/transferpaymentmethodscard.ts

@@ -91,6 +91,9 @@ export type TransferPaymentMethodsCard = {
    * The name of the cardholder as it appears on the card.
    */
   holderName?: string | undefined;
+  /**
+   * The billing address associated with the card.
+   */
   billingAddress: CardAddress;
   /**
    * The results of submitting cardholder data to a card network for verification.
@@ -108,6 +111,12 @@ export type TransferPaymentMethodsCard = {
    * Indicates cardholder has authorized card to be stored for future payments.
    */
   cardOnFile?: boolean | undefined;
+  /**
+   * Merchant account whose details (statement descriptor, address, etc.) are used for the card verification authorization.
+   *
+   * @remarks
+   * If omitted, the partner account's details are used instead.
+   */
   merchantAccountID?: string | undefined;
   /**
    * The results of the most recent card update request.

package/src/models/components/updatecard.ts

@@ -34,12 +34,39 @@ export type UpdateCard = {
    * [GitHub repository](https://github.com/moovfinancial/moov-go/blob/main/examples/e2ee/e2ee_test.go).
    */
   e2ee?: E2EETokenUpdate | undefined;
+  /**
+   * Updated billing address to store on file for the card.
+   */
   billingAddress?: UpdateCardAddress | undefined;
   expiration?: UpdateCardExpiration | undefined;
+  /**
+   * The card's 3- or 4-digit card verification value. Providing this triggers a new $0 verification authorization, which performs both CVV and address verification.
+   */
   cardCvv?: string | undefined;
+  /**
+   * Indicates cardholder has authorized card to be stored for future payments (e.g., recurring payments).
+   *
+   * @remarks
+   * If true and no `merchantAccountID` is provided, the partner account's ID is automatically used as the merchant account for verification.
+   */
   cardOnFile?: boolean | undefined;
+  /**
+   * Merchant account whose details (statement descriptor, address, etc.) are used for the card verification authorization.
+   *
+   * @remarks
+   * If omitted, the partner account's details are used instead.
+   */
   merchantAccountID?: string | undefined;
+  /**
+   * If true, submits the cardholder's name to the card network for verification as part of the $0 authorization.
+   *
+   * @remarks
+   * Only supported for Visa and Mastercard; requesting name verification for American Express or Discover will return an error.
+   */
   verifyName?: boolean | undefined;
+  /**
+   * Updated name of the cardholder as it appears on the card.
+   */
   holderName?: string | undefined;
 };
 

package/src/models/components/updatecardaddress.ts

@@ -8,11 +8,29 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type UpdateCardAddress = {
+  /**
+   * Street address line 1.
+   */
   addressLine1?: string | undefined;
+  /**
+   * Street address line 2 (e.g., apartment or suite number).
+   */
   addressLine2?: string | undefined;
+  /**
+   * City name.
+   */
   city?: string | undefined;
+  /**
+   * Two-letter state or province code.
+   */
   stateOrProvince?: string | undefined;
+  /**
+   * Postal or ZIP code.
+   */
   postalCode?: string | undefined;
+  /**
+   * Two-letter ISO 3166-1 country code.
+   */
   country?: string | undefined;
 };
 

package/src/models/components/updatecardexpiration.ts

@@ -8,7 +8,13 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type UpdateCardExpiration = {
+  /**
+   * Two-digit month the card expires.
+   */
   month?: string | undefined;
+  /**
+   * Two-digit year the card expires.
+   */
   year?: string | undefined;
 };