@moovio/sdk 26.10.0-dev.0 → 26.10.0-dev.1

package/src/models/components/incurredfee.ts

@@ -13,6 +13,11 @@ import {
   AmountDecimal$Outbound,
   AmountDecimal$outboundSchema,
 } from "./amountdecimal.js";
+import {
+  FeePaidBy,
+  FeePaidBy$inboundSchema,
+  FeePaidBy$outboundSchema,
+} from "./feepaidby.js";
 import {
   GeneratedBy,
   GeneratedBy$inboundSchema,
@@ -60,6 +65,10 @@ export type IncurredFee = {
    * Unique identifier for this residual payment calculation.
    */
   residualID?: string | undefined;
+  /**
+   * Indicates which party to the money movement bore this fee.
+   */
+  feePaidBy?: FeePaidBy | undefined;
 };
 
 /** @internal */
@@ -77,6 +86,7 @@ export const IncurredFee$inboundSchema: z.ZodType<
   generatedBy: types.optional(GeneratedBy$inboundSchema),
   feeGroup: types.optional(types.string()),
   residualID: types.optional(types.string()),
+  feePaidBy: types.optional(FeePaidBy$inboundSchema),
 });
 /** @internal */
 export type IncurredFee$Outbound = {
@@ -89,6 +99,7 @@ export type IncurredFee$Outbound = {
   generatedBy?: GeneratedBy$Outbound | undefined;
   feeGroup?: string | undefined;
   residualID?: string | undefined;
+  feePaidBy?: string | undefined;
 };
 
 /** @internal */
@@ -106,6 +117,7 @@ export const IncurredFee$outboundSchema: z.ZodType<
   generatedBy: GeneratedBy$outboundSchema.optional(),
   feeGroup: z.string().optional(),
   residualID: z.string().optional(),
+  feePaidBy: FeePaidBy$outboundSchema.optional(),
 });
 
 export function incurredFeeToJSON(incurredFee: IncurredFee): string {

package/src/models/components/index.ts

@@ -59,6 +59,7 @@ export * from "./asynccreatedrefund.js";
 export * from "./asynctransfer.js";
 export * from "./authtoken.js";
 export * from "./authtokenrequest.js";
+export * from "./avataruploadrequest.js";
 export * from "./bankaccount.js";
 export * from "./bankaccountexception.js";
 export * from "./bankaccountholdertype.js";
@@ -249,6 +250,7 @@ export * from "./fednowinstitution.js";
 export * from "./fednowservices.js";
 export * from "./feecategory.js";
 export * from "./feemodel.js";
+export * from "./feepaidby.js";
 export * from "./feeplan.js";
 export * from "./feeplanagreement.js";
 export * from "./feeplanagreementstatus.js";
@@ -415,6 +417,8 @@ export * from "./plaidpayload.js";
 export * from "./platformfees.js";
 export * from "./primaryregulator.js";
 export * from "./product.js";
+export * from "./productcategories.js";
+export * from "./productcategory.js";
 export * from "./productimagemetadata.js";
 export * from "./productoption.js";
 export * from "./productoptiongroup.js";
@@ -539,6 +543,7 @@ export * from "./transfercontrols.js";
 export * from "./transferdestination.js";
 export * from "./transferentrymode.js";
 export * from "./transferfailurereason.js";
+export * from "./transferfeepaidby.js";
 export * from "./transferlineitem.js";
 export * from "./transferlineitemimagemetadata.js";
 export * from "./transferlineitemoption.js";

package/src/models/components/issuingintervallimit.ts

@@ -6,13 +6,13 @@ import * as z from "zod/v3";
 import { ClosedEnum } from "../../types/enums.js";
 
 /**
- * Specifies the time frame for the velocity limit. Currently supports only per-transaction limits.
+ * Specifies the time frame for a velocity limit. `per-transaction` applies to each individual authorization and never resets. Time-based intervals (where supported) reset at midnight ET.
  */
 export const IssuingIntervalLimit = {
   PerTransaction: "per-transaction",
 } as const;
 /**
- * Specifies the time frame for the velocity limit. Currently supports only per-transaction limits.
+ * Specifies the time frame for a velocity limit. `per-transaction` applies to each individual authorization and never resets. Time-based intervals (where supported) reset at midnight ET.
  */
 export type IssuingIntervalLimit = ClosedEnum<typeof IssuingIntervalLimit>;
 

package/src/models/components/issuingvelocitylimit.ts

@@ -19,7 +19,7 @@ export type IssuingVelocityLimit = {
    */
   amount: number;
   /**
-   * Specifies the time frame for the velocity limit. Currently supports only per-transaction limits.
+   * Specifies the time frame for a velocity limit. `per-transaction` applies to each individual authorization and never resets. Time-based intervals (where supported) reset at midnight ET.
    */
   interval: IssuingIntervalLimit;
 };

package/src/models/components/paymentlinkpayoutdetails.ts

@@ -12,6 +12,11 @@ import {
   DisbursementPaymentMethodType$inboundSchema,
   DisbursementPaymentMethodType$outboundSchema,
 } from "./disbursementpaymentmethodtype.js";
+import {
+  FeePaidBy,
+  FeePaidBy$inboundSchema,
+  FeePaidBy$outboundSchema,
+} from "./feepaidby.js";
 import {
   PayoutRecipient,
   PayoutRecipient$inboundSchema,
@@ -52,6 +57,14 @@ export type PaymentLinkPayoutDetails = {
    * (`push-to-apple-pay`, `push-to-google-pay`) are always delivered instantly regardless of these options.
    */
   pushOptions?: PushOptions | undefined;
+  /**
+   * Indicates which party bears the fee, keyed by disbursement payment method (`DisbursementPaymentMethodType`).
+   *
+   * @remarks
+   *
+   * Sparse — include only the methods you want to attribute. Any method left unset defaults to `source`.
+   */
+  feePaidBy?: { [k: string]: FeePaidBy } | undefined;
 };
 
 /** @internal */
@@ -64,6 +77,7 @@ export const PaymentLinkPayoutDetails$inboundSchema: z.ZodType<
   recipient: PayoutRecipient$inboundSchema,
   metadata: types.optional(z.record(types.string())),
   pushOptions: types.optional(PushOptions$inboundSchema),
+  feePaidBy: types.optional(z.record(FeePaidBy$inboundSchema)),
 });
 /** @internal */
 export type PaymentLinkPayoutDetails$Outbound = {
@@ -71,6 +85,7 @@ export type PaymentLinkPayoutDetails$Outbound = {
   recipient: PayoutRecipient$Outbound;
   metadata?: { [k: string]: string } | undefined;
   pushOptions?: PushOptions$Outbound | undefined;
+  feePaidBy?: { [k: string]: string } | undefined;
 };
 
 /** @internal */
@@ -83,6 +98,7 @@ export const PaymentLinkPayoutDetails$outboundSchema: z.ZodType<
   recipient: PayoutRecipient$outboundSchema,
   metadata: z.record(z.string()).optional(),
   pushOptions: PushOptions$outboundSchema.optional(),
+  feePaidBy: z.record(FeePaidBy$outboundSchema).optional(),
 });
 
 export function paymentLinkPayoutDetailsToJSON(

package/src/models/components/paymentlinkpayoutdetailsupdate.ts

@@ -12,6 +12,11 @@ import {
   DisbursementPaymentMethodType$inboundSchema,
   DisbursementPaymentMethodType$outboundSchema,
 } from "./disbursementpaymentmethodtype.js";
+import {
+  FeePaidBy,
+  FeePaidBy$inboundSchema,
+  FeePaidBy$outboundSchema,
+} from "./feepaidby.js";
 import {
   PayoutRecipient,
   PayoutRecipient$inboundSchema,
@@ -52,6 +57,14 @@ export type PaymentLinkPayoutDetailsUpdate = {
    * (`push-to-apple-pay`, `push-to-google-pay`) are always delivered instantly regardless of these options.
    */
   pushOptions?: PushOptionsUpdate | undefined;
+  /**
+   * Indicates which party bears the fee, keyed by disbursement payment method (`DisbursementPaymentMethodType`).
+   *
+   * @remarks
+   *
+   * Sparse — include only the methods you want to attribute. Any method left unset defaults to `source`.
+   */
+  feePaidBy?: { [k: string]: FeePaidBy } | undefined;
 };
 
 /** @internal */
@@ -66,6 +79,7 @@ export const PaymentLinkPayoutDetailsUpdate$inboundSchema: z.ZodType<
   recipient: types.optional(PayoutRecipient$inboundSchema),
   metadata: types.optional(z.record(types.string())),
   pushOptions: types.optional(PushOptionsUpdate$inboundSchema),
+  feePaidBy: types.optional(z.record(FeePaidBy$inboundSchema)),
 });
 /** @internal */
 export type PaymentLinkPayoutDetailsUpdate$Outbound = {
@@ -73,6 +87,7 @@ export type PaymentLinkPayoutDetailsUpdate$Outbound = {
   recipient?: PayoutRecipient$Outbound | undefined;
   metadata?: { [k: string]: string } | undefined;
   pushOptions?: PushOptionsUpdate$Outbound | undefined;
+  feePaidBy?: { [k: string]: string } | undefined;
 };
 
 /** @internal */
@@ -86,6 +101,7 @@ export const PaymentLinkPayoutDetailsUpdate$outboundSchema: z.ZodType<
   recipient: PayoutRecipient$outboundSchema.optional(),
   metadata: z.record(z.string()).optional(),
   pushOptions: PushOptionsUpdate$outboundSchema.optional(),
+  feePaidBy: z.record(FeePaidBy$outboundSchema).optional(),
 });
 
 export function paymentLinkPayoutDetailsUpdateToJSON(

package/src/models/components/payoutdetailserror.ts

@@ -25,6 +25,7 @@ export type PayoutDetailsError = {
   recipient?: PayoutRecipientError | undefined;
   metadata?: string | undefined;
   pushOptions?: PushOptionsError | undefined;
+  feePaidBy?: string | undefined;
 };
 
 /** @internal */
@@ -37,6 +38,7 @@ export const PayoutDetailsError$inboundSchema: z.ZodType<
   recipient: types.optional(PayoutRecipientError$inboundSchema),
   metadata: types.optional(types.string()),
   pushOptions: types.optional(PushOptionsError$inboundSchema),
+  feePaidBy: types.optional(types.string()),
 });
 /** @internal */
 export type PayoutDetailsError$Outbound = {
@@ -44,6 +46,7 @@ export type PayoutDetailsError$Outbound = {
   recipient?: PayoutRecipientError$Outbound | undefined;
   metadata?: string | undefined;
   pushOptions?: PushOptionsError$Outbound | undefined;
+  feePaidBy?: string | undefined;
 };
 
 /** @internal */
@@ -56,6 +59,7 @@ export const PayoutDetailsError$outboundSchema: z.ZodType<
   recipient: PayoutRecipientError$outboundSchema.optional(),
   metadata: z.string().optional(),
   pushOptions: PushOptionsError$outboundSchema.optional(),
+  feePaidBy: z.string().optional(),
 });
 
 export function payoutDetailsErrorToJSON(

package/src/models/components/product.ts

@@ -13,6 +13,12 @@ import {
   AmountDecimal$Outbound,
   AmountDecimal$outboundSchema,
 } from "./amountdecimal.js";
+import {
+  ProductCategory,
+  ProductCategory$inboundSchema,
+  ProductCategory$Outbound,
+  ProductCategory$outboundSchema,
+} from "./productcategory.js";
 import {
   ProductImageMetadata,
   ProductImageMetadata$inboundSchema,
@@ -57,6 +63,10 @@ export type Product = {
    * Optional images associated with the product.
    */
   images?: Array<ProductImageMetadata> | undefined;
+  /**
+   * The product taxonomy category associated with the product, if any.
+   */
+  category?: ProductCategory | undefined;
   /**
    * The date and time when the product was added.
    */
@@ -80,6 +90,7 @@ export const Product$inboundSchema: z.ZodType<Product, z.ZodTypeDef, unknown> =
     basePrice: AmountDecimal$inboundSchema,
     optionGroups: types.optional(z.array(ProductOptionGroup$inboundSchema)),
     images: types.optional(z.array(ProductImageMetadata$inboundSchema)),
+    category: types.optional(ProductCategory$inboundSchema),
     createdOn: types.date(),
     updatedOn: types.date(),
     disabledOn: types.optional(types.date()),
@@ -92,6 +103,7 @@ export type Product$Outbound = {
   basePrice: AmountDecimal$Outbound;
   optionGroups?: Array<ProductOptionGroup$Outbound> | undefined;
   images?: Array<ProductImageMetadata$Outbound> | undefined;
+  category?: ProductCategory$Outbound | undefined;
   createdOn: string;
   updatedOn: string;
   disabledOn?: string | undefined;
@@ -109,6 +121,7 @@ export const Product$outboundSchema: z.ZodType<
   basePrice: AmountDecimal$outboundSchema,
   optionGroups: z.array(ProductOptionGroup$outboundSchema).optional(),
   images: z.array(ProductImageMetadata$outboundSchema).optional(),
+  category: ProductCategory$outboundSchema.optional(),
   createdOn: z.date().transform(v => v.toISOString()),
   updatedOn: z.date().transform(v => v.toISOString()),
   disabledOn: z.date().transform(v => v.toISOString()).optional(),

package/src/models/components/productcategories.ts

@@ -0,0 +1,60 @@
+/*
+ * 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 {
+  ProductCategory,
+  ProductCategory$inboundSchema,
+  ProductCategory$Outbound,
+  ProductCategory$outboundSchema,
+} from "./productcategory.js";
+
+/**
+ * A list of product categories from the product taxonomy.
+ */
+export type ProductCategories = {
+  categories: Array<ProductCategory>;
+};
+
+/** @internal */
+export const ProductCategories$inboundSchema: z.ZodType<
+  ProductCategories,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  categories: z.array(ProductCategory$inboundSchema),
+});
+/** @internal */
+export type ProductCategories$Outbound = {
+  categories: Array<ProductCategory$Outbound>;
+};
+
+/** @internal */
+export const ProductCategories$outboundSchema: z.ZodType<
+  ProductCategories$Outbound,
+  z.ZodTypeDef,
+  ProductCategories
+> = z.object({
+  categories: z.array(ProductCategory$outboundSchema),
+});
+
+export function productCategoriesToJSON(
+  productCategories: ProductCategories,
+): string {
+  return JSON.stringify(
+    ProductCategories$outboundSchema.parse(productCategories),
+  );
+}
+export function productCategoriesFromJSON(
+  jsonString: string,
+): SafeParseResult<ProductCategories, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProductCategories$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProductCategories' from JSON`,
+  );
+}

package/src/models/components/productcategory.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 * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * A product category from the product taxonomy.
+ */
+export type ProductCategory = {
+  /**
+   * The unique identifier for the category.
+   */
+  categoryID: string;
+  /**
+   * The short display name of the category.
+   */
+  name: string;
+  /**
+   * The full taxonomy path name of the category.
+   */
+  fullName: string;
+  /**
+   * The depth of the category in the taxonomy tree (1 = top-level).
+   */
+  level: number;
+  /**
+   * The identifier of the parent category, if any. Absent for top-level categories.
+   */
+  parentID?: string | undefined;
+};
+
+/** @internal */
+export const ProductCategory$inboundSchema: z.ZodType<
+  ProductCategory,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  categoryID: types.string(),
+  name: types.string(),
+  fullName: types.string(),
+  level: types.number(),
+  parentID: types.optional(types.string()),
+});
+/** @internal */
+export type ProductCategory$Outbound = {
+  categoryID: string;
+  name: string;
+  fullName: string;
+  level: number;
+  parentID?: string | undefined;
+};
+
+/** @internal */
+export const ProductCategory$outboundSchema: z.ZodType<
+  ProductCategory$Outbound,
+  z.ZodTypeDef,
+  ProductCategory
+> = z.object({
+  categoryID: z.string(),
+  name: z.string(),
+  fullName: z.string(),
+  level: z.number().int(),
+  parentID: z.string().optional(),
+});
+
+export function productCategoryToJSON(
+  productCategory: ProductCategory,
+): string {
+  return JSON.stringify(ProductCategory$outboundSchema.parse(productCategory));
+}
+export function productCategoryFromJSON(
+  jsonString: string,
+): SafeParseResult<ProductCategory, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProductCategory$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProductCategory' from JSON`,
+  );
+}

package/src/models/components/productrequest.ts

@@ -53,6 +53,10 @@ export type ProductRequest = {
    * Optional configuration options for a product, such as size or color.
    */
   optionGroups?: Array<CreateProductOptionGroup> | undefined;
+  /**
+   * The ID of a product taxonomy category to associate with the product.
+   */
+  categoryID?: string | undefined;
 };
 
 /** @internal */
@@ -66,6 +70,7 @@ export const ProductRequest$inboundSchema: z.ZodType<
   basePrice: AmountDecimal$inboundSchema,
   images: types.optional(z.array(AssignProductImage$inboundSchema)),
   optionGroups: types.optional(z.array(CreateProductOptionGroup$inboundSchema)),
+  categoryID: types.optional(types.string()),
 });
 /** @internal */
 export type ProductRequest$Outbound = {
@@ -74,6 +79,7 @@ export type ProductRequest$Outbound = {
   basePrice: AmountDecimal$Outbound;
   images?: Array<AssignProductImage$Outbound> | undefined;
   optionGroups?: Array<CreateProductOptionGroup$Outbound> | undefined;
+  categoryID?: string | undefined;
 };
 
 /** @internal */
@@ -87,6 +93,7 @@ export const ProductRequest$outboundSchema: z.ZodType<
   basePrice: AmountDecimal$outboundSchema,
   images: z.array(AssignProductImage$outboundSchema).optional(),
   optionGroups: z.array(CreateProductOptionGroup$outboundSchema).optional(),
+  categoryID: z.string().optional(),
 });
 
 export function productRequestToJSON(productRequest: ProductRequest): string {

package/src/models/components/transferfeepaidby.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 * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  FeePaidBy,
+  FeePaidBy$inboundSchema,
+  FeePaidBy$outboundSchema,
+} from "./feepaidby.js";
+
+/**
+ * Indicates which party bears fees for a transfer, keyed by fee type.
+ */
+export type TransferFeePaidBy = {
+  /**
+   * For payouts, indicates which party bears the fee. Defaults to `source`.
+   */
+  payout?: FeePaidBy | undefined;
+};
+
+/** @internal */
+export const TransferFeePaidBy$inboundSchema: z.ZodType<
+  TransferFeePaidBy,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  payout: types.optional(FeePaidBy$inboundSchema),
+});
+/** @internal */
+export type TransferFeePaidBy$Outbound = {
+  payout?: string | undefined;
+};
+
+/** @internal */
+export const TransferFeePaidBy$outboundSchema: z.ZodType<
+  TransferFeePaidBy$Outbound,
+  z.ZodTypeDef,
+  TransferFeePaidBy
+> = z.object({
+  payout: FeePaidBy$outboundSchema.optional(),
+});
+
+export function transferFeePaidByToJSON(
+  transferFeePaidBy: TransferFeePaidBy,
+): string {
+  return JSON.stringify(
+    TransferFeePaidBy$outboundSchema.parse(transferFeePaidBy),
+  );
+}
+export function transferFeePaidByFromJSON(
+  jsonString: string,
+): SafeParseResult<TransferFeePaidBy, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransferFeePaidBy$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransferFeePaidBy' from JSON`,
+  );
+}

package/src/models/errors/productrequestvalidationerror.ts

@@ -17,6 +17,7 @@ export type ProductRequestValidationErrorData = {
   optionGroups?:
     | { [k: string]: components.ProductOptionGroupValidationError }
     | undefined;
+  categoryID?: string | undefined;
 };
 
 export class ProductRequestValidationError extends MoovError {
@@ -29,6 +30,7 @@ export class ProductRequestValidationError extends MoovError {
   optionGroups?:
     | { [k: string]: components.ProductOptionGroupValidationError }
     | undefined;
+  categoryID?: string | undefined;
 
   /** The original data that was passed to this error instance. */
   data$: ProductRequestValidationErrorData;
@@ -47,6 +49,7 @@ export class ProductRequestValidationError extends MoovError {
     if (err.basePrice != null) this.basePrice = err.basePrice;
     if (err.images != null) this.images = err.images;
     if (err.optionGroups != null) this.optionGroups = err.optionGroups;
+    if (err.categoryID != null) this.categoryID = err.categoryID;
 
     this.name = "ProductRequestValidationError";
   }
@@ -69,6 +72,7 @@ export const ProductRequestValidationError$inboundSchema: z.ZodType<
   optionGroups: types.optional(
     z.record(components.ProductOptionGroupValidationError$inboundSchema),
   ),
+  categoryID: types.optional(types.string()),
   request$: z.instanceof(Request),
   response$: z.instanceof(Response),
   body$: z.string(),
@@ -92,6 +96,7 @@ export type ProductRequestValidationError$Outbound = {
   optionGroups?: {
     [k: string]: components.ProductOptionGroupValidationError$Outbound;
   } | undefined;
+  categoryID?: string | undefined;
 };
 
 /** @internal */
@@ -112,4 +117,5 @@ export const ProductRequestValidationError$outboundSchema: z.ZodType<
     optionGroups: z.record(
       components.ProductOptionGroupValidationError$outboundSchema,
     ).optional(),
+    categoryID: z.string().optional(),
   }));