@moovio/sdk 0.8.1 → 0.10.0

package/src/mcp-server/prompts.ts

@@ -0,0 +1,110 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
+import { GetPromptResult } from "@modelcontextprotocol/sdk/types.js";
+import {
+  objectOutputType,
+  ZodOptional,
+  ZodType,
+  ZodTypeAny,
+  ZodTypeDef,
+} from "zod";
+import { MoovCore } from "../core.js";
+import { ConsoleLogger } from "./console-logger.js";
+import { MCPScope } from "./scopes.js";
+
+// '@modelcontextprotocol/sdk' currently does not export this type
+export type PromptArgsRawShape = {
+  [k: string]:
+    | ZodType<string, ZodTypeDef, string>
+    | ZodOptional<ZodType<string, ZodTypeDef, string>>;
+};
+
+export type PromptDefinition<
+  Args extends undefined | PromptArgsRawShape = undefined,
+> = Args extends PromptArgsRawShape ? {
+    name: string;
+    description?: string;
+    scopes?: MCPScope[];
+    args: Args;
+    prompt: (
+      client: MoovCore,
+      args: objectOutputType<Args, ZodTypeAny>,
+      extra: RequestHandlerExtra,
+    ) => GetPromptResult | Promise<GetPromptResult>;
+  }
+  : {
+    name: string;
+    description?: string;
+    scopes?: MCPScope[];
+    args?: undefined;
+    prompt: (
+      client: MoovCore,
+      extra: RequestHandlerExtra,
+    ) => GetPromptResult | Promise<GetPromptResult>;
+  };
+
+// Optional function to assist with formatting prompt results
+export async function formatResult(value: string): Promise<GetPromptResult> {
+  return {
+    messages: [
+      {
+        role: "user",
+        content: {
+          type: "text",
+          text: value,
+        },
+      },
+    ],
+  };
+}
+
+export function createRegisterPrompt(
+  logger: ConsoleLogger,
+  server: McpServer,
+  sdk: MoovCore,
+  allowedScopes: Set<MCPScope>,
+): <A extends PromptArgsRawShape | undefined>(
+  prompt: PromptDefinition<A>,
+) => void {
+  return <A extends PromptArgsRawShape | undefined>(
+    prompt: PromptDefinition<A>,
+  ): void => {
+    const scopes = prompt.scopes ?? [];
+    if (!scopes.every((s: MCPScope) => allowedScopes.has(s))) {
+      return;
+    }
+
+    if (prompt.args) {
+      if (prompt.description) {
+        server.prompt(
+          prompt.name,
+          prompt.description,
+          prompt.args,
+          async (args, ctx) => prompt.prompt(sdk, args, ctx),
+        );
+      } else {
+        server.prompt(
+          prompt.name,
+          prompt.args,
+          async (args, ctx) => prompt.prompt(sdk, args, ctx),
+        );
+      }
+    } else {
+      if (prompt.description) {
+        server.prompt(
+          prompt.name,
+          prompt.description,
+          async (ctx) => prompt.prompt(sdk, ctx),
+        );
+      } else {
+        server.prompt(prompt.name, async (ctx) => prompt.prompt(sdk, ctx));
+      }
+    }
+
+    logger.debug("Registered prompt", { name: prompt.name });
+  };
+}

package/src/mcp-server/resources.ts

@@ -46,6 +46,7 @@ export type ResourceTemplateDefinition = {
   read: ReadResourceTemplateCallback;
 };
 
+// Optional function to assist with formatting resource results
 export async function formatResult(
   value: unknown,
   uri: URL,

package/src/mcp-server/server.ts

@@ -6,6 +6,7 @@ import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { MoovCore } from "../core.js";
 import { SDKOptions } from "../lib/config.js";
 import type { ConsoleLogger } from "./console-logger.js";
+import { createRegisterPrompt } from "./prompts.js";
 import {
   createRegisterResource,
   createRegisterResourceTemplate,
@@ -155,7 +156,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "Moov",
-    version: "0.8.1",
+    version: "0.10.0",
   });
 
   const client = new MoovCore({
@@ -182,7 +183,8 @@ export function createMCPServer(deps: {
     client,
     scopes,
   );
-  const register = { tool, resource, resourceTemplate };
+  const prompt = createRegisterPrompt(deps.logger, server, client, scopes);
+  const register = { tool, resource, resourceTemplate, prompt };
   void register; // suppress unused warnings
 
   tool(tool$accountsCreate);

package/src/mcp-server/tools.ts

@@ -34,6 +34,7 @@ export type ToolDefinition<Args extends undefined | ZodRawShape = undefined> =
       ) => CallToolResult | Promise<CallToolResult>;
     };
 
+// Optional function to assist with formatting tool results
 export async function formatResult(
   value: unknown,
   init: { response?: Response | undefined },

package/src/models/components/createtransfersource.ts

@@ -31,6 +31,7 @@ export type CreateTransferSource = {
    */
   transferID?: string | undefined;
   paymentMethodID?: string | undefined;
+  paymentToken?: string | undefined;
   cardDetails?: CreateTransferSourceCard | undefined;
   achDetails?: CreateTransferSourceACH | undefined;
 };
@@ -43,6 +44,7 @@ export const CreateTransferSource$inboundSchema: z.ZodType<
 > = z.object({
   transferID: z.string().optional(),
   paymentMethodID: z.string().optional(),
+  paymentToken: z.string().optional(),
   cardDetails: CreateTransferSourceCard$inboundSchema.optional(),
   achDetails: CreateTransferSourceACH$inboundSchema.optional(),
 });
@@ -51,6 +53,7 @@ export const CreateTransferSource$inboundSchema: z.ZodType<
 export type CreateTransferSource$Outbound = {
   transferID?: string | undefined;
   paymentMethodID?: string | undefined;
+  paymentToken?: string | undefined;
   cardDetails?: CreateTransferSourceCard$Outbound | undefined;
   achDetails?: CreateTransferSourceACH$Outbound | undefined;
 };
@@ -63,6 +66,7 @@ export const CreateTransferSource$outboundSchema: z.ZodType<
 > = z.object({
   transferID: z.string().optional(),
   paymentMethodID: z.string().optional(),
+  paymentToken: z.string().optional(),
   cardDetails: CreateTransferSourceCard$outboundSchema.optional(),
   achDetails: CreateTransferSourceACH$outboundSchema.optional(),
 });

package/src/models/components/feeplan.ts

@@ -23,6 +23,12 @@ import {
   MinimumCommitment$Outbound,
   MinimumCommitment$outboundSchema,
 } from "./minimumcommitment.js";
+import {
+  MonthlyPlatformFee,
+  MonthlyPlatformFee$inboundSchema,
+  MonthlyPlatformFee$Outbound,
+  MonthlyPlatformFee$outboundSchema,
+} from "./monthlyplatformfee.js";
 
 export type FeePlan = {
   planID: string;
@@ -46,6 +52,10 @@ export type FeePlan = {
    * The minimum spending amount that must be met in the billing period. If actual usage is below the minimum amount, account is charged the difference.
    */
   minimumCommitment: MinimumCommitment;
+  /**
+   * Fixed recurring amount paid in the billing period regardless of usage.
+   */
+  monthlyPlatformFee: MonthlyPlatformFee;
   createdAt: Date;
 };
 
@@ -58,6 +68,7 @@ export const FeePlan$inboundSchema: z.ZodType<FeePlan, z.ZodTypeDef, unknown> =
     cardAcquiringModel: CardAcquiringModel$inboundSchema,
     billableFees: z.array(BillableFee$inboundSchema),
     minimumCommitment: MinimumCommitment$inboundSchema,
+    monthlyPlatformFee: MonthlyPlatformFee$inboundSchema,
     createdAt: z.string().datetime({ offset: true }).transform(v =>
       new Date(v)
     ),
@@ -71,6 +82,7 @@ export type FeePlan$Outbound = {
   cardAcquiringModel: string;
   billableFees: Array<BillableFee$Outbound>;
   minimumCommitment: MinimumCommitment$Outbound;
+  monthlyPlatformFee: MonthlyPlatformFee$Outbound;
   createdAt: string;
 };
 
@@ -86,6 +98,7 @@ export const FeePlan$outboundSchema: z.ZodType<
   cardAcquiringModel: CardAcquiringModel$outboundSchema,
   billableFees: z.array(BillableFee$outboundSchema),
   minimumCommitment: MinimumCommitment$outboundSchema,
+  monthlyPlatformFee: MonthlyPlatformFee$outboundSchema,
   createdAt: z.date().transform(v => v.toISOString()),
 });
 

package/src/models/components/feeplanagreement.ts

@@ -28,6 +28,12 @@ import {
   MinimumCommitment$Outbound,
   MinimumCommitment$outboundSchema,
 } from "./minimumcommitment.js";
+import {
+  MonthlyPlatformFee,
+  MonthlyPlatformFee$inboundSchema,
+  MonthlyPlatformFee$Outbound,
+  MonthlyPlatformFee$outboundSchema,
+} from "./monthlyplatformfee.js";
 
 export type FeePlanAgreement = {
   agreementID: string;
@@ -52,6 +58,10 @@ export type FeePlanAgreement = {
    * The minimum spending amount that must be met in the billing period. If actual usage is below the minimum amount, account is charged the difference.
    */
   minimumCommitment: MinimumCommitment;
+  /**
+   * Fixed recurring amount paid in the billing period regardless of usage.
+   */
+  monthlyPlatformFee: MonthlyPlatformFee;
 };
 
 /** @internal */
@@ -70,6 +80,7 @@ export const FeePlanAgreement$inboundSchema: z.ZodType<
   cardAcquiringModel: CardAcquiringModel$inboundSchema,
   billableFees: z.array(BillableFee$inboundSchema),
   minimumCommitment: MinimumCommitment$inboundSchema,
+  monthlyPlatformFee: MonthlyPlatformFee$inboundSchema,
 });
 
 /** @internal */
@@ -84,6 +95,7 @@ export type FeePlanAgreement$Outbound = {
   cardAcquiringModel: string;
   billableFees: Array<BillableFee$Outbound>;
   minimumCommitment: MinimumCommitment$Outbound;
+  monthlyPlatformFee: MonthlyPlatformFee$Outbound;
 };
 
 /** @internal */
@@ -102,6 +114,7 @@ export const FeePlanAgreement$outboundSchema: z.ZodType<
   cardAcquiringModel: CardAcquiringModel$outboundSchema,
   billableFees: z.array(BillableFee$outboundSchema),
   minimumCommitment: MinimumCommitment$outboundSchema,
+  monthlyPlatformFee: MonthlyPlatformFee$outboundSchema,
 });
 
 /**

package/src/models/components/index.ts

@@ -223,6 +223,7 @@ export * from "./manualtermsofserviceupdate.js";
 export * from "./microdepositstatus.js";
 export * from "./minimumcommitment.js";
 export * from "./mode.js";
+export * from "./monthlyplatformfee.js";
 export * from "./moovfeedetails.js";
 export * from "./moovwalletpaymentmethod.js";
 export * from "./mxauthorizationcode.js";

package/src/models/components/monthlyplatformfee.ts

@@ -0,0 +1,83 @@
+/*
+ * 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";
+
+/**
+ * Fixed recurring amount paid in the billing period regardless of usage.
+ */
+export type MonthlyPlatformFee = {
+  /**
+   * A 3-letter ISO 4217 currency code.
+   */
+  currency: string;
+  /**
+   * A decimal-formatted numerical string that represents up to 9 decimal place precision.
+   *
+   * @remarks
+   *
+   * For example, $12.987654321 is '12.987654321'.
+   */
+  valueDecimal: string;
+};
+
+/** @internal */
+export const MonthlyPlatformFee$inboundSchema: z.ZodType<
+  MonthlyPlatformFee,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string(),
+  valueDecimal: z.string(),
+});
+
+/** @internal */
+export type MonthlyPlatformFee$Outbound = {
+  currency: string;
+  valueDecimal: string;
+};
+
+/** @internal */
+export const MonthlyPlatformFee$outboundSchema: z.ZodType<
+  MonthlyPlatformFee$Outbound,
+  z.ZodTypeDef,
+  MonthlyPlatformFee
+> = z.object({
+  currency: z.string(),
+  valueDecimal: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MonthlyPlatformFee$ {
+  /** @deprecated use `MonthlyPlatformFee$inboundSchema` instead. */
+  export const inboundSchema = MonthlyPlatformFee$inboundSchema;
+  /** @deprecated use `MonthlyPlatformFee$outboundSchema` instead. */
+  export const outboundSchema = MonthlyPlatformFee$outboundSchema;
+  /** @deprecated use `MonthlyPlatformFee$Outbound` instead. */
+  export type Outbound = MonthlyPlatformFee$Outbound;
+}
+
+export function monthlyPlatformFeeToJSON(
+  monthlyPlatformFee: MonthlyPlatformFee,
+): string {
+  return JSON.stringify(
+    MonthlyPlatformFee$outboundSchema.parse(monthlyPlatformFee),
+  );
+}
+
+export function monthlyPlatformFeeFromJSON(
+  jsonString: string,
+): SafeParseResult<MonthlyPlatformFee, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MonthlyPlatformFee$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MonthlyPlatformFee' from JSON`,
+  );
+}

package/src/models/components/partnerpricing.ts

@@ -23,6 +23,12 @@ import {
   MinimumCommitment$Outbound,
   MinimumCommitment$outboundSchema,
 } from "./minimumcommitment.js";
+import {
+  MonthlyPlatformFee,
+  MonthlyPlatformFee$inboundSchema,
+  MonthlyPlatformFee$Outbound,
+  MonthlyPlatformFee$outboundSchema,
+} from "./monthlyplatformfee.js";
 
 export type PartnerPricing = {
   planID: string;
@@ -47,6 +53,10 @@ export type PartnerPricing = {
    * The minimum spending amount that must be met in the billing period. If actual usage is below the minimum amount, account is charged the difference.
    */
   minimumCommitment: MinimumCommitment;
+  /**
+   * Fixed recurring amount paid in the billing period regardless of usage.
+   */
+  monthlyPlatformFee: MonthlyPlatformFee;
   createdAt: Date;
 };
 
@@ -63,6 +73,7 @@ export const PartnerPricing$inboundSchema: z.ZodType<
   cardAcquiringModel: CardAcquiringModel$inboundSchema,
   billableFees: z.array(BillableFee$inboundSchema),
   minimumCommitment: MinimumCommitment$inboundSchema,
+  monthlyPlatformFee: MonthlyPlatformFee$inboundSchema,
   createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
 });
 
@@ -75,6 +86,7 @@ export type PartnerPricing$Outbound = {
   cardAcquiringModel: string;
   billableFees: Array<BillableFee$Outbound>;
   minimumCommitment: MinimumCommitment$Outbound;
+  monthlyPlatformFee: MonthlyPlatformFee$Outbound;
   createdAt: string;
 };
 
@@ -91,6 +103,7 @@ export const PartnerPricing$outboundSchema: z.ZodType<
   cardAcquiringModel: CardAcquiringModel$outboundSchema,
   billableFees: z.array(BillableFee$outboundSchema),
   minimumCommitment: MinimumCommitment$outboundSchema,
+  monthlyPlatformFee: MonthlyPlatformFee$outboundSchema,
   createdAt: z.date().transform(v => v.toISOString()),
 });
 

package/src/models/components/partnerpricingagreement.ts

@@ -28,6 +28,12 @@ import {
   MinimumCommitment$Outbound,
   MinimumCommitment$outboundSchema,
 } from "./minimumcommitment.js";
+import {
+  MonthlyPlatformFee,
+  MonthlyPlatformFee$inboundSchema,
+  MonthlyPlatformFee$Outbound,
+  MonthlyPlatformFee$outboundSchema,
+} from "./monthlyplatformfee.js";
 
 export type PartnerPricingAgreement = {
   agreementID: string;
@@ -52,6 +58,10 @@ export type PartnerPricingAgreement = {
    * The minimum spending amount that must be met in the billing period. If actual usage is below the minimum amount, account is charged the difference.
    */
   minimumCommitment: MinimumCommitment;
+  /**
+   * Fixed recurring amount paid in the billing period regardless of usage.
+   */
+  monthlyPlatformFee: MonthlyPlatformFee;
   /**
    * The integer percentage value of the revenue split for partner.
    */
@@ -74,6 +84,7 @@ export const PartnerPricingAgreement$inboundSchema: z.ZodType<
   cardAcquiringModel: CardAcquiringModel$inboundSchema,
   billableFees: z.array(BillableFee$inboundSchema),
   minimumCommitment: MinimumCommitment$inboundSchema,
+  monthlyPlatformFee: MonthlyPlatformFee$inboundSchema,
   revenueShare: z.number().int(),
 });
 
@@ -89,6 +100,7 @@ export type PartnerPricingAgreement$Outbound = {
   cardAcquiringModel: string;
   billableFees: Array<BillableFee$Outbound>;
   minimumCommitment: MinimumCommitment$Outbound;
+  monthlyPlatformFee: MonthlyPlatformFee$Outbound;
   revenueShare: number;
 };
 
@@ -108,6 +120,7 @@ export const PartnerPricingAgreement$outboundSchema: z.ZodType<
   cardAcquiringModel: CardAcquiringModel$outboundSchema,
   billableFees: z.array(BillableFee$outboundSchema),
   minimumCommitment: MinimumCommitment$outboundSchema,
+  monthlyPlatformFee: MonthlyPlatformFee$outboundSchema,
   revenueShare: z.number().int(),
 });
 

package/src/models/components/transfersource.ts

@@ -47,6 +47,12 @@ import {
   PaymentMethodType$inboundSchema,
   PaymentMethodType$outboundSchema,
 } from "./paymentmethodtype.js";
+import {
+  TerminalCard,
+  TerminalCard$inboundSchema,
+  TerminalCard$Outbound,
+  TerminalCard$outboundSchema,
+} from "./terminalcard.js";
 import {
   TransferAccount,
   TransferAccount$inboundSchema,
@@ -78,6 +84,10 @@ export type TransferSource = {
    * Describes an Apple Pay token on a Moov account.
    */
   applePay?: ApplePayResponse | undefined;
+  /**
+   * Describes payment card details captured with tap or in-person payment.
+   */
+  terminalCard?: TerminalCard | undefined;
   /**
    * Card-specific details about the transaction.
    */
@@ -102,6 +112,7 @@ export const TransferSource$inboundSchema: z.ZodType<
   wallet: PaymentMethodsWallet$inboundSchema.optional(),
   card: PaymentMethodsCard$inboundSchema.optional(),
   applePay: ApplePayResponse$inboundSchema.optional(),
+  terminalCard: TerminalCard$inboundSchema.optional(),
   cardDetails: CardTransactionDetails$inboundSchema.optional(),
   achDetails: ACHTransactionDetails$inboundSchema.optional(),
 });
@@ -116,6 +127,7 @@ export type TransferSource$Outbound = {
   wallet?: PaymentMethodsWallet$Outbound | undefined;
   card?: PaymentMethodsCard$Outbound | undefined;
   applePay?: ApplePayResponse$Outbound | undefined;
+  terminalCard?: TerminalCard$Outbound | undefined;
   cardDetails?: CardTransactionDetails$Outbound | undefined;
   achDetails?: ACHTransactionDetails$Outbound | undefined;
 };
@@ -134,6 +146,7 @@ export const TransferSource$outboundSchema: z.ZodType<
   wallet: PaymentMethodsWallet$outboundSchema.optional(),
   card: PaymentMethodsCard$outboundSchema.optional(),
   applePay: ApplePayResponse$outboundSchema.optional(),
+  terminalCard: TerminalCard$outboundSchema.optional(),
   cardDetails: CardTransactionDetails$outboundSchema.optional(),
   achDetails: ACHTransactionDetails$outboundSchema.optional(),
 });

package/src/models/components/wallettransactionsourcetype.ts

@@ -12,6 +12,7 @@ export const WalletTransactionSourceType = {
   IssuingAuthorization: "issuing-authorization",
   Sweep: "sweep",
   Adjustment: "adjustment",
+  Fee: "fee",
 } as const;
 export type WalletTransactionSourceType = ClosedEnum<
   typeof WalletTransactionSourceType