btrz-api-client 8.30.0 → 8.31.0

package/src/endpoints/inventory/routes.js

@@ -1,6 +1,27 @@
 /* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /routes (btrz-api-inventory). See get-routes getSpec().
+ * @typedef {Object} RoutesListQuery
+ * @property {string} [disabled] - Get enabled or disabled routes [true, false]
+ * @property {string} [productId] - Filter by product id (object id)
+ * @property {string} [routeGTFSID] - Filter by route external ID (GTFS)
+ * @property {string} [providerId] - Filter by provider
+ * @property {string} [name] - Filter by exact name (case sensitive)
+ * @property {string} [partialName] - Filter by partial name (case insensitive)
+ * @property {number} [page] - Page for pagination
+ * @property {boolean} [minimalPayload] - If true, schedules not included in response
+ */
+
+/**
+ * Query params for GET /routes/proration-tables (btrz-api-inventory). See get-proration-tables getSpec().
+ * @typedef {Object} RoutesProrationTablesListQuery
+ * @property {string} [routeId] - Route id
+ * @property {string} [providerId] - Provider id
+ * @property {string} [productId] - Product id (journey pricing)
+ */
+
 /**
  * Factory for routes API (btrz-api-inventory).
  * @param {Object} deps
@@ -10,12 +31,11 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function routesFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /routes/:routeId - get route by id.
+   * GET /routes/:routeId - get route 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.routeId - Route id
-   * @param {Object} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -28,15 +48,15 @@ function routesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /routes/prices - get route prices.
+   * GET /routes/prices - get route prices. Client merges productId, originId, destinationId, channel into query.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.productId - Product id
-   * @param {string} opts.originId - Origin id
-   * @param {string} opts.destinationId - Destination id
-   * @param {string} opts.channel - Channel
-   * @param {Object} [opts.query] - Query params
+   * @param {string} opts.productId - Product id (merged into query)
+   * @param {string} opts.originId - Origin id (merged into query)
+   * @param {string} opts.destinationId - Destination id (merged into query)
+   * @param {string} opts.channel - Channel (merged into query)
+   * @param {Object} [opts.query] - Additional query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -55,7 +75,7 @@ function routesFactory({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 {RoutesListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -67,7 +87,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /routes/:routeId/stations - get route stations.
+   * GET /routes/:routeId/stations - get route stations. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -83,7 +103,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /routes - create route.
+   * POST /routes - create route. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -103,7 +123,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /routes/:routeId - update route.
+   * PUT /routes/:routeId - update route. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -124,7 +144,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /routes/:routeId - remove route.
+   * DELETE /routes/:routeId - remove route. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -145,11 +165,10 @@ function routesFactory({client, internalAuthTokenProvider}) {
   /** @type {{ all: function, create: function, update: function }} */
   const fareTables = {
     /**
-     * GET /routes/fare-tables - list fare tables.
+     * GET /routes/fare-tables - list fare tables. 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.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -165,7 +184,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * POST /routes/:routeId/fare-tables - create fare table.
+     * POST /routes/:routeId/fare-tables - create fare table. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -189,7 +208,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /routes/:routeId/fare-tables/:fareTableId - update fare table.
+     * PUT /routes/:routeId/fare-tables/:fareTableId - update fare table. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -217,7 +236,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
   /** @type {{ create: function }} */
   const stops = {
     /**
-     * POST /routes/:routeId/stops - create stop.
+     * POST /routes/:routeId/stops - create stop. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -241,7 +260,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
   /** @type {{ get: function, create: function, update: function, remove: function }} */
   const fareRules = {
     /**
-     * GET /routes/:routeId/fare-rules - get fare rules.
+     * GET /routes/:routeId/fare-rules - get fare rules. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -258,7 +277,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * POST /routes/:routeId/fare-rules - create fare rule.
+     * POST /routes/:routeId/fare-rules - create fare rule. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -280,7 +299,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /routes/:routeId/fare-rules/:fareRuleId - update fare rule.
+     * PUT /routes/:routeId/fare-rules/:fareRuleId - update fare rule. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -303,7 +322,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * DELETE /routes/:routeId/fare-rules/:fareRuleId - remove fare rule.
+     * DELETE /routes/:routeId/fare-rules/:fareRuleId - remove fare rule. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -326,7 +345,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
   /** @type {{ get: function, create: function, update: function, remove: function }} */
   const priceBuckets = {
     /**
-     * GET /routes/:routeId/price-buckets - get price buckets.
+     * GET /routes/:routeId/price-buckets - get price buckets. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -343,7 +362,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * POST /routes/:routeId/price-buckets - create price bucket.
+     * POST /routes/:routeId/price-buckets - create price bucket. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -365,7 +384,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /routes/:routeId/price-buckets/:bucketId - update price bucket.
+     * PUT /routes/:routeId/price-buckets/:bucketId - update price bucket. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -388,7 +407,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * DELETE /routes/:routeId/price-buckets/:bucketId - remove price bucket.
+     * DELETE /routes/:routeId/price-buckets/:bucketId - remove price bucket. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -411,7 +430,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
   /** @type {{ get: function, update: function }} */
   const crossBorderDistances = {
     /**
-     * GET /routes/:routeId/cross-border-distances - get cross border distances.
+     * GET /routes/:routeId/cross-border-distances - get cross border distances. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -428,7 +447,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /routes/:routeId/cross-border-distances - update cross border distances.
+     * PUT /routes/:routeId/cross-border-distances - update cross border distances. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -459,7 +478,7 @@ function routesFactory({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 {RoutesProrationTablesListQuery} [opts.query] - Query params (routeId, providerId, productId)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -478,7 +497,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.routeId - Route id
-     * @param {string} [opts.productId] - Product id (optional query)
+     * @param {string} [opts.productId] - Product id (optional query; filters by product)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -493,7 +512,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /routes/:routeId/proration-tables - update proration table by route id.
+     * PUT /routes/:routeId/proration-tables - update proration table by route 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

package/src/endpoints/inventory/schedule-groups.js

@@ -1,8 +1,9 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} ScheduleGroupsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /schedule-groups (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} ScheduleGroupsListQuery
+ * @property {number} [page] - Page number to retrieve
  */
 
 /**
@@ -18,7 +19,7 @@ function scheduleGroupsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {ScheduleGroupsQuery} [opts.query] - Query params
+   * @param {ScheduleGroupsListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -30,12 +31,11 @@ function scheduleGroupsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /schedule-groups/:scheduleGroupId - get schedule group by id.
+   * GET /schedule-groups/:scheduleGroupId - get schedule group 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.scheduleGroupId - Schedule group id
-   * @param {ScheduleGroupsQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -47,7 +47,7 @@ function scheduleGroupsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /schedule-groups - create schedule group.
+   * POST /schedule-groups - create schedule group. 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 +65,7 @@ function scheduleGroupsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /schedule-groups/:scheduleGroupId - update schedule group.
+   * PUT /schedule-groups/:scheduleGroupId - update schedule group. 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/schedules.js

@@ -1,6 +1,20 @@
 /* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /routes/schedules (btrz-api-inventory). See get-schedules getSpec().
+ * @typedef {Object} SchedulesListQuery
+ * @property {string} [displayName] - Exact schedule name (case sensitive)
+ * @property {string} [stationId] - Schedules that contain this station on legs
+ * @property {string} [routeId] - Filter by route id
+ * @property {string} [labelId] - Filter by label id
+ * @property {string} [onlyActive] - Get active schedules (mutually exclusive with onlyInactive)
+ * @property {string} [onlyInactive] - Get inactive schedules (mutually exclusive with onlyActive)
+ * @property {string} [date] - Schedules active on this date (MM/DD/YYYY)
+ * @property {number} [page] - Page for pagination
+ * @property {string} [providerId] - Filter by provider
+ */
+
 /**
  * Factory for schedules API (btrz-api-inventory).
  * @param {Object} deps
@@ -14,7 +28,7 @@ function schedulesFactory({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 {SchedulesListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -26,13 +40,12 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /routes/:routeId/schedules/:scheduleId - get schedule by id.
+   * GET /routes/:routeId/schedules/:scheduleId - get schedule 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.routeId - Route id
    * @param {string} opts.scheduleId - Schedule id
-   * @param {Object} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -44,7 +57,7 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /routes/:routeId/schedules - create schedule.
+   * POST /routes/:routeId/schedules - create schedule. 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 +78,7 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /routes/:routeId/schedules/:scheduleId - update schedule.
+   * PUT /routes/:routeId/schedules/:scheduleId - update schedule. 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 +100,7 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /routes/:routeId/schedules/:scheduleId - delete schedule.
+   * DELETE /routes/:routeId/schedules/:scheduleId - delete schedule. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -109,7 +122,7 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
   /** @type {{ create: function, delete: function }} */
   const autoBouncing = {
     /**
-     * POST /routes/schedules/auto-bouncing - create auto bouncing.
+     * POST /routes/schedules/auto-bouncing - create auto bouncing. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -128,7 +141,7 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * DELETE /routes/:routeId/schedules/:parentScheduleId/auto-bouncing - delete auto bouncing.
+     * DELETE /routes/:routeId/schedules/:parentScheduleId/auto-bouncing - delete auto bouncing. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -151,7 +164,7 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
   /** @type {{ create: function, delete: function, update: function }} */
   const exceptions = {
     /**
-     * POST /schedules/:scheduleId/schedule-exceptions - create schedule exception.
+     * POST /schedules/:scheduleId/schedule-exceptions - create schedule exception. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -171,7 +184,7 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * DELETE /schedules/:scheduleId/schedule-exceptions/:exceptionId - delete schedule exception.
+     * DELETE /schedules/:scheduleId/schedule-exceptions/:exceptionId - delete schedule exception. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -190,7 +203,7 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /schedules/:scheduleId/schedule-exceptions/:exceptionId - update schedule exception.
+     * PUT /schedules/:scheduleId/schedule-exceptions/:exceptionId - update schedule exception. 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/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>}
    */