@moovio/sdk 26.7.1 → 26.7.2

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/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;

package/src/models/components/createdtransfer.ts

@@ -98,6 +98,14 @@ export type CreatedTransfer = {
    * Reason for a transfer's failure.
    */
   failureReason?: 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?: Amount | undefined;
   /**
    * An optional description of the transfer that is used on receipts and for your own internal use.

package/src/models/components/createfeeplanagreement.ts

@@ -10,9 +10,23 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type CreateFeePlanAgreement = {
   /**
-   * A unique identifier for a Moov resource. Supports UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) or typed format with base32-encoded UUID and type suffix (e.g., kuoaydiojf7uszaokc2ggnaaaa_xfer).
+   * A unique identifier for a fee plan: the pricing terms, such as flat-rate or cost-plus, that an account
+   *
+   * @remarks
+   * is charged under its fee plan agreement. Use GET /accounts/{accountID}/fee-plans to list the fee plans
+   * available to assign to a given account.
    */
   planID: string;
+  /**
+   * The account's active fee plan agreement to supersede. When set, that agreement is terminated and
+   *
+   * @remarks
+   * the new one takes its place in a single operation, so the account is never without an active fee
+   * plan agreement. This new agreement always receives a newly issued agreementID.
+   *
+   * Omit it if the account doesn't already have an active fee plan agreement.
+   */
+  priorAgreementID?: string | undefined;
 };
 
 /** @internal */
@@ -22,10 +36,12 @@ export const CreateFeePlanAgreement$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   planID: types.string(),
+  priorAgreementID: types.optional(types.string()),
 });
 /** @internal */
 export type CreateFeePlanAgreement$Outbound = {
   planID: string;
+  priorAgreementID?: string | undefined;
 };
 
 /** @internal */
@@ -35,6 +51,7 @@ export const CreateFeePlanAgreement$outboundSchema: z.ZodType<
   CreateFeePlanAgreement
 > = z.object({
   planID: z.string(),
+  priorAgreementID: z.string().optional(),
 });
 
 export function createFeePlanAgreementToJSON(

package/src/models/components/createpaymentlink.ts

@@ -106,6 +106,9 @@ export type CreatePaymentLink = {
    * Options for payment links used to collect payment.
    */
   payment?: PaymentLinkPaymentDetails | undefined;
+  /**
+   * Options for payout links used to send a payout.
+   */
   payout?: PaymentLinkPayoutDetails | undefined;
   /**
    * Options for a custom amount payment link. Mutually exclusive with `payment` and `payout`.

package/src/models/components/createrefund.ts

@@ -23,7 +23,7 @@ import {
  */
 export type CreateRefund = {
   /**
-   * Amount to refund. Before v2026.10, specify the amount in integer cents. If omitted, the original transfer's full amount will be refunded.
+   * Amount to refund. If omitted, the original transfer's full amount will be refunded.
    */
   amount?: number | undefined;
   /**

package/src/models/components/createreversal.ts

@@ -16,7 +16,12 @@ import {
 
 export type CreateReversal = {
   /**
-   * Amount to reverse. Before v2026.10, specify the amount in integer cents. Partial amounts automatically trigger a refund instead of a cancellation.
+   * Amount to reverse.
+   *
+   * @remarks
+   * Before v2026.10, specify the amount in integer cents.
+   * For supported auth-capture `card-payment` reversals in v2026.10 and later, a transfer with no captures uses the full `capturableAmount`.
+   * For those transfers with one final capture, a cancellation uses the full capture amount, while a refund may be partial.
    */
   amount: number;
   /**

package/src/models/components/createtransfer.ts

@@ -85,7 +85,7 @@ export type CreateTransfer = {
   lineItems?: CreateTransferLineItems | undefined;
   amountDetails?: CreateTransferAmountDetails | undefined;
   /**
-   * Indicates which party bears fees for the transfer, keyed by fee type.
+   * Indicates which party bears fees for a transfer, keyed by fee type.
    */
   feePaidBy?: TransferFeePaidBy | undefined;
 };

package/src/models/components/facilitatorfee.ts

@@ -13,7 +13,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  */
 export type FacilitatorFee = {
   /**
-   * Total facilitator fee in cents. Only either `total` or `totalDecimal` can be set.
+   * Total facilitator fee.
    */
   total?: number | undefined;
   /**
@@ -25,7 +25,7 @@ export type FacilitatorFee = {
    */
   totalDecimal?: string | undefined;
   /**
-   * Markup facilitator fee in cents. Only either `markup` or `markupDecimal` can be set.
+   * Markup facilitator fee.
    */
   markup?: number | undefined;
   /**

package/src/models/components/feepaidby.ts

@@ -6,16 +6,10 @@ import * as z from "zod/v3";
 import * as openEnums from "../../types/enums.js";
 import { OpenEnum } from "../../types/enums.js";
 
-/**
- * Indicates which party to a money movement bears an incurred fee.
- */
 export const FeePaidBy = {
   Source: "source",
   Destination: "destination",
 } as const;
-/**
- * Indicates which party to a money movement bears an incurred fee.
- */
 export type FeePaidBy = OpenEnum<typeof FeePaidBy>;
 
 /** @internal */

package/src/models/components/feeplanagreement.ts

@@ -72,6 +72,14 @@ export type FeePlanAgreement = {
    * Fixed recurring amount paid in the billing period regardless of usage.
    */
   monthlyPlatformFee: MonthlyPlatformFee;
+  /**
+   * The agreement this one replaced. Only set when the agreement was created by replacing another.
+   */
+  priorAgreementID?: string | undefined;
+  /**
+   * The date and time the prior agreement was terminated.
+   */
+  priorAgreementTerminatedOn?: Date | undefined;
 };
 
 /** @internal */
@@ -91,6 +99,8 @@ export const FeePlanAgreement$inboundSchema: z.ZodType<
   billableFees: z.array(BillableFee$inboundSchema),
   minimumCommitment: MinimumCommitment$inboundSchema,
   monthlyPlatformFee: MonthlyPlatformFee$inboundSchema,
+  priorAgreementID: types.optional(types.string()),
+  priorAgreementTerminatedOn: types.optional(types.date()),
 });
 /** @internal */
 export type FeePlanAgreement$Outbound = {
@@ -105,6 +115,8 @@ export type FeePlanAgreement$Outbound = {
   billableFees: Array<BillableFee$Outbound>;
   minimumCommitment: MinimumCommitment$Outbound;
   monthlyPlatformFee: MonthlyPlatformFee$Outbound;
+  priorAgreementID?: string | undefined;
+  priorAgreementTerminatedOn?: string | undefined;
 };
 
 /** @internal */
@@ -124,6 +136,9 @@ export const FeePlanAgreement$outboundSchema: z.ZodType<
   billableFees: z.array(BillableFee$outboundSchema),
   minimumCommitment: MinimumCommitment$outboundSchema,
   monthlyPlatformFee: MonthlyPlatformFee$outboundSchema,
+  priorAgreementID: z.string().optional(),
+  priorAgreementTerminatedOn: z.date().transform(v => v.toISOString())
+    .optional(),
 });
 
 export function feePlanAgreementToJSON(

package/src/models/components/fullissuedcard.ts

@@ -81,6 +81,7 @@ export type FullIssuedCard = {
    * @remarks
    *
    * - `active`: The card is operational and can approve authorizations.
+   * - `frozen`: The card is temporarily suspended and cannot approve authorizations. A frozen card can be reactivated by setting its state back to `active`.
    * - `closed`: The card is permanently deactivated and cannot approve authorizations. A card can be closed by request or when it expires.
    */
   state: IssuedCardState;

package/src/models/components/index.ts

@@ -35,6 +35,7 @@ export * from "./addresserror.js";
 export * from "./addresssuggestion.js";
 export * from "./addressupdate.js";
 export * from "./adjustment.js";
+export * from "./adjustmentfees.js";
 export * from "./allowedscheduleerror.js";
 export * from "./amount.js";
 export * from "./amountdecimal.js";
@@ -77,6 +78,7 @@ export * from "./bankaccountwaitfor.js";
 export * from "./basicpaymentmethod.js";
 export * from "./batchgettransfersrequest.js";
 export * from "./billablefee.js";
+export * from "./billingadjustment.js";
 export * from "./billingcountandamount.js";
 export * from "./billinginterchangeprogramfee.js";
 export * from "./billingsummary.js";

package/src/models/components/issuedcard.ts

@@ -78,6 +78,7 @@ export type IssuedCard = {
    * @remarks
    *
    * - `active`: The card is operational and can approve authorizations.
+   * - `frozen`: The card is temporarily suspended and cannot approve authorizations. A frozen card can be reactivated by setting its state back to `active`.
    * - `closed`: The card is permanently deactivated and cannot approve authorizations. A card can be closed by request or when it expires.
    */
   state: IssuedCardState;

package/src/models/components/issuedcardstate.ts

@@ -12,10 +12,12 @@ import { OpenEnum } from "../../types/enums.js";
  * @remarks
  *
  * - `active`: The card is operational and can approve authorizations.
+ * - `frozen`: The card is temporarily suspended and cannot approve authorizations. A frozen card can be reactivated by setting its state back to `active`.
  * - `closed`: The card is permanently deactivated and cannot approve authorizations. A card can be closed by request or when it expires.
  */
 export const IssuedCardState = {
   Active: "active",
+  Frozen: "frozen",
   Closed: "closed",
 } as const;
 /**
@@ -24,6 +26,7 @@ export const IssuedCardState = {
  * @remarks
  *
  * - `active`: The card is operational and can approve authorizations.
+ * - `frozen`: The card is temporarily suspended and cannot approve authorizations. A frozen card can be reactivated by setting its state back to `active`.
  * - `closed`: The card is permanently deactivated and cannot approve authorizations. A card can be closed by request or when it expires.
  */
 export type IssuedCardState = OpenEnum<typeof IssuedCardState>;

package/src/models/components/issuedcontrols.ts

@@ -63,12 +63,9 @@ export type IssuedControls = {
    */
   merchantCategoryRestrictions?: MerchantCategoryRestrictions | undefined;
   /**
-   * Restricts card usage to specific merchants, or blocks specific merchants.
+   * Restricts card usage to specific merchants, independent of merchant category.
    */
   merchantRestrictions?: MerchantRestrictions | undefined;
-  /**
-   * Limits card usage to specific days and times.
-   */
   allowedSchedule?: IssuedControlsAllowedSchedule | null | undefined;
   /**
    * A spend cutoff date and time. When set, all authorizations after this datetime are declined regardless of other controls.

package/src/models/components/issuingcontrols.ts

@@ -33,7 +33,7 @@ import {
 } from "./schedulewindow.js";
 
 /**
- * Limits card usage to specific days and times. Set to `null` to remove all schedule restrictions.
+ * Limits card usage to specific days and times.
  */
 export type AllowedSchedule = {
   /**
@@ -46,6 +46,9 @@ export type AllowedSchedule = {
   windows: Array<ScheduleWindow>;
 };
 
+/**
+ * Mutable spend controls for the card.
+ */
 export type IssuingControls = {
   /**
    * Indicates if the card is single-use. If true, the card closes after the first authorization.
@@ -60,12 +63,9 @@ export type IssuingControls = {
    */
   merchantCategoryRestrictions?: MerchantCategoryRestrictions | undefined;
   /**
-   * Restricts card usage to specific merchants, or blocks specific merchants.
+   * Restricts card usage to specific merchants, independent of merchant category.
    */
   merchantRestrictions?: MerchantRestrictions | undefined;
-  /**
-   * Limits card usage to specific days and times. Set to `null` to remove all schedule restrictions.
-   */
   allowedSchedule?: AllowedSchedule | null | undefined;
   /**
    * A spend cutoff date and time. When set, all authorizations after this datetime are declined regardless of other controls. Set to `null` for no cutoff.

package/src/models/components/issuingcontrolsrestrictionmode.ts

@@ -7,14 +7,14 @@ import * as openEnums from "../../types/enums.js";
 import { OpenEnum } from "../../types/enums.js";
 
 /**
- * Whether the listed items are the only ones allowed (`allow`) or the ones to block (`block`).
+ * Whether the listed items should be allowed (`allow`) or blocked (`block`).
  */
 export const IssuingControlsRestrictionMode = {
   Allow: "allow",
   Block: "block",
 } as const;
 /**
- * Whether the listed items are the only ones allowed (`allow`) or the ones to block (`block`).
+ * Whether the listed items should be allowed (`allow`) or blocked (`block`).
  */
 export type IssuingControlsRestrictionMode = OpenEnum<
   typeof IssuingControlsRestrictionMode