@moovio/sdk 0.0.0-dev.5 → 0.0.0-dev.7

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

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { resolutionLinksList } from "../../funcs/resolutionLinksList.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ListResolutionLinksRequest$inboundSchema,
+};
+
+export const tool$resolutionLinksList: ToolDefinition<typeof args> = {
+  name: "resolution-links-list",
+  description: `List resolution links for the specified 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 resolutionLinksList(
+      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/createinvoicelineitem.ts

@@ -39,7 +39,8 @@ export type CreateInvoiceLineItem = {
    *   Optional unique identifier associating the line item with a product.
    *
    * @remarks
-   *   This is for reporting or tracking purposes, and does not populate other details of the line item.
+   *   When provided, images associated with the product will be included on the line item.
+   *   This does not populate other details of the line item.
    */
   productID?: string | undefined;
   /**

package/src/models/components/createpaymentlinklineitem.ts

@@ -52,7 +52,8 @@ export type CreatePaymentLinkLineItem = {
    *   Optional unique identifier associating the line item with a product.
    *
    * @remarks
-   *   This is for reporting or tracking purposes, and does not populate other details of the line item.
+   *   When provided, images associated with the product will be included on the line item.
+   *   This does not populate other details of the line item.
    */
   productID?: string | undefined;
 };

package/src/models/components/createresolutionlink.ts

@@ -0,0 +1,63 @@
+/*
+ * 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 {
+  ResolutionLinkRecipient,
+  ResolutionLinkRecipient$inboundSchema,
+  ResolutionLinkRecipient$Outbound,
+  ResolutionLinkRecipient$outboundSchema,
+} from "./resolutionlinkrecipient.js";
+
+/**
+ * Request body for creating a resolution link.
+ */
+export type CreateResolutionLink = {
+  /**
+   * The recipient contact information for the resolution link.
+   */
+  recipient: ResolutionLinkRecipient;
+};
+
+/** @internal */
+export const CreateResolutionLink$inboundSchema: z.ZodType<
+  CreateResolutionLink,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  recipient: ResolutionLinkRecipient$inboundSchema,
+});
+/** @internal */
+export type CreateResolutionLink$Outbound = {
+  recipient: ResolutionLinkRecipient$Outbound;
+};
+
+/** @internal */
+export const CreateResolutionLink$outboundSchema: z.ZodType<
+  CreateResolutionLink$Outbound,
+  z.ZodTypeDef,
+  CreateResolutionLink
+> = z.object({
+  recipient: ResolutionLinkRecipient$outboundSchema,
+});
+
+export function createResolutionLinkToJSON(
+  createResolutionLink: CreateResolutionLink,
+): string {
+  return JSON.stringify(
+    CreateResolutionLink$outboundSchema.parse(createResolutionLink),
+  );
+}
+export function createResolutionLinkFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateResolutionLink, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateResolutionLink$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateResolutionLink' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -174,6 +174,7 @@ export * from "./createprofileerror.js";
 export * from "./createrefund.js";
 export * from "./createrefundresponse.js";
 export * from "./createrepresentative.js";
+export * from "./createresolutionlink.js";
 export * from "./createreversal.js";
 export * from "./createruntransfer.js";
 export * from "./createscheduledtransferlineitem.js";
@@ -415,6 +416,8 @@ export * from "./requirementerror.js";
 export * from "./requirementerrorcode.js";
 export * from "./requirementid.js";
 export * from "./residual.js";
+export * from "./resolutionlink.js";
+export * from "./resolutionlinkrecipient.js";
 export * from "./returnpolicytype.js";
 export * from "./reversal.js";
 export * from "./reversedwithcancellation.js";
@@ -422,12 +425,9 @@ export * from "./reversedwithrefund.js";
 export * from "./revoketokenrequest.js";
 export * from "./rtpcreditpaymentmethod.js";
 export * from "./rtpcredittransferpaymentmethod.js";
-export * from "./rtpfailurecode.js";
 export * from "./rtpinstitution.js";
 export * from "./rtprejectioncode.js";
 export * from "./rtpservices.js";
-export * from "./rtptransactiondetails.js";
-export * from "./rtptransactionstatus.js";
 export * from "./runtransfer.js";
 export * from "./scheduledtransferimagemetadata.js";
 export * from "./scheduledtransferlineitem.js";

package/src/models/components/invoice.ts

@@ -41,6 +41,14 @@ export type Invoice = {
    * A unique identifier for a Moov resource. Supports UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) or typed format with base32-encoded UUID and type suffix (e.g., kuoaydiojf7uszaokc2ggnaaaa_xfer).
    */
   customerAccountID: string;
+  /**
+   * Display name of the customer account.
+   */
+  customerDisplayName: string;
+  /**
+   * Email address of the customer account.
+   */
+  customerEmail: string;
   /**
    * A unique identifier for a Moov resource. Supports UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) or typed format with base32-encoded UUID and type suffix (e.g., kuoaydiojf7uszaokc2ggnaaaa_xfer).
    */
@@ -83,6 +91,7 @@ export type Invoice = {
   sentOn?: Date | undefined;
   paidOn?: Date | undefined;
   canceledOn?: Date | undefined;
+  disabledOn?: Date | undefined;
 };
 
 /** @internal */
@@ -92,6 +101,8 @@ export const Invoice$inboundSchema: z.ZodType<Invoice, z.ZodTypeDef, unknown> =
     invoiceNumber: z.string(),
     description: z.string().optional(),
     customerAccountID: z.string(),
+    customerDisplayName: z.string(),
+    customerEmail: z.string(),
     partnerAccountID: z.string(),
     status: InvoiceStatus$inboundSchema,
     lineItems: InvoiceLineItems$inboundSchema,
@@ -119,6 +130,9 @@ export const Invoice$inboundSchema: z.ZodType<Invoice, z.ZodTypeDef, unknown> =
     canceledOn: z.string().datetime({ offset: true }).transform(v =>
       new Date(v)
     ).optional(),
+    disabledOn: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ).optional(),
   });
 /** @internal */
 export type Invoice$Outbound = {
@@ -126,6 +140,8 @@ export type Invoice$Outbound = {
   invoiceNumber: string;
   description?: string | undefined;
   customerAccountID: string;
+  customerDisplayName: string;
+  customerEmail: string;
   partnerAccountID: string;
   status: string;
   lineItems: InvoiceLineItems$Outbound;
@@ -144,6 +160,7 @@ export type Invoice$Outbound = {
   sentOn?: string | undefined;
   paidOn?: string | undefined;
   canceledOn?: string | undefined;
+  disabledOn?: string | undefined;
 };
 
 /** @internal */
@@ -156,6 +173,8 @@ export const Invoice$outboundSchema: z.ZodType<
   invoiceNumber: z.string(),
   description: z.string().optional(),
   customerAccountID: z.string(),
+  customerDisplayName: z.string(),
+  customerEmail: z.string(),
   partnerAccountID: z.string(),
   status: InvoiceStatus$outboundSchema,
   lineItems: InvoiceLineItems$outboundSchema,
@@ -174,6 +193,7 @@ export const Invoice$outboundSchema: z.ZodType<
   sentOn: z.date().transform(v => v.toISOString()).optional(),
   paidOn: z.date().transform(v => v.toISOString()).optional(),
   canceledOn: z.date().transform(v => v.toISOString()).optional(),
+  disabledOn: z.date().transform(v => v.toISOString()).optional(),
 });
 
 export function invoiceToJSON(invoice: Invoice): string {

package/src/models/components/invoicelineitem.ts

@@ -45,7 +45,8 @@ export type InvoiceLineItem = {
    *   Optional unique identifier associating the line item with a product.
    *
    * @remarks
-   *   This is for reporting or tracking purposes, and does not populate other details of the line item.
+   *   When provided, images associated with the product will be included on the line item.
+   *   This does not populate other details of the line item.
    */
   productID?: string | undefined;
   /**

package/src/models/components/resolutionlink.ts

@@ -0,0 +1,110 @@
+/*
+ * 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";
+
+/**
+ * A temporary, secure link sent to a merchant to resolve account requirements such as KYC verification or document uploads.
+ */
+export type ResolutionLink = {
+  /**
+   * A unique nanoid identifier for the resolution link.
+   */
+  code: string;
+  /**
+   * The ID of the merchant account this resolution link is associated with.
+   */
+  accountID: string;
+  /**
+   * The ID of the partner account this resolution link is associated with.
+   */
+  partnerAccountID: string;
+  /**
+   * The recipient contact information for the resolution link.
+   */
+  recipient: string;
+  /**
+   * The URL of the resolution link.
+   */
+  url: string;
+  /**
+   * The date and time the resolution link was created.
+   */
+  createdOn: Date;
+  /**
+   * The date and time the resolution link was last updated.
+   */
+  updatedOn: Date;
+  /**
+   * The date and time the resolution link was disabled, if applicable.
+   */
+  disabledOn?: Date | undefined;
+  /**
+   * The date and time the resolution link expires.
+   */
+  expiresOn: Date;
+};
+
+/** @internal */
+export const ResolutionLink$inboundSchema: z.ZodType<
+  ResolutionLink,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string(),
+  accountID: z.string(),
+  partnerAccountID: z.string(),
+  recipient: z.string(),
+  url: z.string(),
+  createdOn: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  updatedOn: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  disabledOn: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  expiresOn: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+});
+/** @internal */
+export type ResolutionLink$Outbound = {
+  code: string;
+  accountID: string;
+  partnerAccountID: string;
+  recipient: string;
+  url: string;
+  createdOn: string;
+  updatedOn: string;
+  disabledOn?: string | undefined;
+  expiresOn: string;
+};
+
+/** @internal */
+export const ResolutionLink$outboundSchema: z.ZodType<
+  ResolutionLink$Outbound,
+  z.ZodTypeDef,
+  ResolutionLink
+> = z.object({
+  code: z.string(),
+  accountID: z.string(),
+  partnerAccountID: z.string(),
+  recipient: z.string(),
+  url: z.string(),
+  createdOn: z.date().transform(v => v.toISOString()),
+  updatedOn: z.date().transform(v => v.toISOString()),
+  disabledOn: z.date().transform(v => v.toISOString()).optional(),
+  expiresOn: z.date().transform(v => v.toISOString()),
+});
+
+export function resolutionLinkToJSON(resolutionLink: ResolutionLink): string {
+  return JSON.stringify(ResolutionLink$outboundSchema.parse(resolutionLink));
+}
+export function resolutionLinkFromJSON(
+  jsonString: string,
+): SafeParseResult<ResolutionLink, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResolutionLink$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResolutionLink' from JSON`,
+  );
+}

package/src/models/components/resolutionlinkrecipient.ts

@@ -0,0 +1,70 @@
+/*
+ * 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 {
+  PhoneNumber,
+  PhoneNumber$inboundSchema,
+  PhoneNumber$Outbound,
+  PhoneNumber$outboundSchema,
+} from "./phonenumber.js";
+
+/**
+ * Contact information for the recipient of a resolution link. Provide either `email` or `phone`, but not both.
+ */
+export type ResolutionLinkRecipient = {
+  /**
+   * The email address of the recipient.
+   */
+  email?: string | undefined;
+  /**
+   * The phone number of the recipient.
+   */
+  phone?: PhoneNumber | undefined;
+};
+
+/** @internal */
+export const ResolutionLinkRecipient$inboundSchema: z.ZodType<
+  ResolutionLinkRecipient,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  email: z.string().optional(),
+  phone: PhoneNumber$inboundSchema.optional(),
+});
+/** @internal */
+export type ResolutionLinkRecipient$Outbound = {
+  email?: string | undefined;
+  phone?: PhoneNumber$Outbound | undefined;
+};
+
+/** @internal */
+export const ResolutionLinkRecipient$outboundSchema: z.ZodType<
+  ResolutionLinkRecipient$Outbound,
+  z.ZodTypeDef,
+  ResolutionLinkRecipient
+> = z.object({
+  email: z.string().optional(),
+  phone: PhoneNumber$outboundSchema.optional(),
+});
+
+export function resolutionLinkRecipientToJSON(
+  resolutionLinkRecipient: ResolutionLinkRecipient,
+): string {
+  return JSON.stringify(
+    ResolutionLinkRecipient$outboundSchema.parse(resolutionLinkRecipient),
+  );
+}
+export function resolutionLinkRecipientFromJSON(
+  jsonString: string,
+): SafeParseResult<ResolutionLinkRecipient, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResolutionLinkRecipient$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResolutionLinkRecipient' from JSON`,
+  );
+}

package/src/models/components/transferdestination.ts

@@ -30,12 +30,6 @@ import {
   InstantBankTransactionDetails$Outbound,
   InstantBankTransactionDetails$outboundSchema,
 } from "./instantbanktransactiondetails.js";
-import {
-  RTPTransactionDetails,
-  RTPTransactionDetails$inboundSchema,
-  RTPTransactionDetails$Outbound,
-  RTPTransactionDetails$outboundSchema,
-} from "./rtptransactiondetails.js";
 import {
   TransferAccount,
   TransferAccount$inboundSchema,
@@ -94,10 +88,6 @@ export type TransferDestination = {
    * Card-specific details about the transaction.
    */
   cardDetails?: CardTransactionDetails | undefined;
-  /**
-   * RTP specific details about the transaction.
-   */
-  rtpDetails?: RTPTransactionDetails | undefined;
   /**
    * Instant-bank specific details about the transaction.
    */
@@ -119,7 +109,6 @@ export const TransferDestination$inboundSchema: z.ZodType<
   achDetails: ACHTransactionDetails$inboundSchema.optional(),
   applePay: ApplePayResponse$inboundSchema.optional(),
   cardDetails: CardTransactionDetails$inboundSchema.optional(),
-  rtpDetails: RTPTransactionDetails$inboundSchema.optional(),
   instantBankDetails: InstantBankTransactionDetails$inboundSchema.optional(),
 });
 /** @internal */
@@ -133,7 +122,6 @@ export type TransferDestination$Outbound = {
   achDetails?: ACHTransactionDetails$Outbound | undefined;
   applePay?: ApplePayResponse$Outbound | undefined;
   cardDetails?: CardTransactionDetails$Outbound | undefined;
-  rtpDetails?: RTPTransactionDetails$Outbound | undefined;
   instantBankDetails?: InstantBankTransactionDetails$Outbound | undefined;
 };
 
@@ -152,7 +140,6 @@ export const TransferDestination$outboundSchema: z.ZodType<
   achDetails: ACHTransactionDetails$outboundSchema.optional(),
   applePay: ApplePayResponse$outboundSchema.optional(),
   cardDetails: CardTransactionDetails$outboundSchema.optional(),
-  rtpDetails: RTPTransactionDetails$outboundSchema.optional(),
   instantBankDetails: InstantBankTransactionDetails$outboundSchema.optional(),
 });
 

package/src/models/components/updateinvoice.ts

@@ -36,7 +36,10 @@ export type UpdateInvoice = {
    * The status can be updated to one of the following values under specific conditions:
    *
    * @remarks
-   * - `canceled`: Can only be set if the current status is `draft`, `unpaid`, or `overdue`.
+   * - `canceled`: Can only be set if the current status is `draft`, `unpaid`, or `overdue`. Canceling an invoice
+   *   indicates the invoice is no longer expected to be paid (e.g., the charge was waived or terms changed).
+   *   Canceled invoices still appear in list results by default and remain part of the invoice history.
+   *   To completely discard an invoice created by mistake, use the delete endpoint instead.
    * - `unpaid`: Can only be set if the current status is `draft`. Setting the status to `unpaid` finalizes the invoice and sends an email with a payment link to the customer.
    */
   status?: InvoiceStatus | undefined;

package/src/models/errors/createresolutionlinkerror.ts

@@ -0,0 +1,90 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { MoovError } from "./mooverror.js";
+
+/**
+ * Describes validation errors for the create resolution link request.
+ */
+export type CreateResolutionLinkErrorData = {
+  /**
+   * An error with the recipient email address.
+   */
+  email?: string | undefined;
+  /**
+   * An error with the recipient phone number.
+   */
+  phone?: string | undefined;
+};
+
+/**
+ * Describes validation errors for the create resolution link request.
+ */
+export class CreateResolutionLinkError extends MoovError {
+  /**
+   * An error with the recipient email address.
+   */
+  email?: string | undefined;
+  /**
+   * An error with the recipient phone number.
+   */
+  phone?: string | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: CreateResolutionLinkErrorData;
+
+  constructor(
+    err: CreateResolutionLinkErrorData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    if (err.email != null) this.email = err.email;
+    if (err.phone != null) this.phone = err.phone;
+
+    this.name = "CreateResolutionLinkError";
+  }
+}
+
+/** @internal */
+export const CreateResolutionLinkError$inboundSchema: z.ZodType<
+  CreateResolutionLinkError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  email: z.string().optional(),
+  phone: z.string().optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new CreateResolutionLinkError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type CreateResolutionLinkError$Outbound = {
+  email?: string | undefined;
+  phone?: string | undefined;
+};
+
+/** @internal */
+export const CreateResolutionLinkError$outboundSchema: z.ZodType<
+  CreateResolutionLinkError$Outbound,
+  z.ZodTypeDef,
+  CreateResolutionLinkError
+> = z.instanceof(CreateResolutionLinkError)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    email: z.string().optional(),
+    phone: z.string().optional(),
+  }));

package/src/models/errors/index.ts

@@ -15,6 +15,7 @@ export * from "./createaccounterror.js";
 export * from "./createinvoiceerror.js";
 export * from "./createinvoicepaymenterror.js";
 export * from "./createpaymentlinkerror.js";
+export * from "./createresolutionlinkerror.js";
 export * from "./createsweepconfigerror.js";
 export * from "./createticketerror.js";
 export * from "./createwalletvalidationerror.js";