@moovio/sdk 0.19.1 → 0.20.0

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

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { feePlansGetResidual } from "../../funcs/feePlansGetResidual.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GetResidualRequest$inboundSchema,
+};
+
+export const tool$feePlansGetResidual: ToolDefinition<typeof args> = {
+  name: "fee-plans-get-residual",
+  description: `Get a residual associated with an account.
+
+To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 
+you'll need to specify the \`/accounts/{accountID}/profile.read\` scope.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await feePlansGetResidual(
+      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/feePlansListResidualFees.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { feePlansListResidualFees } from "../../funcs/feePlansListResidualFees.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ListResidualFeesRequest$inboundSchema,
+};
+
+export const tool$feePlansListResidualFees: ToolDefinition<typeof args> = {
+  name: "fee-plans-list-residual-fees",
+  description: `List all fees associated with a residual.
+
+To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 
+you'll need to specify the \`/accounts/{accountID}/profile.read\` scope.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await feePlansListResidualFees(
+      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/feePlansListResiduals.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { feePlansListResiduals } from "../../funcs/feePlansListResiduals.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ListResidualsRequest$inboundSchema,
+};
+
+export const tool$feePlansListResiduals: ToolDefinition<typeof args> = {
+  name: "fee-plans-list-residuals",
+  description: `List all residuals associated with an account.
+
+To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 
+you'll need to specify the \`/accounts/{accountID}/profile.read\` scope.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await feePlansListResiduals(
+      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/imagemetadata.ts

@@ -12,6 +12,10 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  */
 export type ImageMetadata = {
   imageID: string;
+  /**
+   * The ID used to get an image with the public endpoint.
+   */
+  publicID: string;
   /**
    * Alternative text for the image.
    */
@@ -34,6 +38,7 @@ export const ImageMetadata$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   imageID: z.string(),
+  publicID: z.string(),
   altText: z.string().optional(),
   link: z.string(),
   createdOn: z.string().datetime({ offset: true }).transform(v => new Date(v)),
@@ -43,6 +48,7 @@ export const ImageMetadata$inboundSchema: z.ZodType<
 /** @internal */
 export type ImageMetadata$Outbound = {
   imageID: string;
+  publicID: string;
   altText?: string | undefined;
   link: string;
   createdOn: string;
@@ -56,6 +62,7 @@ export const ImageMetadata$outboundSchema: z.ZodType<
   ImageMetadata
 > = z.object({
   imageID: z.string(),
+  publicID: z.string(),
   altText: z.string().optional(),
   link: z.string(),
   createdOn: z.date().transform(v => v.toISOString()),

package/src/models/components/incurredfee.ts

@@ -33,6 +33,7 @@ export type IncurredFee = {
    * The entity that generated the fee.
    */
   generatedBy?: GeneratedBy | undefined;
+  feeGroup?: string | undefined;
 };
 
 /** @internal */
@@ -49,6 +50,7 @@ export const IncurredFee$inboundSchema: z.ZodType<
   feeName: z.string().optional(),
   amount: AmountDecimal$inboundSchema.optional(),
   generatedBy: GeneratedBy$inboundSchema.optional(),
+  feeGroup: z.string().optional(),
 });
 
 /** @internal */
@@ -60,6 +62,7 @@ export type IncurredFee$Outbound = {
   feeName?: string | undefined;
   amount?: AmountDecimal$Outbound | undefined;
   generatedBy?: GeneratedBy$Outbound | undefined;
+  feeGroup?: string | undefined;
 };
 
 /** @internal */
@@ -75,6 +78,7 @@ export const IncurredFee$outboundSchema: z.ZodType<
   feeName: z.string().optional(),
   amount: AmountDecimal$outboundSchema.optional(),
   generatedBy: GeneratedBy$outboundSchema.optional(),
+  feeGroup: z.string().optional(),
 });
 
 /**

package/src/models/components/index.ts

@@ -348,6 +348,7 @@ export * from "./requestcard.js";
 export * from "./requirementerror.js";
 export * from "./requirementerrorcode.js";
 export * from "./requirementid.js";
+export * from "./residual.js";
 export * from "./returnpolicytype.js";
 export * from "./reversal.js";
 export * from "./reversedwithcancellation.js";

package/src/models/components/residual.ts

@@ -0,0 +1,121 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AmountDecimal,
+  AmountDecimal$inboundSchema,
+  AmountDecimal$Outbound,
+  AmountDecimal$outboundSchema,
+} from "./amountdecimal.js";
+
+export type Residual = {
+  residualID: string;
+  partnerAccountID: string;
+  periodStart: Date;
+  periodEnd: Date;
+  merchantFees: AmountDecimal;
+  partnerCost: AmountDecimal;
+  netIncome: AmountDecimal;
+  /**
+   *   The decimal-formatted numerical string of the revenue split for partner.
+   *
+   * @remarks
+   *
+   *   For example, 2.25% is '2.25'.
+   */
+  revenueShare: string;
+  residualAmount: AmountDecimal;
+  moovShare: AmountDecimal;
+  createdOn: Date;
+  updatedOn: Date;
+};
+
+/** @internal */
+export const Residual$inboundSchema: z.ZodType<
+  Residual,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  residualID: z.string(),
+  partnerAccountID: z.string(),
+  periodStart: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  periodEnd: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  merchantFees: AmountDecimal$inboundSchema,
+  partnerCost: AmountDecimal$inboundSchema,
+  netIncome: AmountDecimal$inboundSchema,
+  revenueShare: z.string(),
+  residualAmount: AmountDecimal$inboundSchema,
+  moovShare: AmountDecimal$inboundSchema,
+  createdOn: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  updatedOn: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+});
+
+/** @internal */
+export type Residual$Outbound = {
+  residualID: string;
+  partnerAccountID: string;
+  periodStart: string;
+  periodEnd: string;
+  merchantFees: AmountDecimal$Outbound;
+  partnerCost: AmountDecimal$Outbound;
+  netIncome: AmountDecimal$Outbound;
+  revenueShare: string;
+  residualAmount: AmountDecimal$Outbound;
+  moovShare: AmountDecimal$Outbound;
+  createdOn: string;
+  updatedOn: string;
+};
+
+/** @internal */
+export const Residual$outboundSchema: z.ZodType<
+  Residual$Outbound,
+  z.ZodTypeDef,
+  Residual
+> = z.object({
+  residualID: z.string(),
+  partnerAccountID: z.string(),
+  periodStart: z.date().transform(v => v.toISOString()),
+  periodEnd: z.date().transform(v => v.toISOString()),
+  merchantFees: AmountDecimal$outboundSchema,
+  partnerCost: AmountDecimal$outboundSchema,
+  netIncome: AmountDecimal$outboundSchema,
+  revenueShare: z.string(),
+  residualAmount: AmountDecimal$outboundSchema,
+  moovShare: AmountDecimal$outboundSchema,
+  createdOn: z.date().transform(v => v.toISOString()),
+  updatedOn: z.date().transform(v => v.toISOString()),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Residual$ {
+  /** @deprecated use `Residual$inboundSchema` instead. */
+  export const inboundSchema = Residual$inboundSchema;
+  /** @deprecated use `Residual$outboundSchema` instead. */
+  export const outboundSchema = Residual$outboundSchema;
+  /** @deprecated use `Residual$Outbound` instead. */
+  export type Outbound = Residual$Outbound;
+}
+
+export function residualToJSON(residual: Residual): string {
+  return JSON.stringify(Residual$outboundSchema.parse(residual));
+}
+
+export function residualFromJSON(
+  jsonString: string,
+): SafeParseResult<Residual, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Residual$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Residual' from JSON`,
+  );
+}

package/src/models/operations/getresidual.ts

@@ -0,0 +1,223 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetResidualGlobals = {
+  /**
+   * Specify an API version.
+   *
+   * @remarks
+   *
+   * API versioning follows the format `vYYYY.QQ.BB`, where
+   *   - `YYYY` is the year
+   *   - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
+   *   - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter.
+   *     - For example, `v2024.01.00` is the initial release of the first quarter of 2024.
+   *
+   * The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
+   */
+  xMoovVersion?: string | undefined;
+};
+
+export type GetResidualRequest = {
+  accountID: string;
+  residualID: string;
+};
+
+export type GetResidualResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.Residual;
+};
+
+/** @internal */
+export const GetResidualGlobals$inboundSchema: z.ZodType<
+  GetResidualGlobals,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "X-Moov-Version": z.string().default("v2024.01.00"),
+}).transform((v) => {
+  return remap$(v, {
+    "X-Moov-Version": "xMoovVersion",
+  });
+});
+
+/** @internal */
+export type GetResidualGlobals$Outbound = {
+  "X-Moov-Version": string;
+};
+
+/** @internal */
+export const GetResidualGlobals$outboundSchema: z.ZodType<
+  GetResidualGlobals$Outbound,
+  z.ZodTypeDef,
+  GetResidualGlobals
+> = z.object({
+  xMoovVersion: z.string().default("v2024.01.00"),
+}).transform((v) => {
+  return remap$(v, {
+    xMoovVersion: "X-Moov-Version",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetResidualGlobals$ {
+  /** @deprecated use `GetResidualGlobals$inboundSchema` instead. */
+  export const inboundSchema = GetResidualGlobals$inboundSchema;
+  /** @deprecated use `GetResidualGlobals$outboundSchema` instead. */
+  export const outboundSchema = GetResidualGlobals$outboundSchema;
+  /** @deprecated use `GetResidualGlobals$Outbound` instead. */
+  export type Outbound = GetResidualGlobals$Outbound;
+}
+
+export function getResidualGlobalsToJSON(
+  getResidualGlobals: GetResidualGlobals,
+): string {
+  return JSON.stringify(
+    GetResidualGlobals$outboundSchema.parse(getResidualGlobals),
+  );
+}
+
+export function getResidualGlobalsFromJSON(
+  jsonString: string,
+): SafeParseResult<GetResidualGlobals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetResidualGlobals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetResidualGlobals' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetResidualRequest$inboundSchema: z.ZodType<
+  GetResidualRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  accountID: z.string(),
+  residualID: z.string(),
+});
+
+/** @internal */
+export type GetResidualRequest$Outbound = {
+  accountID: string;
+  residualID: string;
+};
+
+/** @internal */
+export const GetResidualRequest$outboundSchema: z.ZodType<
+  GetResidualRequest$Outbound,
+  z.ZodTypeDef,
+  GetResidualRequest
+> = z.object({
+  accountID: z.string(),
+  residualID: 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 GetResidualRequest$ {
+  /** @deprecated use `GetResidualRequest$inboundSchema` instead. */
+  export const inboundSchema = GetResidualRequest$inboundSchema;
+  /** @deprecated use `GetResidualRequest$outboundSchema` instead. */
+  export const outboundSchema = GetResidualRequest$outboundSchema;
+  /** @deprecated use `GetResidualRequest$Outbound` instead. */
+  export type Outbound = GetResidualRequest$Outbound;
+}
+
+export function getResidualRequestToJSON(
+  getResidualRequest: GetResidualRequest,
+): string {
+  return JSON.stringify(
+    GetResidualRequest$outboundSchema.parse(getResidualRequest),
+  );
+}
+
+export function getResidualRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetResidualRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetResidualRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetResidualRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetResidualResponse$inboundSchema: z.ZodType<
+  GetResidualResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: components.Residual$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type GetResidualResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: components.Residual$Outbound;
+};
+
+/** @internal */
+export const GetResidualResponse$outboundSchema: z.ZodType<
+  GetResidualResponse$Outbound,
+  z.ZodTypeDef,
+  GetResidualResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: components.Residual$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+    result: "Result",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetResidualResponse$ {
+  /** @deprecated use `GetResidualResponse$inboundSchema` instead. */
+  export const inboundSchema = GetResidualResponse$inboundSchema;
+  /** @deprecated use `GetResidualResponse$outboundSchema` instead. */
+  export const outboundSchema = GetResidualResponse$outboundSchema;
+  /** @deprecated use `GetResidualResponse$Outbound` instead. */
+  export type Outbound = GetResidualResponse$Outbound;
+}
+
+export function getResidualResponseToJSON(
+  getResidualResponse: GetResidualResponse,
+): string {
+  return JSON.stringify(
+    GetResidualResponse$outboundSchema.parse(getResidualResponse),
+  );
+}
+
+export function getResidualResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetResidualResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetResidualResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetResidualResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -70,6 +70,7 @@ export * from "./getproduct.js";
 export * from "./getpublicimage.js";
 export * from "./getrefund.js";
 export * from "./getrepresentative.js";
+export * from "./getresidual.js";
 export * from "./getscheduledoccurrence.js";
 export * from "./getschedules.js";
 export * from "./getstatement.js";
@@ -118,6 +119,8 @@ export * from "./listproducts.js";
 export * from "./listreceipts.js";
 export * from "./listrefunds.js";
 export * from "./listrepresentatives.js";
+export * from "./listresidualfees.js";
+export * from "./listresiduals.js";
 export * from "./listschedules.js";
 export * from "./liststatements.js";
 export * from "./listsweepconfigs.js";