@moovio/sdk 0.0.0-dev.28 → 0.0.0-dev.29

package/src/models/components/transferrailoptions.ts

@@ -0,0 +1,98 @@
+/*
+ * 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 {
+  ACHCreditOptions,
+  ACHCreditOptions$inboundSchema,
+  ACHCreditOptions$Outbound,
+  ACHCreditOptions$outboundSchema,
+} from "./achcreditoptions.js";
+import {
+  ACHDebitOptions,
+  ACHDebitOptions$inboundSchema,
+  ACHDebitOptions$Outbound,
+  ACHDebitOptions$outboundSchema,
+} from "./achdebitoptions.js";
+import {
+  CardPaymentOptions,
+  CardPaymentOptions$inboundSchema,
+  CardPaymentOptions$Outbound,
+  CardPaymentOptions$outboundSchema,
+} from "./cardpaymentoptions.js";
+import {
+  PullFromCardOptions,
+  PullFromCardOptions$inboundSchema,
+  PullFromCardOptions$Outbound,
+  PullFromCardOptions$outboundSchema,
+} from "./pullfromcardoptions.js";
+import {
+  PushToCardOptions,
+  PushToCardOptions$inboundSchema,
+  PushToCardOptions$Outbound,
+  PushToCardOptions$outboundSchema,
+} from "./pushtocardoptions.js";
+
+export type TransferRailOptions = {
+  cardPayment?: CardPaymentOptions | undefined;
+  pushToCard?: PushToCardOptions | undefined;
+  pullFromCard?: PullFromCardOptions | undefined;
+  achDebit?: ACHDebitOptions | undefined;
+  achCredit?: ACHCreditOptions | undefined;
+};
+
+/** @internal */
+export const TransferRailOptions$inboundSchema: z.ZodType<
+  TransferRailOptions,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  cardPayment: types.optional(CardPaymentOptions$inboundSchema),
+  pushToCard: types.optional(PushToCardOptions$inboundSchema),
+  pullFromCard: types.optional(PullFromCardOptions$inboundSchema),
+  achDebit: types.optional(ACHDebitOptions$inboundSchema),
+  achCredit: types.optional(ACHCreditOptions$inboundSchema),
+});
+/** @internal */
+export type TransferRailOptions$Outbound = {
+  cardPayment?: CardPaymentOptions$Outbound | undefined;
+  pushToCard?: PushToCardOptions$Outbound | undefined;
+  pullFromCard?: PullFromCardOptions$Outbound | undefined;
+  achDebit?: ACHDebitOptions$Outbound | undefined;
+  achCredit?: ACHCreditOptions$Outbound | undefined;
+};
+
+/** @internal */
+export const TransferRailOptions$outboundSchema: z.ZodType<
+  TransferRailOptions$Outbound,
+  z.ZodTypeDef,
+  TransferRailOptions
+> = z.object({
+  cardPayment: CardPaymentOptions$outboundSchema.optional(),
+  pushToCard: PushToCardOptions$outboundSchema.optional(),
+  pullFromCard: PullFromCardOptions$outboundSchema.optional(),
+  achDebit: ACHDebitOptions$outboundSchema.optional(),
+  achCredit: ACHCreditOptions$outboundSchema.optional(),
+});
+
+export function transferRailOptionsToJSON(
+  transferRailOptions: TransferRailOptions,
+): string {
+  return JSON.stringify(
+    TransferRailOptions$outboundSchema.parse(transferRailOptions),
+  );
+}
+export function transferRailOptionsFromJSON(
+  jsonString: string,
+): SafeParseResult<TransferRailOptions, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransferRailOptions$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransferRailOptions' from JSON`,
+  );
+}

package/src/models/components/transfersource.ts

@@ -7,24 +7,12 @@ 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 {
-  ACHTransactionDetails,
-  ACHTransactionDetails$inboundSchema,
-  ACHTransactionDetails$Outbound,
-  ACHTransactionDetails$outboundSchema,
-} from "./achtransactiondetails.js";
 import {
   ApplePayResponse,
   ApplePayResponse$inboundSchema,
   ApplePayResponse$Outbound,
   ApplePayResponse$outboundSchema,
 } from "./applepayresponse.js";
-import {
-  CardTransactionDetails,
-  CardTransactionDetails$inboundSchema,
-  CardTransactionDetails$Outbound,
-  CardTransactionDetails$outboundSchema,
-} from "./cardtransactiondetails.js";
 import {
   GooglePayResponse,
   GooglePayResponse$inboundSchema,
@@ -72,12 +60,12 @@ export type TransferSource = {
    * String present only if the transfer is part of a transfer group.
    */
   transferID?: string | undefined;
-  paymentMethodID: string;
+  paymentMethodID?: string | undefined;
   /**
    * The payment method type that represents a payment rail and directionality
    */
-  paymentMethodType: TransferPaymentMethodType;
-  account: TransferAccount;
+  paymentMethodType?: TransferPaymentMethodType | undefined;
+  account?: TransferAccount | undefined;
   /**
    * A bank account as contained within a payment method.
    */
@@ -99,14 +87,6 @@ export type TransferSource = {
    * Describes payment card details captured with tap or in-person payment.
    */
   terminalCard?: TransferTerminalCard | undefined;
-  /**
-   * Card-specific details about the transaction.
-   */
-  cardDetails?: CardTransactionDetails | undefined;
-  /**
-   * ACH specific details about the transaction.
-   */
-  achDetails?: ACHTransactionDetails | undefined;
 };
 
 /** @internal */
@@ -116,32 +96,28 @@ export const TransferSource$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   transferID: types.optional(types.string()),
-  paymentMethodID: types.string(),
-  paymentMethodType: TransferPaymentMethodType$inboundSchema,
-  account: TransferAccount$inboundSchema,
+  paymentMethodID: types.optional(types.string()),
+  paymentMethodType: types.optional(TransferPaymentMethodType$inboundSchema),
+  account: types.optional(TransferAccount$inboundSchema),
   bankAccount: types.optional(TransferPaymentMethodsBankAccount$inboundSchema),
   wallet: types.optional(TransferPaymentMethodsWallet$inboundSchema),
   card: types.optional(TransferPaymentMethodsCard$inboundSchema),
   applePay: types.optional(ApplePayResponse$inboundSchema),
   googlePay: types.optional(GooglePayResponse$inboundSchema),
   terminalCard: types.optional(TransferTerminalCard$inboundSchema),
-  cardDetails: types.optional(CardTransactionDetails$inboundSchema),
-  achDetails: types.optional(ACHTransactionDetails$inboundSchema),
 });
 /** @internal */
 export type TransferSource$Outbound = {
   transferID?: string | undefined;
-  paymentMethodID: string;
-  paymentMethodType: string;
-  account: TransferAccount$Outbound;
+  paymentMethodID?: string | undefined;
+  paymentMethodType?: string | undefined;
+  account?: TransferAccount$Outbound | undefined;
   bankAccount?: TransferPaymentMethodsBankAccount$Outbound | undefined;
   wallet?: TransferPaymentMethodsWallet$Outbound | undefined;
   card?: TransferPaymentMethodsCard$Outbound | undefined;
   applePay?: ApplePayResponse$Outbound | undefined;
   googlePay?: GooglePayResponse$Outbound | undefined;
   terminalCard?: TransferTerminalCard$Outbound | undefined;
-  cardDetails?: CardTransactionDetails$Outbound | undefined;
-  achDetails?: ACHTransactionDetails$Outbound | undefined;
 };
 
 /** @internal */
@@ -151,17 +127,15 @@ export const TransferSource$outboundSchema: z.ZodType<
   TransferSource
 > = z.object({
   transferID: z.string().optional(),
-  paymentMethodID: z.string(),
-  paymentMethodType: TransferPaymentMethodType$outboundSchema,
-  account: TransferAccount$outboundSchema,
+  paymentMethodID: z.string().optional(),
+  paymentMethodType: TransferPaymentMethodType$outboundSchema.optional(),
+  account: TransferAccount$outboundSchema.optional(),
   bankAccount: TransferPaymentMethodsBankAccount$outboundSchema.optional(),
   wallet: TransferPaymentMethodsWallet$outboundSchema.optional(),
   card: TransferPaymentMethodsCard$outboundSchema.optional(),
   applePay: ApplePayResponse$outboundSchema.optional(),
   googlePay: GooglePayResponse$outboundSchema.optional(),
   terminalCard: TransferTerminalCard$outboundSchema.optional(),
-  cardDetails: CardTransactionDetails$outboundSchema.optional(),
-  achDetails: ACHTransactionDetails$outboundSchema.optional(),
 });
 
 export function transferSourceToJSON(transferSource: TransferSource): string {

package/src/models/components/transferstatus.ts

@@ -16,6 +16,7 @@ export const TransferStatus = {
   Failed: "failed",
   Reversed: "reversed",
   Queued: "queued",
+  AwaitingCapture: "awaiting-capture",
   Canceled: "canceled",
 } as const;
 /**

package/src/models/components/transfertype.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * The rail and direction used to move funds for a transfer.
+ */
+export const TransferType = {
+  CardPayment: "card-payment",
+  PushToCard: "push-to-card",
+  PullFromCard: "pull-from-card",
+  AchDebit: "ach-debit",
+  AchCredit: "ach-credit",
+  AchDebitToAchCredit: "ach-debit-to-ach-credit",
+  InstantBankCredit: "instant-bank-credit",
+  Wallet: "wallet",
+} as const;
+/**
+ * The rail and direction used to move funds for a transfer.
+ */
+export type TransferType = OpenEnum<typeof TransferType>;
+
+/** @internal */
+export const TransferType$inboundSchema: z.ZodType<
+  TransferType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(TransferType);
+/** @internal */
+export const TransferType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  TransferType
+> = openEnums.outboundSchema(TransferType);

package/src/models/components/wallet.ts

@@ -49,6 +49,7 @@ export type Wallet = {
    * @remarks
    *   - `default`: The system-generated wallet automatically created when an account is granted the wallet capability.
    *   - `general`: An additional, user-defined wallet created via API or Dashboard.
+   *   - `card-issuing`: The system-generated wallet automatically created when an account is granted the card-issuing capability.
    */
   walletType: WalletType;
   /**

package/src/models/components/wallettype.ts

@@ -12,10 +12,12 @@ import { OpenEnum } from "../../types/enums.js";
  * @remarks
  *   - `default`: The system-generated wallet automatically created when an account is granted the wallet capability.
  *   - `general`: An additional, user-defined wallet created via API or Dashboard.
+ *   - `card-issuing`: The system-generated wallet automatically created when an account is granted the card-issuing capability.
  */
 export const WalletType = {
   Default: "default",
   General: "general",
+  CardIssuing: "card-issuing",
 } as const;
 /**
  * Type of a wallet.
@@ -23,6 +25,7 @@ export const WalletType = {
  * @remarks
  *   - `default`: The system-generated wallet automatically created when an account is granted the wallet capability.
  *   - `general`: An additional, user-defined wallet created via API or Dashboard.
+ *   - `card-issuing`: The system-generated wallet automatically created when an account is granted the card-issuing capability.
  */
 export type WalletType = OpenEnum<typeof WalletType>;
 

package/src/models/components/webhookdatatransferstatus.ts

@@ -28,8 +28,11 @@ export const WebhookDataTransferStatus = {
   DestinationReturned: "destination.returned",
   DestinationOriginated: "destination.originated",
   DestinationConfirmed: "destination.confirmed",
+  DestinationSettled: "destination.settled",
   DestinationFailed: "destination.failed",
+  DestinationCanceled: "destination.canceled",
   DestinationAcceptedWithoutPosting: "destination.accepted-without-posting",
+  DestinationDeferred: "destination.deferred",
 } as const;
 export type WebhookDataTransferStatus = ClosedEnum<
   typeof WebhookDataTransferStatus

package/src/models/errors/capturevalidationerror.ts

@@ -0,0 +1,145 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as types from "../../types/primitives.js";
+import * as components from "../components/index.js";
+import { MoovError } from "./mooverror.js";
+
+/**
+ * Descriptions of any field validations that failed on a capture request.
+ */
+export type CaptureValidationErrorData = {
+  destinationPaymentMethodID?: string | undefined;
+  amount?: components.AmountDecimalValidationError | undefined;
+  isFinal?: string | undefined;
+  description?: string | undefined;
+  facilitatorFeeAmount?: components.AmountDecimalValidationError | undefined;
+  metadata?: string | undefined;
+  foreignID?: string | undefined;
+  lineItems?: components.CreateTransferLineItemsValidationError | undefined;
+  amountDetails?:
+    | components.CreateTransferAmountDetailsValidationError
+    | undefined;
+};
+
+/**
+ * Descriptions of any field validations that failed on a capture request.
+ */
+export class CaptureValidationError extends MoovError {
+  destinationPaymentMethodID?: string | undefined;
+  amount?: components.AmountDecimalValidationError | undefined;
+  isFinal?: string | undefined;
+  description?: string | undefined;
+  facilitatorFeeAmount?: components.AmountDecimalValidationError | undefined;
+  metadata?: string | undefined;
+  foreignID?: string | undefined;
+  lineItems?: components.CreateTransferLineItemsValidationError | undefined;
+  amountDetails?:
+    | components.CreateTransferAmountDetailsValidationError
+    | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: CaptureValidationErrorData;
+
+  constructor(
+    err: CaptureValidationErrorData,
+    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;
+    if (err.destinationPaymentMethodID != null) {
+      this.destinationPaymentMethodID = err.destinationPaymentMethodID;
+    }
+    if (err.amount != null) this.amount = err.amount;
+    if (err.isFinal != null) this.isFinal = err.isFinal;
+    if (err.description != null) this.description = err.description;
+    if (err.facilitatorFeeAmount != null) {
+      this.facilitatorFeeAmount = err.facilitatorFeeAmount;
+    }
+    if (err.metadata != null) this.metadata = err.metadata;
+    if (err.foreignID != null) this.foreignID = err.foreignID;
+    if (err.lineItems != null) this.lineItems = err.lineItems;
+    if (err.amountDetails != null) this.amountDetails = err.amountDetails;
+
+    this.name = "CaptureValidationError";
+  }
+}
+
+/** @internal */
+export const CaptureValidationError$inboundSchema: z.ZodType<
+  CaptureValidationError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  destinationPaymentMethodID: types.optional(types.string()),
+  amount: types.optional(components.AmountDecimalValidationError$inboundSchema),
+  isFinal: types.optional(types.string()),
+  description: types.optional(types.string()),
+  facilitatorFeeAmount: types.optional(
+    components.AmountDecimalValidationError$inboundSchema,
+  ),
+  metadata: types.optional(types.string()),
+  foreignID: types.optional(types.string()),
+  lineItems: types.optional(
+    components.CreateTransferLineItemsValidationError$inboundSchema,
+  ),
+  amountDetails: types.optional(
+    components.CreateTransferAmountDetailsValidationError$inboundSchema,
+  ),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new CaptureValidationError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type CaptureValidationError$Outbound = {
+  destinationPaymentMethodID?: string | undefined;
+  amount?: components.AmountDecimalValidationError$Outbound | undefined;
+  isFinal?: string | undefined;
+  description?: string | undefined;
+  facilitatorFeeAmount?:
+    | components.AmountDecimalValidationError$Outbound
+    | undefined;
+  metadata?: string | undefined;
+  foreignID?: string | undefined;
+  lineItems?:
+    | components.CreateTransferLineItemsValidationError$Outbound
+    | undefined;
+  amountDetails?:
+    | components.CreateTransferAmountDetailsValidationError$Outbound
+    | undefined;
+};
+
+/** @internal */
+export const CaptureValidationError$outboundSchema: z.ZodType<
+  CaptureValidationError$Outbound,
+  z.ZodTypeDef,
+  CaptureValidationError
+> = z.instanceof(CaptureValidationError)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    destinationPaymentMethodID: z.string().optional(),
+    amount: components.AmountDecimalValidationError$outboundSchema.optional(),
+    isFinal: z.string().optional(),
+    description: z.string().optional(),
+    facilitatorFeeAmount: components.AmountDecimalValidationError$outboundSchema
+      .optional(),
+    metadata: z.string().optional(),
+    foreignID: z.string().optional(),
+    lineItems: components.CreateTransferLineItemsValidationError$outboundSchema
+      .optional(),
+    amountDetails: components
+      .CreateTransferAmountDetailsValidationError$outboundSchema.optional(),
+  }));

package/src/models/errors/cardacquiringrefund.ts

@@ -18,9 +18,13 @@ export type CardAcquiringRefundData = {
   createdOn: Date;
   updatedOn: Date;
   status: components.RefundStatus;
-  amount: components.Amount;
+  amount: components.AmountDecimal;
+  /**
+   * ID of the capture this refund applies to, when applicable.
+   */
+  captureID?: string | undefined;
   amountDetails?: components.RefundAmountDetails | undefined;
-  cardDetails?: components.RefundCardDetails | undefined;
+  processingDetails: components.RefundProcessingDetails;
 };
 
 /**
@@ -34,9 +38,13 @@ export class CardAcquiringRefund extends MoovError {
   createdOn: Date;
   updatedOn: Date;
   status: components.RefundStatus;
-  amount: components.Amount;
+  amount: components.AmountDecimal;
+  /**
+   * ID of the capture this refund applies to, when applicable.
+   */
+  captureID?: string | undefined;
   amountDetails?: components.RefundAmountDetails | undefined;
-  cardDetails?: components.RefundCardDetails | undefined;
+  processingDetails: components.RefundProcessingDetails;
 
   /** The original data that was passed to this error instance. */
   data$: CardAcquiringRefundData;
@@ -55,8 +63,9 @@ export class CardAcquiringRefund extends MoovError {
     this.updatedOn = err.updatedOn;
     this.status = err.status;
     this.amount = err.amount;
+    if (err.captureID != null) this.captureID = err.captureID;
     if (err.amountDetails != null) this.amountDetails = err.amountDetails;
-    if (err.cardDetails != null) this.cardDetails = err.cardDetails;
+    this.processingDetails = err.processingDetails;
 
     this.name = "CardAcquiringRefund";
   }
@@ -72,9 +81,10 @@ export const CardAcquiringRefund$inboundSchema: z.ZodType<
   createdOn: types.date(),
   updatedOn: types.date(),
   status: components.RefundStatus$inboundSchema,
-  amount: components.Amount$inboundSchema,
+  amount: components.AmountDecimal$inboundSchema,
+  captureID: types.optional(types.string()),
   amountDetails: types.optional(components.RefundAmountDetails$inboundSchema),
-  cardDetails: types.optional(components.RefundCardDetails$inboundSchema),
+  processingDetails: components.RefundProcessingDetails$inboundSchema,
   request$: z.instanceof(Request),
   response$: z.instanceof(Response),
   body$: z.string(),
@@ -93,9 +103,10 @@ export type CardAcquiringRefund$Outbound = {
   createdOn: string;
   updatedOn: string;
   status: string;
-  amount: components.Amount$Outbound;
+  amount: components.AmountDecimal$Outbound;
+  captureID?: string | undefined;
   amountDetails?: components.RefundAmountDetails$Outbound | undefined;
-  cardDetails?: components.RefundCardDetails$Outbound | undefined;
+  processingDetails: components.RefundProcessingDetails$Outbound;
 };
 
 /** @internal */
@@ -110,7 +121,8 @@ export const CardAcquiringRefund$outboundSchema: z.ZodType<
     createdOn: z.date().transform(v => v.toISOString()),
     updatedOn: z.date().transform(v => v.toISOString()),
     status: components.RefundStatus$outboundSchema,
-    amount: components.Amount$outboundSchema,
+    amount: components.AmountDecimal$outboundSchema,
+    captureID: z.string().optional(),
     amountDetails: components.RefundAmountDetails$outboundSchema.optional(),
-    cardDetails: components.RefundCardDetails$outboundSchema.optional(),
+    processingDetails: components.RefundProcessingDetails$outboundSchema,
   }));

package/src/models/errors/index.ts

@@ -9,6 +9,7 @@ export * from "./assigncountrieserror.js";
 export * from "./authtokenrequesterror.js";
 export * from "./bankaccountvalidationerror.js";
 export * from "./brandvalidationerror.js";
+export * from "./capturevalidationerror.js";
 export * from "./cardacquiringrefund.js";
 export * from "./cardmetadatarequesterror.js";
 export * from "./connectaccountrequestvalidationerror.js";