rebilly-js-sdk 62.227.2 → 62.228.1

package/CHANGELOG.md

@@ -1,5 +1,3 @@
-## 62.227.2 (2026-10-20)
+## 62.228.1 (2026-10-20)
 
-### 🧱 Updated Dependencies
-
-- Updated eslint-config to 4.32.8
+This was a version bump only for rebilly-js-sdk to align it with other projects, there were no code changes.

package/dist/rebilly-js-sdk.d.cts

@@ -23351,7 +23351,7 @@ export interface coreComponents {
         amount: number;
       }[];
       /**
-       * Short name used to identify the batch.
+       * Name that is used to identify the batch.
        * This value is `null` if the batch has no name.
        */
       name?: string | null;
@@ -27101,7 +27101,13 @@ export interface coreComponents {
     };
     /** Change customer subscription items. */
     PostSubscriptionItemsChange: {
-      /** Effective time when changes are applied. */
+      /**
+       * Effective time when changes are applied.
+       * If this value is `auto` or `next-service-period`, a downgrade is scheduled for the next renewal,
+       * and the quote `order.applyAt` value is `nextRenewal`.
+       * If the order cannot take a scheduled change, for example a legacy order or an order in trial,
+       * the downgrade is applied at the beginning of the next service period.
+       */
       effectiveTime?: "now" | "next-service-period" | "auto";
       /** Details of items in the subscription. */
       items?: {
@@ -27196,8 +27202,25 @@ export interface coreComponents {
         /**
          * Date from which the renewal time for `reset` operations and proration calculations are made.
          * If this field is omitted, this value defaults to the time of quote acceptance.
+         * If `applyAt` is `nextRenewal`, this value is `null`.
          */
         effectiveTime?: string | null;
+        /**
+         * Time when the new items are applied.
+         *
+         * - `now`: The items change when the quote is accepted.
+         *   `prorated`, `renewalPolicy` and `effectiveTime` apply.
+         * - `nextRenewal`: The current items remain until the next renewal.
+         *   The new items are billed on the next renewal invoice.
+         *   `prorated`, `renewalPolicy` and `usageSettings` are ignored.
+         *   `effectiveTime` is `null`.
+         *   A later change of items replaces the pending change.
+         *   The pending change is locked when the next renewal invoice is issued.
+         *
+         * If the request `effectiveTime` is `auto` or `next-service-period` and the order can take a scheduled change,
+         * a downgrade is scheduled for the next renewal.
+         */
+        applyAt?: "now" | "nextRenewal";
         /**
          * Deprecated.
          * Use the `retainTrialThenRecurring` value of `renewalPolicy` instead.
@@ -29739,22 +29762,22 @@ export interface coreComponents {
     /**
      * Fields for updating the payout request batch.
      * At least one property must be present.
-     * Do not set `name`, `description`, or `allocationOrder` to `null`.
      */
     PatchPayoutRequestBatch: {
       content: {
         "application/json": {
           /**
-           * Short name used to identify the batch.
-           * Omit this property when not updating the name.
-           * Do not send `null`; use a string value when this property is present.
-           * If this property is an empty string, the name is removed.
+           * Name that is used to identify the batch.
+           * To retain the current name, omit this property.
+           * This value must be a string.
+           * To remove the name, set this property to an empty string.
            */
           name?: string;
           /**
            * Description of the batch.
-           * Omit this property when not updating the description.
-           * Do not send `null`; use a string value when this property is present.
+           * To retain the current description, omit this property.
+           * This value must be a string.
+           * To remove the description, set this property to an empty string.
            */
           description?: string;
           /**
@@ -29762,8 +29785,8 @@ export interface coreComponents {
            * When set, this field overrides the organization-level allocation order during batch auto-allocation.
            * Must contain `selected-payment-instrument` exactly once.
            * Valid values: `payment-card` (payment cards), `alternative-payment-methods` (catch-all for alternative payment methods), `selected-payment-instrument` (customer-requested instrument), or any payment method API name (for example, `paypal`, `Interac-eTransfer`).
-           * Omit this property when not updating the allocation order.
-           * Do not send `null`; use an array value when this property is present.
+           * To retain the current allocation order, omit this property.
+           * This value must be an array.
            */
           allocationOrder?: string[];
         };
@@ -43988,7 +44011,7 @@ export interface operations {
           | {
               /** Array of payout request IDs to include in the batch. */
               payoutRequestIds: string[];
-              /** Optional short name used to identify the batch. */
+              /** Name that is used to identify the batch. */
               name?: string | null;
               /** Optional description of the batch. */
               description?: string | null;
@@ -44007,7 +44030,7 @@ export interface operations {
                * If more than 1000 payout requests match the filter, only the oldest 1000 are included in the batch, sorted by creation time.
                */
               filter: string;
-              /** Optional short name used to identify the batch. */
+              /** Name that is used to identify the batch. */
               name?: string | null;
               /** Optional description of the batch. */
               description?: string | null;
@@ -45850,6 +45873,8 @@ export interface storefrontPaths {
     /**
      * Creates a quote for requested changes to items and quantities.
      * This operation applies the requested changes to the subscription when the quote is accepted.
+     * If `effectiveTime` is `auto` or `next-service-period`, a downgrade is scheduled for the next renewal.
+     * The `order.applyAt` value of the quote indicates when the changes are applied.
      */
     post: operations["StorefrontPostSubscriptionItemsChange"];
     parameters: {
@@ -63553,7 +63578,7 @@ export interface storefrontComponents {
         amount: number;
       }[];
       /**
-       * Short name used to identify the batch.
+       * Name that is used to identify the batch.
        * This value is `null` if the batch has no name.
        */
       name?: string | null;
@@ -67303,7 +67328,13 @@ export interface storefrontComponents {
     };
     /** Change customer subscription items. */
     PostSubscriptionItemsChange: {
-      /** Effective time when changes are applied. */
+      /**
+       * Effective time when changes are applied.
+       * If this value is `auto` or `next-service-period`, a downgrade is scheduled for the next renewal,
+       * and the quote `order.applyAt` value is `nextRenewal`.
+       * If the order cannot take a scheduled change, for example a legacy order or an order in trial,
+       * the downgrade is applied at the beginning of the next service period.
+       */
       effectiveTime?: "now" | "next-service-period" | "auto";
       /** Details of items in the subscription. */
       items?: {
@@ -67398,8 +67429,25 @@ export interface storefrontComponents {
         /**
          * Date from which the renewal time for `reset` operations and proration calculations are made.
          * If this field is omitted, this value defaults to the time of quote acceptance.
+         * If `applyAt` is `nextRenewal`, this value is `null`.
          */
         effectiveTime?: string | null;
+        /**
+         * Time when the new items are applied.
+         *
+         * - `now`: The items change when the quote is accepted.
+         *   `prorated`, `renewalPolicy` and `effectiveTime` apply.
+         * - `nextRenewal`: The current items remain until the next renewal.
+         *   The new items are billed on the next renewal invoice.
+         *   `prorated`, `renewalPolicy` and `usageSettings` are ignored.
+         *   `effectiveTime` is `null`.
+         *   A later change of items replaces the pending change.
+         *   The pending change is locked when the next renewal invoice is issued.
+         *
+         * If the request `effectiveTime` is `auto` or `next-service-period` and the order can take a scheduled change,
+         * a downgrade is scheduled for the next renewal.
+         */
+        applyAt?: "now" | "nextRenewal";
         /**
          * Deprecated.
          * Use the `retainTrialThenRecurring` value of `renewalPolicy` instead.
@@ -69941,22 +69989,22 @@ export interface storefrontComponents {
     /**
      * Fields for updating the payout request batch.
      * At least one property must be present.
-     * Do not set `name`, `description`, or `allocationOrder` to `null`.
      */
     PatchPayoutRequestBatch: {
       content: {
         "application/json": {
           /**
-           * Short name used to identify the batch.
-           * Omit this property when not updating the name.
-           * Do not send `null`; use a string value when this property is present.
-           * If this property is an empty string, the name is removed.
+           * Name that is used to identify the batch.
+           * To retain the current name, omit this property.
+           * This value must be a string.
+           * To remove the name, set this property to an empty string.
            */
           name?: string;
           /**
            * Description of the batch.
-           * Omit this property when not updating the description.
-           * Do not send `null`; use a string value when this property is present.
+           * To retain the current description, omit this property.
+           * This value must be a string.
+           * To remove the description, set this property to an empty string.
            */
           description?: string;
           /**
@@ -69964,8 +70012,8 @@ export interface storefrontComponents {
            * When set, this field overrides the organization-level allocation order during batch auto-allocation.
            * Must contain `selected-payment-instrument` exactly once.
            * Valid values: `payment-card` (payment cards), `alternative-payment-methods` (catch-all for alternative payment methods), `selected-payment-instrument` (customer-requested instrument), or any payment method API name (for example, `paypal`, `Interac-eTransfer`).
-           * Omit this property when not updating the allocation order.
-           * Do not send `null`; use an array value when this property is present.
+           * To retain the current allocation order, omit this property.
+           * This value must be an array.
            */
           allocationOrder?: string[];
         };
@@ -72285,6 +72333,8 @@ export interface operations {
   /**
    * Creates a quote for requested changes to items and quantities.
    * This operation applies the requested changes to the subscription when the quote is accepted.
+   * If `effectiveTime` is `auto` or `next-service-period`, a downgrade is scheduled for the next renewal.
+   * The `order.applyAt` value of the quote indicates when the changes are applied.
    */
   StorefrontPostSubscriptionItemsChange: {
     parameters: {
@@ -90978,7 +91028,7 @@ export interface reportsComponents {
         amount: number;
       }[];
       /**
-       * Short name used to identify the batch.
+       * Name that is used to identify the batch.
        * This value is `null` if the batch has no name.
        */
       name?: string | null;
@@ -94728,7 +94778,13 @@ export interface reportsComponents {
     };
     /** Change customer subscription items. */
     PostSubscriptionItemsChange: {
-      /** Effective time when changes are applied. */
+      /**
+       * Effective time when changes are applied.
+       * If this value is `auto` or `next-service-period`, a downgrade is scheduled for the next renewal,
+       * and the quote `order.applyAt` value is `nextRenewal`.
+       * If the order cannot take a scheduled change, for example a legacy order or an order in trial,
+       * the downgrade is applied at the beginning of the next service period.
+       */
       effectiveTime?: "now" | "next-service-period" | "auto";
       /** Details of items in the subscription. */
       items?: {
@@ -94823,8 +94879,25 @@ export interface reportsComponents {
         /**
          * Date from which the renewal time for `reset` operations and proration calculations are made.
          * If this field is omitted, this value defaults to the time of quote acceptance.
+         * If `applyAt` is `nextRenewal`, this value is `null`.
          */
         effectiveTime?: string | null;
+        /**
+         * Time when the new items are applied.
+         *
+         * - `now`: The items change when the quote is accepted.
+         *   `prorated`, `renewalPolicy` and `effectiveTime` apply.
+         * - `nextRenewal`: The current items remain until the next renewal.
+         *   The new items are billed on the next renewal invoice.
+         *   `prorated`, `renewalPolicy` and `usageSettings` are ignored.
+         *   `effectiveTime` is `null`.
+         *   A later change of items replaces the pending change.
+         *   The pending change is locked when the next renewal invoice is issued.
+         *
+         * If the request `effectiveTime` is `auto` or `next-service-period` and the order can take a scheduled change,
+         * a downgrade is scheduled for the next renewal.
+         */
+        applyAt?: "now" | "nextRenewal";
         /**
          * Deprecated.
          * Use the `retainTrialThenRecurring` value of `renewalPolicy` instead.
@@ -97366,22 +97439,22 @@ export interface reportsComponents {
     /**
      * Fields for updating the payout request batch.
      * At least one property must be present.
-     * Do not set `name`, `description`, or `allocationOrder` to `null`.
      */
     PatchPayoutRequestBatch: {
       content: {
         "application/json": {
           /**
-           * Short name used to identify the batch.
-           * Omit this property when not updating the name.
-           * Do not send `null`; use a string value when this property is present.
-           * If this property is an empty string, the name is removed.
+           * Name that is used to identify the batch.
+           * To retain the current name, omit this property.
+           * This value must be a string.
+           * To remove the name, set this property to an empty string.
            */
           name?: string;
           /**
            * Description of the batch.
-           * Omit this property when not updating the description.
-           * Do not send `null`; use a string value when this property is present.
+           * To retain the current description, omit this property.
+           * This value must be a string.
+           * To remove the description, set this property to an empty string.
            */
           description?: string;
           /**
@@ -97389,8 +97462,8 @@ export interface reportsComponents {
            * When set, this field overrides the organization-level allocation order during batch auto-allocation.
            * Must contain `selected-payment-instrument` exactly once.
            * Valid values: `payment-card` (payment cards), `alternative-payment-methods` (catch-all for alternative payment methods), `selected-payment-instrument` (customer-requested instrument), or any payment method API name (for example, `paypal`, `Interac-eTransfer`).
-           * Omit this property when not updating the allocation order.
-           * Do not send `null`; use an array value when this property is present.
+           * To retain the current allocation order, omit this property.
+           * This value must be an array.
            */
           allocationOrder?: string[];
         };

package/dist/rebilly-js-sdk.d.mts

@@ -23351,7 +23351,7 @@ export interface coreComponents {
         amount: number;
       }[];
       /**
-       * Short name used to identify the batch.
+       * Name that is used to identify the batch.
        * This value is `null` if the batch has no name.
        */
       name?: string | null;
@@ -27101,7 +27101,13 @@ export interface coreComponents {
     };
     /** Change customer subscription items. */
     PostSubscriptionItemsChange: {
-      /** Effective time when changes are applied. */
+      /**
+       * Effective time when changes are applied.
+       * If this value is `auto` or `next-service-period`, a downgrade is scheduled for the next renewal,
+       * and the quote `order.applyAt` value is `nextRenewal`.
+       * If the order cannot take a scheduled change, for example a legacy order or an order in trial,
+       * the downgrade is applied at the beginning of the next service period.
+       */
       effectiveTime?: "now" | "next-service-period" | "auto";
       /** Details of items in the subscription. */
       items?: {
@@ -27196,8 +27202,25 @@ export interface coreComponents {
         /**
          * Date from which the renewal time for `reset` operations and proration calculations are made.
          * If this field is omitted, this value defaults to the time of quote acceptance.
+         * If `applyAt` is `nextRenewal`, this value is `null`.
          */
         effectiveTime?: string | null;
+        /**
+         * Time when the new items are applied.
+         *
+         * - `now`: The items change when the quote is accepted.
+         *   `prorated`, `renewalPolicy` and `effectiveTime` apply.
+         * - `nextRenewal`: The current items remain until the next renewal.
+         *   The new items are billed on the next renewal invoice.
+         *   `prorated`, `renewalPolicy` and `usageSettings` are ignored.
+         *   `effectiveTime` is `null`.
+         *   A later change of items replaces the pending change.
+         *   The pending change is locked when the next renewal invoice is issued.
+         *
+         * If the request `effectiveTime` is `auto` or `next-service-period` and the order can take a scheduled change,
+         * a downgrade is scheduled for the next renewal.
+         */
+        applyAt?: "now" | "nextRenewal";
         /**
          * Deprecated.
          * Use the `retainTrialThenRecurring` value of `renewalPolicy` instead.
@@ -29739,22 +29762,22 @@ export interface coreComponents {
     /**
      * Fields for updating the payout request batch.
      * At least one property must be present.
-     * Do not set `name`, `description`, or `allocationOrder` to `null`.
      */
     PatchPayoutRequestBatch: {
       content: {
         "application/json": {
           /**
-           * Short name used to identify the batch.
-           * Omit this property when not updating the name.
-           * Do not send `null`; use a string value when this property is present.
-           * If this property is an empty string, the name is removed.
+           * Name that is used to identify the batch.
+           * To retain the current name, omit this property.
+           * This value must be a string.
+           * To remove the name, set this property to an empty string.
            */
           name?: string;
           /**
            * Description of the batch.
-           * Omit this property when not updating the description.
-           * Do not send `null`; use a string value when this property is present.
+           * To retain the current description, omit this property.
+           * This value must be a string.
+           * To remove the description, set this property to an empty string.
            */
           description?: string;
           /**
@@ -29762,8 +29785,8 @@ export interface coreComponents {
            * When set, this field overrides the organization-level allocation order during batch auto-allocation.
            * Must contain `selected-payment-instrument` exactly once.
            * Valid values: `payment-card` (payment cards), `alternative-payment-methods` (catch-all for alternative payment methods), `selected-payment-instrument` (customer-requested instrument), or any payment method API name (for example, `paypal`, `Interac-eTransfer`).
-           * Omit this property when not updating the allocation order.
-           * Do not send `null`; use an array value when this property is present.
+           * To retain the current allocation order, omit this property.
+           * This value must be an array.
            */
           allocationOrder?: string[];
         };
@@ -43988,7 +44011,7 @@ export interface operations {
           | {
               /** Array of payout request IDs to include in the batch. */
               payoutRequestIds: string[];
-              /** Optional short name used to identify the batch. */
+              /** Name that is used to identify the batch. */
               name?: string | null;
               /** Optional description of the batch. */
               description?: string | null;
@@ -44007,7 +44030,7 @@ export interface operations {
                * If more than 1000 payout requests match the filter, only the oldest 1000 are included in the batch, sorted by creation time.
                */
               filter: string;
-              /** Optional short name used to identify the batch. */
+              /** Name that is used to identify the batch. */
               name?: string | null;
               /** Optional description of the batch. */
               description?: string | null;
@@ -45850,6 +45873,8 @@ export interface storefrontPaths {
     /**
      * Creates a quote for requested changes to items and quantities.
      * This operation applies the requested changes to the subscription when the quote is accepted.
+     * If `effectiveTime` is `auto` or `next-service-period`, a downgrade is scheduled for the next renewal.
+     * The `order.applyAt` value of the quote indicates when the changes are applied.
      */
     post: operations["StorefrontPostSubscriptionItemsChange"];
     parameters: {
@@ -63553,7 +63578,7 @@ export interface storefrontComponents {
         amount: number;
       }[];
       /**
-       * Short name used to identify the batch.
+       * Name that is used to identify the batch.
        * This value is `null` if the batch has no name.
        */
       name?: string | null;
@@ -67303,7 +67328,13 @@ export interface storefrontComponents {
     };
     /** Change customer subscription items. */
     PostSubscriptionItemsChange: {
-      /** Effective time when changes are applied. */
+      /**
+       * Effective time when changes are applied.
+       * If this value is `auto` or `next-service-period`, a downgrade is scheduled for the next renewal,
+       * and the quote `order.applyAt` value is `nextRenewal`.
+       * If the order cannot take a scheduled change, for example a legacy order or an order in trial,
+       * the downgrade is applied at the beginning of the next service period.
+       */
       effectiveTime?: "now" | "next-service-period" | "auto";
       /** Details of items in the subscription. */
       items?: {
@@ -67398,8 +67429,25 @@ export interface storefrontComponents {
         /**
          * Date from which the renewal time for `reset` operations and proration calculations are made.
          * If this field is omitted, this value defaults to the time of quote acceptance.
+         * If `applyAt` is `nextRenewal`, this value is `null`.
          */
         effectiveTime?: string | null;
+        /**
+         * Time when the new items are applied.
+         *
+         * - `now`: The items change when the quote is accepted.
+         *   `prorated`, `renewalPolicy` and `effectiveTime` apply.
+         * - `nextRenewal`: The current items remain until the next renewal.
+         *   The new items are billed on the next renewal invoice.
+         *   `prorated`, `renewalPolicy` and `usageSettings` are ignored.
+         *   `effectiveTime` is `null`.
+         *   A later change of items replaces the pending change.
+         *   The pending change is locked when the next renewal invoice is issued.
+         *
+         * If the request `effectiveTime` is `auto` or `next-service-period` and the order can take a scheduled change,
+         * a downgrade is scheduled for the next renewal.
+         */
+        applyAt?: "now" | "nextRenewal";
         /**
          * Deprecated.
          * Use the `retainTrialThenRecurring` value of `renewalPolicy` instead.
@@ -69941,22 +69989,22 @@ export interface storefrontComponents {
     /**
      * Fields for updating the payout request batch.
      * At least one property must be present.
-     * Do not set `name`, `description`, or `allocationOrder` to `null`.
      */
     PatchPayoutRequestBatch: {
       content: {
         "application/json": {
           /**
-           * Short name used to identify the batch.
-           * Omit this property when not updating the name.
-           * Do not send `null`; use a string value when this property is present.
-           * If this property is an empty string, the name is removed.
+           * Name that is used to identify the batch.
+           * To retain the current name, omit this property.
+           * This value must be a string.
+           * To remove the name, set this property to an empty string.
            */
           name?: string;
           /**
            * Description of the batch.
-           * Omit this property when not updating the description.
-           * Do not send `null`; use a string value when this property is present.
+           * To retain the current description, omit this property.
+           * This value must be a string.
+           * To remove the description, set this property to an empty string.
            */
           description?: string;
           /**
@@ -69964,8 +70012,8 @@ export interface storefrontComponents {
            * When set, this field overrides the organization-level allocation order during batch auto-allocation.
            * Must contain `selected-payment-instrument` exactly once.
            * Valid values: `payment-card` (payment cards), `alternative-payment-methods` (catch-all for alternative payment methods), `selected-payment-instrument` (customer-requested instrument), or any payment method API name (for example, `paypal`, `Interac-eTransfer`).
-           * Omit this property when not updating the allocation order.
-           * Do not send `null`; use an array value when this property is present.
+           * To retain the current allocation order, omit this property.
+           * This value must be an array.
            */
           allocationOrder?: string[];
         };
@@ -72285,6 +72333,8 @@ export interface operations {
   /**
    * Creates a quote for requested changes to items and quantities.
    * This operation applies the requested changes to the subscription when the quote is accepted.
+   * If `effectiveTime` is `auto` or `next-service-period`, a downgrade is scheduled for the next renewal.
+   * The `order.applyAt` value of the quote indicates when the changes are applied.
    */
   StorefrontPostSubscriptionItemsChange: {
     parameters: {
@@ -90978,7 +91028,7 @@ export interface reportsComponents {
         amount: number;
       }[];
       /**
-       * Short name used to identify the batch.
+       * Name that is used to identify the batch.
        * This value is `null` if the batch has no name.
        */
       name?: string | null;
@@ -94728,7 +94778,13 @@ export interface reportsComponents {
     };
     /** Change customer subscription items. */
     PostSubscriptionItemsChange: {
-      /** Effective time when changes are applied. */
+      /**
+       * Effective time when changes are applied.
+       * If this value is `auto` or `next-service-period`, a downgrade is scheduled for the next renewal,
+       * and the quote `order.applyAt` value is `nextRenewal`.
+       * If the order cannot take a scheduled change, for example a legacy order or an order in trial,
+       * the downgrade is applied at the beginning of the next service period.
+       */
       effectiveTime?: "now" | "next-service-period" | "auto";
       /** Details of items in the subscription. */
       items?: {
@@ -94823,8 +94879,25 @@ export interface reportsComponents {
         /**
          * Date from which the renewal time for `reset` operations and proration calculations are made.
          * If this field is omitted, this value defaults to the time of quote acceptance.
+         * If `applyAt` is `nextRenewal`, this value is `null`.
          */
         effectiveTime?: string | null;
+        /**
+         * Time when the new items are applied.
+         *
+         * - `now`: The items change when the quote is accepted.
+         *   `prorated`, `renewalPolicy` and `effectiveTime` apply.
+         * - `nextRenewal`: The current items remain until the next renewal.
+         *   The new items are billed on the next renewal invoice.
+         *   `prorated`, `renewalPolicy` and `usageSettings` are ignored.
+         *   `effectiveTime` is `null`.
+         *   A later change of items replaces the pending change.
+         *   The pending change is locked when the next renewal invoice is issued.
+         *
+         * If the request `effectiveTime` is `auto` or `next-service-period` and the order can take a scheduled change,
+         * a downgrade is scheduled for the next renewal.
+         */
+        applyAt?: "now" | "nextRenewal";
         /**
          * Deprecated.
          * Use the `retainTrialThenRecurring` value of `renewalPolicy` instead.
@@ -97366,22 +97439,22 @@ export interface reportsComponents {
     /**
      * Fields for updating the payout request batch.
      * At least one property must be present.
-     * Do not set `name`, `description`, or `allocationOrder` to `null`.
      */
     PatchPayoutRequestBatch: {
       content: {
         "application/json": {
           /**
-           * Short name used to identify the batch.
-           * Omit this property when not updating the name.
-           * Do not send `null`; use a string value when this property is present.
-           * If this property is an empty string, the name is removed.
+           * Name that is used to identify the batch.
+           * To retain the current name, omit this property.
+           * This value must be a string.
+           * To remove the name, set this property to an empty string.
            */
           name?: string;
           /**
            * Description of the batch.
-           * Omit this property when not updating the description.
-           * Do not send `null`; use a string value when this property is present.
+           * To retain the current description, omit this property.
+           * This value must be a string.
+           * To remove the description, set this property to an empty string.
            */
           description?: string;
           /**
@@ -97389,8 +97462,8 @@ export interface reportsComponents {
            * When set, this field overrides the organization-level allocation order during batch auto-allocation.
            * Must contain `selected-payment-instrument` exactly once.
            * Valid values: `payment-card` (payment cards), `alternative-payment-methods` (catch-all for alternative payment methods), `selected-payment-instrument` (customer-requested instrument), or any payment method API name (for example, `paypal`, `Interac-eTransfer`).
-           * Omit this property when not updating the allocation order.
-           * Do not send `null`; use an array value when this property is present.
+           * To retain the current allocation order, omit this property.
+           * This value must be an array.
            */
           allocationOrder?: string[];
         };