rebilly-js-sdk 62.158.2 → 62.159.0

package/CHANGELOG.md

@@ -1 +1,6 @@
-## [62.158.2](https://github.com/Rebilly/rebilly/compare/rebilly-js-sdk-v62.158.1...rebilly-js-sdk-v62.158.2) (2026-08-11)
+## [62.159.0](https://github.com/Rebilly/rebilly/compare/rebilly-js-sdk-v62.158.3...rebilly-js-sdk-v62.159.0) (2026-08-14)
+
+
+### Features
+
+* **api-metadata, rebilly-js-sdk:** Update resources based on latest api definitions ([#24648](https://github.com/Rebilly/rebilly/issues/24648)) ([826a075](https://github.com/Rebilly/rebilly/commit/826a07539b844fcddd822a4c843575532a3e9c35))

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

@@ -3137,7 +3137,10 @@ export interface corePaths {
   "/invoices/{id}": {
     /** Retrieves an invoice with a specified ID. */
     get: operations["GetInvoice"];
-    /** Creates or updates (upserts) an invoice with a specified ID. */
+    /**
+     * Creates or updates (upserts) an invoice with a specified ID.
+     * Returns a conflict error if the specified ID belongs to an upcoming invoice.
+     */
     put: operations["PutInvoice"];
     parameters: {
       path: {
@@ -13396,6 +13399,13 @@ export interface coreComponents {
      * For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/).
      */
     Country: string;
+    /**
+     * ISO 3166 alpha-2 country code where the payment is processed.
+     * This is often the location for settling the payment.
+     * Consult with your Payment Service Provider (PSP) to determine the
+     * appropriate country code.
+     */
+    DigitalWalletCountry: coreComponents["schemas"]["Country"];
     ApplePayFeature: {
       /** Name of the feature. */
       name?: "Apple Pay";
@@ -13405,7 +13415,7 @@ export interface coreComponents {
        * Do not localize the name.
        */
       displayName?: string;
-      country?: coreComponents["schemas"]["Country"];
+      country?: coreComponents["schemas"]["DigitalWalletCountry"];
     };
     GooglePayFeature: {
       /** Name of the feature. */
@@ -13417,7 +13427,7 @@ export interface coreComponents {
        * The fully qualified domain name.
        */
       merchantOrigin?: string;
-      country?: coreComponents["schemas"]["Country"];
+      country?: coreComponents["schemas"]["DigitalWalletCountry"];
     };
     SamsungPayFeature: {
       /** Name of the feature. */
@@ -18404,6 +18414,14 @@ export interface coreComponents {
         | "covered-payout"
         | "approved-payment"
         | "none";
+      /**
+       * Payout limits for the gateway account applied during payout request auto-allocation.
+       * These limits do not apply to manual allocations.
+       *
+       * This field is distinct from deposit and sale
+       * [volume limits](https://www.rebilly.com/catalog/all/gateway-accounts/getgatewayaccountlimitcollection/).
+       */
+      payoutLimits?: coreComponents["schemas"]["GatewayAccountPayoutLimits"] | null;
       /**
        * Email address template used in place of a customer's real email address when sending transaction data to a processor.
        * Use `{{customerId}}` as a placeholder for the customer's ID.
@@ -21801,6 +21819,8 @@ export interface coreComponents {
         merchantId: string;
         /** API key for Viva basic authentication. */
         apiKey: string;
+        /** Key of the Viva IPN validation. */
+        ipnKey: string;
       };
       /** Viva settings object. */
       settings?: {
@@ -22100,7 +22120,7 @@ export interface coreComponents {
          * Do not localize this name.
          */
         displayName?: string | null;
-        country?: coreComponents["schemas"]["Country"];
+        country?: coreComponents["schemas"]["DigitalWalletCountry"];
       };
       /**
        * Google Pay™ digital wallet configuration. If not using Google Pay™,
@@ -22116,9 +22136,40 @@ export interface coreComponents {
          * This uses the fully qualified domain name.
          */
         merchantOrigin?: string | null;
-        country?: coreComponents["schemas"]["Country"];
+        country?: coreComponents["schemas"]["DigitalWalletCountry"];
       };
     };
+    /**
+     * Payout method limits for payout request auto-allocation.
+     * Limits apply to auto-allocation only.
+     * Manual allocations are uncapped.
+     */
+    GatewayAccountPayoutLimits: {
+      /**
+       * Maximum amount limit for single allocation.
+       * At most one entry per each currency that this gateway account supports.
+       */
+      maxPerTransaction?:
+        | {
+            /** Limit amount. */
+            amount: number;
+            currency: coreComponents["schemas"]["CurrencyCode"];
+          }[]
+        | null;
+      /**
+       * Maximum amount limit for a rolling period.
+       * At most one entry per each currency that this gateway account supports.
+       */
+      maxPerPeriod?:
+        | {
+            /** Limit amount. */
+            amount: number;
+            currency: coreComponents["schemas"]["CurrencyCode"];
+            /** Rolling period for the amount limit. */
+            period: "24-hours";
+          }[]
+        | null;
+    };
     ValidationErrorExtensions: {
       /** Invalid field details. */
       invalidFields?: {
@@ -22503,6 +22554,21 @@ export interface coreComponents {
           /** List of email addresses to send notifications to. */
           notificationEmailAddresses?: string[];
         };
+        /**
+         * Settings for annual compliance screening of all active customers.
+         * When enabled, a compliance screening report is generated for every active customer
+         * on the configured month and day each year.
+         */
+        annualComplianceScreening?: {
+          /** Specifies whether annual compliance screening is enabled for the organization. */
+          enabled?: boolean;
+          /**
+           * Month and day when annual compliance screening runs, in `MM-DD` format.
+           * Required when `enabled` is `true`.
+           * Valid calendar date only. Leap day `02-29` is not allowed.
+           */
+          monthDay?: string | null;
+        };
         /**
          * Default order for auto-allocation of payout requests.
          * When set, this value is used when a payout request batch does not specify its own allocation order.
@@ -25062,17 +25128,36 @@ export interface coreComponents {
     TimeSeriesTransaction: {
       /** Time series data. */
       data?: {
-        /** Date in `YYYY-MM-DD` format . */
+        /** Date in `YYYY-MM-DD` format. */
         date?: string;
-        /** Total number of all transactions within the aggregation. */
+        /**
+         * Aggregated value for all transactions for the day, in the unit specified by the `type` parameter:
+         *   - `count`: Total number of transactions.
+         *   - `amount`: Total amount of approved transactions in the merchant reporting currency.
+         *   - `approval-rate`: Ratio of approved transactions to all transactions.
+         *   - `incomplete-rate`: Ratio of incomplete transactions to all transactions.
+         *
+         * This value does not depend on the `subaggregate` parameter and is not the sum of the values in `subaggregates`.
+         * Each transaction is included once, even if the `subaggregate` field contains multiple values for the transaction.
+         * Transactions with no value for the `subaggregate` field are also included.
+         */
         total?: number;
-        /** Subaggregates that have transactions within the range. */
+        /**
+         * Breakdown by the `subaggregate` field for the day.
+         * Each element contains one `subaggregate` value and its aggregated value.
+         * Each `subaggregate` value found in the report has an element,
+         * in the same order for each day.
+         */
         subaggregates?: {
-          /** ID of the subaggregate. */
+          /** One value of the `subaggregate` field, such as a website ID, a currency code, or a lead source. */
           subaggregate?: string;
-          /** Total number of all subaggregate transactions within the aggregation. */
+          /**
+           * Aggregated value for transactions that have this `subaggregate` value,
+           * in the same unit as `total`.
+           * This value is `0` if no transactions have this `subaggregate` value.
+           */
           value?: number;
-        };
+        }[];
       }[];
     };
     ReportDisputeDelays: {
@@ -30199,6 +30284,18 @@ export interface coreComponents {
            * This value is `null` if the export failed.
            */
           fileId?: string | null;
+          /**
+           * Total number of records in the export, excluding the header row.
+           * This value is `0` if the export failed.
+           */
+          recordCount?: number;
+          /**
+           * Status of the data export.
+           * This webhook is sent only when the data export reaches a terminal status.
+           * This value is never `pending`, `queued`, or `processing`.
+           */
+          status?: "completed" | "failed";
+          failureReason?: coreComponents["schemas"]["DataExportFailureReason"];
           /** Type of event that triggered the webhook. */
           eventType?: "data-export-completed" | "data-export-failed";
           /** Embedded objects related to the data export event. */
@@ -32799,7 +32896,10 @@ export interface operations {
       404: coreComponents["responses"]["NotFound"];
     };
   };
-  /** Creates or updates (upserts) an invoice with a specified ID. */
+  /**
+   * Creates or updates (upserts) an invoice with a specified ID.
+   * Returns a conflict error if the specified ID belongs to an upcoming invoice.
+   */
   PutInvoice: {
     parameters: {
       path: {
@@ -32825,6 +32925,7 @@ export interface operations {
       401: coreComponents["responses"]["Unauthorized"];
       403: coreComponents["responses"]["Forbidden"];
       404: coreComponents["responses"]["NotFound"];
+      409: coreComponents["responses"]["Conflict"];
       422: coreComponents["responses"]["ValidationError"];
       429: coreComponents["responses"]["TooManyRequests"];
     };
@@ -52434,6 +52535,13 @@ export interface storefrontComponents {
      * For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/).
      */
     Country: string;
+    /**
+     * ISO 3166 alpha-2 country code where the payment is processed.
+     * This is often the location for settling the payment.
+     * Consult with your Payment Service Provider (PSP) to determine the
+     * appropriate country code.
+     */
+    DigitalWalletCountry: storefrontComponents["schemas"]["Country"];
     ApplePayFeature: {
       /** Name of the feature. */
       name?: "Apple Pay";
@@ -52443,7 +52551,7 @@ export interface storefrontComponents {
        * Do not localize the name.
        */
       displayName?: string;
-      country?: storefrontComponents["schemas"]["Country"];
+      country?: storefrontComponents["schemas"]["DigitalWalletCountry"];
     };
     GooglePayFeature: {
       /** Name of the feature. */
@@ -52455,7 +52563,7 @@ export interface storefrontComponents {
        * The fully qualified domain name.
        */
       merchantOrigin?: string;
-      country?: storefrontComponents["schemas"]["Country"];
+      country?: storefrontComponents["schemas"]["DigitalWalletCountry"];
     };
     SamsungPayFeature: {
       /** Name of the feature. */
@@ -57442,6 +57550,14 @@ export interface storefrontComponents {
         | "covered-payout"
         | "approved-payment"
         | "none";
+      /**
+       * Payout limits for the gateway account applied during payout request auto-allocation.
+       * These limits do not apply to manual allocations.
+       *
+       * This field is distinct from deposit and sale
+       * [volume limits](https://www.rebilly.com/catalog/all/gateway-accounts/getgatewayaccountlimitcollection/).
+       */
+      payoutLimits?: storefrontComponents["schemas"]["GatewayAccountPayoutLimits"] | null;
       /**
        * Email address template used in place of a customer's real email address when sending transaction data to a processor.
        * Use `{{customerId}}` as a placeholder for the customer's ID.
@@ -60839,6 +60955,8 @@ export interface storefrontComponents {
         merchantId: string;
         /** API key for Viva basic authentication. */
         apiKey: string;
+        /** Key of the Viva IPN validation. */
+        ipnKey: string;
       };
       /** Viva settings object. */
       settings?: {
@@ -61138,7 +61256,7 @@ export interface storefrontComponents {
          * Do not localize this name.
          */
         displayName?: string | null;
-        country?: storefrontComponents["schemas"]["Country"];
+        country?: storefrontComponents["schemas"]["DigitalWalletCountry"];
       };
       /**
        * Google Pay™ digital wallet configuration. If not using Google Pay™,
@@ -61154,9 +61272,40 @@ export interface storefrontComponents {
          * This uses the fully qualified domain name.
          */
         merchantOrigin?: string | null;
-        country?: storefrontComponents["schemas"]["Country"];
+        country?: storefrontComponents["schemas"]["DigitalWalletCountry"];
       };
     };
+    /**
+     * Payout method limits for payout request auto-allocation.
+     * Limits apply to auto-allocation only.
+     * Manual allocations are uncapped.
+     */
+    GatewayAccountPayoutLimits: {
+      /**
+       * Maximum amount limit for single allocation.
+       * At most one entry per each currency that this gateway account supports.
+       */
+      maxPerTransaction?:
+        | {
+            /** Limit amount. */
+            amount: number;
+            currency: storefrontComponents["schemas"]["CurrencyCode"];
+          }[]
+        | null;
+      /**
+       * Maximum amount limit for a rolling period.
+       * At most one entry per each currency that this gateway account supports.
+       */
+      maxPerPeriod?:
+        | {
+            /** Limit amount. */
+            amount: number;
+            currency: storefrontComponents["schemas"]["CurrencyCode"];
+            /** Rolling period for the amount limit. */
+            period: "24-hours";
+          }[]
+        | null;
+    };
     ValidationErrorExtensions: {
       /** Invalid field details. */
       invalidFields?: {
@@ -61541,6 +61690,21 @@ export interface storefrontComponents {
           /** List of email addresses to send notifications to. */
           notificationEmailAddresses?: string[];
         };
+        /**
+         * Settings for annual compliance screening of all active customers.
+         * When enabled, a compliance screening report is generated for every active customer
+         * on the configured month and day each year.
+         */
+        annualComplianceScreening?: {
+          /** Specifies whether annual compliance screening is enabled for the organization. */
+          enabled?: boolean;
+          /**
+           * Month and day when annual compliance screening runs, in `MM-DD` format.
+           * Required when `enabled` is `true`.
+           * Valid calendar date only. Leap day `02-29` is not allowed.
+           */
+          monthDay?: string | null;
+        };
         /**
          * Default order for auto-allocation of payout requests.
          * When set, this value is used when a payout request batch does not specify its own allocation order.
@@ -64100,17 +64264,36 @@ export interface storefrontComponents {
     TimeSeriesTransaction: {
       /** Time series data. */
       data?: {
-        /** Date in `YYYY-MM-DD` format . */
+        /** Date in `YYYY-MM-DD` format. */
         date?: string;
-        /** Total number of all transactions within the aggregation. */
+        /**
+         * Aggregated value for all transactions for the day, in the unit specified by the `type` parameter:
+         *   - `count`: Total number of transactions.
+         *   - `amount`: Total amount of approved transactions in the merchant reporting currency.
+         *   - `approval-rate`: Ratio of approved transactions to all transactions.
+         *   - `incomplete-rate`: Ratio of incomplete transactions to all transactions.
+         *
+         * This value does not depend on the `subaggregate` parameter and is not the sum of the values in `subaggregates`.
+         * Each transaction is included once, even if the `subaggregate` field contains multiple values for the transaction.
+         * Transactions with no value for the `subaggregate` field are also included.
+         */
         total?: number;
-        /** Subaggregates that have transactions within the range. */
+        /**
+         * Breakdown by the `subaggregate` field for the day.
+         * Each element contains one `subaggregate` value and its aggregated value.
+         * Each `subaggregate` value found in the report has an element,
+         * in the same order for each day.
+         */
         subaggregates?: {
-          /** ID of the subaggregate. */
+          /** One value of the `subaggregate` field, such as a website ID, a currency code, or a lead source. */
           subaggregate?: string;
-          /** Total number of all subaggregate transactions within the aggregation. */
+          /**
+           * Aggregated value for transactions that have this `subaggregate` value,
+           * in the same unit as `total`.
+           * This value is `0` if no transactions have this `subaggregate` value.
+           */
           value?: number;
-        };
+        }[];
       }[];
     };
     ReportDisputeDelays: {
@@ -69237,6 +69420,18 @@ export interface storefrontComponents {
            * This value is `null` if the export failed.
            */
           fileId?: string | null;
+          /**
+           * Total number of records in the export, excluding the header row.
+           * This value is `0` if the export failed.
+           */
+          recordCount?: number;
+          /**
+           * Status of the data export.
+           * This webhook is sent only when the data export reaches a terminal status.
+           * This value is never `pending`, `queued`, or `processing`.
+           */
+          status?: "completed" | "failed";
+          failureReason?: storefrontComponents["schemas"]["DataExportFailureReason"];
           /** Type of event that triggered the webhook. */
           eventType?: "data-export-completed" | "data-export-failed";
           /** Embedded objects related to the data export event. */
@@ -71297,7 +71492,12 @@ export interface reportsPaths {
     get: operations["GetTaxReport"];
   };
   "/reports/time-series-transaction": {
-    /** Retrieves a transactions report that is aggregated by time periods. */
+    /**
+     * Retrieves a report of sale and capture transactions, with one row for each day of the period.
+     * Each row holds an aggregation of every transaction of the day,
+     * and a breakdown of that day by the `subaggregate` field.
+     * Transactions occur on the day of the `processedTime` value.
+     */
     get: operations["GetTimeSeriesTransactionReport"];
   };
   "/reports/transactions-time-dispute": {
@@ -78724,6 +78924,13 @@ export interface reportsComponents {
      * For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/).
      */
     Country: string;
+    /**
+     * ISO 3166 alpha-2 country code where the payment is processed.
+     * This is often the location for settling the payment.
+     * Consult with your Payment Service Provider (PSP) to determine the
+     * appropriate country code.
+     */
+    DigitalWalletCountry: reportsComponents["schemas"]["Country"];
     ApplePayFeature: {
       /** Name of the feature. */
       name?: "Apple Pay";
@@ -78733,7 +78940,7 @@ export interface reportsComponents {
        * Do not localize the name.
        */
       displayName?: string;
-      country?: reportsComponents["schemas"]["Country"];
+      country?: reportsComponents["schemas"]["DigitalWalletCountry"];
     };
     GooglePayFeature: {
       /** Name of the feature. */
@@ -78745,7 +78952,7 @@ export interface reportsComponents {
        * The fully qualified domain name.
        */
       merchantOrigin?: string;
-      country?: reportsComponents["schemas"]["Country"];
+      country?: reportsComponents["schemas"]["DigitalWalletCountry"];
     };
     SamsungPayFeature: {
       /** Name of the feature. */
@@ -83732,6 +83939,14 @@ export interface reportsComponents {
         | "covered-payout"
         | "approved-payment"
         | "none";
+      /**
+       * Payout limits for the gateway account applied during payout request auto-allocation.
+       * These limits do not apply to manual allocations.
+       *
+       * This field is distinct from deposit and sale
+       * [volume limits](https://www.rebilly.com/catalog/all/gateway-accounts/getgatewayaccountlimitcollection/).
+       */
+      payoutLimits?: reportsComponents["schemas"]["GatewayAccountPayoutLimits"] | null;
       /**
        * Email address template used in place of a customer's real email address when sending transaction data to a processor.
        * Use `{{customerId}}` as a placeholder for the customer's ID.
@@ -87129,6 +87344,8 @@ export interface reportsComponents {
         merchantId: string;
         /** API key for Viva basic authentication. */
         apiKey: string;
+        /** Key of the Viva IPN validation. */
+        ipnKey: string;
       };
       /** Viva settings object. */
       settings?: {
@@ -87428,7 +87645,7 @@ export interface reportsComponents {
          * Do not localize this name.
          */
         displayName?: string | null;
-        country?: reportsComponents["schemas"]["Country"];
+        country?: reportsComponents["schemas"]["DigitalWalletCountry"];
       };
       /**
        * Google Pay™ digital wallet configuration. If not using Google Pay™,
@@ -87444,9 +87661,40 @@ export interface reportsComponents {
          * This uses the fully qualified domain name.
          */
         merchantOrigin?: string | null;
-        country?: reportsComponents["schemas"]["Country"];
+        country?: reportsComponents["schemas"]["DigitalWalletCountry"];
       };
     };
+    /**
+     * Payout method limits for payout request auto-allocation.
+     * Limits apply to auto-allocation only.
+     * Manual allocations are uncapped.
+     */
+    GatewayAccountPayoutLimits: {
+      /**
+       * Maximum amount limit for single allocation.
+       * At most one entry per each currency that this gateway account supports.
+       */
+      maxPerTransaction?:
+        | {
+            /** Limit amount. */
+            amount: number;
+            currency: reportsComponents["schemas"]["CurrencyCode"];
+          }[]
+        | null;
+      /**
+       * Maximum amount limit for a rolling period.
+       * At most one entry per each currency that this gateway account supports.
+       */
+      maxPerPeriod?:
+        | {
+            /** Limit amount. */
+            amount: number;
+            currency: reportsComponents["schemas"]["CurrencyCode"];
+            /** Rolling period for the amount limit. */
+            period: "24-hours";
+          }[]
+        | null;
+    };
     ValidationErrorExtensions: {
       /** Invalid field details. */
       invalidFields?: {
@@ -87831,6 +88079,21 @@ export interface reportsComponents {
           /** List of email addresses to send notifications to. */
           notificationEmailAddresses?: string[];
         };
+        /**
+         * Settings for annual compliance screening of all active customers.
+         * When enabled, a compliance screening report is generated for every active customer
+         * on the configured month and day each year.
+         */
+        annualComplianceScreening?: {
+          /** Specifies whether annual compliance screening is enabled for the organization. */
+          enabled?: boolean;
+          /**
+           * Month and day when annual compliance screening runs, in `MM-DD` format.
+           * Required when `enabled` is `true`.
+           * Valid calendar date only. Leap day `02-29` is not allowed.
+           */
+          monthDay?: string | null;
+        };
         /**
          * Default order for auto-allocation of payout requests.
          * When set, this value is used when a payout request batch does not specify its own allocation order.
@@ -90390,17 +90653,36 @@ export interface reportsComponents {
     TimeSeriesTransaction: {
       /** Time series data. */
       data?: {
-        /** Date in `YYYY-MM-DD` format . */
+        /** Date in `YYYY-MM-DD` format. */
         date?: string;
-        /** Total number of all transactions within the aggregation. */
+        /**
+         * Aggregated value for all transactions for the day, in the unit specified by the `type` parameter:
+         *   - `count`: Total number of transactions.
+         *   - `amount`: Total amount of approved transactions in the merchant reporting currency.
+         *   - `approval-rate`: Ratio of approved transactions to all transactions.
+         *   - `incomplete-rate`: Ratio of incomplete transactions to all transactions.
+         *
+         * This value does not depend on the `subaggregate` parameter and is not the sum of the values in `subaggregates`.
+         * Each transaction is included once, even if the `subaggregate` field contains multiple values for the transaction.
+         * Transactions with no value for the `subaggregate` field are also included.
+         */
         total?: number;
-        /** Subaggregates that have transactions within the range. */
+        /**
+         * Breakdown by the `subaggregate` field for the day.
+         * Each element contains one `subaggregate` value and its aggregated value.
+         * Each `subaggregate` value found in the report has an element,
+         * in the same order for each day.
+         */
         subaggregates?: {
-          /** ID of the subaggregate. */
+          /** One value of the `subaggregate` field, such as a website ID, a currency code, or a lead source. */
           subaggregate?: string;
-          /** Total number of all subaggregate transactions within the aggregation. */
+          /**
+           * Aggregated value for transactions that have this `subaggregate` value,
+           * in the same unit as `total`.
+           * This value is `0` if no transactions have this `subaggregate` value.
+           */
           value?: number;
-        };
+        }[];
       }[];
     };
     ReportDisputeDelays: {
@@ -95527,6 +95809,18 @@ export interface reportsComponents {
            * This value is `null` if the export failed.
            */
           fileId?: string | null;
+          /**
+           * Total number of records in the export, excluding the header row.
+           * This value is `0` if the export failed.
+           */
+          recordCount?: number;
+          /**
+           * Status of the data export.
+           * This webhook is sent only when the data export reaches a terminal status.
+           * This value is never `pending`, `queued`, or `processing`.
+           */
+          status?: "completed" | "failed";
+          failureReason?: reportsComponents["schemas"]["DataExportFailureReason"];
           /** Type of event that triggered the webhook. */
           eventType?: "data-export-completed" | "data-export-failed";
           /** Embedded objects related to the data export event. */
@@ -97098,13 +97392,18 @@ export interface operations {
       403: reportsComponents["responses"]["Forbidden"];
     };
   };
-  /** Retrieves a transactions report that is aggregated by time periods. */
+  /**
+   * Retrieves a report of sale and capture transactions, with one row for each day of the period.
+   * Each row holds an aggregation of every transaction of the day,
+   * and a breakdown of that day by the `subaggregate` field.
+   * Transactions occur on the day of the `processedTime` value.
+   */
   GetTimeSeriesTransactionReport: {
     parameters: {
       query: {
-        /** Type of report aggregation. */
+        /** Aggregate the transactions of each day by count, sum of amounts, approval rate, or incomplete rate. */
         type?: "count" | "amount" | "approval-rate" | "incomplete-rate";
-        /** Report subaggregate. */
+        /** Group the transactions of each day by this field, one subaggregate for each value. */
         subaggregate?:
           | "website"
           | "gateway-account"