btrz-api-client 8.30.0 → 8.31.0

package/src/endpoints/inventory/insurances.js

@@ -3,8 +3,11 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
- * Query params for insurances endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryInsurancesQuery
+ * Query params for GET /insurances (btrz-api-inventory). See get-insurances getSpec().
+ * @typedef {Object} InsurancesListQuery
+ * @property {string} [productId] - Filter by product id
+ * @property {boolean} [enabled] - Filter by enabled
+ * @property {string[]} [providerIds] - Filter by provider ids
  */
 
 /**
@@ -21,7 +24,7 @@ function insurancesFactory({
    * GET /insurances - list insurances.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {InventoryInsurancesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {InsurancesListQuery} [opts.query] - Query params (productId, enabled, providerIds)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -37,7 +40,7 @@ function insurancesFactory({
   }
 
   /**
-   * GET /insurances/:insuranceId - get insurance by id.
+   * GET /insurances/:insuranceId - get insurance by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.insuranceId - Insurance id
@@ -55,7 +58,7 @@ function insurancesFactory({
   }
 
   /**
-   * POST /insurances - create insurance.
+   * POST /insurances - create insurance. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {Object} opts.insurance - Insurance payload
@@ -77,7 +80,7 @@ function insurancesFactory({
   }
 
   /**
-   * PUT /insurances/:insuranceId - update insurance.
+   * PUT /insurances/:insuranceId - update insurance. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {Object} opts.insurance - Insurance payload
@@ -100,7 +103,7 @@ function insurancesFactory({
   }
 
   /**
-   * DELETE /insurances/:insuranceId - remove insurance.
+   * DELETE /insurances/:insuranceId - remove insurance. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/src/endpoints/inventory/insurancesCost.js

@@ -3,8 +3,11 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
- * Query params for insurances cost endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryInsurancesCostQuery
+ * Query params for GET /insurances/:productId/cost (btrz-api-inventory). See GetInsuranceCostsHandler getSpec().
+ * Client merges opts.declaredValue into query.
+ * @typedef {Object} InsurancesCostQuery
+ * @property {*} declaredValue - Declared value (required by API; may be passed as opts.declaredValue)
+ * @property {string} [providerId] - Provider id
  */
 
 /**
@@ -18,12 +21,12 @@ function insurancesCostFactory({
   client, internalAuthTokenProvider
 }) {
   /**
-   * GET /insurances/:productId/cost - get insurance cost for product.
+   * GET /insurances/:productId/cost - get insurance cost for product. Client merges opts.declaredValue into query.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.productId - Product id
-   * @param {*} opts.declaredValue - Declared value (merged into query)
-   * @param {InventoryInsurancesCostQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {*} opts.declaredValue - Declared value (required; merged into query)
+   * @param {InsurancesCostQuery} [opts.query] - Additional query params (e.g. providerId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/inventory/items.js

@@ -2,6 +2,25 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /items (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} ItemsQuery
+ * @property {string} [productId] - The ids of the products to get products for
+ * @property {string} [associatedProductId] - The id of the associated products when used as an SSR
+ * @property {string} [disabled] - Filter by disabled: "true" | "false"
+ * @property {string} [type] - Filter by type: "paid_in" | "paid_out"
+ * @property {string} [providerIds] - The id of the provider to get products for
+ * @property {string} [filterToCurrentShiftLocation] - Filter items sellable in current location: "true" | "false". Requires JwtAuth
+ * @property {string} [channels] - Filter by channels (comma-separated, e.g. "backoffice,websales"). Requires JwtAuth
+ * @property {string} [currency] - The isocode of the selected currency
+ */
+
+/**
+ * Query params for GET /items/:itemId (btrz-api-inventory). See get-by-id-handler getSpec().
+ * @typedef {Object} ItemByIdQuery
+ * @property {string} [currency] - The isocode of the selected currency
+ */
+
 /**
  * Factory for items API (btrz-api-inventory).
  * @param {Object} deps
@@ -15,7 +34,7 @@ function itemsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} [opts.query] - Query params
+   * @param {ItemsQuery} [opts.query] - Query params (productId, disabled, type, providerIds, channels, currency, etc.)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -37,8 +56,8 @@ function itemsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.itemId - Item id
-   * @param {Object} [opts.query] - Query params
+   * @param {string} opts.itemId - Item id (ObjectId format)
+   * @param {ItemByIdQuery} [opts.query] - Query params (currency)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -95,7 +114,6 @@ function itemsFactory({client, internalAuthTokenProvider}) {
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.soldItemId - Sold item id
      * @param {string} opts.ticketId - Ticket id
-     * @param {Object} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */

package/src/endpoints/inventory/journey-prices.js

@@ -1,8 +1,37 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for journey-prices endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryJourneyPricesQuery
+ * Query params for GET /journey-prices (btrz-api-inventory). See get-journey-prices getSpec().
+ * @typedef {Object} JourneyPricesListQuery
+ * @property {string} providerIds - Provider IDs (required). Comma-separated for multiple
+ * @property {string} [versionIds] - Version IDs filter. Comma-separated
+ * @property {string} [productIds] - Product IDs filter. Comma-separated
+ * @property {string} [fareClassIds] - Fare class IDs. Comma-separated
+ * @property {string} [seatClassIds] - Seat class IDs. Comma-separated
+ * @property {string} [fareIds] - Fare IDs. Comma-separated
+ * @property {string} [brandIds] - Brand IDs. Comma-separated
+ * @property {string} [amenityGroupIds] - Amenity group IDs. Comma-separated
+ * @property {string} [operatingCompanyIds] - Operating company IDs. Comma-separated
+ * @property {string} [routeIds] - Route IDs. Comma-separated
+ * @property {string} [travelRoutesIds] - Travel route IDs. Comma-separated
+ * @property {string} [shiftLocationIds] - Shift location IDs. Comma-separated
+ * @property {string} [originIds] - Origin (departure) station IDs. Comma-separated
+ * @property {string} [destinationIds] - Destination (arrival) station IDs. Comma-separated
+ * @property {number} [price.min] - Min price filter
+ * @property {number} [price.max] - Max price filter
+ * @property {number} [regularPrice.min] - Min regular price filter
+ * @property {number} [regularPrice.max] - Max regular price filter
+ * @property {number} [returnPriceModifier.min] - Min return price modifier filter
+ * @property {number} [returnPriceModifier.max] - Max return price modifier filter
+ * @property {string} [currencies] - ISO 4217 codes. Comma-separated (e.g. USD,MXN)
+ * @property {string} [taxExempted] - Filter by tax exempted [true, false]
+ */
+
+/**
+ * Query params for GET /journey-prices/:id (btrz-api-inventory). See get-journey-price getSpec().
+ * @typedef {Object} JourneyPriceGetQuery
+ * @property {boolean} [outdated] - If true, return history of updates
+ * @property {string} [versionId] - Return only this versionId (object id)
  */
 
 /**
@@ -18,7 +47,7 @@ function journeyPricesFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InventoryJourneyPricesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {JourneyPricesListQuery} [opts.query] - Query params (providerIds required; see getSpec for full list)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -36,7 +65,7 @@ function journeyPricesFactory({client, internalAuthTokenProvider}) {
    * @param {string} opts.id - Journey price id
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InventoryJourneyPricesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {JourneyPriceGetQuery} [opts.query] - Query params (outdated, versionId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -49,7 +78,7 @@ function journeyPricesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /journey-prices/:id - delete journey price.
+   * DELETE /journey-prices/:id - delete journey price. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -66,7 +95,7 @@ function journeyPricesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /journey-prices - create journey price.
+   * POST /journey-prices - create journey price. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -84,7 +113,7 @@ function journeyPricesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PATCH /journey-prices/:journeyPriceId - update journey price.
+   * PATCH /journey-prices/:journeyPriceId - update journey price. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/src/endpoints/inventory/labels.js

@@ -1,8 +1,10 @@
 const {authorizationHeaders} = require("../endpoints_helpers.js");
 
 /**
+ * Query params for GET /labels (btrz-api-inventory). See get-handler getSpec().
  * @typedef {Object} LabelsQuery
- * @property {string} [providerId] - Provider account ID
+ * @property {string} [name] - The name of the label to search for; omit to return all
+ * @property {number} [page] - Page number; omit for first page
  */
 
 /**
@@ -18,7 +20,7 @@ function labelsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {LabelsQuery} [opts.query] - Query params
+   * @param {LabelsQuery} [opts.query] - Query params (name, page)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -30,12 +32,11 @@ function labelsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /labels/:labelId - get label by id.
+   * GET /labels/:labelId - get label by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.labelId - Label id
-   * @param {LabelsQuery} [opts.query] - Query params
+   * @param {string} opts.labelId - Label id (ObjectId format)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/inventory/marital-status.js

@@ -1,8 +1,9 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for marital-status endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryMaritalStatusQuery
+ * Query params for GET /marital-status (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} MaritalStatusListQuery
+ * @property {string} [providerIds] - Provider IDs to get marital status for
  */
 
 /**
@@ -18,7 +19,7 @@ function maritalStatusFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InventoryMaritalStatusQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {MaritalStatusListQuery} [opts.query] - Query params (providerIds)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -32,12 +33,11 @@ function maritalStatusFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /marital-status/:id - get marital status by id.
+   * GET /marital-status/:id - get marital status by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.id - Marital status id
-   * @param {InventoryMaritalStatusQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -51,13 +51,12 @@ function maritalStatusFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /marital-status/:id - update marital status.
+   * PUT /marital-status/:id - update marital status. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.id - Marital status id
    * @param {Object} opts.data - Request body
-   * @param {InventoryMaritalStatusQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -72,12 +71,11 @@ function maritalStatusFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /marital-status/:id - remove marital status.
+   * DELETE /marital-status/:id - remove marital status. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.id - Marital status id
-   * @param {InventoryMaritalStatusQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -91,12 +89,11 @@ function maritalStatusFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /marital-status - create marital status.
+   * POST /marital-status - create marital status. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {Object} opts.data - Request body
-   * @param {InventoryMaritalStatusQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/inventory/marketplace-modifiers.js

@@ -3,8 +3,17 @@ const {
 } = require("../endpoints_helpers.js");
 
 /**
- * Query params for marketplace-modifiers endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryMarketplaceModifiersQuery
+ * Query params for GET /marketplace-modifiers (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} MarketplaceModifiersListQuery
+ * @property {string} [externalField1] - Filter by externalField1
+ * @property {string} [externalField2] - Filter by externalField2
+ * @property {string} [externalField3] - Filter by externalField3
+ * @property {string} [createdBy] - Comma-separated user IDs (created by)
+ * @property {string} [updatedBy] - Comma-separated user IDs (updated by)
+ * @property {string} [earliestPurchaseDate] - ISO 8601 datetime (purchase on or after)
+ * @property {string} [latestPurchaseDate] - ISO 8601 datetime (purchase on or before)
+ * @property {string} [earliestTravelDate] - ISO 8601 datetime (trip depart on or after)
+ * @property {string} [latestTravelDate] - ISO 8601 datetime (trip depart on or before)
  */
 
 /**
@@ -19,7 +28,7 @@ function marketplaceModifierFactory({client, internalAuthTokenProvider}) {
    * GET /marketplace-modifiers - list marketplace modifiers.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {InventoryMarketplaceModifiersQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {MarketplaceModifiersListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -35,7 +44,7 @@ function marketplaceModifierFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /marketplace-modifiers/:marketplaceModifierId - get marketplace modifier by id.
+   * GET /marketplace-modifiers/:marketplaceModifierId - get marketplace modifier by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} opts.marketplaceModifierId - Marketplace modifier id
    * @param {string} [opts.token] - API key
@@ -49,7 +58,7 @@ function marketplaceModifierFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /marketplace-modifiers - create marketplace modifier.
+   * POST /marketplace-modifiers - create marketplace modifier. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.token] - API key
@@ -69,7 +78,7 @@ function marketplaceModifierFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /marketplace-modifiers/:marketplaceModifierId - remove marketplace modifier.
+   * DELETE /marketplace-modifiers/:marketplaceModifierId - remove marketplace modifier. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.marketplaceModifierId - Marketplace modifier id
@@ -86,7 +95,7 @@ function marketplaceModifierFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /marketplace-modifiers/:marketplaceModifierId - update marketplace modifier.
+   * PUT /marketplace-modifiers/:marketplaceModifierId - update marketplace modifier. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.token] - API key

package/src/endpoints/inventory/mit-terminal-settings.js

@@ -2,11 +2,6 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
-/**
- * @typedef {Object} MitTerminalSettingsQuery
- * @property {string} [providerId] - Provider account ID
- */
-
 /**
  * Factory for mit-terminals-settings API (btrz-api-inventory).
  * @param {Object} deps
@@ -16,11 +11,10 @@ const {
  */
 function mitTerminalFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /mit-terminals-settings - list MIT terminal settings.
+   * GET /mit-terminals-settings - list MIT terminal settings. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {MitTerminalSettingsQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -37,7 +31,7 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /mit-terminals-settings/:id - get MIT terminal setting by id.
+   * GET /mit-terminals-settings/:id - get MIT terminal setting by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -52,7 +46,7 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /mit-terminals-settings - create MIT terminal settings.
+   * POST /mit-terminals-settings - create MIT terminal settings. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -72,7 +66,7 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /mit-terminals-settings/:id - remove MIT terminal settings.
+   * DELETE /mit-terminals-settings/:id - remove MIT terminal settings. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -89,7 +83,7 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /mit-terminals-settings/:id - update MIT terminal settings.
+   * PUT /mit-terminals-settings/:id - update MIT terminal settings. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/src/endpoints/inventory/mit-terminals.js

@@ -2,11 +2,6 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
-/**
- * @typedef {Object} MitTerminalsQuery
- * @property {string} [providerId] - Provider account ID
- */
-
 /**
  * Factory for mit-terminals API (btrz-api-inventory).
  * @param {Object} deps
@@ -16,11 +11,10 @@ const {
  */
 function mitTerminalFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /mit-terminals - list MIT terminals.
+   * GET /mit-terminals - list MIT terminals. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {MitTerminalsQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -36,7 +30,7 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /mit-terminals/:mitTerminalId - get MIT terminal by id.
+   * GET /mit-terminals/:mitTerminalId - get MIT terminal by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -51,7 +45,7 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /mit-terminals - create MIT terminal.
+   * POST /mit-terminals - create MIT terminal. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -71,7 +65,7 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /mit-terminals/:mitTerminalId - remove MIT terminal.
+   * DELETE /mit-terminals/:mitTerminalId - remove MIT terminal. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -88,7 +82,7 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /mit-terminals/:mitTerminalId - update MIT terminal.
+   * PUT /mit-terminals/:mitTerminalId - update MIT terminal. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/src/endpoints/inventory/operating-companies.js

@@ -1,8 +1,11 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} OperatingCompaniesQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /operating-companies (btrz-api-inventory). See get-operating-companies getSpec().
+ * @typedef {Object} OperatingCompaniesListQuery
+ * @property {string} [providerIds] - Provider IDs to get operating companies for
+ * @property {string} [enabled] - Filter by enabled [true, false]
+ * @property {number} [page] - Page number (1-based); null for unpaginated
  */
 
 /**
@@ -18,7 +21,7 @@ function operatingCompaniesFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {OperatingCompaniesQuery} [opts.query] - Query params
+   * @param {OperatingCompaniesListQuery} [opts.query] - Query params (providerIds, enabled, page)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -31,7 +34,7 @@ function operatingCompaniesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /operating-companies - create operating company.
+   * POST /operating-companies - create operating company. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -49,7 +52,7 @@ function operatingCompaniesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /operating-companies/:operatingCompanyId - update operating company.
+   * PUT /operating-companies/:operatingCompanyId - update operating company. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -68,7 +71,7 @@ function operatingCompaniesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /operating-companies/:operatingCompanyId - get operating company by id.
+   * GET /operating-companies/:operatingCompanyId - get operating company by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -87,7 +90,7 @@ function operatingCompaniesFactory({client, internalAuthTokenProvider}) {
   /** @type {{ create: function, all: function, get: function, update: function }} */
   const sequences = {
     /**
-     * POST /operating-companies/:operatingCompanyId/sequences - create sequence.
+     * POST /operating-companies/:operatingCompanyId/sequences - create sequence. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -105,7 +108,7 @@ function operatingCompaniesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * GET /operating-companies/:operatingCompanyId/sequences - list sequences.
+     * GET /operating-companies/:operatingCompanyId/sequences - list sequences. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -121,7 +124,7 @@ function operatingCompaniesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * GET /operating-companies/:operatingCompanyId/sequences/:sequenceId - get sequence.
+     * GET /operating-companies/:operatingCompanyId/sequences/:sequenceId - get sequence. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -138,7 +141,7 @@ function operatingCompaniesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /operating-companies/:operatingCompanyId/sequences/:sequenceId - update sequence.
+     * PUT /operating-companies/:operatingCompanyId/sequences/:sequenceId - update sequence. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol