@moovio/sdk 0.6.1 → 0.6.2

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.6.2",
+  genVersion: "2.541.0",
+  userAgent: "speakeasy-sdk/typescript 0.6.2 2.541.0 latest @moovio/sdk",
 } as const;

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.6.2",
   },
 });
 

package/src/mcp-server/server.ts

@@ -99,6 +99,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 +151,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "Moov",
-    version: "0.6.1",
+    version: "0.6.2",
   });
 
   const client = new MoovCore({
@@ -293,6 +295,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/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;
+}

package/src/models/components/receiptrequest.ts

@@ -0,0 +1,123 @@
+/*
+ * 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 {
+  ReceiptKind,
+  ReceiptKind$inboundSchema,
+  ReceiptKind$outboundSchema,
+} from "./receiptkind.js";
+
+/**
+ * A receipt request for a specific transfer, schedule, or schedule occurrence.
+ */
+export type ReceiptRequest = {
+  /**
+   * The type of receipt being requested.
+   */
+  kind: ReceiptKind;
+  /**
+   * The email address to send the receipt to.
+   *
+   * @remarks
+   * Either email or emailAccountID must be provided, but not both.
+   */
+  email?: string | undefined;
+  /**
+   * The accountID to send the receipt to.
+   *
+   * @remarks
+   * Either email or emailAccountID must be provided, but not both.
+   */
+  emailAccountID?: string | undefined;
+  /**
+   * The ID of the transfer associated with this receipt.
+   *
+   * @remarks
+   * Exactly one of forTransferID, forScheduleID, or forOccurrenceID must be provided.
+   */
+  forTransferID?: string | undefined;
+  /**
+   * The ID of the schedule associated with this receipt.
+   *
+   * @remarks
+   * Exactly one of forTransferID, forScheduleID, or forOccurrenceID must be provided.
+   */
+  forScheduleID?: string | undefined;
+  /**
+   * The ID of the schedule occurrence associated with this receipt.
+   *
+   * @remarks
+   * Exactly one of forTransferID, forScheduleID, or forOccurrenceID must be provided.
+   */
+  forOccurrenceID?: string | undefined;
+};
+
+/** @internal */
+export const ReceiptRequest$inboundSchema: z.ZodType<
+  ReceiptRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  kind: ReceiptKind$inboundSchema,
+  email: z.string().optional(),
+  emailAccountID: z.string().optional(),
+  forTransferID: z.string().optional(),
+  forScheduleID: z.string().optional(),
+  forOccurrenceID: z.string().optional(),
+});
+
+/** @internal */
+export type ReceiptRequest$Outbound = {
+  kind: string;
+  email?: string | undefined;
+  emailAccountID?: string | undefined;
+  forTransferID?: string | undefined;
+  forScheduleID?: string | undefined;
+  forOccurrenceID?: string | undefined;
+};
+
+/** @internal */
+export const ReceiptRequest$outboundSchema: z.ZodType<
+  ReceiptRequest$Outbound,
+  z.ZodTypeDef,
+  ReceiptRequest
+> = z.object({
+  kind: ReceiptKind$outboundSchema,
+  email: z.string().optional(),
+  emailAccountID: z.string().optional(),
+  forTransferID: z.string().optional(),
+  forScheduleID: z.string().optional(),
+  forOccurrenceID: 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 ReceiptRequest$ {
+  /** @deprecated use `ReceiptRequest$inboundSchema` instead. */
+  export const inboundSchema = ReceiptRequest$inboundSchema;
+  /** @deprecated use `ReceiptRequest$outboundSchema` instead. */
+  export const outboundSchema = ReceiptRequest$outboundSchema;
+  /** @deprecated use `ReceiptRequest$Outbound` instead. */
+  export type Outbound = ReceiptRequest$Outbound;
+}
+
+export function receiptRequestToJSON(receiptRequest: ReceiptRequest): string {
+  return JSON.stringify(ReceiptRequest$outboundSchema.parse(receiptRequest));
+}
+
+export function receiptRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ReceiptRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ReceiptRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReceiptRequest' from JSON`,
+  );
+}

package/src/models/components/receiptresponse.ts

@@ -0,0 +1,157 @@
+/*
+ * 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 {
+  ReceiptKind,
+  ReceiptKind$inboundSchema,
+  ReceiptKind$outboundSchema,
+} from "./receiptkind.js";
+import {
+  SentReceipt,
+  SentReceipt$inboundSchema,
+  SentReceipt$Outbound,
+  SentReceipt$outboundSchema,
+} from "./sentreceipt.js";
+
+export type ReceiptResponse = {
+  /**
+   * Unique identifier for the receipt request.
+   */
+  receiptID: string;
+  /**
+   * AccountID for which the receipt request was created.
+   */
+  createdBy: string;
+  /**
+   * The date and time the receipt was disabled.
+   */
+  disabledOn?: Date | undefined;
+  /**
+   * The type of receipt.
+   */
+  kind: ReceiptKind;
+  /**
+   * The email address the receipt is sent to.
+   *
+   * @remarks
+   * Either email or emailAccountID will be in the response, but not both.
+   */
+  email?: string | undefined;
+  /**
+   * The accountID the receipt is sent to.
+   *
+   * @remarks
+   * Either email or emailAccountID will be in the response, but not both.
+   */
+  emailAccountID?: string | undefined;
+  /**
+   * The ID of the transfer associated with this receipt.
+   *
+   * @remarks
+   * Exactly one of forTransferID, forScheduleID, or forOccurrenceID must be provided.
+   */
+  forTransferID?: string | undefined;
+  /**
+   * The ID of the schedule associated with this receipt.
+   *
+   * @remarks
+   * Exactly one of forTransferID, forScheduleID, or forOccurrenceID must be provided.
+   */
+  forScheduleID?: string | undefined;
+  /**
+   * The ID of the schedule occurrence associated with this receipt.
+   *
+   * @remarks
+   * Exactly one of forTransferID, forScheduleID, or forOccurrenceID must be provided.
+   */
+  forOccurrenceID?: string | undefined;
+  /**
+   * The list of receipts that have been sent.
+   */
+  sentFor: Array<SentReceipt>;
+};
+
+/** @internal */
+export const ReceiptResponse$inboundSchema: z.ZodType<
+  ReceiptResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  receiptID: z.string(),
+  createdBy: z.string(),
+  disabledOn: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  kind: ReceiptKind$inboundSchema,
+  email: z.string().optional(),
+  emailAccountID: z.string().optional(),
+  forTransferID: z.string().optional(),
+  forScheduleID: z.string().optional(),
+  forOccurrenceID: z.string().optional(),
+  sentFor: z.array(SentReceipt$inboundSchema),
+});
+
+/** @internal */
+export type ReceiptResponse$Outbound = {
+  receiptID: string;
+  createdBy: string;
+  disabledOn?: string | undefined;
+  kind: string;
+  email?: string | undefined;
+  emailAccountID?: string | undefined;
+  forTransferID?: string | undefined;
+  forScheduleID?: string | undefined;
+  forOccurrenceID?: string | undefined;
+  sentFor: Array<SentReceipt$Outbound>;
+};
+
+/** @internal */
+export const ReceiptResponse$outboundSchema: z.ZodType<
+  ReceiptResponse$Outbound,
+  z.ZodTypeDef,
+  ReceiptResponse
+> = z.object({
+  receiptID: z.string(),
+  createdBy: z.string(),
+  disabledOn: z.date().transform(v => v.toISOString()).optional(),
+  kind: ReceiptKind$outboundSchema,
+  email: z.string().optional(),
+  emailAccountID: z.string().optional(),
+  forTransferID: z.string().optional(),
+  forScheduleID: z.string().optional(),
+  forOccurrenceID: z.string().optional(),
+  sentFor: z.array(SentReceipt$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ReceiptResponse$ {
+  /** @deprecated use `ReceiptResponse$inboundSchema` instead. */
+  export const inboundSchema = ReceiptResponse$inboundSchema;
+  /** @deprecated use `ReceiptResponse$outboundSchema` instead. */
+  export const outboundSchema = ReceiptResponse$outboundSchema;
+  /** @deprecated use `ReceiptResponse$Outbound` instead. */
+  export type Outbound = ReceiptResponse$Outbound;
+}
+
+export function receiptResponseToJSON(
+  receiptResponse: ReceiptResponse,
+): string {
+  return JSON.stringify(ReceiptResponse$outboundSchema.parse(receiptResponse));
+}
+
+export function receiptResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ReceiptResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ReceiptResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReceiptResponse' from JSON`,
+  );
+}