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

package/src/models/components/achtransactionstatus.ts

@@ -0,0 +1,37 @@
+/*
+ * 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";
+
+/**
+ * Status of a transaction within the ACH lifecycle.
+ */
+export const ACHTransactionStatus = {
+  Unknown: "",
+  Initiated: "initiated",
+  Originated: "originated",
+  Corrected: "corrected",
+  Returned: "returned",
+  Completed: "completed",
+  Canceled: "canceled",
+} as const;
+/**
+ * Status of a transaction within the ACH lifecycle.
+ */
+export type ACHTransactionStatus = OpenEnum<typeof ACHTransactionStatus>;
+
+/** @internal */
+export const ACHTransactionStatus$inboundSchema: z.ZodType<
+  ACHTransactionStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ACHTransactionStatus);
+/** @internal */
+export const ACHTransactionStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ACHTransactionStatus
+> = openEnums.outboundSchema(ACHTransactionStatus);

package/src/models/components/adjustmentfees.ts

@@ -0,0 +1,72 @@
+/*
+ * 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 {
+  BillingAdjustment,
+  BillingAdjustment$inboundSchema,
+  BillingAdjustment$Outbound,
+  BillingAdjustment$outboundSchema,
+} from "./billingadjustment.js";
+import {
+  BillingCountAndAmount,
+  BillingCountAndAmount$inboundSchema,
+  BillingCountAndAmount$Outbound,
+  BillingCountAndAmount$outboundSchema,
+} from "./billingcountandamount.js";
+
+/**
+ * A detailed breakdown of adjustment (correction) fees by fee name.
+ */
+export type AdjustmentFees = {
+  /**
+   * Adjustment fees grouped by fee name.
+   */
+  items: Array<BillingAdjustment>;
+  /**
+   * Total adjustment fees.
+   */
+  total: BillingCountAndAmount;
+};
+
+/** @internal */
+export const AdjustmentFees$inboundSchema: z.ZodType<
+  AdjustmentFees,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.array(BillingAdjustment$inboundSchema),
+  total: BillingCountAndAmount$inboundSchema,
+});
+/** @internal */
+export type AdjustmentFees$Outbound = {
+  items: Array<BillingAdjustment$Outbound>;
+  total: BillingCountAndAmount$Outbound;
+};
+
+/** @internal */
+export const AdjustmentFees$outboundSchema: z.ZodType<
+  AdjustmentFees$Outbound,
+  z.ZodTypeDef,
+  AdjustmentFees
+> = z.object({
+  items: z.array(BillingAdjustment$outboundSchema),
+  total: BillingCountAndAmount$outboundSchema,
+});
+
+export function adjustmentFeesToJSON(adjustmentFees: AdjustmentFees): string {
+  return JSON.stringify(AdjustmentFees$outboundSchema.parse(adjustmentFees));
+}
+export function adjustmentFeesFromJSON(
+  jsonString: string,
+): SafeParseResult<AdjustmentFees, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AdjustmentFees$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AdjustmentFees' from JSON`,
+  );
+}

package/src/models/components/amountdecimalrange.ts

@@ -15,12 +15,10 @@ import {
 } from "./amountdecimal.js";
 
 /**
- * A range of values that an AmountDecimal can take.
+ * If either `minimum` or `maximum` is omitted, the range is "open" on that end:
  *
  * @remarks
  *
- * If either `minimum` or `maximum` is omitted, the range is "open" on that end:
- *
  * `minimum` specified: `amt >= minimum`
  * `maximum` specified: `amt <= maximum`
  * both specified: `minimum <= amt <= maximum`

package/src/models/components/amountdecimalrangeupdate.ts

@@ -15,12 +15,10 @@ import {
 } from "./amountdecimalupdate.js";
 
 /**
- * A range of values that an AmountDecimal can take.
+ * If either `minimum` or `maximum` is omitted, the range is "open" on that end:
  *
  * @remarks
  *
- * If either `minimum` or `maximum` is omitted, the range is "open" on that end:
- *
  * `minimum` specified: `amt >= minimum`
  * `maximum` specified: `amt <= maximum`
  * both specified: `minimum <= amt <= maximum`

package/src/models/components/applicationscope.ts

@@ -30,7 +30,7 @@ export const ApplicationScope = {
   FilesWrite: "files.write",
   IssuedCardsRead: "issued-cards.read",
   IssuedCardsWrite: "issued-cards.write",
-  IssuedCardsReadSecure: "issued-cards.read-secure",
+  IssuedCardsReadPrivate: "issued-cards.read-private",
   PaymentMethodsRead: "payment-methods.read",
   PingRead: "ping.read",
   ProfileEnrichmentRead: "profile-enrichment.read",

package/src/models/components/asynccreatedrefund.ts

@@ -28,7 +28,7 @@ export type AsyncCreatedRefund = {
   createdOn: Date;
   amount: AmountDecimal;
   /**
-   * ID of the capture this refund applies to, when applicable.
+   * ID of the capture refunded for an auth-capture `card-payment` transfer.
    */
   captureID?: string | undefined;
   amountDetails?: RefundAmountDetails | undefined;

package/src/models/components/bankaccountattestation.ts

@@ -0,0 +1,95 @@
+/*
+ * 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";
+
+/**
+ * An attestation that a new authorization was obtained for a R29-errored bank account.
+ */
+export type BankAccountAttestation = {
+  /**
+   * ID of the created attestation.
+   */
+  attestationID: string;
+  /**
+   * ID of the bank account the attestation belongs to.
+   */
+  bankAccountID: string;
+  /**
+   * ID of the Moov account the bank account is linked to.
+   */
+  accountID: string;
+  /**
+   * Timestamp at which the attestation was created.
+   */
+  createdOn: Date;
+  /**
+   * Date on which new authorization was obtained from the receiver, formatted as YYYY-MM-DD.
+   */
+  attestedAt: Date;
+  /**
+   * Freeform text description describing how the authorization was obtained.
+   */
+  description: string;
+};
+
+/** @internal */
+export const BankAccountAttestation$inboundSchema: z.ZodType<
+  BankAccountAttestation,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  attestationID: types.string(),
+  bankAccountID: types.string(),
+  accountID: types.string(),
+  createdOn: types.date(),
+  attestedAt: types.date(),
+  description: types.string(),
+});
+/** @internal */
+export type BankAccountAttestation$Outbound = {
+  attestationID: string;
+  bankAccountID: string;
+  accountID: string;
+  createdOn: string;
+  attestedAt: string;
+  description: string;
+};
+
+/** @internal */
+export const BankAccountAttestation$outboundSchema: z.ZodType<
+  BankAccountAttestation$Outbound,
+  z.ZodTypeDef,
+  BankAccountAttestation
+> = z.object({
+  attestationID: z.string(),
+  bankAccountID: z.string(),
+  accountID: z.string(),
+  createdOn: z.date().transform(v => v.toISOString()),
+  attestedAt: z.date().transform(v =>
+    v.toISOString().slice(0, "YYYY-MM-DD".length)
+  ),
+  description: z.string(),
+});
+
+export function bankAccountAttestationToJSON(
+  bankAccountAttestation: BankAccountAttestation,
+): string {
+  return JSON.stringify(
+    BankAccountAttestation$outboundSchema.parse(bankAccountAttestation),
+  );
+}
+export function bankAccountAttestationFromJSON(
+  jsonString: string,
+): SafeParseResult<BankAccountAttestation, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BankAccountAttestation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BankAccountAttestation' from JSON`,
+  );
+}

package/src/models/components/bankaccountattestationeligibility.ts

@@ -0,0 +1,67 @@
+/*
+ * 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";
+
+/**
+ * Whether a bank account is currently eligible to receive a new attestation.
+ */
+export type BankAccountAttestationEligibility = {
+  /**
+   * Whether the calling account is allowlisted for the attestations feature. When `false`, `eligible` is always `false`.
+   */
+  enabled: boolean;
+  /**
+   * Whether the bank account currently meets the requirements to receive a new attestation.
+   */
+  eligible: boolean;
+};
+
+/** @internal */
+export const BankAccountAttestationEligibility$inboundSchema: z.ZodType<
+  BankAccountAttestationEligibility,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  enabled: types.boolean(),
+  eligible: types.boolean(),
+});
+/** @internal */
+export type BankAccountAttestationEligibility$Outbound = {
+  enabled: boolean;
+  eligible: boolean;
+};
+
+/** @internal */
+export const BankAccountAttestationEligibility$outboundSchema: z.ZodType<
+  BankAccountAttestationEligibility$Outbound,
+  z.ZodTypeDef,
+  BankAccountAttestationEligibility
+> = z.object({
+  enabled: z.boolean(),
+  eligible: z.boolean(),
+});
+
+export function bankAccountAttestationEligibilityToJSON(
+  bankAccountAttestationEligibility: BankAccountAttestationEligibility,
+): string {
+  return JSON.stringify(
+    BankAccountAttestationEligibility$outboundSchema.parse(
+      bankAccountAttestationEligibility,
+    ),
+  );
+}
+export function bankAccountAttestationEligibilityFromJSON(
+  jsonString: string,
+): SafeParseResult<BankAccountAttestationEligibility, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BankAccountAttestationEligibility$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BankAccountAttestationEligibility' from JSON`,
+  );
+}

package/src/models/components/bankaccountattestationsummary.ts

@@ -0,0 +1,83 @@
+/*
+ * 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 partner-visible summary of a bank account attestation.
+ */
+export type BankAccountAttestationSummary = {
+  /**
+   * ID of the attestation.
+   */
+  attestationID: string;
+  /**
+   * Freeform text description describing how the authorization was obtained.
+   */
+  description: string;
+  /**
+   * Timestamp at which the attestation was created.
+   */
+  createdOn: Date;
+  /**
+   * Date on which new authorization was obtained from the receiver, formatted as YYYY-MM-DD.
+   */
+  attestedAt: Date;
+};
+
+/** @internal */
+export const BankAccountAttestationSummary$inboundSchema: z.ZodType<
+  BankAccountAttestationSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  attestationID: types.string(),
+  description: types.string(),
+  createdOn: types.date(),
+  attestedAt: types.date(),
+});
+/** @internal */
+export type BankAccountAttestationSummary$Outbound = {
+  attestationID: string;
+  description: string;
+  createdOn: string;
+  attestedAt: string;
+};
+
+/** @internal */
+export const BankAccountAttestationSummary$outboundSchema: z.ZodType<
+  BankAccountAttestationSummary$Outbound,
+  z.ZodTypeDef,
+  BankAccountAttestationSummary
+> = z.object({
+  attestationID: z.string(),
+  description: z.string(),
+  createdOn: z.date().transform(v => v.toISOString()),
+  attestedAt: z.date().transform(v =>
+    v.toISOString().slice(0, "YYYY-MM-DD".length)
+  ),
+});
+
+export function bankAccountAttestationSummaryToJSON(
+  bankAccountAttestationSummary: BankAccountAttestationSummary,
+): string {
+  return JSON.stringify(
+    BankAccountAttestationSummary$outboundSchema.parse(
+      bankAccountAttestationSummary,
+    ),
+  );
+}
+export function bankAccountAttestationSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<BankAccountAttestationSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BankAccountAttestationSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BankAccountAttestationSummary' from JSON`,
+  );
+}

package/src/models/components/billingadjustment.ts

@@ -0,0 +1,78 @@
+/*
+ * 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 {
+  AmountDecimal,
+  AmountDecimal$inboundSchema,
+  AmountDecimal$Outbound,
+  AmountDecimal$outboundSchema,
+} from "./amountdecimal.js";
+
+/**
+ * An adjustment (correction) fee grouped by its statement line-item name.
+ */
+export type BillingAdjustment = {
+  /**
+   * The name of the adjustment fee, shown as the statement line item.
+   */
+  feeName: string;
+  /**
+   * The number of adjustments with this fee name.
+   */
+  count: number;
+  /**
+   * The total amount for this fee name. May be negative for a credit/refund.
+   */
+  amount: AmountDecimal;
+};
+
+/** @internal */
+export const BillingAdjustment$inboundSchema: z.ZodType<
+  BillingAdjustment,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  feeName: types.string(),
+  count: types.number(),
+  amount: AmountDecimal$inboundSchema,
+});
+/** @internal */
+export type BillingAdjustment$Outbound = {
+  feeName: string;
+  count: number;
+  amount: AmountDecimal$Outbound;
+};
+
+/** @internal */
+export const BillingAdjustment$outboundSchema: z.ZodType<
+  BillingAdjustment$Outbound,
+  z.ZodTypeDef,
+  BillingAdjustment
+> = z.object({
+  feeName: z.string(),
+  count: z.number().int(),
+  amount: AmountDecimal$outboundSchema,
+});
+
+export function billingAdjustmentToJSON(
+  billingAdjustment: BillingAdjustment,
+): string {
+  return JSON.stringify(
+    BillingAdjustment$outboundSchema.parse(billingAdjustment),
+  );
+}
+export function billingAdjustmentFromJSON(
+  jsonString: string,
+): SafeParseResult<BillingAdjustment, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BillingAdjustment$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BillingAdjustment' from JSON`,
+  );
+}

package/src/models/components/billingsummary.ts

@@ -111,11 +111,11 @@ export type BillingSummaryPlatformFees = {
 };
 
 /**
- * The total amount of adjustment fees. This field is deprecated and will be removed in a future release.
+ * The total amount of adjustment fees. This field is deprecated and will be removed in a future release. Use adjustments.total.
  *
  * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
  */
-export type AdjustmentFees = {
+export type BillingSummaryAdjustmentFees = {
   /**
    * A 3-letter ISO 4217 currency code.
    */
@@ -177,11 +177,11 @@ export type BillingSummary = {
    */
   accountFees?: BillingSummaryDetails | undefined;
   /**
-   * The total amount of adjustment fees. This field is deprecated and will be removed in a future release.
+   * The total amount of adjustment fees. This field is deprecated and will be removed in a future release. Use adjustments.total.
    *
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
-  adjustmentFees?: AdjustmentFees | undefined;
+  adjustmentFees?: BillingSummaryAdjustmentFees | undefined;
   /**
    * The total amount of other card fees. This field is deprecated and will be removed in a future release. Use summary.otherCardFees.
    *
@@ -216,6 +216,10 @@ export type BillingSummary = {
    * Final partner payment after deducting monthlyPartnerCosts.
    */
   netPartnerPayment?: AmountDecimal | undefined;
+  /**
+   * Final partner payment after deducting monthlyPartnerCosts and any adjustments.
+   */
+  totalNetPartnerPayment?: AmountDecimal | undefined;
 };
 
 /** @internal */
@@ -359,8 +363,8 @@ export function billingSummaryPlatformFeesFromJSON(
 }
 
 /** @internal */
-export const AdjustmentFees$inboundSchema: z.ZodType<
-  AdjustmentFees,
+export const BillingSummaryAdjustmentFees$inboundSchema: z.ZodType<
+  BillingSummaryAdjustmentFees,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -368,31 +372,37 @@ export const AdjustmentFees$inboundSchema: z.ZodType<
   valueDecimal: types.string(),
 });
 /** @internal */
-export type AdjustmentFees$Outbound = {
+export type BillingSummaryAdjustmentFees$Outbound = {
   currency: string;
   valueDecimal: string;
 };
 
 /** @internal */
-export const AdjustmentFees$outboundSchema: z.ZodType<
-  AdjustmentFees$Outbound,
+export const BillingSummaryAdjustmentFees$outboundSchema: z.ZodType<
+  BillingSummaryAdjustmentFees$Outbound,
   z.ZodTypeDef,
-  AdjustmentFees
+  BillingSummaryAdjustmentFees
 > = z.object({
   currency: z.string(),
   valueDecimal: z.string(),
 });
 
-export function adjustmentFeesToJSON(adjustmentFees: AdjustmentFees): string {
-  return JSON.stringify(AdjustmentFees$outboundSchema.parse(adjustmentFees));
+export function billingSummaryAdjustmentFeesToJSON(
+  billingSummaryAdjustmentFees: BillingSummaryAdjustmentFees,
+): string {
+  return JSON.stringify(
+    BillingSummaryAdjustmentFees$outboundSchema.parse(
+      billingSummaryAdjustmentFees,
+    ),
+  );
 }
-export function adjustmentFeesFromJSON(
+export function billingSummaryAdjustmentFeesFromJSON(
   jsonString: string,
-): SafeParseResult<AdjustmentFees, SDKValidationError> {
+): SafeParseResult<BillingSummaryAdjustmentFees, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => AdjustmentFees$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'AdjustmentFees' from JSON`,
+    (x) => BillingSummaryAdjustmentFees$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BillingSummaryAdjustmentFees' from JSON`,
   );
 }
 
@@ -447,7 +457,9 @@ export const BillingSummary$inboundSchema: z.ZodType<
     z.lazy(() => BillingSummaryPlatformFees$inboundSchema),
   ),
   accountFees: types.optional(BillingSummaryDetails$inboundSchema),
-  adjustmentFees: types.optional(z.lazy(() => AdjustmentFees$inboundSchema)),
+  adjustmentFees: types.optional(
+    z.lazy(() => BillingSummaryAdjustmentFees$inboundSchema),
+  ),
   otherFees: types.optional(z.lazy(() => OtherFees$inboundSchema)),
   otherCardFees: types.optional(BillingSummaryDetails$inboundSchema),
   total: types.optional(AmountDecimal$inboundSchema),
@@ -456,6 +468,7 @@ export const BillingSummary$inboundSchema: z.ZodType<
   residualSubtotal: types.optional(AmountDecimal$inboundSchema),
   monthlyPartnerCosts: types.optional(PartnerFees$inboundSchema),
   netPartnerPayment: types.optional(AmountDecimal$inboundSchema),
+  totalNetPartnerPayment: types.optional(AmountDecimal$inboundSchema),
 });
 /** @internal */
 export type BillingSummary$Outbound = {
@@ -464,7 +477,7 @@ export type BillingSummary$Outbound = {
   instantPayments?: BillingSummaryDetails$Outbound | undefined;
   platformFees?: BillingSummaryPlatformFees$Outbound | undefined;
   accountFees?: BillingSummaryDetails$Outbound | undefined;
-  adjustmentFees?: AdjustmentFees$Outbound | undefined;
+  adjustmentFees?: BillingSummaryAdjustmentFees$Outbound | undefined;
   otherFees?: OtherFees$Outbound | undefined;
   otherCardFees?: BillingSummaryDetails$Outbound | undefined;
   total?: AmountDecimal$Outbound | undefined;
@@ -473,6 +486,7 @@ export type BillingSummary$Outbound = {
   residualSubtotal?: AmountDecimal$Outbound | undefined;
   monthlyPartnerCosts?: PartnerFees$Outbound | undefined;
   netPartnerPayment?: AmountDecimal$Outbound | undefined;
+  totalNetPartnerPayment?: AmountDecimal$Outbound | undefined;
 };
 
 /** @internal */
@@ -487,7 +501,8 @@ export const BillingSummary$outboundSchema: z.ZodType<
   platformFees: z.lazy(() => BillingSummaryPlatformFees$outboundSchema)
     .optional(),
   accountFees: BillingSummaryDetails$outboundSchema.optional(),
-  adjustmentFees: z.lazy(() => AdjustmentFees$outboundSchema).optional(),
+  adjustmentFees: z.lazy(() => BillingSummaryAdjustmentFees$outboundSchema)
+    .optional(),
   otherFees: z.lazy(() => OtherFees$outboundSchema).optional(),
   otherCardFees: BillingSummaryDetails$outboundSchema.optional(),
   total: AmountDecimal$outboundSchema.optional(),
@@ -496,6 +511,7 @@ export const BillingSummary$outboundSchema: z.ZodType<
   residualSubtotal: AmountDecimal$outboundSchema.optional(),
   monthlyPartnerCosts: PartnerFees$outboundSchema.optional(),
   netPartnerPayment: AmountDecimal$outboundSchema.optional(),
+  totalNetPartnerPayment: AmountDecimal$outboundSchema.optional(),
 });
 
 export function billingSummaryToJSON(billingSummary: BillingSummary): string {

package/src/models/components/cancellation.ts

@@ -13,6 +13,9 @@ import {
   CancellationStatus$outboundSchema,
 } from "./cancellationstatus.js";
 
+/**
+ * Cancellation of a transfer.
+ */
 export type Cancellation = {
   cancellationID: string;
   status: CancellationStatus;