@moovio/sdk 26.4.0-dev.9 → 26.4.1

package/src/models/components/card.ts

@@ -104,6 +104,9 @@ export type Card = {
    * The name of the cardholder as it appears on the card.
    */
   holderName?: string | undefined;
+  /**
+   * The billing address associated with the card.
+   */
   billingAddress: CardAddress;
   /**
    * The results of submitting cardholder data to a card network for verification.
@@ -143,6 +146,12 @@ export type Card = {
    * Indicates cardholder has authorized card to be stored for future payments.
    */
   cardOnFile?: boolean | undefined;
+  /**
+   * Merchant account whose details (statement descriptor, address, etc.) are used for the card verification authorization.
+   *
+   * @remarks
+   * If omitted, the partner account's details are used instead.
+   */
   merchantAccountID?: string | undefined;
   /**
    * The results of the most recent card update request.

package/src/models/components/cardaccountupdater.ts

@@ -16,6 +16,9 @@ import {
  * The results of the most recent card update request.
  */
 export type CardAccountUpdater = {
+  /**
+   * Timestamp from the card network indicating when the card update was processed.
+   */
   updatedOn?: Date | undefined;
   /**
    * The results of the card update request.

package/src/models/components/cardaddress.ts

@@ -8,11 +8,29 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type CardAddress = {
+  /**
+   * Street address line 1.
+   */
   addressLine1?: string | undefined;
+  /**
+   * Street address line 2 (e.g., apartment or suite number).
+   */
   addressLine2?: string | undefined;
+  /**
+   * City name.
+   */
   city?: string | undefined;
+  /**
+   * Two-letter state or province code.
+   */
   stateOrProvince?: string | undefined;
+  /**
+   * Postal or ZIP code.
+   */
   postalCode: string;
+  /**
+   * Two-letter ISO 3166-1 country code.
+   */
   country?: string | undefined;
 };
 

package/src/models/components/cardexpiration.ts

@@ -11,7 +11,13 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  * The expiration date of the card or token.
  */
 export type CardExpiration = {
+  /**
+   * Two-digit month the card expires.
+   */
   month: string;
+  /**
+   * Two-digit year the card expires.
+   */
   year: string;
 };
 

package/src/models/components/cardpayouttype.ts

@@ -0,0 +1,26 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Specifies the type of card payout for push-to-card transfers, used to determine the business application identifier (BAI) sent to the card network.
+ */
+export const CardPayoutType = {
+  Loyalty: "loyalty",
+} as const;
+/**
+ * Specifies the type of card payout for push-to-card transfers, used to determine the business application identifier (BAI) sent to the card network.
+ */
+export type CardPayoutType = ClosedEnum<typeof CardPayoutType>;
+
+/** @internal */
+export const CardPayoutType$inboundSchema: z.ZodNativeEnum<
+  typeof CardPayoutType
+> = z.nativeEnum(CardPayoutType);
+/** @internal */
+export const CardPayoutType$outboundSchema: z.ZodNativeEnum<
+  typeof CardPayoutType
+> = CardPayoutType$inboundSchema;

package/src/models/components/cardverification.ts

@@ -22,11 +22,26 @@ import {
  * The results of submitting cardholder data to a card network for verification.
  */
 export type CardVerification = {
+  /**
+   * Verification result of the card's CVV.
+   */
   cvv: CardVerificationResult;
+  /**
+   * Verification result of the billing address line 1.
+   *
+   * @remarks
+   * Derived from the same AVS code as `postalCode`; the card network returns a single code covering both address fields.
+   */
   addressLine1: CardVerificationResult;
+  /**
+   * Verification result of the billing address postal code.
+   *
+   * @remarks
+   * Derived from the same AVS code as `addressLine1`; the card network returns a single code covering both address fields.
+   */
   postalCode: CardVerificationResult;
   /**
-   * The results of submitting cardholder name to a card network for verification.
+   * Verification results of the cardholder's name, broken down by name component.
    */
   accountName?: AccountNameVerification | undefined;
 };

package/src/models/components/cardverificationresult.ts

@@ -5,6 +5,9 @@
 import * as z from "zod/v3";
 import { ClosedEnum } from "../../types/enums.js";
 
+/**
+ * The result of a card verification check.
+ */
 export const CardVerificationResult = {
   NoMatch: "noMatch",
   Match: "match",
@@ -12,6 +15,9 @@ export const CardVerificationResult = {
   Unavailable: "unavailable",
   PartialMatch: "partialMatch",
 } as const;
+/**
+ * The result of a card verification check.
+ */
 export type CardVerificationResult = ClosedEnum<typeof CardVerificationResult>;
 
 /** @internal */

package/src/models/components/createdtransfer.ts

@@ -42,6 +42,12 @@ import {
   MoovFeeDetails$Outbound,
   MoovFeeDetails$outboundSchema,
 } from "./moovfeedetails.js";
+import {
+  TransferAmountDetails,
+  TransferAmountDetails$inboundSchema,
+  TransferAmountDetails$Outbound,
+  TransferAmountDetails$outboundSchema,
+} from "./transferamountdetails.js";
 import {
   TransferDestination,
   TransferDestination$inboundSchema,
@@ -121,7 +127,7 @@ export type CreatedTransfer = {
   occurrenceID?: string | undefined;
   paymentLinkCode?: string | undefined;
   /**
-   * Optional sales tax amount. `transfer.amount.value` should be inclusive of any sales tax and represents the total amount charged.
+   * Optional sales tax amount.
    */
   salesTaxAmount?: Amount | undefined;
   /**
@@ -135,6 +141,7 @@ export type CreatedTransfer = {
    * When line items are provided, their total plus sales tax must equal the transfer amount.
    */
   lineItems?: TransferLineItems | undefined;
+  amountDetails?: TransferAmountDetails | undefined;
 };
 
 /** @internal */
@@ -171,6 +178,7 @@ export const CreatedTransfer$inboundSchema: z.ZodType<
   salesTaxAmount: Amount$inboundSchema.optional(),
   foreignID: z.string().optional(),
   lineItems: TransferLineItems$inboundSchema.optional(),
+  amountDetails: TransferAmountDetails$inboundSchema.optional(),
 });
 /** @internal */
 export type CreatedTransfer$Outbound = {
@@ -201,6 +209,7 @@ export type CreatedTransfer$Outbound = {
   salesTaxAmount?: Amount$Outbound | undefined;
   foreignID?: string | undefined;
   lineItems?: TransferLineItems$Outbound | undefined;
+  amountDetails?: TransferAmountDetails$Outbound | undefined;
 };
 
 /** @internal */
@@ -236,6 +245,7 @@ export const CreatedTransfer$outboundSchema: z.ZodType<
   salesTaxAmount: Amount$outboundSchema.optional(),
   foreignID: z.string().optional(),
   lineItems: TransferLineItems$outboundSchema.optional(),
+  amountDetails: TransferAmountDetails$outboundSchema.optional(),
 });
 
 export function createdTransferToJSON(

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/createpaymentlink.ts

@@ -61,7 +61,20 @@ export type CreatePaymentLink = {
    * The merchant's preferred payment method ID. Must be a wallet payment method.
    */
   merchantPaymentMethodID: string;
+  /**
+   * The fixed amount of the payment link.
+   *
+   * @remarks
+   *
+   * In API versions before `2026.07.00`, this was a required field.
+   *
+   * In API version `2026.07.00` and beyond, this field is required for `fixed` payment amount types and omitted
+   * for `open` payment amount types.
+   */
   amount: Amount;
+  /**
+   * Optional sales tax amount.
+   */
   salesTaxAmount?: Amount | undefined;
   /**
    * An optional limit on the number of times this payment link can be used.

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/createtippresets.ts

@@ -0,0 +1,83 @@
+/*
+ * 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 {
+  TipCalculationBasis,
+  TipCalculationBasis$inboundSchema,
+  TipCalculationBasis$outboundSchema,
+} from "./tipcalculationbasis.js";
+
+export type CreateTipPresets = {
+  /**
+   * Defines which amount should be used when calculating the final payment total. This calculation applies for percentage tip values.
+   *
+   * @remarks
+   * - `pre-tax`: Tip amounts are calculated using the subtotal amount before taxes
+   * - `post-tax`: Tip amounts are calculated using the subtotal amount + taxes
+   */
+  calculationBasis?: TipCalculationBasis | undefined;
+  /**
+   * Defines the set of suggested tip preset values presented to customers. Percentages must be between 0 and 100 (exclusive) and must be unique. A maximum of 3 values are allowed.
+   */
+  percentageOptions?: Array<number> | undefined;
+  /**
+   * Defines the set of suggested tip preset values presented to customers. Fixed amounts must be positive and unique. A maximum of 3 values are allowed.
+   */
+  fixedAmountOptions?: Array<AmountDecimal> | undefined;
+};
+
+/** @internal */
+export const CreateTipPresets$inboundSchema: z.ZodType<
+  CreateTipPresets,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  calculationBasis: TipCalculationBasis$inboundSchema.optional(),
+  percentageOptions: z.array(z.number().int()).optional(),
+  fixedAmountOptions: z.array(AmountDecimal$inboundSchema).optional(),
+});
+/** @internal */
+export type CreateTipPresets$Outbound = {
+  calculationBasis?: string | undefined;
+  percentageOptions?: Array<number> | undefined;
+  fixedAmountOptions?: Array<AmountDecimal$Outbound> | undefined;
+};
+
+/** @internal */
+export const CreateTipPresets$outboundSchema: z.ZodType<
+  CreateTipPresets$Outbound,
+  z.ZodTypeDef,
+  CreateTipPresets
+> = z.object({
+  calculationBasis: TipCalculationBasis$outboundSchema.optional(),
+  percentageOptions: z.array(z.number().int()).optional(),
+  fixedAmountOptions: z.array(AmountDecimal$outboundSchema).optional(),
+});
+
+export function createTipPresetsToJSON(
+  createTipPresets: CreateTipPresets,
+): string {
+  return JSON.stringify(
+    CreateTipPresets$outboundSchema.parse(createTipPresets),
+  );
+}
+export function createTipPresetsFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateTipPresets, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateTipPresets$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateTipPresets' from JSON`,
+  );
+}

package/src/models/components/createtransfer.ts

@@ -12,6 +12,12 @@ import {
   Amount$Outbound,
   Amount$outboundSchema,
 } from "./amount.js";
+import {
+  CreateTransferAmountDetails,
+  CreateTransferAmountDetails$inboundSchema,
+  CreateTransferAmountDetails$Outbound,
+  CreateTransferAmountDetails$outboundSchema,
+} from "./createtransferamountdetails.js";
 import {
   CreateTransferDestination,
   CreateTransferDestination$inboundSchema,
@@ -59,9 +65,6 @@ export type CreateTransfer = {
    * Free-form key-value pair list. Useful for storing information that is not captured elsewhere.
    */
   metadata?: { [k: string]: string } | undefined;
-  /**
-   * Optional sales tax amount. `transfer.amount.value` should be inclusive of any sales tax and represents the total amount charged.
-   */
   salesTaxAmount?: Amount | undefined;
   /**
    * Optional alias from a foreign/external system which can be used to reference this resource.
@@ -74,6 +77,7 @@ export type CreateTransfer = {
    * When line items are provided, their total plus sales tax must equal the transfer amount.
    */
   lineItems?: CreateTransferLineItems | undefined;
+  amountDetails?: CreateTransferAmountDetails | undefined;
 };
 
 /** @internal */
@@ -91,6 +95,7 @@ export const CreateTransfer$inboundSchema: z.ZodType<
   salesTaxAmount: Amount$inboundSchema.optional(),
   foreignID: z.string().optional(),
   lineItems: CreateTransferLineItems$inboundSchema.optional(),
+  amountDetails: CreateTransferAmountDetails$inboundSchema.optional(),
 });
 /** @internal */
 export type CreateTransfer$Outbound = {
@@ -103,6 +108,7 @@ export type CreateTransfer$Outbound = {
   salesTaxAmount?: Amount$Outbound | undefined;
   foreignID?: string | undefined;
   lineItems?: CreateTransferLineItems$Outbound | undefined;
+  amountDetails?: CreateTransferAmountDetails$Outbound | undefined;
 };
 
 /** @internal */
@@ -120,6 +126,7 @@ export const CreateTransfer$outboundSchema: z.ZodType<
   salesTaxAmount: Amount$outboundSchema.optional(),
   foreignID: z.string().optional(),
   lineItems: CreateTransferLineItems$outboundSchema.optional(),
+  amountDetails: CreateTransferAmountDetails$outboundSchema.optional(),
 });
 
 export function createTransferToJSON(createTransfer: CreateTransfer): string {

package/src/models/components/createtransferamountdetails.ts

@@ -0,0 +1,62 @@
+/*
+ * 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 CreateTransferAmountDetails = {
+  /**
+   * The amount of tip applied to the transfer.
+   */
+  tip?: AmountDecimal | undefined;
+};
+
+/** @internal */
+export const CreateTransferAmountDetails$inboundSchema: z.ZodType<
+  CreateTransferAmountDetails,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  tip: AmountDecimal$inboundSchema.optional(),
+});
+/** @internal */
+export type CreateTransferAmountDetails$Outbound = {
+  tip?: AmountDecimal$Outbound | undefined;
+};
+
+/** @internal */
+export const CreateTransferAmountDetails$outboundSchema: z.ZodType<
+  CreateTransferAmountDetails$Outbound,
+  z.ZodTypeDef,
+  CreateTransferAmountDetails
+> = z.object({
+  tip: AmountDecimal$outboundSchema.optional(),
+});
+
+export function createTransferAmountDetailsToJSON(
+  createTransferAmountDetails: CreateTransferAmountDetails,
+): string {
+  return JSON.stringify(
+    CreateTransferAmountDetails$outboundSchema.parse(
+      createTransferAmountDetails,
+    ),
+  );
+}
+export function createTransferAmountDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateTransferAmountDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateTransferAmountDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateTransferAmountDetails' from JSON`,
+  );
+}

package/src/models/components/createtransferamountdetailsvalidationerror.ts

@@ -0,0 +1,59 @@
+/*
+ * 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 CreateTransferAmountDetailsValidationError = {
+  tip?: string | undefined;
+};
+
+/** @internal */
+export const CreateTransferAmountDetailsValidationError$inboundSchema:
+  z.ZodType<CreateTransferAmountDetailsValidationError, z.ZodTypeDef, unknown> =
+    z.object({
+      tip: z.string().optional(),
+    });
+/** @internal */
+export type CreateTransferAmountDetailsValidationError$Outbound = {
+  tip?: string | undefined;
+};
+
+/** @internal */
+export const CreateTransferAmountDetailsValidationError$outboundSchema:
+  z.ZodType<
+    CreateTransferAmountDetailsValidationError$Outbound,
+    z.ZodTypeDef,
+    CreateTransferAmountDetailsValidationError
+  > = z.object({
+    tip: z.string().optional(),
+  });
+
+export function createTransferAmountDetailsValidationErrorToJSON(
+  createTransferAmountDetailsValidationError:
+    CreateTransferAmountDetailsValidationError,
+): string {
+  return JSON.stringify(
+    CreateTransferAmountDetailsValidationError$outboundSchema.parse(
+      createTransferAmountDetailsValidationError,
+    ),
+  );
+}
+export function createTransferAmountDetailsValidationErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  CreateTransferAmountDetailsValidationError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CreateTransferAmountDetailsValidationError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'CreateTransferAmountDetailsValidationError' from JSON`,
+  );
+}

package/src/models/components/createtransferconfig.ts

@@ -0,0 +1,57 @@
+/*
+ * 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 {
+  CreateTipPresets,
+  CreateTipPresets$inboundSchema,
+  CreateTipPresets$Outbound,
+  CreateTipPresets$outboundSchema,
+} from "./createtippresets.js";
+
+export type CreateTransferConfig = {
+  tipPresets?: CreateTipPresets | undefined;
+};
+
+/** @internal */
+export const CreateTransferConfig$inboundSchema: z.ZodType<
+  CreateTransferConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  tipPresets: CreateTipPresets$inboundSchema.optional(),
+});
+/** @internal */
+export type CreateTransferConfig$Outbound = {
+  tipPresets?: CreateTipPresets$Outbound | undefined;
+};
+
+/** @internal */
+export const CreateTransferConfig$outboundSchema: z.ZodType<
+  CreateTransferConfig$Outbound,
+  z.ZodTypeDef,
+  CreateTransferConfig
+> = z.object({
+  tipPresets: CreateTipPresets$outboundSchema.optional(),
+});
+
+export function createTransferConfigToJSON(
+  createTransferConfig: CreateTransferConfig,
+): string {
+  return JSON.stringify(
+    CreateTransferConfig$outboundSchema.parse(createTransferConfig),
+  );
+}
+export function createTransferConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateTransferConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateTransferConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateTransferConfig' from JSON`,
+  );
+}

package/src/models/components/createtransferdestinationcard.ts

@@ -6,12 +6,21 @@ 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 {
+  CardPayoutType,
+  CardPayoutType$inboundSchema,
+  CardPayoutType$outboundSchema,
+} from "./cardpayouttype.js";
 
 export type CreateTransferDestinationCard = {
   /**
    * An optional override of the default card statement descriptor for a transfer. Accounts must be enabled by Moov to set this field.
    */
   dynamicDescriptor?: string | undefined;
+  /**
+   * An optional field to specify the type of card payout, used to route the transfer with the appropriate business application identifier (BAI).
+   */
+  payoutType?: CardPayoutType | undefined;
 };
 
 /** @internal */
@@ -21,10 +30,12 @@ export const CreateTransferDestinationCard$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   dynamicDescriptor: z.string().optional(),
+  payoutType: CardPayoutType$inboundSchema.optional(),
 });
 /** @internal */
 export type CreateTransferDestinationCard$Outbound = {
   dynamicDescriptor?: string | undefined;
+  payoutType?: string | undefined;
 };
 
 /** @internal */
@@ -34,6 +45,7 @@ export const CreateTransferDestinationCard$outboundSchema: z.ZodType<
   CreateTransferDestinationCard
 > = z.object({
   dynamicDescriptor: z.string().optional(),
+  payoutType: CardPayoutType$outboundSchema.optional(),
 });
 
 export function createTransferDestinationCardToJSON(