btrz-api-client 8.30.0 → 8.32.0

package/src/endpoints/inventory/seatclasses.js

@@ -1,11 +1,6 @@
 /* eslint-disable import/extensions */
 const {authorizationHeaders} = require("./../endpoints_helpers");
 
-/**
- * Query params for seat-classes endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventorySeatclassesQuery
- */
-
 /**
  * Factory for seat-classes API (btrz-api-inventory).
  * @param {Object} deps
@@ -15,11 +10,10 @@ const {authorizationHeaders} = require("./../endpoints_helpers");
  */
 function seatClassesFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /seat-classes - list seat classes.
+   * GET /seat-classes - list seat classes. 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 {InventorySeatclassesQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -33,12 +27,11 @@ function seatClassesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /seat-classes/:id - get seat class by id.
+   * GET /seat-classes/:id - get seat class 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 - Seat class id
-   * @param {InventorySeatclassesQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -52,13 +45,12 @@ function seatClassesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /seat-classes/:id - update seat class.
+   * PUT /seat-classes/:id - update seat class. 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 - Seat class id
    * @param {Object} opts.data - Request body
-   * @param {InventorySeatclassesQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -73,12 +65,11 @@ function seatClassesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /seat-classes/:id - remove seat class.
+   * DELETE /seat-classes/:id - remove seat class. 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 - Seat class id
-   * @param {InventorySeatclassesQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -92,12 +83,11 @@ function seatClassesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /seat-classes - create seat class.
+   * POST /seat-classes - create seat class. 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 {InventorySeatclassesQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/inventory/seatfees.js

@@ -3,8 +3,11 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
- * Query params for seatfees endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventorySeatfeesQuery
+ * Query params for GET /seat-fees (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} SeatFeesListQuery
+ * @property {string} [disabled] - Filter disabled/enabled [true, false]
+ * @property {string} [providerId] - Provider account id to get seat fees for
+ * @property {string} [currency] - ISO 4217 currency code; defaults to account currency
  */
 
 /**
@@ -19,7 +22,7 @@ function seatfeesFactory({client, internalAuthTokenProvider}) {
    * GET /seat-fees - list seat fees.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {InventorySeatfeesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {SeatFeesListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -35,7 +38,7 @@ function seatfeesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /seat-fees/:seatfeeId - get seat fee by id.
+   * GET /seat-fees/:seatfeeId - get seat fee by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} opts.seatfeeId - Seat fee id
    * @param {string} [opts.token] - API key
@@ -49,7 +52,7 @@ function seatfeesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /seat-fees - create seat fee.
+   * POST /seat-fees - create seat fee. 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 +72,7 @@ function seatfeesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /seat-fees/:seatfeeId - update seat fee.
+   * PUT /seat-fees/:seatfeeId - update seat fee. 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/seatmaps.js

@@ -2,8 +2,35 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} SeatmapsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /seatmaps (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} SeatmapsListQuery
+ * @property {string} [vehicleId] - Return only seatmaps assigned to this vehicle; disables pagination
+ * @property {string} [name] - Filter by name (case-insensitive partial match)
+ * @property {string} [amenityGroupId] - Filter by amenity group id
+ * @property {string} [brandId] - Filter by brand id
+ * @property {number} [capacity] - Filter by exact capacity
+ * @property {boolean} [standard] - Filter by standard seatmap flag
+ * @property {boolean} [originalOnly] - When true, only original seatmaps (no manifest copies)
+ * @property {boolean} [newdesign] - When true, query new design collection; otherwise legacy
+ * @property {number} [page] - Page number (1-based, 20 per page); ignored when vehicleId provided
+ */
+
+/**
+ * Query params for GET /seatmaps/:seatmapId/available-seats/... (btrz-api-inventory). See get-seatmaps-id-available-seats getSpec().
+ * @typedef {Object} SeatmapsAvailableSeatsQuery
+ * @property {boolean} [newdesign] - If true and account uses new design, return new structure
+ * @property {string} [originId] - Origin station for segment (required for API)
+ * @property {string} [destinationId] - Destination station for segment (required for API)
+ * @property {string} [providerId] - Provider id; defaults to account
+ * @property {string} [legFromIndex] - Departure station index in schedule (0-based)
+ * @property {string} [legToIndex] - Arrival station index in schedule (0-based)
+ * @property {string} [channel] - Channel: agency, agency-backoffice, backoffice, websales, agency-websales
+ */
+
+/**
+ * Query for GET /seatmaps/:seatmapId/occupied-seats (btrz-api-inventory). See get-occupied-seats getSpec().
+ * @typedef {Object} SeatmapsOccupiedSeatsQuery
+ * @property {boolean} newdesign - Must be true; required for new-design seatmaps
  */
 
 /**
@@ -19,7 +46,7 @@ function seatmapsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {SeatmapsQuery} [opts.query] - Query params
+   * @param {SeatmapsListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -38,7 +65,7 @@ function seatmapsFactory({client, internalAuthTokenProvider}) {
    * @param {string} opts.routeId - Route id
    * @param {string} opts.scheduleId - Schedule id
    * @param {string} opts.manifestDate - Manifest date
-   * @param {SeatmapsQuery} [opts.query] - Query params
+   * @param {SeatmapsAvailableSeatsQuery} [opts.query] - Query params (originId, destinationId, etc.)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -55,7 +82,7 @@ function seatmapsFactory({client, internalAuthTokenProvider}) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.seatmapId - Seatmap id
-   * @param {SeatmapsQuery} [opts.query] - Query params
+   * @param {string} [opts.providerId] - Optional account id to scope lookup (query)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -67,7 +94,7 @@ function seatmapsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /seatmaps - create seatmap.
+   * POST /seatmaps - create seatmap. 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 +114,7 @@ function seatmapsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /seatmaps/:seatmapId - update seatmap.
+   * PUT /seatmaps/:seatmapId - update seatmap. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -108,7 +135,7 @@ function seatmapsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /seatmaps/:seatmapId - remove seatmap.
+   * DELETE /seatmaps/:seatmapId - remove seatmap. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -125,12 +152,12 @@ function seatmapsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /seatmaps/:seatmapId/occupied-seats - get occupied seats.
+   * GET /seatmaps/:seatmapId/occupied-seats - get occupied seats. Requires newdesign=true in query.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.seatmapId - Seatmap id
-   * @param {SeatmapsQuery} [opts.query] - Query params
+   * @param {SeatmapsOccupiedSeatsQuery} [opts.query] - Query (newdesign required)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/inventory/segments-information-tables.js

@@ -3,12 +3,13 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
+ * Query params for GET /segments-information-tables/:routeId (btrz-api-inventory-trips). See get-by-id-handler getSpec().
  * @typedef {Object} SegmentsInformationTablesQuery
- * @property {string} [providerId] - Provider account ID
+ * @property {string} [providerId] - Provider id of the route if not the same as the user making the request (ObjectId format)
  */
 
 /**
- * Factory for segments-information-tables API (btrz-api-inventory).
+ * Factory for segments-information-tables API (btrz-api-inventory-trips).
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
@@ -20,8 +21,8 @@ function segmentInformationTableFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.routeId - Route id
-   * @param {SegmentsInformationTablesQuery} [opts.query] - Query params
+   * @param {string} opts.routeId - Route id (ObjectId format)
+   * @param {SegmentsInformationTablesQuery} [opts.query] - Query params (providerId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/inventory/segments-information.js

@@ -3,8 +3,10 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
+ * Query params for GET /segments-information (btrz-api-inventory). See get-handler getSpec().
  * @typedef {Object} SegmentsInformationQuery
- * @property {string} [providerId] - Provider account ID
+ * @property {string} [originId] - Filter by origin ID (ObjectId format)
+ * @property {string} [destinationId] - Filter by destination ID (ObjectId format)
  */
 
 /**
@@ -20,7 +22,7 @@ function segmentsInformationFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {SegmentsInformationQuery} [opts.query] - Query params
+   * @param {SegmentsInformationQuery} [opts.query] - Query params (originId, destinationId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/inventory/service-numbers.js

@@ -3,8 +3,11 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
- * Query params for service-numbers endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryServiceNumbersQuery
+ * Query params for GET /service-numbers (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} ServiceNumbersListQuery
+ * @property {string} [name] - Filter by service number name
+ * @property {boolean} [enabled] - Filter enabled/disabled
+ * @property {number} [page] - Page for pagination
  */
 
 /**
@@ -23,7 +26,7 @@ function serviceNumbersFactory({
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InventoryServiceNumbersQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {ServiceNumbersListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -38,7 +41,7 @@ function serviceNumbersFactory({
   }
 
   /**
-   * POST /service-numbers - create service number.
+   * POST /service-numbers - create service number. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -60,7 +63,7 @@ function serviceNumbersFactory({
   }
 
   /**
-   * PUT /service-numbers/:serviceNumberId - update service number.
+   * PUT /service-numbers/:serviceNumberId - update service number. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.token] - API key
@@ -83,7 +86,7 @@ function serviceNumbersFactory({
   }
 
   /**
-   * GET /service-numbers/:serviceNumberId - get service number by id.
+   * GET /service-numbers/:serviceNumberId - get service number by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.serviceNumberId - Service number id

package/src/endpoints/inventory/service-types.js

@@ -2,11 +2,6 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
-/**
- * Query params for GET /service-types (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryServiceTypesListQuery
- */
-
 /**
  * Factory for service-types API (btrz-api-inventory).
  * @param {Object} deps
@@ -16,10 +11,9 @@ const {
  */
 function serviceTypesFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /service-types - list service types.
+   * GET /service-types - list service types. API does not accept query params (getSpec has no query parameters).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {InventoryServiceTypesListQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -35,7 +29,7 @@ function serviceTypesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /service-types/:serviceTypeId - get service type by id.
+   * GET /service-types/:serviceTypeId - get service type by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} opts.serviceTypeId - Service type id
    * @param {string} [opts.token] - API key
@@ -49,7 +43,7 @@ function serviceTypesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /service-types - create service type.
+   * POST /service-types - create service type. 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 +63,7 @@ function serviceTypesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /service-types/:serviceTypeId - remove service type.
+   * DELETE /service-types/:serviceTypeId - remove service type. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.serviceTypeId - Service type id
@@ -86,7 +80,7 @@ function serviceTypesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /service-types/:serviceTypeId - update service type.
+   * PUT /service-types/:serviceTypeId - update service type. 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/ssrs.js

@@ -1,8 +1,16 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for ssrs endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventorySsrsQuery
+ * Query params for GET /ssrs (btrz-api-inventory). See get-ssrs getSpec().
+ * @typedef {Object} SsrsListQuery
+ * @property {string} [providerIds] - Provider ids to get SSRs for
+ * @property {string} [travelDate] - Travel date (yyyy-mm-dd)
+ * @property {string} [travelTime] - Travel time (HH:MM); required if travelDate provided
+ * @property {string} [tripId] - Trip id to get SSRs for
+ * @property {string} [productIds] - Product type ids
+ * @property {string} [enabled] - Filter enabled/disabled [true, false]
+ * @property {string} [currency] - Currency ISO code
+ * @property {string} [brandIds] - Trip brand ids
  */
 
 /**
@@ -17,7 +25,7 @@ function ssrsFactory({client, internalAuthTokenProvider}) {
    * GET /ssrs - list SSRs.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {InventorySsrsQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {SsrsListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/inventory/station-classes.js

@@ -1,5 +1,12 @@
 const {authorizationHeaders} = require("../endpoints_helpers.js");
 
+/**
+ * Query params for GET /station-classes (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} StationClassesListQuery
+ * @property {number} [page] - Page number to retrieve
+ * @property {string} [name] - Filter by station class name
+ */
+
 /**
  * Factory for station-classes API (btrz-api-inventory).
  * @param {Object} deps
@@ -13,7 +20,7 @@ function stationClassFactory({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 {StationClassesListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -27,12 +34,11 @@ function stationClassFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /station-classes/:stationClassId - get station class by id.
+   * GET /station-classes/:stationClassId - get station class 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.stationClassId - Station class id
-   * @param {Object} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -46,7 +52,7 @@ function stationClassFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /station-classes/:stationClassId - update station class.
+   * PUT /station-classes/:stationClassId - update station class. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -65,7 +71,7 @@ function stationClassFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /station-classes/:stationClassId - remove station class.
+   * DELETE /station-classes/:stationClassId - remove station class. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -82,7 +88,7 @@ function stationClassFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /station-classes - create station class.
+   * POST /station-classes - create station class. 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/station-groups.js

@@ -3,8 +3,9 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} StationGroupsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /station-groups (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} StationGroupsListQuery
+ * @property {string} [providerIds] - Provider ids to get station groups for
  */
 
 /**
@@ -20,7 +21,7 @@ function stationGroupsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {StationGroupsQuery} [opts.query] - Query params
+   * @param {StationGroupsListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/inventory/stations-provinces.js

@@ -2,11 +2,6 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
-/**
- * @typedef {Object} StationsProvincesQuery
- * @property {string} [providerId] - Provider account ID
- */
-
 /**
  * Factory for stations/provinces API (btrz-api-inventory).
  * @param {Object} deps
@@ -16,11 +11,10 @@ const {
  */
 function stationsProvincesFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /stations/provinces - list station provinces.
+   * GET /stations/provinces - list station provinces. 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 {StationsProvincesQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/inventory/stations-zones.js

@@ -3,8 +3,9 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
+ * Query params for GET /stations/zones (btrz-api-inventory). See 01-get-stations-zones getSpec().
  * @typedef {Object} StationsZonesQuery
- * @property {string} [providerId] - Provider account ID
+ * @property {string} [accountIds] - Comma-separated account ids to get zones for (agency accounts)
  */
 
 /**
@@ -20,7 +21,7 @@ function stationsZonesFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {StationsZonesQuery} [opts.query] - Query params
+   * @param {StationsZonesQuery} [opts.query] - Query params (accountIds)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/inventory/stations.js

@@ -1,8 +1,26 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
+ * Query params for GET /stations (btrz-api-inventory). See get-stations getSpec().
  * @typedef {Object} StationsQuery
- * @property {string} [providerId] - Provider account ID
+ * @property {string} [providerId] - The id of the provider to get stations for
+ * @property {string} [providerIds] - The ids of the providers to get stations for
+ * @property {string} [productId] - The id of the product
+ * @property {string} [departure] - The id of the origin station
+ * @property {string} [province] - The province of the station
+ * @property {string} [zone] - The zone of the station
+ * @property {string} [type] - The type name of the station
+ * @property {string} [name] - The full name of the station
+ * @property {string} [partialName] - Full or partial name (case-insensitive match)
+ * @property {string} [enabled] - Filter by enabled: "true" | "false"
+ * @property {number} [page] - Page for pagination
+ * @property {string} [orderBy] - Field to order by
+ * @property {string} [orderDir] - Order direction: asc (1) or desc (-1), default 1
+ * @property {string} [stationIds] - Comma-separated station ids to return
+ * @property {string} [filterHeadStations] - Filter stations that are grouping any station
+ * @property {string} [includesStationsGroupFor] - Include stations that group/include the sent station id
+ * @property {string} [externalId] - The id of the station in the external system
+ * @property {string} [shortcode] - The shortcode of the station to filter by
  */
 
 /**
@@ -14,7 +32,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function stationsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /stations/:id - get station by id.
+   * GET /stations/:id - get station 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
@@ -33,7 +51,7 @@ function stationsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {StationsQuery} [opts.query] - Query params
+   * @param {StationsQuery} [opts.query] - Query params (providerId, productId, name, page, etc.)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -45,7 +63,7 @@ function stationsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /stations - create station.
+   * POST /stations - create station. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -65,7 +83,7 @@ function stationsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /station/:stationId - update station.
+   * PUT /station/:stationId - update station. 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/taxes.js

@@ -1,8 +1,9 @@
 const {authorizationHeaders} = require("../endpoints_helpers.js");
 
 /**
+ * Query params for GET /taxes (btrz-api-inventory). See get-handler getSpec().
  * @typedef {Object} TaxesQuery
- * @property {string} [providerId] - Provider account ID
+ * @property {string} [providerIds] - The id of the providers to get taxes for
  */
 
 /**
@@ -18,7 +19,7 @@ function taxesFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {TaxesQuery} [opts.query] - Query params
+   * @param {TaxesQuery} [opts.query] - Query params (providerIds)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -30,12 +31,11 @@ function taxesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /taxes/:taxId - get tax by id.
+   * GET /taxes/:taxId - get tax 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.taxId - Tax id
-   * @param {TaxesQuery} [opts.query] - Query params
+   * @param {string} opts.taxId - Tax id (ObjectId format)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -140,7 +140,6 @@ function taxesFactory({client, internalAuthTokenProvider}) {
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {TaxesQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */