kalshi-typescript 3.7.0 → 3.9.0

package/api/order-groups-api.ts

@@ -4,7 +4,7 @@
  * Kalshi Trade API Manual Endpoints
  * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
  *
- * The version of the OpenAPI document: 3.7.0
+ * The version of the OpenAPI document: 3.9.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -90,7 +90,7 @@ export const OrderGroupsApiAxiosParamCreator = function (configuration?: Configu
          *  Deletes an order group and cancels all orders within it. This permanently removes the group.
          * @summary Delete Order Group
          * @param {string} orderGroupId Order group ID
-         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -138,7 +138,7 @@ export const OrderGroupsApiAxiosParamCreator = function (configuration?: Configu
          *  Retrieves details for a single order group including all order IDs and auto-cancel status.
          * @summary Get Order Group
          * @param {string} orderGroupId Order group ID
-         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -185,7 +185,7 @@ export const OrderGroupsApiAxiosParamCreator = function (configuration?: Configu
         /**
          *  Retrieves all order groups for the authenticated user.
          * @summary Get Order Groups
-         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -230,7 +230,7 @@ export const OrderGroupsApiAxiosParamCreator = function (configuration?: Configu
          *  Resets the order group\'s matched contracts counter to zero, allowing new orders to be placed again after the limit was hit.
          * @summary Reset Order Group
          * @param {string} orderGroupId Order group ID
-         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
          * @param {object} [body] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -282,7 +282,7 @@ export const OrderGroupsApiAxiosParamCreator = function (configuration?: Configu
          *  Triggers the order group, canceling all orders in the group and preventing new orders until the group is reset.
          * @summary Trigger Order Group
          * @param {string} orderGroupId Order group ID
-         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
          * @param {object} [body] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -405,7 +405,7 @@ export const OrderGroupsApiFp = function(configuration?: Configuration) {
          *  Deletes an order group and cancels all orders within it. This permanently removes the group.
          * @summary Delete Order Group
          * @param {string} orderGroupId Order group ID
-         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -419,7 +419,7 @@ export const OrderGroupsApiFp = function(configuration?: Configuration) {
          *  Retrieves details for a single order group including all order IDs and auto-cancel status.
          * @summary Get Order Group
          * @param {string} orderGroupId Order group ID
-         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -432,7 +432,7 @@ export const OrderGroupsApiFp = function(configuration?: Configuration) {
         /**
          *  Retrieves all order groups for the authenticated user.
          * @summary Get Order Groups
-         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -446,7 +446,7 @@ export const OrderGroupsApiFp = function(configuration?: Configuration) {
          *  Resets the order group\'s matched contracts counter to zero, allowing new orders to be placed again after the limit was hit.
          * @summary Reset Order Group
          * @param {string} orderGroupId Order group ID
-         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
          * @param {object} [body] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -461,7 +461,7 @@ export const OrderGroupsApiFp = function(configuration?: Configuration) {
          *  Triggers the order group, canceling all orders in the group and preventing new orders until the group is reset.
          * @summary Trigger Order Group
          * @param {string} orderGroupId Order group ID
-         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
          * @param {object} [body] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -509,7 +509,7 @@ export const OrderGroupsApiFactory = function (configuration?: Configuration, ba
          *  Deletes an order group and cancels all orders within it. This permanently removes the group.
          * @summary Delete Order Group
          * @param {string} orderGroupId Order group ID
-         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -520,7 +520,7 @@ export const OrderGroupsApiFactory = function (configuration?: Configuration, ba
          *  Retrieves details for a single order group including all order IDs and auto-cancel status.
          * @summary Get Order Group
          * @param {string} orderGroupId Order group ID
-         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -530,7 +530,7 @@ export const OrderGroupsApiFactory = function (configuration?: Configuration, ba
         /**
          *  Retrieves all order groups for the authenticated user.
          * @summary Get Order Groups
-         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -541,7 +541,7 @@ export const OrderGroupsApiFactory = function (configuration?: Configuration, ba
          *  Resets the order group\'s matched contracts counter to zero, allowing new orders to be placed again after the limit was hit.
          * @summary Reset Order Group
          * @param {string} orderGroupId Order group ID
-         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
          * @param {object} [body] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -553,7 +553,7 @@ export const OrderGroupsApiFactory = function (configuration?: Configuration, ba
          *  Triggers the order group, canceling all orders in the group and preventing new orders until the group is reset.
          * @summary Trigger Order Group
          * @param {string} orderGroupId Order group ID
-         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
          * @param {object} [body] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -594,7 +594,7 @@ export class OrderGroupsApi extends BaseAPI {
      *  Deletes an order group and cancels all orders within it. This permanently removes the group.
      * @summary Delete Order Group
      * @param {string} orderGroupId Order group ID
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -606,7 +606,7 @@ export class OrderGroupsApi extends BaseAPI {
      *  Retrieves details for a single order group including all order IDs and auto-cancel status.
      * @summary Get Order Group
      * @param {string} orderGroupId Order group ID
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -617,7 +617,7 @@ export class OrderGroupsApi extends BaseAPI {
     /**
      *  Retrieves all order groups for the authenticated user.
      * @summary Get Order Groups
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -629,7 +629,7 @@ export class OrderGroupsApi extends BaseAPI {
      *  Resets the order group\'s matched contracts counter to zero, allowing new orders to be placed again after the limit was hit.
      * @summary Reset Order Group
      * @param {string} orderGroupId Order group ID
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
      * @param {object} [body] 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -642,7 +642,7 @@ export class OrderGroupsApi extends BaseAPI {
      *  Triggers the order group, canceling all orders in the group and preventing new orders until the group is reset.
      * @summary Trigger Order Group
      * @param {string} orderGroupId Order group ID
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
      * @param {object} [body] 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

package/api/orders-api.ts

@@ -4,7 +4,7 @@
  * Kalshi Trade API Manual Endpoints
  * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
  *
- * The version of the OpenAPI document: 3.7.0
+ * The version of the OpenAPI document: 3.9.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -204,7 +204,7 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
          *  Endpoint for canceling orders. The value for the orderId should match the id field of the order you want to decrease. Commonly, DELETE-type endpoints return 204 status with no body content on success. But we can\'t completely delete the order, as it may be partially filled already. Instead, the DeleteOrder endpoint reduce the order completely, essentially zeroing the remaining resting contracts on it. The zeroed order is returned on the response payload as a form of validation for the client.
          * @summary Cancel Order
          * @param {string} orderId Order ID
-         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -433,7 +433,7 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
          * @summary Get Queue Positions for Orders
          * @param {string} [marketTickers] Comma-separated list of market tickers to filter by
          * @param {string} [eventTicker] Event ticker to filter by
-         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -483,16 +483,16 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
             };
         },
         /**
-         * Restricts the response to orders that have a certain status: resting, canceled, or executed.
+         * Restricts the response to orders that have a certain status: resting, canceled, or executed. Orders that have been canceled or fully executed before the historical cutoff are only available via `GET /historical/orders`. Resting orders will always be available through this endpoint. See [Historical Data](https://kalshi.com/docs/getting_started/historical_data) for details. 
          * @summary Get Orders
          * @param {string} [ticker] Filter by market ticker
-         * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
+         * @param {string} [eventTicker] Event tickers to filter by, as a comma-separated list (maximum 10).
          * @param {number} [minTs] Filter items after this Unix timestamp
          * @param {number} [maxTs] Filter items before this Unix timestamp
          * @param {string} [status] Filter by status. Possible values depend on the endpoint.
          * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
          * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
-         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -614,7 +614,7 @@ export const OrdersApiFp = function(configuration?: Configuration) {
          *  Endpoint for canceling orders. The value for the orderId should match the id field of the order you want to decrease. Commonly, DELETE-type endpoints return 204 status with no body content on success. But we can\'t completely delete the order, as it may be partially filled already. Instead, the DeleteOrder endpoint reduce the order completely, essentially zeroing the remaining resting contracts on it. The zeroed order is returned on the response payload as a form of validation for the client.
          * @summary Cancel Order
          * @param {string} orderId Order ID
-         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -682,7 +682,7 @@ export const OrdersApiFp = function(configuration?: Configuration) {
          * @summary Get Queue Positions for Orders
          * @param {string} [marketTickers] Comma-separated list of market tickers to filter by
          * @param {string} [eventTicker] Event ticker to filter by
-         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -693,16 +693,16 @@ export const OrdersApiFp = function(configuration?: Configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Restricts the response to orders that have a certain status: resting, canceled, or executed.
+         * Restricts the response to orders that have a certain status: resting, canceled, or executed. Orders that have been canceled or fully executed before the historical cutoff are only available via `GET /historical/orders`. Resting orders will always be available through this endpoint. See [Historical Data](https://kalshi.com/docs/getting_started/historical_data) for details. 
          * @summary Get Orders
          * @param {string} [ticker] Filter by market ticker
-         * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
+         * @param {string} [eventTicker] Event tickers to filter by, as a comma-separated list (maximum 10).
          * @param {number} [minTs] Filter items after this Unix timestamp
          * @param {number} [maxTs] Filter items before this Unix timestamp
          * @param {string} [status] Filter by status. Possible values depend on the endpoint.
          * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
          * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
-         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -756,7 +756,7 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
          *  Endpoint for canceling orders. The value for the orderId should match the id field of the order you want to decrease. Commonly, DELETE-type endpoints return 204 status with no body content on success. But we can\'t completely delete the order, as it may be partially filled already. Instead, the DeleteOrder endpoint reduce the order completely, essentially zeroing the remaining resting contracts on it. The zeroed order is returned on the response payload as a form of validation for the client.
          * @summary Cancel Order
          * @param {string} orderId Order ID
-         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -809,7 +809,7 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
          * @summary Get Queue Positions for Orders
          * @param {string} [marketTickers] Comma-separated list of market tickers to filter by
          * @param {string} [eventTicker] Event ticker to filter by
-         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -817,16 +817,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
             return localVarFp.getOrderQueuePositions(marketTickers, eventTicker, subaccount, options).then((request) => request(axios, basePath));
         },
         /**
-         * Restricts the response to orders that have a certain status: resting, canceled, or executed.
+         * Restricts the response to orders that have a certain status: resting, canceled, or executed. Orders that have been canceled or fully executed before the historical cutoff are only available via `GET /historical/orders`. Resting orders will always be available through this endpoint. See [Historical Data](https://kalshi.com/docs/getting_started/historical_data) for details. 
          * @summary Get Orders
          * @param {string} [ticker] Filter by market ticker
-         * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
+         * @param {string} [eventTicker] Event tickers to filter by, as a comma-separated list (maximum 10).
          * @param {number} [minTs] Filter items after this Unix timestamp
          * @param {number} [maxTs] Filter items before this Unix timestamp
          * @param {string} [status] Filter by status. Possible values depend on the endpoint.
          * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
          * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
-         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+         * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -878,7 +878,7 @@ export class OrdersApi extends BaseAPI {
      *  Endpoint for canceling orders. The value for the orderId should match the id field of the order you want to decrease. Commonly, DELETE-type endpoints return 204 status with no body content on success. But we can\'t completely delete the order, as it may be partially filled already. Instead, the DeleteOrder endpoint reduce the order completely, essentially zeroing the remaining resting contracts on it. The zeroed order is returned on the response payload as a form of validation for the client.
      * @summary Cancel Order
      * @param {string} orderId Order ID
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -936,7 +936,7 @@ export class OrdersApi extends BaseAPI {
      * @summary Get Queue Positions for Orders
      * @param {string} [marketTickers] Comma-separated list of market tickers to filter by
      * @param {string} [eventTicker] Event ticker to filter by
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). Defaults to 0.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -945,16 +945,16 @@ export class OrdersApi extends BaseAPI {
     }
 
     /**
-     * Restricts the response to orders that have a certain status: resting, canceled, or executed.
+     * Restricts the response to orders that have a certain status: resting, canceled, or executed. Orders that have been canceled or fully executed before the historical cutoff are only available via `GET /historical/orders`. Resting orders will always be available through this endpoint. See [Historical Data](https://kalshi.com/docs/getting_started/historical_data) for details. 
      * @summary Get Orders
      * @param {string} [ticker] Filter by market ticker
-     * @param {string} [eventTicker] Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).
+     * @param {string} [eventTicker] Event tickers to filter by, as a comma-separated list (maximum 10).
      * @param {number} [minTs] Filter items after this Unix timestamp
      * @param {number} [maxTs] Filter items before this Unix timestamp
      * @param {string} [status] Filter by status. Possible values depend on the endpoint.
      * @param {number} [limit] Number of results per page. Defaults to 100. Maximum value is 200.
      * @param {string} [cursor] Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.
-     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, returns results across all subaccounts.
+     * @param {number} [subaccount] Subaccount number (0 for primary, 1-32 for subaccounts). If omitted, defaults to all subaccounts.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */