btrz-api-client 8.30.0 → 8.32.0

package/src/endpoints/operations/manifest.js

@@ -4,8 +4,75 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} ManifestQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /manifests (btrz-api-operations). See get-manifests getSpec().
+ * @typedef {Object} ManifestsListQuery
+ * @property {string} [providerIds] - Provider IDs of the manifests
+ * @property {string} [routeIds] - Route IDs
+ * @property {string} [scheduleIds] - Schedule IDs
+ * @property {string} [date] - Date (yyyy-mm-dd)
+ * @property {string} [dateFrom] - Start date range (yyyy-mm-dd)
+ * @property {string} [dateTo] - End date range (yyyy-mm-dd)
+ * @property {string} [seatmapId] - Seatmap ID
+ * @property {string} [vehicleId] - Vehicle ID
+ * @property {string} [assignedUserId] - Assigned user ID
+ * @property {boolean} [dispatched] - If manifest was dispatched
+ * @property {boolean} [reviewed] - If manifest was reviewed
+ * @property {string} [sendToSAP] - If manifest should be sent to SAP
+ * @property {string} [operatingCompanyId] - Operating company ID
+ * @property {number} [vehicleFrom] - First vehicle id (range)
+ * @property {number} [vehicleTo] - Last vehicle id (range)
+ * @property {string} [dispatchedStatus] - Filter by dispatched status
+ * @property {boolean} [manifestOnly] - If only manifest (no ticket info)
+ * @property {string} [status] - Comma-separated manifest statuses
+ */
+
+/**
+ * Query params for PUT /manifests (btrz-api-operations). See put-manifest getSpec().
+ * @typedef {Object} ManifestSaveQuery
+ * @property {string} providerId - Provider ID (required)
+ * @property {string} [manifestId] - Manifest ID to update (omit to create)
+ * @property {boolean} [bypassBusValidation] - Bypass bus validation
+ */
+
+/**
+ * Query params for PATCH /manifests (btrz-api-operations). See patch-manifest getSpec().
+ * @typedef {Object} ManifestPatchQuery
+ * @property {string} providerId - Provider ID (required)
+ * @property {string} [routeId] - Route ID for update_schedule
+ * @property {string} [scheduleId] - New schedule ID for update_schedule
+ * @property {string} [oldScheduleId] - Old schedule ID for update_schedule
+ * @property {string} [accommodateOnAnySeat] - "true" to assign missing seats to any available
+ * @property {string} [newdesign] - "true" when using new seatmap design
+ */
+
+/**
+ * Query params for GET /outlook-manifests (btrz-api-operations). See get-outlook-manifests getSpec().
+ * @typedef {Object} OutlookManifestsListQuery
+ * @property {string} providerId - Provider ID (required)
+ * @property {string} productId - Product ID (required)
+ * @property {string} from - Start date (required, yyyy-mm-dd)
+ * @property {string} to - End date (required, yyyy-mm-dd, max 1 month range)
+ * @property {string} [scheduleName] - Schedule name filter
+ * @property {string} [loadFactorFrom] - Min load factor
+ * @property {string} [loadFactorTo] - Max load factor
+ * @property {string} [timeFrom] - Min time filter
+ * @property {string} [timeTo] - Max time filter
+ * @property {string} [originId] - Origin station id
+ * @property {string} [destinationId] - Destination station id
+ * @property {string} [amenityGroupId] - Amenity group id
+ * @property {string} [userId] - Only manifests with this user assigned
+ * @property {string} [withAssignedUsers] - Filter by assigned users (true/false)
+ * @property {string} [status] - Comma-separated statuses (published, paused, planned, canceled)
+ * @property {boolean} [isExtraRun] - Only extra run trips
+ * @property {boolean} [minimalPayload] - Minimal data for five day outlook
+ * @property {string} [labelId] - Label id filter
+ * @property {boolean} [dispatched] - Only dispatched manifests
+ */
+
+/**
+ * Query params for PUT /manifests/:manifestKey/driver-relays (btrz-api-operations). See put-driver-relays-handler getSpec().
+ * @typedef {Object} ManifestDriverRelaysQuery
+ * @property {boolean} [bypassValidations] - If true, bypass driver validations
  */
 
 /**
@@ -56,14 +123,13 @@ function manifestFactory({
   }
 
   /**
-   * POST manifests/:manifestId/dispatches - dispatch manifest.
+   * POST manifests/:manifestId/dispatches - dispatch manifest. 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.headers] - Optional headers
    * @param {string} opts.manifestId - Manifest id
    * @param {Object} opts.data - Request body
-   * @param {ManifestQuery} [opts.query] - Query params
    * @returns {Promise<import("axios").AxiosResponse>}
    */
   function dispatch({token, jwtToken, headers, manifestId, data, query}) {
@@ -81,7 +147,7 @@ function manifestFactory({
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {ManifestQuery} [opts.query] - Query params
+   * @param {ManifestsListQuery} [opts.query] - Query params (all optional)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -95,12 +161,11 @@ function manifestFactory({
   }
 
   /**
-   * GET /manifests/:manifestId - get manifest by id.
+   * GET /manifests/:manifestId - get manifest 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.manifestId - Manifest id
-   * @param {ManifestQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -163,7 +228,7 @@ function manifestFactory({
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {ManifestQuery} [opts.query] - Query params
+   * @param {OutlookManifestsListQuery} [opts.query] - Query params (providerId, productId, from, to required)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -185,7 +250,7 @@ function manifestFactory({
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {ManifestQuery} [opts.query] - Query params
+   * @param {ManifestPatchQuery} [opts.query] - Query params (providerId required)
    * @param {Object} opts.operations - JSON Patch operations
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
@@ -209,10 +274,10 @@ function manifestFactory({
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} [opts.providerId] - Provider id
+   * @param {string} [opts.providerId] - Provider id (required by API as query)
    * @param {Object} opts.data - Request body
    * @param {Object} [opts.headers] - Optional headers
-   * @param {ManifestQuery} [opts.query] - Query params
+   * @param {ManifestSaveQuery} [opts.query] - Query params (providerId required; manifestId, bypassBusValidation optional)
    * @returns {Promise<import("axios").AxiosResponse>}
    */
   function save({
@@ -233,8 +298,7 @@ function manifestFactory({
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.manifestId - Manifest id
-   * @param {ManifestQuery} [opts.query] - Query params
-   * @param {Object} opts.data - Request body
+       * @param {Object} opts.data - Request body
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -280,8 +344,7 @@ function manifestFactory({
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.manifestId - Manifest id
-   * @param {ManifestQuery} [opts.query] - Query params
-   * @param {Object} opts.data - Request body
+       * @param {Object} opts.data - Request body
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -328,8 +391,7 @@ function manifestFactory({
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.manifestId - Manifest id
-   * @param {ManifestQuery} [opts.query] - Query params
-   * @param {Object} opts.data - Request body
+       * @param {Object} opts.data - Request body
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -353,8 +415,7 @@ function manifestFactory({
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.manifestId - Manifest id
-   * @param {ManifestQuery} [opts.query] - Query params
-   * @param {Object} opts.data - Request body
+       * @param {Object} opts.data - Request body
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -378,7 +439,6 @@ function manifestFactory({
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.manifestKey - Manifest key
-   * @param {ManifestQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -402,7 +462,6 @@ function manifestFactory({
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {ManifestQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @param {Object} opts.data - Request body
      * @param {string} opts.manifestId - Manifest id
@@ -425,7 +484,6 @@ function manifestFactory({
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {ManifestQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @param {string} opts.manifestId - Manifest id
      * @param {string} opts.legFromId - Leg from id
@@ -451,7 +509,6 @@ function manifestFactory({
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {ManifestQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @param {string} opts.manifestId - Manifest id
      * @param {string} opts.legFromId - Leg from id
@@ -482,7 +539,6 @@ function manifestFactory({
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {Object} opts.data - Request body
-     * @param {ManifestQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @param {string} opts.manifestId - Manifest id
      * @param {string} opts.legFromId - Leg from id
@@ -504,8 +560,7 @@ function manifestFactory({
        * @param {string} [opts.token] - API key
        * @param {string} [opts.jwtToken] - JWT or internal auth symbol
        * @param {Object} opts.data - Request body
-       * @param {ManifestQuery} [opts.query] - Query params
-       * @param {Object} [opts.headers] - Optional headers
+     * @param {Object} [opts.headers] - Optional headers
        * @param {string} opts.manifestId - Manifest id
        * @param {string} opts.legFromId - Leg from id
        * @param {string} opts.ticketId - Ticket id
@@ -525,8 +580,7 @@ function manifestFactory({
        * @param {Object} opts
        * @param {string} [opts.token] - API key
        * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-       * @param {ManifestQuery} [opts.query] - Query params
-       * @param {Object} [opts.headers] - Optional headers
+     * @param {Object} [opts.headers] - Optional headers
        * @param {string} opts.manifestId - Manifest id
        * @param {string} opts.legFromId - Leg from id
        * @param {string} opts.ticketId - Ticket id
@@ -549,7 +603,6 @@ function manifestFactory({
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {ManifestQuery} [opts.query] - Query params
      * @param {string} [opts.responseType] - Response type (e.g. "json")
      * @param {string} opts.id - Manifest id
      * @param {Object} [opts.headers] - Optional headers
@@ -573,7 +626,6 @@ function manifestFactory({
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.manifestId - Manifest id
-     * @param {ManifestQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @param {Object} opts.data - Request body
      * @returns {Promise<import("axios").AxiosResponse>}
@@ -613,7 +665,6 @@ function manifestFactory({
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.manifestId - Manifest id
-     * @param {ManifestQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -634,7 +685,7 @@ function manifestFactory({
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.manifestId - Manifest id
-     * @param {ManifestQuery} [opts.query] - Query params
+     * @param {ManifestDriverRelaysQuery} [opts.query] - Query params (bypassValidations optional)
      * @param {Object} [opts.headers] - Optional headers
      * @param {Object} opts.data - Request body
      * @returns {Promise<import("axios").AxiosResponse>}
@@ -659,7 +710,6 @@ function manifestFactory({
      * @param {string} opts.manifestKey - Manifest key
      * @param {Object} opts.manifestException - Manifest exception payload
      * @param {Object} [opts.headers] - Optional headers
-     * @param {ManifestQuery} [opts.query] - Query params
      * @returns {Promise<import("axios").AxiosResponse>}
      */
     update({token, jwtToken, manifestKey, manifestException, headers, query = {}}) {

package/src/endpoints/operations/manifest_leg_for_tickets.js

@@ -9,12 +9,11 @@ const {authorizationHeaders} = require("../endpoints_helpers.js");
  */
 function manifestLegForTicketsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /manifest-leg-for-tickets/:ticketId - get manifest leg for ticket.
+   * GET /manifest-leg-for-tickets/:ticketId - get manifest leg for ticket. 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.ticketId - Ticket id
-   * @param {Object} [opts.params] - Query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/operations/movements.js

@@ -1,10 +1,5 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-/**
- * @typedef {Object} MovementsQuery
- * @property {string} [providerId] - Provider account ID
- */
-
 /**
  * Factory for movements API (btrz-api-operations).
  * @param {Object} deps
@@ -14,12 +9,11 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function movementsFactory({client, internalAuthTokenProvider}) {
   /**
-   * POST /movements - create movement.
+   * POST /movements - create movement. 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.movement - Movement payload
-   * @param {MovementsQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/operations/outlook-trips.js

@@ -1,8 +1,18 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} OutlookTripsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /outlook-trips (btrz-api-operations). See get-outlook-trips getSpec().
+ * @typedef {Object} OutlookTripsListQuery
+ * @property {string} from - Travel start date (required, date format)
+ * @property {string} to - Travel end date (required, date format)
+ * @property {string} [fromTime] - Cutoff time for first date (HH:MM)
+ * @property {string} [toTime] - Cutoff time for last date (HH:MM)
+ * @property {string} productId - Product ID (required)
+ * @property {string} [originId] - Origin (departure) station ID
+ * @property {string} [destinationId] - Destination station ID
+ * @property {string} [routeId] - Route ID
+ * @property {string} [scheduleId] - Schedule ID
+ * @property {boolean} [isExtraRun] - Only trips marked as extra run
  */
 
 /**
@@ -18,7 +28,7 @@ function outlookTripsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {OutlookTripsQuery} [opts.query] - Query params
+   * @param {OutlookTripsListQuery} [opts.query] - Query params (from, to, productId required)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/operations/parcels.js

@@ -1,8 +1,22 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} ParcelsQuery
+ * Query params for GET /parcels list (btrz-api-operations). See get-parcel-handler getSpec().
+ * @typedef {Object} ParcelsListQuery
+ * @property {string} [trxId] - Transaction ID
+ * @property {string} [transactionId] - Transaction ID (alias)
+ * @property {string} [parcelId] - Parcel ID
+ * @property {string} [dateFrom] - Filter from date
+ * @property {string} [dateTo] - Filter to date
+ * @property {string} [originId] - Origin station ID
+ * @property {string} [destinationId] - Destination station ID
+ * @property {string} [trackingStatus] - Tracking status
+ * @property {boolean} [notInManifest] - Exclude parcels already in a manifest
  * @property {string} [providerId] - Provider account ID (also set via opts.providerId)
+ * @property {string} [lookupSearchParams] - Search for lookup
+ * @property {number} [page] - Page number
+ * @property {number} [recordsPerPage] - Records per page
+ * @property {boolean} [assignableToManifest] - Only parcels assignable to manifest
  */
 
 /**
@@ -14,7 +28,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function parcelFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /parcels/:id - get parcel by id.
+   * GET /parcels/:id - get parcel 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
@@ -34,7 +48,7 @@ function parcelFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {ParcelsQuery} [opts.query] - Query params (providerId merged if opts.providerId set)
+   * @param {ParcelsListQuery} [opts.query] - Query params (providerId merged if opts.providerId set)
    * @param {string} [opts.providerId] - Provider id (merged into query)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
@@ -49,7 +63,7 @@ function parcelFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /parcels/:id/scans - add scan to parcel.
+   * POST /parcels/:id/scans - add scan to parcel. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -69,7 +83,7 @@ function parcelFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /parcels/:id/user-comments - add comment to parcel.
+   * POST /parcels/:id/user-comments - add comment to parcel. 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 +102,7 @@ function parcelFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /parcels/:id/user-comments/:commentId - delete parcel comment.
+   * DELETE /parcels/:id/user-comments/:commentId - delete parcel comment. 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/operations/parcels_manifests.js

@@ -14,12 +14,6 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  * @property {number} [recordsPerPage] - Records per page (max 100)
  */
 
-/**
- * POST /parcels-manifests, POST .../parcels, POST .../vehicles do not define query params in backend getSpec.
- * Use for optional query keys forwarded as-is.
- * @typedef {Object} ParcelsManifestsPostQuery
- */
-
 /**
  * Factory for parcels-manifests API (btrz-api-operations).
  * @param {Object} deps
@@ -46,7 +40,7 @@ function parcelsManifestsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /parcels-manifests/:id - get parcels manifest by id.
+   * GET /parcels-manifests/:id - get parcels manifest 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
@@ -85,7 +79,7 @@ function parcelsManifestsFactory({client, internalAuthTokenProvider}) {
 
   const parcels = {
     /**
-     * DELETE /parcels-manifests/:manifestId/parcels/:parcelId - remove parcel from manifest.
+     * DELETE /parcels-manifests/:manifestId/parcels/:parcelId - remove parcel from manifest. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -102,14 +96,12 @@ function parcelsManifestsFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * POST /parcels-manifests/:manifestId/parcels - create parcel on manifest. Body: ParcelsManifestsPostData.
-     * Backend getSpec does not define query params; query is passed through as-is if provided.
+     * POST /parcels-manifests/:manifestId/parcels - create parcel on manifest. 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.manifestId - Parcel manifest id (ObjectId)
-     * @param {ParcelsManifestsPostQuery} [opts.query] - Optional query params (backend getSpec has none; forwarded as-is)
-     * @param {Object} opts.data - Parcel payload (parcelsmanifests / ParcelsManifestsPostData: parcels, optional overrideOandD)
+     * @param {Object} opts.data - Parcel payload (parcels, optional overrideOandD)
      * @param {Object} [opts.headers] - Optional request headers
      * @returns {Promise<import("axios").AxiosResponse>} PostParcelsManifestsResponse; 400 WRONG_DATA, 404, 409 CAN_ADD_PARCEL_TO_MANIFEST_BECAUSE_OF_CUTOFF
      */
@@ -126,14 +118,12 @@ function parcelsManifestsFactory({client, internalAuthTokenProvider}) {
 
   const vehicles = {
     /**
-     * POST /parcels-manifests/:manifestId/vehicles - create or update vehicle on manifest. Body: ParcelManifestVehiclePostData.
-     * Backend getSpec does not define query params; query is passed through as-is if provided.
+     * POST /parcels-manifests/:manifestId/vehicles - create or update vehicle on manifest. 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.manifestId - Parcel manifest id (ObjectId)
-     * @param {ParcelsManifestsPostQuery} [opts.query] - Optional query params (backend getSpec has none; forwarded as-is)
-     * @param {Object} opts.data - Vehicle payload (sent as parcelManifestVehicle in body; vehicleId required)
+     * @param {Object} opts.data - Vehicle payload (vehicleId required)
      * @param {Object} [opts.headers] - Optional request headers
      * @returns {Promise<import("axios").AxiosResponse>} PostVehicleManifestsResponse; 400 WRONG_DATA, 404 MANIFEST_NOT_FOUND, 409 MANIFEST_HAS_PASSENGERS
      */

package/src/endpoints/operations/passenger_check_in_info.js

@@ -8,11 +8,6 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  * @property {string} [providerId] - Provider/account id; defaults to authenticated account when omitted
  */
 
-/**
- * PUT and POST /passenger-check-in-info do not define query params in backend getSpec. Use for optional query keys forwarded as-is.
- * @typedef {Object} PassengerCheckInInfoPostQuery
- */
-
 /**
  * Factory for passenger-check-in-info API (btrz-api-operations).
  * @param {Object} deps
@@ -39,7 +34,7 @@ function passengerCheckInInfoFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /passenger-check-in-info/:id - get passenger check-in info by id.
+   * GET /passenger-check-in-info/:id - get passenger check-in info 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
@@ -56,13 +51,12 @@ function passengerCheckInInfoFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /passenger-check-in-info/:id - update passenger check-in info. Backend getSpec has no query params; query is passed through.
+   * PUT /passenger-check-in-info/:id - update passenger check-in info. 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 - Passenger check-in info id (ObjectId)
    * @param {Object} opts.data - PassengerCheckInInfoPutData
-   * @param {PassengerCheckInInfoPostQuery} [opts.query] - Optional query params (backend getSpec has none; forwarded as-is)
    * @param {Object} [opts.headers] - Optional request headers
    * @returns {Promise<import("axios").AxiosResponse>} 404 PASSENGERCHECKININFO_NOT_FOUND
    */
@@ -85,11 +79,10 @@ function passengerCheckInInfoFactory({client, internalAuthTokenProvider}) {
   // }
 
   /**
-   * POST /passenger-check-in-info - create passenger check-in info. Backend getSpec has no query params; query is passed through.
+   * POST /passenger-check-in-info - create passenger check-in info. 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 {PassengerCheckInInfoPostQuery} [opts.query] - Optional query params (backend getSpec has none; forwarded as-is)
    * @param {Object} opts.data - PassengerCheckInInfoPostData (passengercheckininfo: ticketId, trxId, information, type)
    * @param {Object} [opts.headers] - Optional request headers
    * @returns {Promise<import("axios").AxiosResponse>}

package/src/endpoints/operations/redemption.js

@@ -9,7 +9,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function redemptionFactory({client, internalAuthTokenProvider}) {
   /**
-   * POST /redemptions - create redemption.
+   * POST /redemptions - create redemption. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -27,12 +27,12 @@ function redemptionFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /redemptions/validate/:passId - validate redemption.
+   * GET /redemptions/validate/:passId - validate redemption. Query: timezone (required per getSpec).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.passId - Pass id
-   * @param {string} [opts.timezone] - Timezone (query param)
+   * @param {string} opts.timezone - Timezone (required query param per btrz-api-operations getSpec)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -46,7 +46,7 @@ function redemptionFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /unredeem - unredeem.
+   * POST /unredeem - unredeem. 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/operations/rms.js

@@ -3,8 +3,34 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} RmsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /rms/manifest-forecast (btrz-api-operations). See get-handler getSpec() and handlers-common parameters().
+ * @typedef {Object} RmsManifestForecastListQuery
+ * @property {string} date - Manifest forecast date (required; YYYY-MM-DD)
+ * @property {string} [time] - Time (HH:mm)
+ * @property {string} [brandId] - Brand id (ObjectId)
+ * @property {string} [productId] - Product id (ObjectId)
+ * @property {string} [routeId] - Route id
+ * @property {string} [amenityGroupId] - Amenity group id
+ * @property {string} [scheduleGroupId] - Schedule group id
+ * @property {string} [originId] - Origin station id (ObjectId)
+ * @property {string} [destinationId] - Destination station id (ObjectId)
+ * @property {string[]} [status] - Manifest status filter (valid manifest status values)
+ * @property {number} [forecastMin] - Minimum forecast value
+ * @property {number} [forecastMax] - Maximum forecast value
+ * @property {number} [loadMin] - Minimum load value
+ * @property {number} [loadMax] - Maximum load value
+ */
+
+/**
+ * Query params for GET /rms/manifest-forecast/:scheduleId (btrz-api-operations). Only common params (no date).
+ * @typedef {Object} RmsManifestForecastGetQuery
+ * @property {string} [originId] - Origin station id (ObjectId)
+ * @property {string} [destinationId] - Destination station id (ObjectId)
+ * @property {string[]} [status] - Manifest status filter
+ * @property {number} [forecastMin] - Minimum forecast value
+ * @property {number} [forecastMax] - Maximum forecast value
+ * @property {number} [loadMin] - Minimum load value
+ * @property {number} [loadMax] - Maximum load value
  */
 
 /**
@@ -19,11 +45,11 @@ function rmsFactory({
 }) {
   const manifestForecasts = {
     /**
-     * GET /rms/manifest-forecast - list manifest forecasts.
+     * GET /rms/manifest-forecast - list manifest forecasts. Query: date required.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {RmsQuery} [opts.query] - Query params
+     * @param {RmsManifestForecastListQuery} [opts.query] - Query params (date required)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -40,11 +66,12 @@ function rmsFactory({
     },
     /**
      * GET /rms/manifest-forecast/:scheduleId - get manifest forecast by schedule id.
+     * Optional query: originId, destinationId, status, forecastMin/Max, loadMin/Max.
      * @param {Object} opts
-     * @param {string} opts.scheduleId - Schedule id
+     * @param {string} opts.scheduleId - Schedule id (UUID4)
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {RmsQuery} [opts.query] - Query params
+     * @param {RmsManifestForecastGetQuery} [opts.query] - Optional query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */