@moovio/sdk 0.22.13 → 0.22.14

package/src/models/components/recur.ts

@@ -7,11 +7,11 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
-  RunTransfer,
-  RunTransfer$inboundSchema,
-  RunTransfer$Outbound,
-  RunTransfer$outboundSchema,
-} from "./runtransfer.js";
+  CreateRunTransfer,
+  CreateRunTransfer$inboundSchema,
+  CreateRunTransfer$Outbound,
+  CreateRunTransfer$outboundSchema,
+} from "./createruntransfer.js";
 
 /**
  * Defines configuration for recurring transfers.
@@ -27,7 +27,7 @@ export type Recur = {
   /**
    * Defines the attributes of a transfer.
    */
-  runTransfer: RunTransfer;
+  runTransfer: CreateRunTransfer;
   /**
    * True if the RRule set runs indefinitely.
    */
@@ -39,7 +39,7 @@ export type Recur = {
 export const Recur$inboundSchema: z.ZodType<Recur, z.ZodTypeDef, unknown> = z
   .object({
     recurrenceRule: z.string(),
-    runTransfer: RunTransfer$inboundSchema,
+    runTransfer: CreateRunTransfer$inboundSchema,
     indefinite: z.boolean().optional(),
     start: z.string().datetime({ offset: true }).transform(v => new Date(v))
       .optional(),
@@ -47,7 +47,7 @@ export const Recur$inboundSchema: z.ZodType<Recur, z.ZodTypeDef, unknown> = z
 /** @internal */
 export type Recur$Outbound = {
   recurrenceRule: string;
-  runTransfer: RunTransfer$Outbound;
+  runTransfer: CreateRunTransfer$Outbound;
   indefinite?: boolean | undefined;
   start?: string | undefined;
 };
@@ -59,7 +59,7 @@ export const Recur$outboundSchema: z.ZodType<
   Recur
 > = z.object({
   recurrenceRule: z.string(),
-  runTransfer: RunTransfer$outboundSchema,
+  runTransfer: CreateRunTransfer$outboundSchema,
   indefinite: z.boolean().optional(),
   start: z.date().transform(v => v.toISOString()).optional(),
 });

package/src/models/components/recurresponse.ts

@@ -0,0 +1,75 @@
+/*
+ * 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 {
+  RunTransfer,
+  RunTransfer$inboundSchema,
+  RunTransfer$Outbound,
+  RunTransfer$outboundSchema,
+} from "./runtransfer.js";
+
+export type RecurResponse = {
+  /**
+   *   RRule as defined by RFC 5545 (https://www.rfc-editor.org/rfc/rfc5545#section-3.3.10).
+   *
+   * @remarks
+   *   Generators available online at the following sites - https://freetools.textmagic.com/rrule-generator, https://jkbrzt.github.io/rrule/
+   */
+  recurrenceRule: string;
+  runTransfer: RunTransfer;
+  /**
+   * True if the RRule set runs indefinitely.
+   */
+  indefinite?: boolean | undefined;
+  start?: Date | undefined;
+};
+
+/** @internal */
+export const RecurResponse$inboundSchema: z.ZodType<
+  RecurResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  recurrenceRule: z.string(),
+  runTransfer: RunTransfer$inboundSchema,
+  indefinite: z.boolean().optional(),
+  start: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+});
+/** @internal */
+export type RecurResponse$Outbound = {
+  recurrenceRule: string;
+  runTransfer: RunTransfer$Outbound;
+  indefinite?: boolean | undefined;
+  start?: string | undefined;
+};
+
+/** @internal */
+export const RecurResponse$outboundSchema: z.ZodType<
+  RecurResponse$Outbound,
+  z.ZodTypeDef,
+  RecurResponse
+> = z.object({
+  recurrenceRule: z.string(),
+  runTransfer: RunTransfer$outboundSchema,
+  indefinite: z.boolean().optional(),
+  start: z.date().transform(v => v.toISOString()).optional(),
+});
+
+export function recurResponseToJSON(recurResponse: RecurResponse): string {
+  return JSON.stringify(RecurResponse$outboundSchema.parse(recurResponse));
+}
+export function recurResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<RecurResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RecurResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RecurResponse' from JSON`,
+  );
+}

package/src/models/components/runtransfer.ts

@@ -25,9 +25,6 @@ import {
   SchedulePaymentMethod$outboundSchema,
 } from "./schedulepaymentmethod.js";
 
-/**
- * Defines the attributes of a transfer.
- */
 export type RunTransfer = {
   amount: Amount;
   /**
@@ -42,10 +39,7 @@ export type RunTransfer = {
    */
   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`.
+   * Line items for a scheduled transfer.
    */
   lineItems?: ScheduledTransferLineItems | undefined;
 };

package/src/models/components/scheduledtransferimagemetadata.ts

@@ -0,0 +1,77 @@
+/*
+ * 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 ScheduledTransferImageMetadata = {
+  /**
+   * Unique identifier for a image resource.
+   */
+  imageID: string;
+  /**
+   * Alternative text for the image.
+   */
+  altText?: string | undefined;
+  /**
+   * The image's public URL.
+   */
+  link: string;
+  /**
+   * A unique identifier for an image, used in public image links.
+   */
+  publicID: string;
+};
+
+/** @internal */
+export const ScheduledTransferImageMetadata$inboundSchema: z.ZodType<
+  ScheduledTransferImageMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  imageID: z.string(),
+  altText: z.string().optional(),
+  link: z.string(),
+  publicID: z.string(),
+});
+/** @internal */
+export type ScheduledTransferImageMetadata$Outbound = {
+  imageID: string;
+  altText?: string | undefined;
+  link: string;
+  publicID: string;
+};
+
+/** @internal */
+export const ScheduledTransferImageMetadata$outboundSchema: z.ZodType<
+  ScheduledTransferImageMetadata$Outbound,
+  z.ZodTypeDef,
+  ScheduledTransferImageMetadata
+> = z.object({
+  imageID: z.string(),
+  altText: z.string().optional(),
+  link: z.string(),
+  publicID: z.string(),
+});
+
+export function scheduledTransferImageMetadataToJSON(
+  scheduledTransferImageMetadata: ScheduledTransferImageMetadata,
+): string {
+  return JSON.stringify(
+    ScheduledTransferImageMetadata$outboundSchema.parse(
+      scheduledTransferImageMetadata,
+    ),
+  );
+}
+export function scheduledTransferImageMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<ScheduledTransferImageMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ScheduledTransferImageMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ScheduledTransferImageMetadata' from JSON`,
+  );
+}

package/src/models/components/scheduledtransferlineitem.ts

@@ -12,6 +12,12 @@ import {
   AmountDecimal$Outbound,
   AmountDecimal$outboundSchema,
 } from "./amountdecimal.js";
+import {
+  ScheduledTransferImageMetadata,
+  ScheduledTransferImageMetadata$inboundSchema,
+  ScheduledTransferImageMetadata$Outbound,
+  ScheduledTransferImageMetadata$outboundSchema,
+} from "./scheduledtransferimagemetadata.js";
 import {
   ScheduledTransferLineItemOption,
   ScheduledTransferLineItemOption$inboundSchema,
@@ -43,6 +49,10 @@ export type ScheduledTransferLineItem = {
    * Optional unique identifier associating the line item with a product.
    */
   productID?: string | undefined;
+  /**
+   * Optional list of images associated with this line item.
+   */
+  images?: Array<ScheduledTransferImageMetadata> | undefined;
 };
 
 /** @internal */
@@ -56,6 +66,7 @@ export const ScheduledTransferLineItem$inboundSchema: z.ZodType<
   quantity: z.number().int(),
   options: z.array(ScheduledTransferLineItemOption$inboundSchema).optional(),
   productID: z.string().optional(),
+  images: z.array(ScheduledTransferImageMetadata$inboundSchema).optional(),
 });
 /** @internal */
 export type ScheduledTransferLineItem$Outbound = {
@@ -64,6 +75,7 @@ export type ScheduledTransferLineItem$Outbound = {
   quantity: number;
   options?: Array<ScheduledTransferLineItemOption$Outbound> | undefined;
   productID?: string | undefined;
+  images?: Array<ScheduledTransferImageMetadata$Outbound> | undefined;
 };
 
 /** @internal */
@@ -77,6 +89,7 @@ export const ScheduledTransferLineItem$outboundSchema: z.ZodType<
   quantity: z.number().int(),
   options: z.array(ScheduledTransferLineItemOption$outboundSchema).optional(),
   productID: z.string().optional(),
+  images: z.array(ScheduledTransferImageMetadata$outboundSchema).optional(),
 });
 
 export function scheduledTransferLineItemToJSON(

package/src/models/components/scheduledtransferlineitemoption.ts

@@ -12,6 +12,12 @@ import {
   AmountDecimal$Outbound,
   AmountDecimal$outboundSchema,
 } from "./amountdecimal.js";
+import {
+  ScheduledTransferImageMetadata,
+  ScheduledTransferImageMetadata$inboundSchema,
+  ScheduledTransferImageMetadata$Outbound,
+  ScheduledTransferImageMetadata$outboundSchema,
+} from "./scheduledtransferimagemetadata.js";
 
 /**
  * Represents a modifier or option applied to a scheduled transfer line item.
@@ -33,6 +39,10 @@ export type ScheduledTransferLineItemOption = {
    * Optional group identifier to categorize related options (e.g., 'toppings').
    */
   group?: string | undefined;
+  /**
+   * Optional list of images associated with this line item.
+   */
+  images?: Array<ScheduledTransferImageMetadata> | undefined;
 };
 
 /** @internal */
@@ -45,6 +55,7 @@ export const ScheduledTransferLineItemOption$inboundSchema: z.ZodType<
   quantity: z.number().int(),
   priceModifier: AmountDecimal$inboundSchema.optional(),
   group: z.string().optional(),
+  images: z.array(ScheduledTransferImageMetadata$inboundSchema).optional(),
 });
 /** @internal */
 export type ScheduledTransferLineItemOption$Outbound = {
@@ -52,6 +63,7 @@ export type ScheduledTransferLineItemOption$Outbound = {
   quantity: number;
   priceModifier?: AmountDecimal$Outbound | undefined;
   group?: string | undefined;
+  images?: Array<ScheduledTransferImageMetadata$Outbound> | undefined;
 };
 
 /** @internal */
@@ -64,6 +76,7 @@ export const ScheduledTransferLineItemOption$outboundSchema: z.ZodType<
   quantity: z.number().int(),
   priceModifier: AmountDecimal$outboundSchema.optional(),
   group: z.string().optional(),
+  images: z.array(ScheduledTransferImageMetadata$outboundSchema).optional(),
 });
 
 export function scheduledTransferLineItemOptionToJSON(

package/src/models/components/scheduledtransferlineitems.ts

@@ -14,10 +14,7 @@ import {
 } 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`.
+ * Line items for a scheduled transfer.
  */
 export type ScheduledTransferLineItems = {
   /**

package/src/models/components/schedulelistresponse.ts

@@ -20,11 +20,11 @@ import {
   PartialScheduleAccount$outboundSchema,
 } from "./partialscheduleaccount.js";
 import {
-  Recur,
-  Recur$inboundSchema,
-  Recur$Outbound,
-  Recur$outboundSchema,
-} from "./recur.js";
+  RecurResponse,
+  RecurResponse$inboundSchema,
+  RecurResponse$Outbound,
+  RecurResponse$outboundSchema,
+} from "./recurresponse.js";
 
 export type ScheduleListResponse = {
   /**
@@ -39,10 +39,7 @@ export type ScheduleListResponse = {
   occurrences?: Array<OccurrencesResponse> | undefined;
   ownerAccountID: string;
   partnerAccountID: string;
-  /**
-   * Defines configuration for recurring transfers.
-   */
-  recur?: Recur | undefined;
+  recur?: RecurResponse | undefined;
   scheduleID: string;
   sourceAccountID: string;
   createdOn: Date;
@@ -65,7 +62,7 @@ export const ScheduleListResponse$inboundSchema: z.ZodType<
   occurrences: z.array(OccurrencesResponse$inboundSchema).optional(),
   ownerAccountID: z.string(),
   partnerAccountID: z.string(),
-  recur: Recur$inboundSchema.optional(),
+  recur: RecurResponse$inboundSchema.optional(),
   scheduleID: z.string(),
   sourceAccountID: z.string(),
   createdOn: z.string().datetime({ offset: true }).transform(v => new Date(v)),
@@ -84,7 +81,7 @@ export type ScheduleListResponse$Outbound = {
   occurrences?: Array<OccurrencesResponse$Outbound> | undefined;
   ownerAccountID: string;
   partnerAccountID: string;
-  recur?: Recur$Outbound | undefined;
+  recur?: RecurResponse$Outbound | undefined;
   scheduleID: string;
   sourceAccountID: string;
   createdOn: string;
@@ -107,7 +104,7 @@ export const ScheduleListResponse$outboundSchema: z.ZodType<
   occurrences: z.array(OccurrencesResponse$outboundSchema).optional(),
   ownerAccountID: z.string(),
   partnerAccountID: z.string(),
-  recur: Recur$outboundSchema.optional(),
+  recur: RecurResponse$outboundSchema.optional(),
   scheduleID: z.string(),
   sourceAccountID: z.string(),
   createdOn: z.date().transform(v => v.toISOString()),

package/src/models/components/scheduleresponse.ts

@@ -14,11 +14,11 @@ import {
   OccurrencesResponse$outboundSchema,
 } from "./occurrencesresponse.js";
 import {
-  Recur,
-  Recur$inboundSchema,
-  Recur$Outbound,
-  Recur$outboundSchema,
-} from "./recur.js";
+  RecurResponse,
+  RecurResponse$inboundSchema,
+  RecurResponse$Outbound,
+  RecurResponse$outboundSchema,
+} from "./recurresponse.js";
 
 export type ScheduleResponse = {
   /**
@@ -33,10 +33,7 @@ export type ScheduleResponse = {
   occurrences?: Array<OccurrencesResponse> | undefined;
   ownerAccountID: string;
   partnerAccountID: string;
-  /**
-   * Defines configuration for recurring transfers.
-   */
-  recur?: Recur | undefined;
+  recur?: RecurResponse | undefined;
   scheduleID: string;
   sourceAccountID: string;
   createdOn: Date;
@@ -56,7 +53,7 @@ export const ScheduleResponse$inboundSchema: z.ZodType<
   occurrences: z.array(OccurrencesResponse$inboundSchema).optional(),
   ownerAccountID: z.string(),
   partnerAccountID: z.string(),
-  recur: Recur$inboundSchema.optional(),
+  recur: RecurResponse$inboundSchema.optional(),
   scheduleID: z.string(),
   sourceAccountID: z.string(),
   createdOn: z.string().datetime({ offset: true }).transform(v => new Date(v)),
@@ -72,7 +69,7 @@ export type ScheduleResponse$Outbound = {
   occurrences?: Array<OccurrencesResponse$Outbound> | undefined;
   ownerAccountID: string;
   partnerAccountID: string;
-  recur?: Recur$Outbound | undefined;
+  recur?: RecurResponse$Outbound | undefined;
   scheduleID: string;
   sourceAccountID: string;
   createdOn: string;
@@ -92,7 +89,7 @@ export const ScheduleResponse$outboundSchema: z.ZodType<
   occurrences: z.array(OccurrencesResponse$outboundSchema).optional(),
   ownerAccountID: z.string(),
   partnerAccountID: z.string(),
-  recur: Recur$outboundSchema.optional(),
+  recur: RecurResponse$outboundSchema.optional(),
   scheduleID: z.string(),
   sourceAccountID: z.string(),
   createdOn: z.date().transform(v => v.toISOString()),

package/src/models/errors/createinvoicepaymenterror.ts

@@ -3,15 +3,18 @@
  */
 
 import * as z from "zod/v3";
+import * as components from "../components/index.js";
 import { MoovError } from "./mooverror.js";
 
 export type CreateInvoicePaymentErrorData = {
+  amount?: components.AmountDecimalValidationError | undefined;
   foreignID?: string | undefined;
   description?: string | undefined;
   paymentDate?: string | undefined;
 };
 
 export class CreateInvoicePaymentError extends MoovError {
+  amount?: components.AmountDecimalValidationError | undefined;
   foreignID?: string | undefined;
   description?: string | undefined;
   paymentDate?: string | undefined;
@@ -28,6 +31,7 @@ export class CreateInvoicePaymentError extends MoovError {
       : `API error occurred: ${JSON.stringify(err)}`;
     super(message, httpMeta);
     this.data$ = err;
+    if (err.amount != null) this.amount = err.amount;
     if (err.foreignID != null) this.foreignID = err.foreignID;
     if (err.description != null) this.description = err.description;
     if (err.paymentDate != null) this.paymentDate = err.paymentDate;
@@ -42,6 +46,7 @@ export const CreateInvoicePaymentError$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  amount: components.AmountDecimalValidationError$inboundSchema.optional(),
   foreignID: z.string().optional(),
   description: z.string().optional(),
   paymentDate: z.string().optional(),
@@ -59,6 +64,7 @@ export const CreateInvoicePaymentError$inboundSchema: z.ZodType<
 
 /** @internal */
 export type CreateInvoicePaymentError$Outbound = {
+  amount?: components.AmountDecimalValidationError$Outbound | undefined;
   foreignID?: string | undefined;
   description?: string | undefined;
   paymentDate?: string | undefined;
@@ -72,6 +78,7 @@ export const CreateInvoicePaymentError$outboundSchema: z.ZodType<
 > = z.instanceof(CreateInvoicePaymentError)
   .transform(v => v.data$)
   .pipe(z.object({
+    amount: components.AmountDecimalValidationError$outboundSchema.optional(),
     foreignID: z.string().optional(),
     description: z.string().optional(),
     paymentDate: z.string().optional(),

package/src/models/operations/listfeerevenue.ts

@@ -34,6 +34,18 @@ export type ListFeeRevenueRequest = {
    * The Partner's AccountID.
    */
   accountID: string;
+  /**
+   * Optional transfer ID to filter the results by.
+   */
+  transferID?: string | undefined;
+  /**
+   * Optional dispute ID to filter the results by.
+   */
+  disputeID?: string | undefined;
+  /**
+   * Optional residual ID to filter the results by.
+   */
+  residualID?: string | undefined;
   /**
    * Optional date-time to inclusively filter all fees created after this date-time.
    */
@@ -105,6 +117,9 @@ export const ListFeeRevenueRequest$inboundSchema: z.ZodType<
   skip: z.number().int().optional(),
   count: z.number().int().optional(),
   accountID: z.string(),
+  transferID: z.string().optional(),
+  disputeID: z.string().optional(),
+  residualID: z.string().optional(),
   startDateTime: z.string().optional(),
   endDateTime: z.string().optional(),
 });
@@ -113,6 +128,9 @@ export type ListFeeRevenueRequest$Outbound = {
   skip?: number | undefined;
   count?: number | undefined;
   accountID: string;
+  transferID?: string | undefined;
+  disputeID?: string | undefined;
+  residualID?: string | undefined;
   startDateTime?: string | undefined;
   endDateTime?: string | undefined;
 };
@@ -126,6 +144,9 @@ export const ListFeeRevenueRequest$outboundSchema: z.ZodType<
   skip: z.number().int().optional(),
   count: z.number().int().optional(),
   accountID: z.string(),
+  transferID: z.string().optional(),
+  disputeID: z.string().optional(),
+  residualID: z.string().optional(),
   startDateTime: z.string().optional(),
   endDateTime: z.string().optional(),
 });

package/src/models/operations/retrievefees.ts

@@ -37,6 +37,10 @@ export type RetrieveFeesRequest = {
    * Optional dispute ID to filter the results by.
    */
   disputeID?: string | undefined;
+  /**
+   * Optional residual ID to filter the results by.
+   */
+  residualID?: string | undefined;
   /**
    * Optional date-time to inclusively filter all fees created after this date-time.
    */
@@ -110,6 +114,7 @@ export const RetrieveFeesRequest$inboundSchema: z.ZodType<
   accountID: z.string(),
   transferID: z.string().optional(),
   disputeID: z.string().optional(),
+  residualID: z.string().optional(),
   startDateTime: z.string().optional(),
   endDateTime: z.string().optional(),
   skip: z.number().int().optional(),
@@ -120,6 +125,7 @@ export type RetrieveFeesRequest$Outbound = {
   accountID: string;
   transferID?: string | undefined;
   disputeID?: string | undefined;
+  residualID?: string | undefined;
   startDateTime?: string | undefined;
   endDateTime?: string | undefined;
   skip?: number | undefined;
@@ -135,6 +141,7 @@ export const RetrieveFeesRequest$outboundSchema: z.ZodType<
   accountID: z.string(),
   transferID: z.string().optional(),
   disputeID: z.string().optional(),
+  residualID: z.string().optional(),
   startDateTime: z.string().optional(),
   endDateTime: z.string().optional(),
   skip: z.number().int().optional(),