@moovio/sdk 0.22.2 → 0.22.4

package/src/models/components/partnerfees.ts

@@ -0,0 +1,73 @@
+/*
+ * 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 {
+  BillingCountAndAmount,
+  BillingCountAndAmount$inboundSchema,
+  BillingCountAndAmount$Outbound,
+  BillingCountAndAmount$outboundSchema,
+} from "./billingcountandamount.js";
+
+/**
+ * Monthly partner costs that are charged separately and not included in residual subtotal (e.g. platform fees, minimums).
+ */
+export type PartnerFees = {
+  /**
+   * The minimum spending amount that must be met in the billing period. If actual usage is below the minimum amount, account is charged the difference.
+   */
+  minimumCommitment?: BillingCountAndAmount | undefined;
+  /**
+   * Fixed recurring fee for the billing period regardless of usage.
+   */
+  monthlyPlatform?: BillingCountAndAmount | undefined;
+  /**
+   * Total partner fees.
+   */
+  total: BillingCountAndAmount;
+};
+
+/** @internal */
+export const PartnerFees$inboundSchema: z.ZodType<
+  PartnerFees,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  minimumCommitment: BillingCountAndAmount$inboundSchema.optional(),
+  monthlyPlatform: BillingCountAndAmount$inboundSchema.optional(),
+  total: BillingCountAndAmount$inboundSchema,
+});
+/** @internal */
+export type PartnerFees$Outbound = {
+  minimumCommitment?: BillingCountAndAmount$Outbound | undefined;
+  monthlyPlatform?: BillingCountAndAmount$Outbound | undefined;
+  total: BillingCountAndAmount$Outbound;
+};
+
+/** @internal */
+export const PartnerFees$outboundSchema: z.ZodType<
+  PartnerFees$Outbound,
+  z.ZodTypeDef,
+  PartnerFees
+> = z.object({
+  minimumCommitment: BillingCountAndAmount$outboundSchema.optional(),
+  monthlyPlatform: BillingCountAndAmount$outboundSchema.optional(),
+  total: BillingCountAndAmount$outboundSchema,
+});
+
+export function partnerFeesToJSON(partnerFees: PartnerFees): string {
+  return JSON.stringify(PartnerFees$outboundSchema.parse(partnerFees));
+}
+export function partnerFeesFromJSON(
+  jsonString: string,
+): SafeParseResult<PartnerFees, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PartnerFees$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PartnerFees' from JSON`,
+  );
+}

package/src/models/components/platformfees.ts

@@ -14,7 +14,9 @@ import {
 } from "./amountdecimal.js";
 
 /**
- * A detailed breakdown of platform fees.
+ * A detailed breakdown of platform fees. This field is deprecated and will be removed in a future release. Use accountFees.
+ *
+ * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export type PlatformFees = {
   /**

package/src/models/components/runtransfer.ts

@@ -12,6 +12,12 @@ import {
   Amount$Outbound,
   Amount$outboundSchema,
 } from "./amount.js";
+import {
+  ScheduledTransferLineItems,
+  ScheduledTransferLineItems$inboundSchema,
+  ScheduledTransferLineItems$Outbound,
+  ScheduledTransferLineItems$outboundSchema,
+} from "./scheduledtransferlineitems.js";
 import {
   SchedulePaymentMethod,
   SchedulePaymentMethod$inboundSchema,
@@ -24,6 +30,10 @@ import {
  */
 export type RunTransfer = {
   amount: Amount;
+  /**
+   * Optional sales tax amount. This amount is included in the total transfer amount.
+   */
+  salesTaxAmount?: Amount | undefined;
   destination: SchedulePaymentMethod;
   partnerAccountID: string;
   source: SchedulePaymentMethod;
@@ -31,6 +41,13 @@ export type RunTransfer = {
    * Simple description to place on the transfer.
    */
   description: string;
+  /**
+   * An optional collection of line items for a scheduled transfer.
+   *
+   * @remarks
+   * When line items are provided their total must equal `amount` minus `salesTaxAmount`.
+   */
+  lineItems?: ScheduledTransferLineItems | undefined;
 };
 
 /** @internal */
@@ -40,18 +57,22 @@ export const RunTransfer$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   amount: Amount$inboundSchema,
+  salesTaxAmount: Amount$inboundSchema.optional(),
   destination: SchedulePaymentMethod$inboundSchema,
   partnerAccountID: z.string(),
   source: SchedulePaymentMethod$inboundSchema,
   description: z.string(),
+  lineItems: ScheduledTransferLineItems$inboundSchema.optional(),
 });
 /** @internal */
 export type RunTransfer$Outbound = {
   amount: Amount$Outbound;
+  salesTaxAmount?: Amount$Outbound | undefined;
   destination: SchedulePaymentMethod$Outbound;
   partnerAccountID: string;
   source: SchedulePaymentMethod$Outbound;
   description: string;
+  lineItems?: ScheduledTransferLineItems$Outbound | undefined;
 };
 
 /** @internal */
@@ -61,10 +82,12 @@ export const RunTransfer$outboundSchema: z.ZodType<
   RunTransfer
 > = z.object({
   amount: Amount$outboundSchema,
+  salesTaxAmount: Amount$outboundSchema.optional(),
   destination: SchedulePaymentMethod$outboundSchema,
   partnerAccountID: z.string(),
   source: SchedulePaymentMethod$outboundSchema,
   description: z.string(),
+  lineItems: ScheduledTransferLineItems$outboundSchema.optional(),
 });
 
 export function runTransferToJSON(runTransfer: RunTransfer): string {

package/src/models/components/scheduledtransferlineitem.ts

@@ -0,0 +1,97 @@
+/*
+ * 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 {
+  ScheduledTransferLineItemOption,
+  ScheduledTransferLineItemOption$inboundSchema,
+  ScheduledTransferLineItemOption$Outbound,
+  ScheduledTransferLineItemOption$outboundSchema,
+} from "./scheduledtransferlineitemoption.js";
+
+/**
+ * Represents a single item in a scheduled transfer, including optional modifiers and quantity.
+ */
+export type ScheduledTransferLineItem = {
+  /**
+   * The name of the item.
+   */
+  name: string;
+  /**
+   * The base price of the item before applying option modifiers.
+   */
+  basePrice: AmountDecimal;
+  /**
+   * The quantity of this item.
+   */
+  quantity: number;
+  /**
+   * Optional list of modifiers applied to this item (e.g., toppings, upgrades, customizations).
+   */
+  options?: Array<ScheduledTransferLineItemOption> | undefined;
+  /**
+   * Optional unique identifier associating the line item with a product.
+   */
+  productID?: string | undefined;
+};
+
+/** @internal */
+export const ScheduledTransferLineItem$inboundSchema: z.ZodType<
+  ScheduledTransferLineItem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  basePrice: AmountDecimal$inboundSchema,
+  quantity: z.number().int(),
+  options: z.array(ScheduledTransferLineItemOption$inboundSchema).optional(),
+  productID: z.string().optional(),
+});
+/** @internal */
+export type ScheduledTransferLineItem$Outbound = {
+  name: string;
+  basePrice: AmountDecimal$Outbound;
+  quantity: number;
+  options?: Array<ScheduledTransferLineItemOption$Outbound> | undefined;
+  productID?: string | undefined;
+};
+
+/** @internal */
+export const ScheduledTransferLineItem$outboundSchema: z.ZodType<
+  ScheduledTransferLineItem$Outbound,
+  z.ZodTypeDef,
+  ScheduledTransferLineItem
+> = z.object({
+  name: z.string(),
+  basePrice: AmountDecimal$outboundSchema,
+  quantity: z.number().int(),
+  options: z.array(ScheduledTransferLineItemOption$outboundSchema).optional(),
+  productID: z.string().optional(),
+});
+
+export function scheduledTransferLineItemToJSON(
+  scheduledTransferLineItem: ScheduledTransferLineItem,
+): string {
+  return JSON.stringify(
+    ScheduledTransferLineItem$outboundSchema.parse(scheduledTransferLineItem),
+  );
+}
+export function scheduledTransferLineItemFromJSON(
+  jsonString: string,
+): SafeParseResult<ScheduledTransferLineItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ScheduledTransferLineItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ScheduledTransferLineItem' from JSON`,
+  );
+}

package/src/models/components/scheduledtransferlineitemoption.ts

@@ -0,0 +1,86 @@
+/*
+ * 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";
+
+/**
+ * Represents a modifier or option applied to a scheduled transfer line item.
+ */
+export type ScheduledTransferLineItemOption = {
+  /**
+   * The name of the option or modifier.
+   */
+  name: string;
+  /**
+   * The quantity of this option.
+   */
+  quantity: number;
+  /**
+   * Optional price modification applied by this option. Can be positive, negative, or zero.
+   */
+  priceModifier?: AmountDecimal | undefined;
+  /**
+   * Optional group identifier to categorize related options (e.g., 'toppings').
+   */
+  group?: string | undefined;
+};
+
+/** @internal */
+export const ScheduledTransferLineItemOption$inboundSchema: z.ZodType<
+  ScheduledTransferLineItemOption,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  quantity: z.number().int(),
+  priceModifier: AmountDecimal$inboundSchema.optional(),
+  group: z.string().optional(),
+});
+/** @internal */
+export type ScheduledTransferLineItemOption$Outbound = {
+  name: string;
+  quantity: number;
+  priceModifier?: AmountDecimal$Outbound | undefined;
+  group?: string | undefined;
+};
+
+/** @internal */
+export const ScheduledTransferLineItemOption$outboundSchema: z.ZodType<
+  ScheduledTransferLineItemOption$Outbound,
+  z.ZodTypeDef,
+  ScheduledTransferLineItemOption
+> = z.object({
+  name: z.string(),
+  quantity: z.number().int(),
+  priceModifier: AmountDecimal$outboundSchema.optional(),
+  group: z.string().optional(),
+});
+
+export function scheduledTransferLineItemOptionToJSON(
+  scheduledTransferLineItemOption: ScheduledTransferLineItemOption,
+): string {
+  return JSON.stringify(
+    ScheduledTransferLineItemOption$outboundSchema.parse(
+      scheduledTransferLineItemOption,
+    ),
+  );
+}
+export function scheduledTransferLineItemOptionFromJSON(
+  jsonString: string,
+): SafeParseResult<ScheduledTransferLineItemOption, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ScheduledTransferLineItemOption$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ScheduledTransferLineItemOption' from JSON`,
+  );
+}

package/src/models/components/scheduledtransferlineitems.ts

@@ -0,0 +1,66 @@
+/*
+ * 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 {
+  ScheduledTransferLineItem,
+  ScheduledTransferLineItem$inboundSchema,
+  ScheduledTransferLineItem$Outbound,
+  ScheduledTransferLineItem$outboundSchema,
+} from "./scheduledtransferlineitem.js";
+
+/**
+ * An optional collection of line items for a scheduled transfer.
+ *
+ * @remarks
+ * When line items are provided their total must equal `amount` minus `salesTaxAmount`.
+ */
+export type ScheduledTransferLineItems = {
+  /**
+   * The list of line items.
+   */
+  items: Array<ScheduledTransferLineItem>;
+};
+
+/** @internal */
+export const ScheduledTransferLineItems$inboundSchema: z.ZodType<
+  ScheduledTransferLineItems,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.array(ScheduledTransferLineItem$inboundSchema),
+});
+/** @internal */
+export type ScheduledTransferLineItems$Outbound = {
+  items: Array<ScheduledTransferLineItem$Outbound>;
+};
+
+/** @internal */
+export const ScheduledTransferLineItems$outboundSchema: z.ZodType<
+  ScheduledTransferLineItems$Outbound,
+  z.ZodTypeDef,
+  ScheduledTransferLineItems
+> = z.object({
+  items: z.array(ScheduledTransferLineItem$outboundSchema),
+});
+
+export function scheduledTransferLineItemsToJSON(
+  scheduledTransferLineItems: ScheduledTransferLineItems,
+): string {
+  return JSON.stringify(
+    ScheduledTransferLineItems$outboundSchema.parse(scheduledTransferLineItems),
+  );
+}
+export function scheduledTransferLineItemsFromJSON(
+  jsonString: string,
+): SafeParseResult<ScheduledTransferLineItems, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ScheduledTransferLineItems$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ScheduledTransferLineItems' from JSON`,
+  );
+}

package/src/models/components/statement.ts

@@ -6,6 +6,12 @@ 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 {
+  AccountFees,
+  AccountFees$inboundSchema,
+  AccountFees$Outbound,
+  AccountFees$outboundSchema,
+} from "./accountfees.js";
 import {
   ACHFees,
   ACHFees$inboundSchema,
@@ -36,6 +42,12 @@ import {
   OtherCardFees$Outbound,
   OtherCardFees$outboundSchema,
 } from "./othercardfees.js";
+import {
+  PartnerFees,
+  PartnerFees$inboundSchema,
+  PartnerFees$Outbound,
+  PartnerFees$outboundSchema,
+} from "./partnerfees.js";
 import {
   PlatformFees,
   PlatformFees$inboundSchema,
@@ -76,11 +88,11 @@ export type Statement = {
    */
   subscriptionIDs: Array<string>;
   /**
-   * A summary of all fees included in this statement.
+   * A summary of all fees included in a statement.
    */
   summary: BillingSummary;
   /**
-   * A detailed breakdown of card acquiring fees.
+   * A detailed breakdown of card acquiring fees by card brand.
    */
   cardAcquiringFees?: CardAcquiringFees | undefined;
   /**
@@ -92,13 +104,23 @@ export type Statement = {
    */
   instantPaymentFees?: InstantPaymentFees | undefined;
   /**
-   * A detailed breakdown of platform fees.
+   * A detailed breakdown of platform fees. This field is deprecated and will be removed in a future release. Use accountFees.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   platformFees?: PlatformFees | undefined;
+  /**
+   * A detailed breakdown of account fees.
+   */
+  accountFees?: AccountFees | undefined;
   /**
    * A detailed breakdown of other card-related fees.
    */
   otherCardFees?: OtherCardFees | undefined;
+  /**
+   * Monthly partner costs that are charged separately and not included in residual subtotal (e.g. platform fees, minimums).
+   */
+  partnerFees?: PartnerFees | undefined;
   /**
    * The date and time the statement was created.
    */
@@ -131,7 +153,9 @@ export const Statement$inboundSchema: z.ZodType<
   achFees: ACHFees$inboundSchema.optional(),
   instantPaymentFees: InstantPaymentFees$inboundSchema.optional(),
   platformFees: PlatformFees$inboundSchema.optional(),
+  accountFees: AccountFees$inboundSchema.optional(),
   otherCardFees: OtherCardFees$inboundSchema.optional(),
+  partnerFees: PartnerFees$inboundSchema.optional(),
   createdOn: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   updatedOn: z.string().datetime({ offset: true }).transform(v => new Date(v)),
 });
@@ -149,7 +173,9 @@ export type Statement$Outbound = {
   achFees?: ACHFees$Outbound | undefined;
   instantPaymentFees?: InstantPaymentFees$Outbound | undefined;
   platformFees?: PlatformFees$Outbound | undefined;
+  accountFees?: AccountFees$Outbound | undefined;
   otherCardFees?: OtherCardFees$Outbound | undefined;
+  partnerFees?: PartnerFees$Outbound | undefined;
   createdOn: string;
   updatedOn: string;
 };
@@ -172,7 +198,9 @@ export const Statement$outboundSchema: z.ZodType<
   achFees: ACHFees$outboundSchema.optional(),
   instantPaymentFees: InstantPaymentFees$outboundSchema.optional(),
   platformFees: PlatformFees$outboundSchema.optional(),
+  accountFees: AccountFees$outboundSchema.optional(),
   otherCardFees: OtherCardFees$outboundSchema.optional(),
+  partnerFees: PartnerFees$outboundSchema.optional(),
   createdOn: z.date().transform(v => v.toISOString()),
   updatedOn: z.date().transform(v => v.toISOString()),
 });

package/src/sdk/bankaccounts.ts

@@ -139,7 +139,7 @@ export class BankAccounts extends ClientSDK {
   }
 
   /**
-   * Retrieve the current status and details of an instant verification, including whether the verification method was instant or same-day
+   * Retrieve the current status and details of an instant verification, including whether the verification method was instant (RTP or FedNow) or same-day
    * ACH. This helps track the verification process in real-time and provides details in case of exceptions.
    *
    * The status will indicate the following:
@@ -167,14 +167,14 @@ export class BankAccounts extends ClientSDK {
   /**
    * Instant micro-deposit verification offers a quick and efficient way to verify bank account ownership.
    *
-   * Send a $0.01 credit with a unique verification code via RTP or same-day ACH, depending on the receiving bank's capabilities. This
+   * Send a $0.01 credit with a unique verification code via RTP, FedNow, or same-day ACH, depending on the receiving bank's capabilities. This
    * feature provides a faster alternative to traditional methods, allowing verification in a single session.
    *
    * It is recommended to use the `X-Wait-For: rail-response` header to synchronously receive the outcome of the instant credit in the
    *   response payload.
    *
    * Possible verification methods:
-   *   - `instant`: Real-time verification credit sent via RTP
+   *   - `instant`: Real-time verification credit sent via RTP or FedNow
    *   - `ach`: Verification credit sent via same-day ACH
    *
    * Possible statuses: