btrz-api-client 8.30.0 → 8.31.0

package/lib/endpoints/inventory/fares.js

@@ -4,8 +4,14 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Query params for fares endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * Query params for GET /fares (btrz-api-inventory). See get-fares getSpec().
  * @typedef {Object} InventoryFaresQuery
+ * @property {string} [providerIds] - Comma-separated provider IDs to get fares for
+ * @property {string} [productIds] - Comma-separated product IDs to get fares for
+ * @property {string} [productTypes] - Product type names to get fares for
+ * @property {string} [channels] - Filter by channels (must be allowed channel values)
+ * @property {string} [isBaseFare] - Filter by base fare [true, false]
+ * @property {string} [enabled] - Filter by enabled [true, false]
  */
 
 /**
@@ -25,7 +31,7 @@ function faresFactory(_ref) {
    * GET /fares - list fares.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {InventoryFaresQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {InventoryFaresQuery} [opts.query] - Query params (providerIds, productIds, productTypes, channels, isBaseFare, enabled)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -42,7 +48,7 @@ function faresFactory(_ref) {
   }
 
   /**
-   * GET /fare/:id - get fare by id.
+   * GET /fare/:id - get fare by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.id - Fare id
@@ -60,7 +66,7 @@ function faresFactory(_ref) {
   }
 
   /**
-   * POST /fares - create fare.
+   * POST /fares - create fare. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -83,7 +89,7 @@ function faresFactory(_ref) {
   }
 
   /**
-   * PUT /fare/:fareId - update fare.
+   * PUT /fare/:fareId - update fare. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -109,7 +115,7 @@ function faresFactory(_ref) {
 
   var adjustments = {
     /**
-     * POST /fares/:fareId/adjustments-overrides - create adjustments override.
+     * POST /fares/:fareId/adjustments-overrides - create adjustments override. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -135,7 +141,7 @@ function faresFactory(_ref) {
 
 
     /**
-     * DELETE /fares/:fareId/adjustments-override/:adjustmentId - remove adjustments override.
+     * DELETE /fares/:fareId/adjustments-override/:adjustmentId - remove adjustments override. 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/lib/endpoints/inventory/fees.js

@@ -4,8 +4,12 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Query params for fees endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * Query params for GET /fees (btrz-api-inventory). See fees get-handler getSpec().
  * @typedef {Object} InventoryFeesQuery
+ * @property {string} [providerIds] - Provider IDs to get fees for
+ * @property {string} [rules] - Rules where the fees apply
+ * @property {string} [productId] - Product ID for the fee
+ * @property {string} [internalId] - Fee internal id
  */
 
 /**
@@ -42,7 +46,7 @@ function feesFactory(_ref) {
   }
 
   /**
-   * GET /fees/:feeId - get fee by id.
+   * GET /fees/:feeId - get fee 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
@@ -62,7 +66,7 @@ function feesFactory(_ref) {
   }
 
   /**
-   * POST /fees - create fee.
+   * POST /fees - create fee. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -85,7 +89,7 @@ function feesFactory(_ref) {
   }
 
   /**
-   * PUT /fees/:feeId - update fee.
+   * PUT /fees/:feeId - update fee. 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/lib/endpoints/inventory/filtered-trips-v2.js

@@ -17,7 +17,7 @@ function filteredTripsV2Factory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * POST /v2/filtered-trips - create filtered trip.
+   * POST /v2/filtered-trips - create filtered trip. 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/lib/endpoints/inventory/filtered-trips.js

@@ -3,6 +3,18 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /filtered-trips (btrz-api-inventory). See get-filtered-trips getSpec().
+ * @typedef {Object} FilteredTripsListQuery
+ * @property {string} [providerIds] - Comma-separated provider IDs
+ * @property {string} [productId] - Product ID to filter by
+ * @property {string} [originId] - Origin station ID to filter by
+ * @property {string} [destinationId] - Destination station ID to filter by
+ * @property {number} [page] - Page for pagination
+ * @property {string} [orderBy] - Field to order by
+ * @property {string} [orderDir] - asc (1) or desc (-1)
+ */
+
 /**
  * Factory for filtered-trips API (btrz-api-inventory).
  * @param {Object} deps
@@ -21,7 +33,7 @@ function filteredTripsFactory(_ref) {
    * @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 {FilteredTripsListQuery} [opts.query] - Query params (providerIds, productId, originId, destinationId, page, orderBy, orderDir)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -39,7 +51,7 @@ function filteredTripsFactory(_ref) {
   }
 
   /**
-   * POST /filtered-trips - create filtered trip.
+   * POST /filtered-trips - create filtered trip. 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/lib/endpoints/inventory/financing-costs.js

@@ -4,8 +4,16 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * @typedef {Object} FinancingCostsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /financing-costs (btrz-api-inventory). See get-financing-costs getSpec().
+ * @typedef {Object} FinancingCostsListQuery
+ * @property {number} [page] - Page number
+ * @property {string} [providerId] - Provider to get financing costs for
+ */
+
+/**
+ * Query params for GET /financing-costs/:id (btrz-api-inventory). See get-financing-cost-by-id getSpec().
+ * @typedef {Object} FinancingCostGetQuery
+ * @property {string} [providerId] - Provider to get financing cost for
  */
 
 /**
@@ -26,7 +34,7 @@ function financingCostsFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {FinancingCostsQuery} [opts.query] - Query params
+   * @param {FinancingCostsListQuery} [opts.query] - Query params (page, providerId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -49,7 +57,7 @@ function financingCostsFactory(_ref) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.id - Financing cost id
-   * @param {FinancingCostsQuery} [opts.query] - Query params
+   * @param {FinancingCostGetQuery} [opts.query] - Query params (providerId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -68,7 +76,7 @@ function financingCostsFactory(_ref) {
   }
 
   /**
-   * POST /financing-costs - create financing cost.
+   * POST /financing-costs - create financing cost. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -93,12 +101,11 @@ function financingCostsFactory(_ref) {
   }
 
   /**
-   * DELETE /financing-costs/:id - remove financing cost.
+   * DELETE /financing-costs/:id - remove financing cost. 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 - Financing cost id
-   * @param {FinancingCostsQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -119,7 +126,7 @@ function financingCostsFactory(_ref) {
   }
 
   /**
-   * PUT /financing-costs/:id - update financing cost.
+   * PUT /financing-costs/:id - update financing cost. 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/lib/endpoints/inventory/garages.js

@@ -4,8 +4,10 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
+ * Query params for GET /garages (btrz-api-inventory). See get-handler getSpec().
  * @typedef {Object} GaragesQuery
- * @property {string} [providerId] - Provider account ID
+ * @property {string} [location] - The garage's location
+ * @property {string} [stationId] - The id of the station associated to the garage
  */
 
 /**
@@ -26,7 +28,7 @@ function garagesFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {GaragesQuery} [opts.query] - Query params
+   * @param {GaragesQuery} [opts.query] - Query params (location, stationId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -44,7 +46,7 @@ function garagesFactory(_ref) {
   }
 
   /**
-   * GET /garages/:garageId - get garage by id.
+   * GET /garages/:garageId - get garage 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
@@ -64,7 +66,7 @@ function garagesFactory(_ref) {
   }
 
   /**
-   * POST /garages - create garage.
+   * POST /garages - create garage. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -116,7 +118,7 @@ function garagesFactory(_ref) {
   }
 
   /**
-   * DELETE /garages/:garageId - remove garage.
+   * DELETE /garages/:garageId - remove garage. 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/lib/endpoints/inventory/getnet-terminals.js

@@ -3,6 +3,14 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /getnet-terminals (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} GetnetTerminalsQuery
+ * @property {number} [page] - The page number to retrieve
+ * @property {string} [stationId] - Filter terminals by station (location) ID
+ * @property {string} [serialNumber] - Filter terminals by serial number
+ */
+
 /**
  * Factory for getnet-terminals API (btrz-api-inventory).
  * @param {Object} deps
@@ -21,7 +29,7 @@ function getnetTerminalFactory(_ref) {
    * @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 {GetnetTerminalsQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -39,7 +47,7 @@ function getnetTerminalFactory(_ref) {
   }
 
   /**
-   * GET /getnet-terminals/:getnetTerminalId - get a getnet terminal.
+   * GET /getnet-terminals/:getnetTerminalId - get a getnet 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
@@ -84,7 +92,7 @@ function getnetTerminalFactory(_ref) {
   }
 
   /**
-   * DELETE /getnet-terminals/:getnetTerminalId - remove getnet terminal.
+   * DELETE /getnet-terminals/:getnetTerminalId - remove getnet 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
@@ -106,7 +114,7 @@ function getnetTerminalFactory(_ref) {
   }
 
   /**
-   * PUT /getnet-terminals/:getnetTerminalId - update getnet terminal.
+   * PUT /getnet-terminals/:getnetTerminalId - update getnet 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/lib/endpoints/inventory/gift-certificate-definitions.js

@@ -4,8 +4,11 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Query params for gift-certificate-definitions endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryGiftCertificateDefinitionsQuery
+ * Query params for GET /gift-certificate-definitions (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} GiftCertificateDefinitionsListQuery
+ * @property {string[]} [channels] - Filter by channels
+ * @property {string[]} [currencies] - Filter by currencies
+ * @property {string} providerId - Provider id (required by API)
  */
 
 /**
@@ -25,7 +28,7 @@ function giftCertificateDefinitionsFactory(_ref) {
    * GET /gift-certificate-definitions - list gift certificate definitions.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {InventoryGiftCertificateDefinitionsQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {GiftCertificateDefinitionsListQuery} [opts.query] - Query params (channels, currencies, providerId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -42,12 +45,11 @@ function giftCertificateDefinitionsFactory(_ref) {
   }
 
   /**
-   * GET /gift-certificate-definitions/:giftcertificateId - get gift certificate definition by id.
+   * GET /gift-certificate-definitions/:giftcertificateId - get gift certificate definition 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.giftcertificateId - Gift certificate definition id
-   * @param {InventoryGiftCertificateDefinitionsQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -68,12 +70,11 @@ function giftCertificateDefinitionsFactory(_ref) {
   }
 
   /**
-   * POST /gift-certificate-definitions - create gift certificate definition.
+   * POST /gift-certificate-definitions - create gift certificate definition. 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.giftcertificate - Gift certificate payload
-   * @param {InventoryGiftCertificateDefinitionsQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -95,13 +96,12 @@ function giftCertificateDefinitionsFactory(_ref) {
   }
 
   /**
-   * PUT /gift-certificate-definitions/:giftcertificateId - update gift certificate definition.
+   * PUT /gift-certificate-definitions/:giftcertificateId - update gift certificate definition. 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.giftcertificateId - Gift certificate definition id
    * @param {Object} opts.giftcertificate - Gift certificate payload
-   * @param {InventoryGiftCertificateDefinitionsQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -124,12 +124,11 @@ function giftCertificateDefinitionsFactory(_ref) {
   }
 
   /**
-   * DELETE /gift-certificate-definitions/:giftcertificateId - remove gift certificate definition.
+   * DELETE /gift-certificate-definitions/:giftcertificateId - remove gift certificate definition. 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.giftcertificateId - Gift certificate definition id
-   * @param {InventoryGiftCertificateDefinitionsQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/lib/endpoints/inventory/insurances.js

@@ -4,8 +4,11 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * 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
  */
 
 /**
@@ -25,7 +28,7 @@ function insurancesFactory(_ref) {
    * 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>}
    */
@@ -44,7 +47,7 @@ function insurancesFactory(_ref) {
   }
 
   /**
-   * 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
@@ -64,7 +67,7 @@ function insurancesFactory(_ref) {
   }
 
   /**
-   * 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
@@ -89,7 +92,7 @@ function insurancesFactory(_ref) {
   }
 
   /**
-   * 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
@@ -116,7 +119,7 @@ function insurancesFactory(_ref) {
   }
 
   /**
-   * 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/lib/endpoints/inventory/insurancesCost.js

@@ -4,8 +4,11 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * 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
  */
 
 /**
@@ -22,12 +25,12 @@ function insurancesCostFactory(_ref) {
       internalAuthTokenProvider = _ref.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/lib/endpoints/inventory/items.js

@@ -3,6 +3,25 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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
@@ -21,7 +40,7 @@ function itemsFactory(_ref) {
    * @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>}
    */
@@ -44,8 +63,8 @@ function itemsFactory(_ref) {
    * @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>}
    */
@@ -120,7 +139,6 @@ function itemsFactory(_ref) {
      * @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/lib/endpoints/inventory/journey-prices.js

@@ -4,8 +4,37 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * 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)
  */
 
 /**
@@ -26,7 +55,7 @@ function journeyPricesFactory(_ref) {
    * @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>}
    */
@@ -50,7 +79,7 @@ function journeyPricesFactory(_ref) {
    * @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>}
    */
@@ -70,7 +99,7 @@ function journeyPricesFactory(_ref) {
   }
 
   /**
-   * 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
@@ -92,7 +121,7 @@ function journeyPricesFactory(_ref) {
   }
 
   /**
-   * 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
@@ -115,7 +144,7 @@ function journeyPricesFactory(_ref) {
   }
 
   /**
-   * 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/lib/endpoints/inventory/labels.js

@@ -4,8 +4,10 @@ var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
+ * 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
  */
 
 /**
@@ -26,7 +28,7 @@ function labelsFactory(_ref) {
    * @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>}
    */
@@ -44,12 +46,11 @@ function labelsFactory(_ref) {
   }
 
   /**
-   * 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>}
    */