@moovio/sdk 0.6.1 → 0.7.0

package/src/funcs/receiptsList.ts

@@ -0,0 +1,171 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { MoovCore } from "../core.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * List receipts by trasnferID, scheduleID, or occurrenceID.
+ *
+ * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
+ * you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
+ */
+export function receiptsList(
+  client: MoovCore,
+  request: operations.ListReceiptsRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.ListReceiptsResponse,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: MoovCore,
+  request: operations.ListReceiptsRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.ListReceiptsResponse,
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.ListReceiptsRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/receipts")();
+
+  const query = encodeFormQuery({
+    "id": payload.id,
+  }, { explode: false });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+    "x-moov-version": encodeSimple(
+      "x-moov-version",
+      client._options.xMoovVersion,
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "listReceipts",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["401", "403", "429", "4XX", "500", "504", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.ListReceiptsResponse,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, operations.ListReceiptsResponse$inboundSchema, {
+      hdrs: true,
+      key: "Result",
+    }),
+    M.fail([401, 403, 429]),
+    M.fail([500, 504]),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -69,7 +69,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "latest",
-  sdkVersion: "0.6.1",
-  genVersion: "2.539.1",
-  userAgent: "speakeasy-sdk/typescript 0.6.1 2.539.1 latest @moovio/sdk",
+  sdkVersion: "0.7.0",
+  genVersion: "2.545.2",
+  userAgent: "speakeasy-sdk/typescript 0.7.0 2.545.2 latest @moovio/sdk",
 } as const;

package/src/mcp-server/extensions.ts

@@ -0,0 +1,13 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ZodRawShape } from "zod";
+import { ResourceDefinition, ResourceTemplateDefinition } from "./resources.js";
+import { ToolDefinition } from "./tools.js";
+
+export type Register = {
+  tool: <A extends ZodRawShape | undefined>(def: ToolDefinition<A>) => void;
+  resource: (def: ResourceDefinition) => void;
+  resourceTemplate: (def: ResourceTemplateDefinition) => void;
+};

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

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

package/src/mcp-server/resources.ts

@@ -2,12 +2,16 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { ResourceTemplate } from "@modelcontextprotocol/sdk/server/mcp.js";
+import {
+  McpServer,
+  ResourceMetadata,
+  ResourceTemplate,
+} from "@modelcontextprotocol/sdk/server/mcp.js";
 import { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
 import { Variables } from "@modelcontextprotocol/sdk/shared/uriTemplate.js";
 import { ReadResourceResult } from "@modelcontextprotocol/sdk/types.js";
 import { MoovCore } from "../core.js";
-import { Result } from "../types/fp.js";
+import { ConsoleLogger } from "./console-logger.js";
 import { MCPScope } from "./scopes.js";
 import { isAsyncIterable, isBinaryData, valueToBase64 } from "./shared.js";
 
@@ -19,7 +23,8 @@ export type ReadResourceCallback = (
 
 export type ResourceDefinition = {
   name: string;
-  description: string;
+  description?: string;
+  metadata?: ResourceMetadata;
   scopes?: MCPScope[];
   resource: string;
   read: ReadResourceCallback;
@@ -35,30 +40,27 @@ export type ReadResourceTemplateCallback = (
 export type ResourceTemplateDefinition = {
   name: string;
   description: string;
+  metadata?: ResourceMetadata;
   scopes?: MCPScope[];
   resource: ResourceTemplate;
   read: ReadResourceTemplateCallback;
 };
 
 export async function formatResult(
-  result: Result<unknown, Error>,
+  value: unknown,
   uri: URL,
-  init: { response?: Response | undefined },
+  init: { mimeType?: string | undefined; response?: Response | undefined },
 ): Promise<ReadResourceResult> {
-  if (!result.ok) {
-    throw result.error;
-  }
-
-  const { value } = result;
   if (typeof value === "undefined") {
     return { contents: [] };
   }
 
-  const { response } = init;
-  const mimeType = response?.headers.get("content-type") ?? "";
   let contents: ReadResourceResult["contents"] = [];
 
-  if (mimeType.search(/\bjson\b/g)) {
+  const mimeType = init.mimeType ?? init.response?.headers.get("content-type")
+    ?? "";
+
+  if (mimeType.search(/\bjson\b/g) !== -1) {
     contents = [{ uri: uri.toString(), mimeType, text: JSON.stringify(value) }];
   } else if (
     mimeType.startsWith("text/event-stream")
@@ -71,7 +73,10 @@ export async function formatResult(
         text: await stringifySSEToJSON(value),
       },
     ];
-  } else if (mimeType.startsWith("text/") && typeof value === "string") {
+  } else if (
+    (mimeType.startsWith("text/") || mimeType.startsWith("application/"))
+    && typeof value === "string"
+  ) {
     contents = [{ uri: uri.toString(), mimeType, text: value }];
   } else if (isBinaryData(value)) {
     const blob = await valueToBase64(value);
@@ -94,3 +99,59 @@ async function stringifySSEToJSON(
 
   return JSON.stringify(payloads);
 }
+
+export function createRegisterResource(
+  logger: ConsoleLogger,
+  server: McpServer,
+  sdk: MoovCore,
+  allowedScopes: Set<MCPScope>,
+): (resource: ResourceDefinition) => void {
+  return (resource: ResourceDefinition): void => {
+    const scopes = resource.scopes ?? [];
+    if (!scopes.every((s: MCPScope) => allowedScopes.has(s))) {
+      return;
+    }
+
+    const metadata: ResourceMetadata = {
+      ...resource.metadata,
+      description: resource.description,
+    };
+
+    server.resource(
+      resource.name,
+      resource.resource,
+      metadata,
+      async (uri, ctx) => resource.read(sdk, uri, ctx),
+    );
+
+    logger.debug("Registered resource", { name: resource.name });
+  };
+}
+
+export function createRegisterResourceTemplate(
+  logger: ConsoleLogger,
+  server: McpServer,
+  sdk: MoovCore,
+  allowedScopes: Set<MCPScope>,
+): (resource: ResourceTemplateDefinition) => void {
+  return (resource: ResourceTemplateDefinition): void => {
+    const scopes = resource.scopes ?? [];
+    if (!scopes.every((s: MCPScope) => allowedScopes.has(s))) {
+      return;
+    }
+
+    const metadata: ResourceMetadata = {
+      ...resource.metadata,
+      description: resource.description,
+    };
+
+    server.resource(
+      resource.name,
+      resource.resource,
+      metadata,
+      async (uri, vars, ctx) => resource.read(sdk, uri, vars, ctx),
+    );
+
+    logger.debug("Registered resource template", { name: resource.name });
+  };
+}

package/src/mcp-server/server.ts

@@ -6,6 +6,10 @@ 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 {
+  createRegisterResource,
+  createRegisterResourceTemplate,
+} from "./resources.js";
 import { MCPScope, mcpScopes } from "./scopes.js";
 import { createRegisterTool } from "./tools.js";
 import { tool$accountsAssignCountries } from "./tools/accountsAssignCountries.js";
@@ -99,6 +103,8 @@ import { tool$paymentLinksUpdate } from "./tools/paymentLinksUpdate.js";
 import { tool$paymentMethodsGet } from "./tools/paymentMethodsGet.js";
 import { tool$paymentMethodsList } from "./tools/paymentMethodsList.js";
 import { tool$pingPing } from "./tools/pingPing.js";
+import { tool$receiptsCreate } from "./tools/receiptsCreate.js";
+import { tool$receiptsList } from "./tools/receiptsList.js";
 import { tool$representativesCreate } from "./tools/representativesCreate.js";
 import { tool$representativesDelete } from "./tools/representativesDelete.js";
 import { tool$representativesGet } from "./tools/representativesGet.js";
@@ -149,7 +155,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "Moov",
-    version: "0.6.1",
+    version: "0.7.0",
   });
 
   const client = new MoovCore({
@@ -158,7 +164,9 @@ export function createMCPServer(deps: {
     serverURL: deps.serverURL,
     serverIdx: deps.serverIdx,
   });
+
   const scopes = new Set(deps.scopes ?? mcpScopes);
+
   const allowedTools = deps.allowedTools && new Set(deps.allowedTools);
   const tool = createRegisterTool(
     deps.logger,
@@ -167,6 +175,15 @@ export function createMCPServer(deps: {
     scopes,
     allowedTools,
   );
+  const resource = createRegisterResource(deps.logger, server, client, scopes);
+  const resourceTemplate = createRegisterResourceTemplate(
+    deps.logger,
+    server,
+    client,
+    scopes,
+  );
+  const register = { tool, resource, resourceTemplate };
+  void register; // suppress unused warnings
 
   tool(tool$accountsCreate);
   tool(tool$accountsList);
@@ -293,6 +310,8 @@ export function createMCPServer(deps: {
   tool(tool$onboardingGetInvite);
   tool(tool$onboardingRevokeInvite);
   tool(tool$pingPing);
+  tool(tool$receiptsCreate);
+  tool(tool$receiptsList);
   tool(tool$terminalApplicationsCreate);
   tool(tool$terminalApplicationsList);
   tool(tool$terminalApplicationsGet);

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

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { receiptsCreate } from "../../funcs/receiptsCreate.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: z.array(components.ReceiptRequest$inboundSchema),
+};
+
+export const tool$receiptsCreate: ToolDefinition<typeof args> = {
+  name: "receipts_create",
+  description: ` Create receipts for transfers and scheduled transfers.
+
+ To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 
+ you'll need to specify the \`/accounts/{accountID}/transfers.write\` scope.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await receiptsCreate(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

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

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { receiptsList } from "../../funcs/receiptsList.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ListReceiptsRequest$inboundSchema,
+};
+
+export const tool$receiptsList: ToolDefinition<typeof args> = {
+  name: "receipts_list",
+  description: `List receipts by trasnferID, scheduleID, or occurrenceID.
+
+To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 
+you'll need to specify the \`/accounts/{accountID}/transfers.read\` scope.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await receiptsList(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/models/components/achtransactiondetails.ts

@@ -51,6 +51,7 @@ export type ACHTransactionDetails = {
    * Code used to identify the ACH authorization method.
    */
   secCode?: SECCode | undefined;
+  canceledOn?: Date | undefined;
   initiatedOn?: Date | undefined;
   originatedOn?: Date | undefined;
   correctedOn?: Date | undefined;
@@ -76,6 +77,8 @@ export const ACHTransactionDetails$inboundSchema: z.ZodType<
   companyEntryDescription: z.string().optional(),
   originatingCompanyName: z.string().optional(),
   secCode: SECCode$inboundSchema.optional(),
+  canceledOn: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
   initiatedOn: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
   originatedOn: z.string().datetime({ offset: true }).transform(v =>
@@ -101,6 +104,7 @@ export type ACHTransactionDetails$Outbound = {
   companyEntryDescription?: string | undefined;
   originatingCompanyName?: string | undefined;
   secCode?: string | undefined;
+  canceledOn?: string | undefined;
   initiatedOn?: string | undefined;
   originatedOn?: string | undefined;
   correctedOn?: string | undefined;
@@ -123,6 +127,7 @@ export const ACHTransactionDetails$outboundSchema: z.ZodType<
   companyEntryDescription: z.string().optional(),
   originatingCompanyName: z.string().optional(),
   secCode: SECCode$outboundSchema.optional(),
+  canceledOn: z.date().transform(v => v.toISOString()).optional(),
   initiatedOn: z.date().transform(v => v.toISOString()).optional(),
   originatedOn: z.date().transform(v => v.toISOString()).optional(),
   correctedOn: z.date().transform(v => v.toISOString()).optional(),

package/src/models/components/achtransactionstatus.ts

@@ -14,6 +14,7 @@ export const ACHTransactionStatus = {
   Corrected: "corrected",
   Returned: "returned",
   Completed: "completed",
+  Canceled: "canceled",
 } as const;
 /**
  * Status of a transaction within the ACH lifecycle.

package/src/models/components/createaccount.ts

@@ -34,6 +34,7 @@ import {
   ManualTermsOfService$Outbound,
   ManualTermsOfService$outboundSchema,
 } from "./manualtermsofservice.js";
+import { Mode, Mode$inboundSchema, Mode$outboundSchema } from "./mode.js";
 import {
   Settings,
   Settings$inboundSchema,
@@ -78,6 +79,10 @@ export type CreateAccount = {
    */
   settings?: Settings | undefined;
   capabilities?: Array<CapabilityID> | undefined;
+  /**
+   * The operating mode for an account.
+   */
+  mode?: Mode | undefined;
 };
 
 /** @internal */
@@ -155,6 +160,7 @@ export const CreateAccount$inboundSchema: z.ZodType<
   customerSupport: CustomerSupport$inboundSchema.optional(),
   settings: Settings$inboundSchema.optional(),
   capabilities: z.array(CapabilityID$inboundSchema).optional(),
+  mode: Mode$inboundSchema.optional(),
 });
 
 /** @internal */
@@ -170,6 +176,7 @@ export type CreateAccount$Outbound = {
   customerSupport?: CustomerSupport$Outbound | undefined;
   settings?: Settings$Outbound | undefined;
   capabilities?: Array<string> | undefined;
+  mode?: string | undefined;
 };
 
 /** @internal */
@@ -189,6 +196,7 @@ export const CreateAccount$outboundSchema: z.ZodType<
   customerSupport: CustomerSupport$outboundSchema.optional(),
   settings: Settings$outboundSchema.optional(),
   capabilities: z.array(CapabilityID$outboundSchema).optional(),
+  mode: Mode$outboundSchema.optional(),
 });
 
 /**

package/src/models/components/createterminalapplication.ts

@@ -21,19 +21,19 @@ export type CreateTerminalApplication = {
    */
   platform: TerminalApplicationPlatform;
   /**
-   * The app bundle identifier of the terminal application. Required if platform is ios.
+   * 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.
+   * 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.
+   * 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.
+   * The app version of the terminal application. Required if platform is `android`.
    */
   versionCode?: string | undefined;
 };

package/src/models/components/index.ts

@@ -269,6 +269,9 @@ export * from "./profile.js";
 export * from "./pullfromcardpaymentmethod.js";
 export * from "./pushtocardpaymentmethod.js";
 export * from "./qrcode.js";
+export * from "./receiptkind.js";
+export * from "./receiptrequest.js";
+export * from "./receiptresponse.js";
 export * from "./recur.js";
 export * from "./refundcarddetails.js";
 export * from "./refundcardstatus.js";
@@ -296,6 +299,7 @@ export * from "./schedulepaymentmethod.js";
 export * from "./scheduleresponse.js";
 export * from "./seccode.js";
 export * from "./security.js";
+export * from "./sentreceipt.js";
 export * from "./settings.js";
 export * from "./sourcedestinationoptions.js";
 export * from "./sweep.js";

package/src/models/components/receiptkind.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * The type of receipt being requested.
+ */
+export const ReceiptKind = {
+  SaleCustomerV1: "sale.customer.v1",
+} as const;
+/**
+ * The type of receipt being requested.
+ */
+export type ReceiptKind = ClosedEnum<typeof ReceiptKind>;
+
+/** @internal */
+export const ReceiptKind$inboundSchema: z.ZodNativeEnum<typeof ReceiptKind> = z
+  .nativeEnum(ReceiptKind);
+
+/** @internal */
+export const ReceiptKind$outboundSchema: z.ZodNativeEnum<typeof ReceiptKind> =
+  ReceiptKind$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ReceiptKind$ {
+  /** @deprecated use `ReceiptKind$inboundSchema` instead. */
+  export const inboundSchema = ReceiptKind$inboundSchema;
+  /** @deprecated use `ReceiptKind$outboundSchema` instead. */
+  export const outboundSchema = ReceiptKind$outboundSchema;
+}