@moovio/sdk 26.10.0-dev.2 → 26.10.0-dev.3

package/src/models/errors/imagemetadata.ts

@@ -0,0 +1,139 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as types from "../../types/primitives.js";
+import { MoovError } from "./mooverror.js";
+
+/**
+ * Metadata about an uploaded image.
+ */
+export type ImageMetadataData = {
+  /**
+   * Unique identifier for a image resource.
+   */
+  imageID: string;
+  /**
+   * The ID used to get an image with the public endpoint.
+   */
+  publicID: string;
+  /**
+   * Alternative text for the image.
+   */
+  altText?: string | undefined;
+  /**
+   * A public URL to access the image. An optional `size={width}x{height}`
+   *
+   * @remarks
+   * query parameter can be provided to resize the image.
+   */
+  link: string;
+  createdOn: Date;
+  updatedOn: Date;
+  disabledOn?: Date | undefined;
+};
+
+/**
+ * Metadata about an uploaded image.
+ */
+export class ImageMetadata extends MoovError {
+  /**
+   * Unique identifier for a image resource.
+   */
+  imageID: string;
+  /**
+   * The ID used to get an image with the public endpoint.
+   */
+  publicID: string;
+  /**
+   * Alternative text for the image.
+   */
+  altText?: string | undefined;
+  /**
+   * A public URL to access the image. An optional `size={width}x{height}`
+   *
+   * @remarks
+   * query parameter can be provided to resize the image.
+   */
+  link: string;
+  createdOn: Date;
+  updatedOn: Date;
+  disabledOn?: Date | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: ImageMetadataData;
+
+  constructor(
+    err: ImageMetadataData,
+    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;
+    this.imageID = err.imageID;
+    this.publicID = err.publicID;
+    if (err.altText != null) this.altText = err.altText;
+    this.link = err.link;
+    this.createdOn = err.createdOn;
+    this.updatedOn = err.updatedOn;
+    if (err.disabledOn != null) this.disabledOn = err.disabledOn;
+
+    this.name = "ImageMetadata";
+  }
+}
+
+/** @internal */
+export const ImageMetadata$inboundSchema: z.ZodType<
+  ImageMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  imageID: types.string(),
+  publicID: types.string(),
+  altText: types.optional(types.string()),
+  link: types.string(),
+  createdOn: types.date(),
+  updatedOn: types.date(),
+  disabledOn: types.optional(types.date()),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new ImageMetadata(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type ImageMetadata$Outbound = {
+  imageID: string;
+  publicID: string;
+  altText?: string | undefined;
+  link: string;
+  createdOn: string;
+  updatedOn: string;
+  disabledOn?: string | undefined;
+};
+
+/** @internal */
+export const ImageMetadata$outboundSchema: z.ZodType<
+  ImageMetadata$Outbound,
+  z.ZodTypeDef,
+  ImageMetadata
+> = z.instanceof(ImageMetadata)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    imageID: z.string(),
+    publicID: z.string(),
+    altText: z.string().optional(),
+    link: z.string(),
+    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/errors/index.ts

@@ -7,6 +7,7 @@ export * from "./addcapabilitieserror.js";
 export * from "./apierror.js";
 export * from "./assigncountrieserror.js";
 export * from "./authtokenrequesterror.js";
+export * from "./bankaccountattestationvalidationerror.js";
 export * from "./bankaccountvalidationerror.js";
 export * from "./brandvalidationerror.js";
 export * from "./capturevalidationerror.js";
@@ -29,6 +30,7 @@ export * from "./fileuploadvalidationerror.js";
 export * from "./filevalidationerror.js";
 export * from "./genericerror.js";
 export * from "./httpclienterrors.js";
+export * from "./imagemetadata.js";
 export * from "./imagemetadatavalidationerror.js";
 export * from "./imagerequestvalidationerror.js";
 export * from "./linkapplepayerror.js";

package/src/models/errors/transfer.ts

@@ -28,6 +28,14 @@ export type TransferData = {
    * Reason for a transfer's failure.
    */
   failureReason?: components.TransferFailureReason | undefined;
+  /**
+   * Amount associated with this transfer.
+   *
+   * @remarks
+   * In v2026.10 and later, an auth-capture `card-payment` transfer reports the approved authorization amount until a final capture is created.
+   * For these transfers, when a final capture is created, this is updated to the cumulative captured amount.
+   * For other transfer types, this is the transfer amount.
+   */
   amount: components.AmountDecimal;
   /**
    * An optional description of the transfer that is used on receipts and for your own internal use.
@@ -79,6 +87,12 @@ export type TransferData = {
    */
   invoiceID?: string | undefined;
   amountDetails?: components.TransferAmountDetails | undefined;
+  /**
+   * Authorization amounts.
+   *
+   * @remarks
+   * This field is present only for an auth-capture `card-payment` transfer.
+   */
   authorization?: components.TransferAuthorization | undefined;
   options: components.TransferRailOptions;
   processingDetails: components.TransferProcessingDetails;
@@ -105,6 +119,14 @@ export class Transfer extends MoovError {
    * Reason for a transfer's failure.
    */
   failureReason?: components.TransferFailureReason | undefined;
+  /**
+   * Amount associated with this transfer.
+   *
+   * @remarks
+   * In v2026.10 and later, an auth-capture `card-payment` transfer reports the approved authorization amount until a final capture is created.
+   * For these transfers, when a final capture is created, this is updated to the cumulative captured amount.
+   * For other transfer types, this is the transfer amount.
+   */
   amount: components.AmountDecimal;
   /**
    * An optional description of the transfer that is used on receipts and for your own internal use.
@@ -156,6 +178,12 @@ export class Transfer extends MoovError {
    */
   invoiceID?: string | undefined;
   amountDetails?: components.TransferAmountDetails | undefined;
+  /**
+   * Authorization amounts.
+   *
+   * @remarks
+   * This field is present only for an auth-capture `card-payment` transfer.
+   */
   authorization?: components.TransferAuthorization | undefined;
   options: components.TransferRailOptions;
   processingDetails: components.TransferProcessingDetails;

package/src/models/errors/upsertunderwritingerror.ts

@@ -17,6 +17,7 @@ export type UpsertUnderwritingErrorData = {
   collectFunds?: components.CollectFundsError | undefined;
   moneyTransfer?: components.MoneyTransferError | undefined;
   sendFunds?: components.SendFundsError | undefined;
+  cardIssuing?: components.CardIssuingError | undefined;
   averageMonthlyTransactionVolume?: string | undefined;
   error?: string | undefined;
   averageTransactionSize?: string | undefined;
@@ -36,6 +37,7 @@ export class UpsertUnderwritingError extends MoovError {
   collectFunds?: components.CollectFundsError | undefined;
   moneyTransfer?: components.MoneyTransferError | undefined;
   sendFunds?: components.SendFundsError | undefined;
+  cardIssuing?: components.CardIssuingError | undefined;
   averageMonthlyTransactionVolume?: string | undefined;
   error?: string | undefined;
   averageTransactionSize?: string | undefined;
@@ -69,6 +71,7 @@ export class UpsertUnderwritingError extends MoovError {
     if (err.collectFunds != null) this.collectFunds = err.collectFunds;
     if (err.moneyTransfer != null) this.moneyTransfer = err.moneyTransfer;
     if (err.sendFunds != null) this.sendFunds = err.sendFunds;
+    if (err.cardIssuing != null) this.cardIssuing = err.cardIssuing;
     if (err.averageMonthlyTransactionVolume != null) {
       this.averageMonthlyTransactionVolume =
         err.averageMonthlyTransactionVolume;
@@ -107,6 +110,7 @@ export const UpsertUnderwritingError$inboundSchema: z.ZodType<
   collectFunds: types.optional(components.CollectFundsError$inboundSchema),
   moneyTransfer: types.optional(components.MoneyTransferError$inboundSchema),
   sendFunds: types.optional(components.SendFundsError$inboundSchema),
+  cardIssuing: types.optional(components.CardIssuingError$inboundSchema),
   averageMonthlyTransactionVolume: types.optional(types.string()),
   error: types.optional(types.string()),
   averageTransactionSize: types.optional(types.string()),
@@ -141,6 +145,7 @@ export type UpsertUnderwritingError$Outbound = {
   collectFunds?: components.CollectFundsError$Outbound | undefined;
   moneyTransfer?: components.MoneyTransferError$Outbound | undefined;
   sendFunds?: components.SendFundsError$Outbound | undefined;
+  cardIssuing?: components.CardIssuingError$Outbound | undefined;
   averageMonthlyTransactionVolume?: string | undefined;
   error?: string | undefined;
   averageTransactionSize?: string | undefined;
@@ -170,6 +175,7 @@ export const UpsertUnderwritingError$outboundSchema: z.ZodType<
     collectFunds: components.CollectFundsError$outboundSchema.optional(),
     moneyTransfer: components.MoneyTransferError$outboundSchema.optional(),
     sendFunds: components.SendFundsError$outboundSchema.optional(),
+    cardIssuing: components.CardIssuingError$outboundSchema.optional(),
     averageMonthlyTransactionVolume: z.string().optional(),
     error: z.string().optional(),
     averageTransactionSize: z.string().optional(),

package/src/models/operations/createbankaccountattestation.ts

@@ -0,0 +1,136 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type CreateBankAccountAttestationRequest = {
+  accountID: string;
+  bankAccountID: string;
+  createBankAccountAttestation: components.CreateBankAccountAttestation;
+};
+
+export type CreateBankAccountAttestationResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.BankAccountAttestation;
+};
+
+/** @internal */
+export const CreateBankAccountAttestationRequest$inboundSchema: z.ZodType<
+  CreateBankAccountAttestationRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  accountID: types.string(),
+  bankAccountID: types.string(),
+  CreateBankAccountAttestation:
+    components.CreateBankAccountAttestation$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "CreateBankAccountAttestation": "createBankAccountAttestation",
+  });
+});
+/** @internal */
+export type CreateBankAccountAttestationRequest$Outbound = {
+  accountID: string;
+  bankAccountID: string;
+  CreateBankAccountAttestation:
+    components.CreateBankAccountAttestation$Outbound;
+};
+
+/** @internal */
+export const CreateBankAccountAttestationRequest$outboundSchema: z.ZodType<
+  CreateBankAccountAttestationRequest$Outbound,
+  z.ZodTypeDef,
+  CreateBankAccountAttestationRequest
+> = z.object({
+  accountID: z.string(),
+  bankAccountID: z.string(),
+  createBankAccountAttestation:
+    components.CreateBankAccountAttestation$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    createBankAccountAttestation: "CreateBankAccountAttestation",
+  });
+});
+
+export function createBankAccountAttestationRequestToJSON(
+  createBankAccountAttestationRequest: CreateBankAccountAttestationRequest,
+): string {
+  return JSON.stringify(
+    CreateBankAccountAttestationRequest$outboundSchema.parse(
+      createBankAccountAttestationRequest,
+    ),
+  );
+}
+export function createBankAccountAttestationRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateBankAccountAttestationRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CreateBankAccountAttestationRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateBankAccountAttestationRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const CreateBankAccountAttestationResponse$inboundSchema: z.ZodType<
+  CreateBankAccountAttestationResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: components.BankAccountAttestation$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+/** @internal */
+export type CreateBankAccountAttestationResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: components.BankAccountAttestation$Outbound;
+};
+
+/** @internal */
+export const CreateBankAccountAttestationResponse$outboundSchema: z.ZodType<
+  CreateBankAccountAttestationResponse$Outbound,
+  z.ZodTypeDef,
+  CreateBankAccountAttestationResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: components.BankAccountAttestation$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+    result: "Result",
+  });
+});
+
+export function createBankAccountAttestationResponseToJSON(
+  createBankAccountAttestationResponse: CreateBankAccountAttestationResponse,
+): string {
+  return JSON.stringify(
+    CreateBankAccountAttestationResponse$outboundSchema.parse(
+      createBankAccountAttestationResponse,
+    ),
+  );
+}
+export function createBankAccountAttestationResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateBankAccountAttestationResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CreateBankAccountAttestationResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateBankAccountAttestationResponse' from JSON`,
+  );
+}

package/src/models/operations/createcapture.ts

@@ -16,11 +16,11 @@ export type CreateCaptureRequest = {
    */
   xIdempotencyKey: string;
   /**
-   * The merchant's Moov account ID.
+   * Moov account ID of the partner for the transfer.
    */
   accountID: string;
   /**
-   * Identifier for the transfer.
+   * Identifier for the auth-capture `card-payment` transfer.
    */
   transferID: string;
   createCapture: components.CreateCapture;

package/src/models/operations/getbankaccountattestationeligibility.ts

@@ -0,0 +1,149 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetBankAccountAttestationEligibilityRequest = {
+  accountID: string;
+  bankAccountID: string;
+  /**
+   * Date to check eligibility against, as if it were the `attestedAt` value of a new attestation. Defaults
+   *
+   * @remarks
+   * to the current date.
+   */
+  attestedAt?: Date | undefined;
+};
+
+export type GetBankAccountAttestationEligibilityResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.BankAccountAttestationEligibility;
+};
+
+/** @internal */
+export const GetBankAccountAttestationEligibilityRequest$inboundSchema:
+  z.ZodType<
+    GetBankAccountAttestationEligibilityRequest,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    accountID: types.string(),
+    bankAccountID: types.string(),
+    attestedAt: types.optional(types.date()),
+  });
+/** @internal */
+export type GetBankAccountAttestationEligibilityRequest$Outbound = {
+  accountID: string;
+  bankAccountID: string;
+  attestedAt?: string | undefined;
+};
+
+/** @internal */
+export const GetBankAccountAttestationEligibilityRequest$outboundSchema:
+  z.ZodType<
+    GetBankAccountAttestationEligibilityRequest$Outbound,
+    z.ZodTypeDef,
+    GetBankAccountAttestationEligibilityRequest
+  > = z.object({
+    accountID: z.string(),
+    bankAccountID: z.string(),
+    attestedAt: z.date().transform(v =>
+      v.toISOString().slice(0, "YYYY-MM-DD".length)
+    ).optional(),
+  });
+
+export function getBankAccountAttestationEligibilityRequestToJSON(
+  getBankAccountAttestationEligibilityRequest:
+    GetBankAccountAttestationEligibilityRequest,
+): string {
+  return JSON.stringify(
+    GetBankAccountAttestationEligibilityRequest$outboundSchema.parse(
+      getBankAccountAttestationEligibilityRequest,
+    ),
+  );
+}
+export function getBankAccountAttestationEligibilityRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetBankAccountAttestationEligibilityRequest,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetBankAccountAttestationEligibilityRequest$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetBankAccountAttestationEligibilityRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetBankAccountAttestationEligibilityResponse$inboundSchema:
+  z.ZodType<
+    GetBankAccountAttestationEligibilityResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())).default({}),
+    Result: components.BankAccountAttestationEligibility$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+/** @internal */
+export type GetBankAccountAttestationEligibilityResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: components.BankAccountAttestationEligibility$Outbound;
+};
+
+/** @internal */
+export const GetBankAccountAttestationEligibilityResponse$outboundSchema:
+  z.ZodType<
+    GetBankAccountAttestationEligibilityResponse$Outbound,
+    z.ZodTypeDef,
+    GetBankAccountAttestationEligibilityResponse
+  > = z.object({
+    headers: z.record(z.array(z.string())),
+    result: components.BankAccountAttestationEligibility$outboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      headers: "Headers",
+      result: "Result",
+    });
+  });
+
+export function getBankAccountAttestationEligibilityResponseToJSON(
+  getBankAccountAttestationEligibilityResponse:
+    GetBankAccountAttestationEligibilityResponse,
+): string {
+  return JSON.stringify(
+    GetBankAccountAttestationEligibilityResponse$outboundSchema.parse(
+      getBankAccountAttestationEligibilityResponse,
+    ),
+  );
+}
+export function getBankAccountAttestationEligibilityResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetBankAccountAttestationEligibilityResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetBankAccountAttestationEligibilityResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetBankAccountAttestationEligibilityResponse' from JSON`,
+  );
+}

package/src/models/operations/getcapture.ts

@@ -12,11 +12,11 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type GetCaptureRequest = {
   /**
-   * The merchant's Moov account ID.
+   * Moov account ID of an authorized partner or the transfer's source or destination.
    */
   accountID: string;
   /**
-   * Identifier for the transfer.
+   * Identifier for the auth-capture `card-payment` transfer.
    */
   transferID: string;
   /**

package/src/models/operations/index.ts

@@ -12,6 +12,7 @@ export * from "./connectaccount.js";
 export * from "./createaccesstoken.js";
 export * from "./createaccount.js";
 export * from "./createapplepaysession.js";
+export * from "./createbankaccountattestation.js";
 export * from "./createbrand.js";
 export * from "./createcancellation.js";
 export * from "./createcapture.js";
@@ -58,6 +59,7 @@ export * from "./getadjustment.js";
 export * from "./getapplepaymerchantdomains.js";
 export * from "./getavatar.js";
 export * from "./getbankaccount.js";
+export * from "./getbankaccountattestationeligibility.js";
 export * from "./getbankaccountverification.js";
 export * from "./getbrand.js";
 export * from "./getcancellation.js";
@@ -116,6 +118,7 @@ export * from "./linkgooglepaytoken.js";
 export * from "./listaccounts.js";
 export * from "./listaccountterminalapplications.js";
 export * from "./listadjustments.js";
+export * from "./listbankaccountattestations.js";
 export * from "./listbankaccounts.js";
 export * from "./listcancellations.js";
 export * from "./listcapabilities.js";

package/src/models/operations/listaccounts.ts

@@ -67,6 +67,9 @@ export type ListAccountsRequest = {
    */
   capabilityStatus?: components.CapabilityStatus | undefined;
   skip?: number | undefined;
+  /**
+   * Page size. When omitted, the server defaults to `200`.
+   */
   count?: number | undefined;
 };