@moovio/sdk 0.21.14 → 0.21.15

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

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

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { invoicesListInvoices } from "../../funcs/invoicesListInvoices.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ListInvoicesRequest$inboundSchema,
+};
+
+export const tool$invoicesListInvoices: ToolDefinition<typeof args> = {
+  name: "invoices-list-invoices",
+  description: `List all the invoices created under a Moov 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}/invoices.read\` scope.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await invoicesListInvoices(
+      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/invoicesMarkPaidInvoice.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { invoicesMarkPaidInvoice } from "../../funcs/invoicesMarkPaidInvoice.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.MarkPaidInvoiceRequest$inboundSchema,
+};
+
+export const tool$invoicesMarkPaidInvoice: ToolDefinition<typeof args> = {
+  name: "invoices-mark-paid-invoice",
+  description: `Marks an invoice as paid outside of the Moov platform.
+If a payment link was created, the corresponding payment link is canceled, but a receipt is still sent.
+
+To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 
+you'll need to specify the \`/accounts/{accountID}/invoices.write\` scope.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await invoicesMarkPaidInvoice(
+      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/invoicesUpdateInvoice.ts

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

@@ -0,0 +1,65 @@
+/*
+ * 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";
+
+export type AmountDecimalUpdate = {
+  /**
+   * A 3-letter ISO 4217 currency code.
+   */
+  currency?: string | undefined;
+  /**
+   * A decimal-formatted numerical string that represents up to 9 decimal place precision.
+   *
+   * @remarks
+   *
+   * For example, $12.987654321 is '12.987654321'.
+   */
+  valueDecimal?: string | undefined;
+};
+
+/** @internal */
+export const AmountDecimalUpdate$inboundSchema: z.ZodType<
+  AmountDecimalUpdate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string().optional(),
+  valueDecimal: z.string().optional(),
+});
+/** @internal */
+export type AmountDecimalUpdate$Outbound = {
+  currency?: string | undefined;
+  valueDecimal?: string | undefined;
+};
+
+/** @internal */
+export const AmountDecimalUpdate$outboundSchema: z.ZodType<
+  AmountDecimalUpdate$Outbound,
+  z.ZodTypeDef,
+  AmountDecimalUpdate
+> = z.object({
+  currency: z.string().optional(),
+  valueDecimal: z.string().optional(),
+});
+
+export function amountDecimalUpdateToJSON(
+  amountDecimalUpdate: AmountDecimalUpdate,
+): string {
+  return JSON.stringify(
+    AmountDecimalUpdate$outboundSchema.parse(amountDecimalUpdate),
+  );
+}
+export function amountDecimalUpdateFromJSON(
+  jsonString: string,
+): SafeParseResult<AmountDecimalUpdate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AmountDecimalUpdate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AmountDecimalUpdate' from JSON`,
+  );
+}

package/src/models/components/createinvoice.ts

@@ -0,0 +1,84 @@
+/*
+ * 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";
+import {
+  InvoiceLineItems,
+  InvoiceLineItems$inboundSchema,
+  InvoiceLineItems$Outbound,
+  InvoiceLineItems$outboundSchema,
+} from "./invoicelineitems.js";
+
+export type CreateInvoice = {
+  customerAccountID: string;
+  description: string;
+  /**
+   * A collection of line items for an invoice.
+   */
+  lineItems: InvoiceLineItems;
+  invoiceDate?: Date | undefined;
+  dueDate?: Date | undefined;
+  taxAmount?: AmountDecimal | undefined;
+};
+
+/** @internal */
+export const CreateInvoice$inboundSchema: z.ZodType<
+  CreateInvoice,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  customerAccountID: z.string(),
+  description: z.string(),
+  lineItems: InvoiceLineItems$inboundSchema,
+  invoiceDate: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  dueDate: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  taxAmount: AmountDecimal$inboundSchema.optional(),
+});
+/** @internal */
+export type CreateInvoice$Outbound = {
+  customerAccountID: string;
+  description: string;
+  lineItems: InvoiceLineItems$Outbound;
+  invoiceDate?: string | undefined;
+  dueDate?: string | undefined;
+  taxAmount?: AmountDecimal$Outbound | undefined;
+};
+
+/** @internal */
+export const CreateInvoice$outboundSchema: z.ZodType<
+  CreateInvoice$Outbound,
+  z.ZodTypeDef,
+  CreateInvoice
+> = z.object({
+  customerAccountID: z.string(),
+  description: z.string(),
+  lineItems: InvoiceLineItems$outboundSchema,
+  invoiceDate: z.date().transform(v => v.toISOString()).optional(),
+  dueDate: z.date().transform(v => v.toISOString()).optional(),
+  taxAmount: AmountDecimal$outboundSchema.optional(),
+});
+
+export function createInvoiceToJSON(createInvoice: CreateInvoice): string {
+  return JSON.stringify(CreateInvoice$outboundSchema.parse(createInvoice));
+}
+export function createInvoiceFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateInvoice, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateInvoice$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateInvoice' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -32,6 +32,7 @@ export * from "./addressupdate.js";
 export * from "./adjustment.js";
 export * from "./amount.js";
 export * from "./amountdecimal.js";
+export * from "./amountdecimalupdate.js";
 export * from "./amountdecimalvalidationerror.js";
 export * from "./amountupdate.js";
 export * from "./amountvalidationerror.js";
@@ -141,6 +142,7 @@ export * from "./createevidencetext.js";
 export * from "./createfeeplanagreement.js";
 export * from "./createindividualerror.js";
 export * from "./createindividualprofile.js";
+export * from "./createinvoice.js";
 export * from "./createpaymentlink.js";
 export * from "./createproductoption.js";
 export * from "./createproductoptiongroup.js";
@@ -233,6 +235,18 @@ export * from "./industrytaxonomy.js";
 export * from "./instantbankcreditpaymentmethod.js";
 export * from "./instantpaymentfees.js";
 export * from "./institutionssearchresponse.js";
+export * from "./invoice.js";
+export * from "./invoiceexternalpayment.js";
+export * from "./invoicelineitem.js";
+export * from "./invoicelineitemoption.js";
+export * from "./invoicelineitemoptionvalidationerror.js";
+export * from "./invoicelineitems.js";
+export * from "./invoicelineitemsupdate.js";
+export * from "./invoicelineitemsvalidationerror.js";
+export * from "./invoicelineitemvalidationerror.js";
+export * from "./invoicepayment.js";
+export * from "./invoicestatus.js";
+export * from "./invoicetransferpayment.js";
 export * from "./issuedcard.js";
 export * from "./issuedcardauthorization.js";
 export * from "./issuedcardauthorizationevent.js";
@@ -262,6 +276,7 @@ export * from "./linkedapplepaypaymentmethod.js";
 export * from "./listfeesfetchrequest.js";
 export * from "./manualtermsofservice.js";
 export * from "./manualtermsofserviceupdate.js";
+export * from "./markinvoicepaid.js";
 export * from "./microdepositstatus.js";
 export * from "./minimumcommitment.js";
 export * from "./mode.js";
@@ -441,6 +456,7 @@ export * from "./updatecardexpiration.js";
 export * from "./updatecolor.js";
 export * from "./updatecolors.js";
 export * from "./updateevidence.js";
+export * from "./updateinvoice.js";
 export * from "./updateissuedcard.js";
 export * from "./updatepaymentlink.js";
 export * from "./updaterepresentative.js";
@@ -481,6 +497,8 @@ export * from "./webhookdatacapabilityupdated.js";
 export * from "./webhookdatacardautoupdated.js";
 export * from "./webhookdatadisputecreated.js";
 export * from "./webhookdatadisputeupdated.js";
+export * from "./webhookdatainvoicecreated.js";
+export * from "./webhookdatainvoiceupdated.js";
 export * from "./webhookdatanetworkidupdated.js";
 export * from "./webhookdatapaymentmethoddisabled.js";
 export * from "./webhookdatapaymentmethodenabled.js";

package/src/models/components/invoice.ts

@@ -0,0 +1,178 @@
+/*
+ * 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";
+import {
+  InvoiceLineItems,
+  InvoiceLineItems$inboundSchema,
+  InvoiceLineItems$Outbound,
+  InvoiceLineItems$outboundSchema,
+} from "./invoicelineitems.js";
+import {
+  InvoicePayment,
+  InvoicePayment$inboundSchema,
+  InvoicePayment$Outbound,
+  InvoicePayment$outboundSchema,
+} from "./invoicepayment.js";
+import {
+  InvoiceStatus,
+  InvoiceStatus$inboundSchema,
+  InvoiceStatus$outboundSchema,
+} from "./invoicestatus.js";
+
+export type Invoice = {
+  invoiceID: string;
+  invoiceNumber: string;
+  description: string;
+  customerAccountID: string;
+  partnerAccountID: string;
+  status: InvoiceStatus;
+  /**
+   * A collection of line items for an invoice.
+   */
+  lineItems: InvoiceLineItems;
+  subtotalAmount: AmountDecimal;
+  taxAmount: AmountDecimal;
+  /**
+   * Total amount of the invoice, sum of subTotalAmount and taxAmount
+   */
+  totalAmount: AmountDecimal;
+  /**
+   * Total amount of pending transfers paid towards the invoice
+   */
+  pendingAmount: AmountDecimal;
+  /**
+   * Total amount of completed transfers paid towards the invoice
+   */
+  paidAmount: AmountDecimal;
+  /**
+   * Total amount of refunds initiated against transfers paid towards the invoice
+   */
+  refundedAmount: AmountDecimal;
+  /**
+   * Total amount of disputes initiated against transfers paid towards the invoice
+   */
+  disputedAmount: AmountDecimal;
+  paymentLinkCode?: string | undefined;
+  payments?: Array<InvoicePayment> | undefined;
+  createdOn: Date;
+  invoiceDate?: Date | undefined;
+  dueDate?: Date | undefined;
+  sentOn?: Date | undefined;
+  paidOn?: Date | undefined;
+  canceledOn?: Date | undefined;
+};
+
+/** @internal */
+export const Invoice$inboundSchema: z.ZodType<Invoice, z.ZodTypeDef, unknown> =
+  z.object({
+    invoiceID: z.string(),
+    invoiceNumber: z.string(),
+    description: z.string(),
+    customerAccountID: z.string(),
+    partnerAccountID: z.string(),
+    status: InvoiceStatus$inboundSchema,
+    lineItems: InvoiceLineItems$inboundSchema,
+    subtotalAmount: AmountDecimal$inboundSchema,
+    taxAmount: AmountDecimal$inboundSchema,
+    totalAmount: AmountDecimal$inboundSchema,
+    pendingAmount: AmountDecimal$inboundSchema,
+    paidAmount: AmountDecimal$inboundSchema,
+    refundedAmount: AmountDecimal$inboundSchema,
+    disputedAmount: AmountDecimal$inboundSchema,
+    paymentLinkCode: z.string().optional(),
+    payments: z.array(InvoicePayment$inboundSchema).optional(),
+    createdOn: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    invoiceDate: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ).optional(),
+    dueDate: z.string().datetime({ offset: true }).transform(v => new Date(v))
+      .optional(),
+    sentOn: z.string().datetime({ offset: true }).transform(v => new Date(v))
+      .optional(),
+    paidOn: z.string().datetime({ offset: true }).transform(v => new Date(v))
+      .optional(),
+    canceledOn: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ).optional(),
+  });
+/** @internal */
+export type Invoice$Outbound = {
+  invoiceID: string;
+  invoiceNumber: string;
+  description: string;
+  customerAccountID: string;
+  partnerAccountID: string;
+  status: string;
+  lineItems: InvoiceLineItems$Outbound;
+  subtotalAmount: AmountDecimal$Outbound;
+  taxAmount: AmountDecimal$Outbound;
+  totalAmount: AmountDecimal$Outbound;
+  pendingAmount: AmountDecimal$Outbound;
+  paidAmount: AmountDecimal$Outbound;
+  refundedAmount: AmountDecimal$Outbound;
+  disputedAmount: AmountDecimal$Outbound;
+  paymentLinkCode?: string | undefined;
+  payments?: Array<InvoicePayment$Outbound> | undefined;
+  createdOn: string;
+  invoiceDate?: string | undefined;
+  dueDate?: string | undefined;
+  sentOn?: string | undefined;
+  paidOn?: string | undefined;
+  canceledOn?: string | undefined;
+};
+
+/** @internal */
+export const Invoice$outboundSchema: z.ZodType<
+  Invoice$Outbound,
+  z.ZodTypeDef,
+  Invoice
+> = z.object({
+  invoiceID: z.string(),
+  invoiceNumber: z.string(),
+  description: z.string(),
+  customerAccountID: z.string(),
+  partnerAccountID: z.string(),
+  status: InvoiceStatus$outboundSchema,
+  lineItems: InvoiceLineItems$outboundSchema,
+  subtotalAmount: AmountDecimal$outboundSchema,
+  taxAmount: AmountDecimal$outboundSchema,
+  totalAmount: AmountDecimal$outboundSchema,
+  pendingAmount: AmountDecimal$outboundSchema,
+  paidAmount: AmountDecimal$outboundSchema,
+  refundedAmount: AmountDecimal$outboundSchema,
+  disputedAmount: AmountDecimal$outboundSchema,
+  paymentLinkCode: z.string().optional(),
+  payments: z.array(InvoicePayment$outboundSchema).optional(),
+  createdOn: z.date().transform(v => v.toISOString()),
+  invoiceDate: z.date().transform(v => v.toISOString()).optional(),
+  dueDate: z.date().transform(v => v.toISOString()).optional(),
+  sentOn: z.date().transform(v => v.toISOString()).optional(),
+  paidOn: z.date().transform(v => v.toISOString()).optional(),
+  canceledOn: z.date().transform(v => v.toISOString()).optional(),
+});
+
+export function invoiceToJSON(invoice: Invoice): string {
+  return JSON.stringify(Invoice$outboundSchema.parse(invoice));
+}
+export function invoiceFromJSON(
+  jsonString: string,
+): SafeParseResult<Invoice, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Invoice$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Invoice' from JSON`,
+  );
+}

package/src/models/components/invoiceexternalpayment.ts

@@ -0,0 +1,91 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.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 const InvoiceExternalPaymentPaymentType = {
+  External: "external",
+} as const;
+export type InvoiceExternalPaymentPaymentType = ClosedEnum<
+  typeof InvoiceExternalPaymentPaymentType
+>;
+
+export type InvoiceExternalPayment = {
+  paymentType: InvoiceExternalPaymentPaymentType;
+  description: string;
+  foreignID?: string | undefined;
+  paymentDate?: Date | undefined;
+  amount: AmountDecimal;
+};
+
+/** @internal */
+export const InvoiceExternalPaymentPaymentType$inboundSchema: z.ZodNativeEnum<
+  typeof InvoiceExternalPaymentPaymentType
+> = z.nativeEnum(InvoiceExternalPaymentPaymentType);
+/** @internal */
+export const InvoiceExternalPaymentPaymentType$outboundSchema: z.ZodNativeEnum<
+  typeof InvoiceExternalPaymentPaymentType
+> = InvoiceExternalPaymentPaymentType$inboundSchema;
+
+/** @internal */
+export const InvoiceExternalPayment$inboundSchema: z.ZodType<
+  InvoiceExternalPayment,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  paymentType: InvoiceExternalPaymentPaymentType$inboundSchema,
+  description: z.string(),
+  foreignID: z.string().optional(),
+  paymentDate: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  amount: AmountDecimal$inboundSchema,
+});
+/** @internal */
+export type InvoiceExternalPayment$Outbound = {
+  paymentType: string;
+  description: string;
+  foreignID?: string | undefined;
+  paymentDate?: string | undefined;
+  amount: AmountDecimal$Outbound;
+};
+
+/** @internal */
+export const InvoiceExternalPayment$outboundSchema: z.ZodType<
+  InvoiceExternalPayment$Outbound,
+  z.ZodTypeDef,
+  InvoiceExternalPayment
+> = z.object({
+  paymentType: InvoiceExternalPaymentPaymentType$outboundSchema,
+  description: z.string(),
+  foreignID: z.string().optional(),
+  paymentDate: z.date().transform(v => v.toISOString()).optional(),
+  amount: AmountDecimal$outboundSchema,
+});
+
+export function invoiceExternalPaymentToJSON(
+  invoiceExternalPayment: InvoiceExternalPayment,
+): string {
+  return JSON.stringify(
+    InvoiceExternalPayment$outboundSchema.parse(invoiceExternalPayment),
+  );
+}
+export function invoiceExternalPaymentFromJSON(
+  jsonString: string,
+): SafeParseResult<InvoiceExternalPayment, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InvoiceExternalPayment$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InvoiceExternalPayment' from JSON`,
+  );
+}