btrz-api-client 8.29.0 → 8.31.0

package/src/endpoints/inventory/schedules.js

@@ -1,6 +1,37 @@
+/* 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
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, delete: function, autoBouncing: object, exceptions: object }}
+ */
 function schedulesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /routes/schedules - list schedules.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {SchedulesListQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, query = {}, headers}) {
     return client.get("/routes/schedules", {
       params: query,
@@ -8,6 +39,16 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, routeId, scheduleId, headers, query = {}}) {
     return client.get(`/routes/${routeId}/schedules/${scheduleId}`, {
       params: query,
@@ -15,6 +56,16 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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
+   * @param {string} opts.routeId - Route id
+   * @param {Object} opts.data - Schedule payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, data, routeId, headers}) {
     return client({
       url: `/routes/${routeId}/schedules`,
@@ -26,6 +77,17 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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
+   * @param {string} opts.routeId - Route id
+   * @param {string} opts.scheduleId - Schedule id
+   * @param {Object} opts.data - Schedule payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, data, routeId, scheduleId, headers}) {
     return client({
       url: `/routes/${routeId}/schedules/${scheduleId}`,
@@ -37,6 +99,16 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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
+   * @param {string} opts.routeId - Route id
+   * @param {string} opts.scheduleId - Schedule id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function deleteSchedule({token, jwtToken, routeId, scheduleId, headers}) {
     return client({
       url: `/routes/${routeId}/schedules/${scheduleId}`,
@@ -47,7 +119,17 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /** @type {{ create: function, delete: function }} */
   const autoBouncing = {
+    /**
+     * 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
+     * @param {Object} opts.data - Auto bouncing payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: ({token, jwtToken, data, headers}) => {
       return client({
         url: "/routes/schedules/auto-bouncing",
@@ -58,6 +140,16 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
         data
       });
     },
+    /**
+     * 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
+     * @param {string} opts.routeId - Route id
+     * @param {string} opts.parentScheduleId - Parent schedule id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     delete: ({token, jwtToken, routeId, parentScheduleId, headers}) => {
       return client({
         url: `/routes/${routeId}/schedules/${parentScheduleId}/auto-bouncing`,
@@ -69,7 +161,18 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
     }
   };
 
+  /** @type {{ create: function, delete: function, update: function }} */
   const exceptions = {
+    /**
+     * 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
+     * @param {string} opts.scheduleId - Schedule id
+     * @param {Object} opts.data - Exception payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: ({token, jwtToken, data, scheduleId, headers}) => {
       return client({
         url: `/schedules/${scheduleId}/schedule-exceptions`,
@@ -80,6 +183,16 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
         data
       });
     },
+    /**
+     * 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
+     * @param {string} opts.scheduleId - Schedule id
+     * @param {string} opts.exceptionId - Exception id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     delete: ({token, jwtToken, scheduleId, exceptionId, headers}) => {
       return client({
         url: `/schedules/${scheduleId}/schedule-exceptions/${exceptionId}`,
@@ -89,6 +202,17 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
         })
       });
     },
+    /**
+     * 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
+     * @param {string} opts.scheduleId - Schedule id
+     * @param {string} opts.exceptionId - Exception id
+     * @param {Object} opts.data - Exception payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: ({token, jwtToken, data, scheduleId, exceptionId, headers}) => {
       return client({
         url: `/schedules/${scheduleId}/schedule-exceptions/${exceptionId}`,

package/src/endpoints/inventory/seatclasses.js

@@ -1,7 +1,22 @@
 /* eslint-disable import/extensions */
 const {authorizationHeaders} = require("./../endpoints_helpers");
 
+/**
+ * Factory for seat-classes API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, update: function, remove: function, create: function }}
+ */
 function seatClassesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * 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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/seat-classes",
@@ -11,6 +26,15 @@ function seatClassesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, id, query = {}, headers}) {
     return client({
       url: `/seat-classes/${id}`,
@@ -20,6 +44,16 @@ function seatClassesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, id, data, query = {}, headers}) {
     return client({
       url: `/seat-classes/${id}`,
@@ -30,6 +64,15 @@ function seatClassesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({token, jwtToken, id, query = {}, headers}) {
     return client({
       url: `/seat-classes/${id}`,
@@ -39,6 +82,15 @@ function seatClassesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, data, query = {}, headers}) {
     return client({
       url: "/seat-classes",

package/src/endpoints/inventory/seatfees.js

@@ -1,9 +1,31 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * 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
+ */
+
+/**
+ * Factory for seat-fees API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function }}
+ */
 function seatfeesFactory({client, internalAuthTokenProvider}) {
-  
+  /**
+   * GET /seat-fees - list seat fees.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {SeatFeesListQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     query = {},
@@ -15,13 +37,30 @@ function seatfeesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({seatfeeId, token, headers}) {
     return client.get(`/seat-fees/${seatfeeId}`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
-  function create({ jwtToken, token, seatfee, headers }) {
+  /**
+   * 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
+   * @param {Object} opts.seatfee - Seat fee payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({jwtToken, token, seatfee, headers}) {
     return client({
       url: "/seat-fees",
       method: "post",
@@ -32,6 +71,16 @@ function seatfeesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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
+   * @param {string} opts.seatfeeId - Seat fee id
+   * @param {Object} opts.seatfee - Seat fee payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, seatfeeId, seatfee, headers}) {
     return client({
       url: `/seat-fees/${seatfeeId}`,

package/src/endpoints/inventory/seatmaps.js

@@ -1,12 +1,74 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * 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
+ */
+
+/**
+ * Factory for seatmaps API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, getById: function, create: function, remove: function, update: function, getOccupiedSeats: function }}
+ */
 function seatmapsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /seatmaps - list seatmaps.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {SeatmapsListQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, query = {}, headers}) {
     return client.get("/seatmaps", {
       params: query,
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
+  /**
+   * GET /seatmaps/:seatmapId/available-seats/:routeId/:scheduleId/:manifestDate - get available seats.
+   * @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 {string} opts.routeId - Route id
+   * @param {string} opts.scheduleId - Schedule id
+   * @param {string} opts.manifestDate - Manifest date
+   * @param {SeatmapsAvailableSeatsQuery} [opts.query] - Query params (originId, destinationId, etc.)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({seatmapId, routeId, scheduleId, manifestDate, query = {}, token, headers}) {
     return client.get(`/seatmaps/${seatmapId}/available-seats/${routeId}/${scheduleId}/${manifestDate}`, {
       params: query,
@@ -14,6 +76,16 @@ function seatmapsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /seatmaps/:seatmapId - get seatmap by id.
+   * @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 {string} [opts.providerId] - Optional account id to scope lookup (query)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getById({seatmapId, token, jwtToken, query = {}, headers}) {
     return client.get(`/seatmaps/${seatmapId}`, {
       params: query,
@@ -21,6 +93,15 @@ function seatmapsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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
+   * @param {Object} opts.seatmap - Seatmap payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, seatmap, headers}) {
     return client({
       url: "/seatmaps",
@@ -32,6 +113,16 @@ function seatmapsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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
+   * @param {string} opts.seatmapId - Seatmap id
+   * @param {Object} opts.seatmap - Seatmap payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, seatmapId, seatmap, headers}) {
     return client({
       url: `/seatmaps/${seatmapId}`,
@@ -43,6 +134,15 @@ function seatmapsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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
+   * @param {string} opts.seatmapId - Seatmap id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({token, jwtToken, seatmapId, headers}) {
     return client({
       url: `/seatmaps/${seatmapId}`,
@@ -51,6 +151,16 @@ function seatmapsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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 {SeatmapsOccupiedSeatsQuery} [opts.query] - Query (newdesign required)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getOccupiedSeats({token, jwtToken, seatmapId, query = {}, headers}) {
     return client.get(`/seatmaps/${seatmapId}/occupied-seats`, {
       params: query,

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

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

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

@@ -2,7 +2,30 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /segments-information (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} SegmentsInformationQuery
+ * @property {string} [originId] - Filter by origin ID (ObjectId format)
+ * @property {string} [destinationId] - Filter by destination ID (ObjectId format)
+ */
+
+/**
+ * Factory for segments-information API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, remove: function }}
+ */
 function segmentsInformationFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /segments-information - list segments information.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {SegmentsInformationQuery} [opts.query] - Query params (originId, destinationId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     jwtToken,
@@ -15,12 +38,30 @@ function segmentsInformationFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /segments-information/:segmentInformationId - get segment information by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.segmentInformationId - Segment information id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({segmentInformationId, token, headers, jwtToken}) {
     return client.get(`/segments-information/${segmentInformationId}`, {
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * POST /segments-information - create segment information.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.segmentInformation - Segment information payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, segmentInformation, headers}) {
     return client({
       url: "/segments-information",
@@ -32,6 +73,15 @@ function segmentsInformationFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /segments-information/:segmentInformationId - remove segment information.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.segmentInformationId - Segment information id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({jwtToken, segmentInformationId, token, headers}) {
     return client({
       url: `/segments-information/${segmentInformationId}`,
@@ -40,6 +90,16 @@ function segmentsInformationFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /segments-information/:segmentInformationId - update segment information.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.segmentInformationId - Segment information id
+   * @param {Object} opts.segmentInformation - Segment information payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, segmentInformationId, segmentInformation, headers}) {
     return client({
       url: `/segments-information/${segmentInformationId}`,