btrz-api-client 8.30.0 → 8.31.0

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>}
      */

package/src/endpoints/operations/scheduled_notifications.js

@@ -6,11 +6,6 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  * @property {string} [groupId] - Group id to retrieve
  */
 
-/**
- * PUT and POST /scheduled-notifications do not define query params in backend getSpec. Use for optional query keys forwarded as-is.
- * @typedef {Object} ScheduledNotificationsPostQuery
- */
-
 /**
  * Factory for scheduled-notifications API (btrz-api-operations).
  * @param {Object} deps
@@ -37,7 +32,7 @@ function scheduledNotificationsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /scheduled-notifications/:id - get scheduled notification by id.
+   * GET /scheduled-notifications/:id - get scheduled notification 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
@@ -54,13 +49,12 @@ function scheduledNotificationsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /scheduled-notifications/:id - update scheduled notification. Backend getSpec has no query params; query is passed through.
+   * PUT /scheduled-notifications/:id - update scheduled notification. 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 - Scheduled notification id (ObjectId)
    * @param {Object} opts.data - ScheduledNotificationPostData
-   * @param {ScheduledNotificationsPostQuery} [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 SCHEDULEDNOTIFICATION_NOT_FOUND, 409 SCHEDULED_NOTIFICATION_EXISTS
    */
@@ -75,7 +69,7 @@ function scheduledNotificationsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /scheduled-notifications/:id - remove scheduled notification.
+   * DELETE /scheduled-notifications/:id - remove scheduled notification. 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,11 +86,10 @@ function scheduledNotificationsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /scheduled-notifications - create scheduled notification. Backend getSpec has no query params; query is passed through.
+   * POST /scheduled-notifications - create scheduled notification. 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 {ScheduledNotificationsPostQuery} [opts.query] - Optional query params (backend getSpec has none; forwarded as-is)
    * @param {Object} opts.data - ScheduledNotificationPostData
    * @param {Object} [opts.headers] - Optional request headers
    * @returns {Promise<import("axios").AxiosResponse>} 409 SCHEDULED_NOTIFICATION_EXISTS

package/src/endpoints/operations/segments.js

@@ -1,9 +1,9 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for GET /products/:productId/segments/:ticketId (btrz-api-operations). Client passes providerId as query.
+ * Query param for GET /products/:productId/segments/:ticketId (btrz-api-operations getSpec). Client passes via opts.providerId.
  * @typedef {Object} SegmentsListQuery
- * @property {string} [providerId] - Provider/account id
+ * @property {string} [providerId] - Provider/account id (Id of the provider account)
  */
 
 /**

package/src/endpoints/operations/sold-items-fulfillment.js

@@ -1,8 +1,9 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} SoldItemsFulfillmentQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /sold-items/fulfillment (btrz-api-operations). See 01-get-fulfillment-handler getSpec().
+ * @typedef {Object} SoldItemsFulfillmentListQuery
+ * @property {string} soldItemIds - Comma-separated sold item IDs (required)
  */
 
 /**
@@ -18,7 +19,7 @@ function soldItemsFulfillmentFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {SoldItemsFulfillmentQuery} [opts.query] - Query params
+   * @param {SoldItemsFulfillmentListQuery} [opts.query] - Query params (soldItemIds required)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/operations/sold-items.js

@@ -1,8 +1,17 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} SoldItemsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /sold-items list (btrz-api-operations). See get-handler getSpec().
+ * @typedef {Object} SoldItemsListQuery
+ * @property {number} [page] - Page number to retrieve
+ * @property {string} [from] - Ticket manifest date from (yyyy-mm-dd; range max 31 days)
+ * @property {string} [to] - Ticket manifest date to (yyyy-mm-dd; range max 31 days)
+ */
+
+/**
+ * Query params for GET /sold-items/:soldItemId (btrz-api-operations). See get-by-id-handler getSpec().
+ * @typedef {Object} SoldItemsGetQuery
+ * @property {string} [providerId] - Provider account id (ObjectId)
  */
 
 /**
@@ -19,8 +28,8 @@ function soldItems({client, internalAuthTokenProvider}) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.soldItemId - Sold item id
+   * @param {SoldItemsGetQuery} [opts.query] - Optional query (providerId)
    * @param {Object} [opts.headers] - Optional headers
-   * @param {SoldItemsQuery} [opts.query] - Query params
    * @returns {Promise<import("axios").AxiosResponse>}
    */
   function get({token, jwtToken, soldItemId, headers, query}) {
@@ -35,8 +44,8 @@ function soldItems({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {SoldItemsListQuery} [opts.query] - Query params (page, from, to)
    * @param {Object} [opts.headers] - Optional headers
-   * @param {SoldItemsQuery} [opts.query] - Query params
    * @returns {Promise<import("axios").AxiosResponse>}
    */
   function all({token, jwtToken, headers, query}) {

package/src/endpoints/operations/tickets.js

@@ -1,7 +1,8 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} TicketsQuery
+ * Query params for GET /tickets list (btrz-api-operations). providerId merged when opts.providerId set.
+ * @typedef {Object} TicketsListQuery
  * @property {string} [providerId] - Provider account ID
  */
 
@@ -14,13 +15,12 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function ticketsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /tickets/:id - get ticket by id.
+   * GET /tickets/:id - get ticket by id. API does not accept query params (btrz-api-operations).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.id - Ticket id
    * @param {Object} [opts.headers] - Optional headers
-   * @param {TicketsQuery} [opts.query] - Query params
    * @returns {Promise<import("axios").AxiosResponse>}
    */
   function get({token, jwtToken, id, headers, query}) {
@@ -73,7 +73,7 @@ function ticketsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {TicketsQuery} [opts.query] - Query params
+   * @param {TicketsListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @param {string} [opts.providerId] - Provider id
    * @returns {Promise<import("axios").AxiosResponse>}

package/src/endpoints/operations/transaction.js

@@ -9,7 +9,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function transactionFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /transaction/:id - get transaction by id.
+   * GET /transaction/:id - get transaction by id. providerId passed as query param in URL.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/src/endpoints/operations/transactions.js

@@ -1,11 +1,6 @@
 /* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-/**
- * @typedef {Object} TransactionsQuery
- * @property {string} [providerId] - Provider account ID
- */
-
 /**
  * Factory for transactions API (btrz-api-operations).
  * @param {Object} deps
@@ -15,12 +10,11 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function transactionsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /transactions/:trxId - get transaction by id.
+   * GET /transactions/:trxId - get transaction 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.trxId - Transaction id
-   * @param {TransactionsQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -33,11 +27,10 @@ function transactionsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /transactions - list transactions.
+   * GET /transactions - list transactions. 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 {TransactionsQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -128,14 +121,14 @@ function transactionsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /transactions/:transactionId/cancellable-items - get cancellable items.
+   * GET /transactions/:transactionId/cancellable-items - get cancellable items. Query: displayAll, channel (channel required per getSpec).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.transactionId - Transaction id
    * @param {Object} [opts.headers] - Optional headers
-   * @param {boolean} [opts.displayAll] - Whether to display all items
-   * @param {string} [opts.channel] - Channel
+   * @param {boolean} [opts.displayAll] - Display all transaction items whether cancellable or not
+   * @param {string} [opts.channel] - Channel (required per btrz-api-operations getSpec)
    * @returns {Promise<import("axios").AxiosResponse>}
    */
   function cancellableItems({token, jwtToken, transactionId, headers, displayAll, channel}) {
@@ -199,12 +192,11 @@ function transactionsFactory({client, internalAuthTokenProvider}) {
 
   const creditNotes = {
     /**
-     * POST /transactions/:transactionId/credit-notes - create credit note.
+     * POST /transactions/:transactionId/credit-notes - create credit note. 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.transactionId - Transaction id
-     * @param {TransactionsQuery} [opts.query] - Query params
      * @param {Object} opts.creditNote - Credit note payload
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}

package/src/endpoints/operations/transport_regulations.js

@@ -13,7 +13,7 @@ const {
 function transportRegulationsFactory({client, internalAuthTokenProvider}) {
   const cnrt = {
     /**
-     * POST /transport-regulations/cnrt/manifests - create CNRT manifest.
+     * POST /transport-regulations/cnrt/manifests - create CNRT manifest. API does not accept query params.
      * @param {Object} opts
      * @param {Object} opts.data - Request body
      * @param {string} [opts.token] - API key

package/src/endpoints/operations/trip_change_info.js

@@ -1,5 +1,17 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /trip-change-info/:productId (btrz-api-operations get-trip-change-info getSpec).
+ * @typedef {Object} TripChangeInfoGetQuery
+ * @property {string} [providerId] - Provider account id
+ * @property {string} [ticketNumber] - Ticket number (required for Reservation products)
+ * @property {string} [lastName] - Passenger last name (required for Reservation products)
+ * @property {string} [departureDate] - Departure date yyyy-mm-dd (required for Reservation products)
+ * @property {string} [returnDate] - Return date yyyy-mm-dd (optional for Reservation products)
+ * @property {string} [ticketId] - Ticket id
+ * @property {string} [channel] - Sales change channel (default websales)
+ */
+
 /**
  * Factory for trip-change-info API (btrz-api-operations).
  * @param {Object} deps
@@ -14,7 +26,7 @@ function tripChangeInfoFactory({client, internalAuthTokenProvider}) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.productId - Product id
-   * @param {Object} [opts.params] - Query params (forwarded to API)
+   * @param {TripChangeInfoGetQuery} [opts.params] - Query params (providerId, ticketNumber, lastName, etc.)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/operations/vehicle_assignments.js

@@ -3,8 +3,13 @@ const {
 } = require("../endpoints_helpers.js");
 
 /**
- * @typedef {Object} VehicleAssignmentsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /vehicle-assignments list (btrz-api-operations get-handler getSpec).
+ * @typedef {Object} VehicleAssignmentsListQuery
+ * @property {string} [name] - Partial or full name of the vehicle assignment
+ * @property {string} [effectiveFrom] - Valid-from date (format per API)
+ * @property {string} [effectiveTo] - Valid-to date (format per API)
+ * @property {string} [status] - Status, comma-separated; valid: draft, published
+ * @property {number} [page] - Page number (20 records per page)
  */
 
 /**
@@ -33,7 +38,7 @@ function vehicleAssignmentFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * GET /vehicle-assignments/:vehicleAssignmentId - get vehicle assignment by id.
+     * GET /vehicle-assignments/:vehicleAssignmentId - get vehicle assignment 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
@@ -47,7 +52,7 @@ function vehicleAssignmentFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * POST /vehicle-assignments - create vehicle assignment.
+     * POST /vehicle-assignments - create vehicle assignment. 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 +69,7 @@ function vehicleAssignmentFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /vehicle-assignments/:vehicleAssignmentId - update vehicle assignment.
+     * PUT /vehicle-assignments/:vehicleAssignmentId - update vehicle assignment. 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/vouchers.js

@@ -3,11 +3,6 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
-/**
- * @typedef {Object} VouchersQuery
- * @property {string} [providerId] - Provider account ID
- */
-
 /**
  * Factory for vouchers API (btrz-api-operations).
  * @param {Object} deps
@@ -19,12 +14,11 @@ function vouchersFactory({
   client, internalAuthTokenProvider
 }) {
   /**
-   * POST /vouchers - create voucher.
+   * POST /vouchers - create voucher. 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 {VouchersQuery} [opts.query] - Query params
    * @param {Object} [opts.voucher] - Voucher payload
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -46,12 +40,11 @@ function vouchersFactory({
   }
 
   /**
-   * POST /vouchers/compensations - create compensation.
+   * POST /vouchers/compensations - create compensation. 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.compensation - Compensation payload
-   * @param {VouchersQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */