@moovio/sdk 0.4.0 → 0.5.1

package/src/mcp-server/tools.ts

@@ -0,0 +1,116 @@
+/*
+ * 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 { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { objectOutputType, ZodRawShape, ZodTypeAny } from "zod";
+import { MoovCore } from "../core.js";
+import { ConsoleLogger } from "./console-logger.js";
+import { MCPScope } from "./scopes.js";
+import { isAsyncIterable, isBinaryData, valueToBase64 } from "./shared.js";
+
+export type ToolDefinition<Args extends undefined | ZodRawShape = undefined> =
+  Args extends ZodRawShape ? {
+      name: string;
+      description: string;
+      scopes?: MCPScope[];
+      args: Args;
+      tool: (
+        client: MoovCore,
+        args: objectOutputType<Args, ZodTypeAny>,
+        extra: RequestHandlerExtra,
+      ) => CallToolResult | Promise<CallToolResult>;
+    }
+    : {
+      name: string;
+      description: string;
+      scopes?: MCPScope[];
+      args?: undefined;
+      tool: (
+        client: MoovCore,
+        extra: RequestHandlerExtra,
+      ) => CallToolResult | Promise<CallToolResult>;
+    };
+
+export async function formatResult(
+  value: unknown,
+  init: { response?: Response | undefined },
+): Promise<CallToolResult> {
+  if (typeof value === "undefined") {
+    return { content: [] };
+  }
+
+  const { response } = init;
+  const contentType = response?.headers.get("content-type") ?? "";
+  let content: CallToolResult["content"] = [];
+
+  if (contentType.search(/\bjson\b/g)) {
+    content = [{ type: "text", text: JSON.stringify(value) }];
+  } else if (
+    contentType.startsWith("text/event-stream")
+    && isAsyncIterable(value)
+  ) {
+    content = await consumeSSE(value);
+  } else if (contentType.startsWith("text/") && typeof value === "string") {
+    content = [{ type: "text", text: value }];
+  } else if (isBinaryData(value) && contentType.startsWith("image/")) {
+    const data = await valueToBase64(value);
+    content = data == null
+      ? []
+      : [{ type: "image", data, mimeType: contentType }];
+  } else {
+    return {
+      content: [{
+        type: "text",
+        text: `Unsupported content type: "${contentType}"`,
+      }],
+      isError: true,
+    };
+  }
+
+  return { content };
+}
+
+async function consumeSSE(
+  value: AsyncIterable<unknown>,
+): Promise<CallToolResult["content"]> {
+  const content: CallToolResult["content"] = [];
+
+  for await (const chunk of value) {
+    if (typeof chunk === "string") {
+      content.push({ type: "text", text: chunk });
+    } else {
+      content.push({ type: "text", text: JSON.stringify(chunk) });
+    }
+  }
+
+  return content;
+}
+
+export function createRegisterTool(
+  logger: ConsoleLogger,
+  server: McpServer,
+  sdk: MoovCore,
+  allowedScopes: Set<MCPScope>,
+): <A extends ZodRawShape | undefined>(tool: ToolDefinition<A>) => void {
+  return <A extends ZodRawShape | undefined>(tool: ToolDefinition<A>): void => {
+    const toolScopes = tool.scopes ?? [];
+    if (!toolScopes.every((s) => allowedScopes.has(s))) {
+      return;
+    }
+
+    if (tool.args) {
+      server.tool(tool.name, tool.description, tool.args, async (args, ctx) => {
+        return tool.tool(sdk, args, ctx);
+      });
+    } else {
+      server.tool(tool.name, tool.description, async (ctx) => {
+        return tool.tool(sdk, ctx);
+      });
+    }
+
+    logger.debug("Registered tool", { name: tool.name });
+  };
+}

package/src/models/components/bankaccount.ts

@@ -69,7 +69,7 @@ export type BankAccount = {
   /**
    * The reason the bank account status changed to the current value.
    */
-  statusReason: BankAccountStatusReason;
+  statusReason?: BankAccountStatusReason | undefined;
   /**
    * Reason for, and details related to, an `errored` or `verificationFailed` bank account status.
    */
@@ -101,7 +101,7 @@ export const BankAccount$inboundSchema: z.ZodType<
   routingNumber: z.string(),
   lastFourAccountNumber: z.string(),
   updatedOn: z.string().datetime({ offset: true }).transform(v => new Date(v)),
-  statusReason: BankAccountStatusReason$inboundSchema,
+  statusReason: BankAccountStatusReason$inboundSchema.optional(),
   exceptionDetails: BankAccountException$inboundSchema.optional(),
   paymentMethods: z.array(BasicPaymentMethod$inboundSchema).optional(),
 });
@@ -118,7 +118,7 @@ export type BankAccount$Outbound = {
   routingNumber: string;
   lastFourAccountNumber: string;
   updatedOn: string;
-  statusReason: string;
+  statusReason?: string | undefined;
   exceptionDetails?: BankAccountException$Outbound | undefined;
   paymentMethods?: Array<BasicPaymentMethod$Outbound> | undefined;
 };
@@ -139,7 +139,7 @@ export const BankAccount$outboundSchema: z.ZodType<
   routingNumber: z.string(),
   lastFourAccountNumber: z.string(),
   updatedOn: z.date().transform(v => v.toISOString()),
-  statusReason: BankAccountStatusReason$outboundSchema,
+  statusReason: BankAccountStatusReason$outboundSchema.optional(),
   exceptionDetails: BankAccountException$outboundSchema.optional(),
   paymentMethods: z.array(BasicPaymentMethod$outboundSchema).optional(),
 });

package/src/models/components/cancellation.ts

@@ -13,6 +13,7 @@ import {
 } from "./cancellationstatus.js";
 
 export type Cancellation = {
+  cancellationID: string;
   status: CancellationStatus;
   createdOn: Date;
 };
@@ -23,12 +24,14 @@ export const Cancellation$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  cancellationID: z.string(),
   status: CancellationStatus$inboundSchema,
   createdOn: z.string().datetime({ offset: true }).transform(v => new Date(v)),
 });
 
 /** @internal */
 export type Cancellation$Outbound = {
+  cancellationID: string;
   status: string;
   createdOn: string;
 };
@@ -39,6 +42,7 @@ export const Cancellation$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Cancellation
 > = z.object({
+  cancellationID: z.string(),
   status: CancellationStatus$outboundSchema,
   createdOn: z.date().transform(v => v.toISOString()),
 });

package/src/models/components/card.ts

@@ -87,7 +87,7 @@ export type Card = {
    * @remarks
    * Examples include, but not limited to, "REWARDS", "TRADITIONAL REWARDS", "CLASSIC", and "CORPORATE PURCHASING".
    */
-  cardCategory: string;
+  cardCategory?: string | undefined;
   /**
    * Last four digits of the card number
    */
@@ -166,7 +166,7 @@ export const Card$inboundSchema: z.ZodType<Card, z.ZodTypeDef, unknown> = z
     fingerprint: z.string(),
     brand: CardBrand$inboundSchema,
     cardType: CardType$inboundSchema,
-    cardCategory: z.string(),
+    cardCategory: z.string().optional(),
     lastFourCardNumber: z.string(),
     bin: z.string(),
     expiration: CardExpiration$inboundSchema,
@@ -193,7 +193,7 @@ export type Card$Outbound = {
   fingerprint: string;
   brand: string;
   cardType: string;
-  cardCategory: string;
+  cardCategory?: string | undefined;
   lastFourCardNumber: string;
   bin: string;
   expiration: CardExpiration$Outbound;
@@ -221,7 +221,7 @@ export const Card$outboundSchema: z.ZodType<Card$Outbound, z.ZodTypeDef, Card> =
     fingerprint: z.string(),
     brand: CardBrand$outboundSchema,
     cardType: CardType$outboundSchema,
-    cardCategory: z.string(),
+    cardCategory: z.string().optional(),
     lastFourCardNumber: z.string(),
     bin: z.string(),
     expiration: CardExpiration$outboundSchema,

package/src/models/components/cardacquiringmodel.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Specifies the card processing pricing model
+ */
+export const CardAcquiringModel = {
+  CostPlus: "cost-plus",
+  FlatRate: "flat-rate",
+} as const;
+/**
+ * Specifies the card processing pricing model
+ */
+export type CardAcquiringModel = ClosedEnum<typeof CardAcquiringModel>;
+
+/** @internal */
+export const CardAcquiringModel$inboundSchema: z.ZodNativeEnum<
+  typeof CardAcquiringModel
+> = z.nativeEnum(CardAcquiringModel);
+
+/** @internal */
+export const CardAcquiringModel$outboundSchema: z.ZodNativeEnum<
+  typeof CardAcquiringModel
+> = CardAcquiringModel$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CardAcquiringModel$ {
+  /** @deprecated use `CardAcquiringModel$inboundSchema` instead. */
+  export const inboundSchema = CardAcquiringModel$inboundSchema;
+  /** @deprecated use `CardAcquiringModel$outboundSchema` instead. */
+  export const outboundSchema = CardAcquiringModel$outboundSchema;
+}

package/src/models/components/createterminalapplication.ts

@@ -0,0 +1,105 @@
+/*
+ * 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 {
+  TerminalApplicationPlatform,
+  TerminalApplicationPlatform$inboundSchema,
+  TerminalApplicationPlatform$outboundSchema,
+} from "./terminalapplicationplatform.js";
+
+/**
+ * Describes a create terminal application request.
+ */
+export type CreateTerminalApplication = {
+  /**
+   * Platform of the terminal application.
+   */
+  platform: TerminalApplicationPlatform;
+  /**
+   * The app bundle identifier of the terminal application. Required if platform is ios.
+   */
+  appBundleID?: string | undefined;
+  /**
+   * The app package name of the terminal application. Required if platform is android.
+   */
+  packageName?: string | undefined;
+  /**
+   * The app version of the terminal application. Required if paltform is android.
+   */
+  sha256Digest?: string | undefined;
+  /**
+   * The app version of the terminal application. Required if platform is android.
+   */
+  versionCode?: string | undefined;
+};
+
+/** @internal */
+export const CreateTerminalApplication$inboundSchema: z.ZodType<
+  CreateTerminalApplication,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  platform: TerminalApplicationPlatform$inboundSchema,
+  appBundleID: z.string().optional(),
+  packageName: z.string().optional(),
+  sha256Digest: z.string().optional(),
+  versionCode: z.string().optional(),
+});
+
+/** @internal */
+export type CreateTerminalApplication$Outbound = {
+  platform: string;
+  appBundleID?: string | undefined;
+  packageName?: string | undefined;
+  sha256Digest?: string | undefined;
+  versionCode?: string | undefined;
+};
+
+/** @internal */
+export const CreateTerminalApplication$outboundSchema: z.ZodType<
+  CreateTerminalApplication$Outbound,
+  z.ZodTypeDef,
+  CreateTerminalApplication
+> = z.object({
+  platform: TerminalApplicationPlatform$outboundSchema,
+  appBundleID: z.string().optional(),
+  packageName: z.string().optional(),
+  sha256Digest: z.string().optional(),
+  versionCode: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreateTerminalApplication$ {
+  /** @deprecated use `CreateTerminalApplication$inboundSchema` instead. */
+  export const inboundSchema = CreateTerminalApplication$inboundSchema;
+  /** @deprecated use `CreateTerminalApplication$outboundSchema` instead. */
+  export const outboundSchema = CreateTerminalApplication$outboundSchema;
+  /** @deprecated use `CreateTerminalApplication$Outbound` instead. */
+  export type Outbound = CreateTerminalApplication$Outbound;
+}
+
+export function createTerminalApplicationToJSON(
+  createTerminalApplication: CreateTerminalApplication,
+): string {
+  return JSON.stringify(
+    CreateTerminalApplication$outboundSchema.parse(createTerminalApplication),
+  );
+}
+
+export function createTerminalApplicationFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateTerminalApplication, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateTerminalApplication$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateTerminalApplication' from JSON`,
+  );
+}

package/src/models/components/feeplan.ts

@@ -13,10 +13,10 @@ import {
   BillableFee$outboundSchema,
 } from "./billablefee.js";
 import {
-  CardAcquringModel,
-  CardAcquringModel$inboundSchema,
-  CardAcquringModel$outboundSchema,
-} from "./cardacquringmodel.js";
+  CardAcquiringModel,
+  CardAcquiringModel$inboundSchema,
+  CardAcquiringModel$outboundSchema,
+} from "./cardacquiringmodel.js";
 
 export type FeePlan = {
   planID: string;
@@ -31,7 +31,7 @@ export type FeePlan = {
   /**
    * Specifies the card processing pricing model
    */
-  cardAcquringModel: CardAcquringModel;
+  cardAcquiringModel: CardAcquiringModel;
   /**
    * Additional usage-based fees for this plan.
    */
@@ -45,7 +45,7 @@ export const FeePlan$inboundSchema: z.ZodType<FeePlan, z.ZodTypeDef, unknown> =
     planID: z.string(),
     name: z.string(),
     description: z.string().optional(),
-    cardAcquringModel: CardAcquringModel$inboundSchema,
+    cardAcquiringModel: CardAcquiringModel$inboundSchema,
     billableFees: z.array(BillableFee$inboundSchema),
     createdAt: z.string().datetime({ offset: true }).transform(v =>
       new Date(v)
@@ -57,7 +57,7 @@ export type FeePlan$Outbound = {
   planID: string;
   name: string;
   description?: string | undefined;
-  cardAcquringModel: string;
+  cardAcquiringModel: string;
   billableFees: Array<BillableFee$Outbound>;
   createdAt: string;
 };
@@ -71,7 +71,7 @@ export const FeePlan$outboundSchema: z.ZodType<
   planID: z.string(),
   name: z.string(),
   description: z.string().optional(),
-  cardAcquringModel: CardAcquringModel$outboundSchema,
+  cardAcquiringModel: CardAcquiringModel$outboundSchema,
   billableFees: z.array(BillableFee$outboundSchema),
   createdAt: z.date().transform(v => v.toISOString()),
 });

package/src/models/components/feeplanagreement.ts

@@ -13,10 +13,10 @@ import {
   BillableFee$outboundSchema,
 } from "./billablefee.js";
 import {
-  CardAcquringModel,
-  CardAcquringModel$inboundSchema,
-  CardAcquringModel$outboundSchema,
-} from "./cardacquringmodel.js";
+  CardAcquiringModel,
+  CardAcquiringModel$inboundSchema,
+  CardAcquiringModel$outboundSchema,
+} from "./cardacquiringmodel.js";
 import {
   FeePlanAgreementStatus,
   FeePlanAgreementStatus$inboundSchema,
@@ -24,15 +24,23 @@ import {
 } from "./feeplanagreementstatus.js";
 
 export type FeePlanAgreement = {
-  aggreementID: string;
+  agreementID: string;
   planID: string;
   accountID?: string | undefined;
+  /**
+   * The name of the agreement.
+   */
+  name: string;
+  /**
+   * The description of the agreement.
+   */
+  description?: string | undefined;
   acceptedOn: Date;
   status: FeePlanAgreementStatus;
   /**
    * Specifies the card processing pricing model
    */
-  cardAcquringModel: CardAcquringModel;
+  cardAcquiringModel: CardAcquiringModel;
   billableFees: Array<BillableFee>;
 };
 
@@ -42,23 +50,27 @@ export const FeePlanAgreement$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  aggreementID: z.string(),
+  agreementID: z.string(),
   planID: z.string(),
   accountID: z.string().optional(),
+  name: z.string(),
+  description: z.string().optional(),
   acceptedOn: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   status: FeePlanAgreementStatus$inboundSchema,
-  cardAcquringModel: CardAcquringModel$inboundSchema,
+  cardAcquiringModel: CardAcquiringModel$inboundSchema,
   billableFees: z.array(BillableFee$inboundSchema),
 });
 
 /** @internal */
 export type FeePlanAgreement$Outbound = {
-  aggreementID: string;
+  agreementID: string;
   planID: string;
   accountID?: string | undefined;
+  name: string;
+  description?: string | undefined;
   acceptedOn: string;
   status: string;
-  cardAcquringModel: string;
+  cardAcquiringModel: string;
   billableFees: Array<BillableFee$Outbound>;
 };
 
@@ -68,12 +80,14 @@ export const FeePlanAgreement$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   FeePlanAgreement
 > = z.object({
-  aggreementID: z.string(),
+  agreementID: z.string(),
   planID: z.string(),
   accountID: z.string().optional(),
+  name: z.string(),
+  description: z.string().optional(),
   acceptedOn: z.date().transform(v => v.toISOString()),
   status: FeePlanAgreementStatus$outboundSchema,
-  cardAcquringModel: CardAcquringModel$outboundSchema,
+  cardAcquiringModel: CardAcquiringModel$outboundSchema,
   billableFees: z.array(BillableFee$outboundSchema),
 });