btrz-api-client 8.29.0 → 8.31.0

package/lib/endpoints/inventory/schedules.js

@@ -1,12 +1,45 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -19,6 +52,16 @@ function schedulesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var token = _ref3.token,
         routeId = _ref3.routeId,
@@ -33,6 +76,16 @@ function schedulesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -50,6 +103,17 @@ function schedulesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -68,6 +132,16 @@ function schedulesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,
@@ -84,7 +158,17 @@ function schedulesFactory(_ref) {
     });
   }
 
+  /** @type {{ create: function, delete: function }} */
   var 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: function create(_ref7) {
       var token = _ref7.token,
           jwtToken = _ref7.jwtToken,
@@ -100,6 +184,16 @@ function schedulesFactory(_ref) {
         data: 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: function _delete(_ref8) {
       var token = _ref8.token,
           jwtToken = _ref8.jwtToken,
@@ -117,7 +211,18 @@ function schedulesFactory(_ref) {
     }
   };
 
+  /** @type {{ create: function, delete: function, update: function }} */
   var 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: function create(_ref9) {
       var token = _ref9.token,
           jwtToken = _ref9.jwtToken,
@@ -134,6 +239,16 @@ function schedulesFactory(_ref) {
         data: 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: function _delete(_ref10) {
       var token = _ref10.token,
           jwtToken = _ref10.jwtToken,
@@ -149,6 +264,17 @@ function schedulesFactory(_ref) {
         })
       });
     },
+    /**
+     * 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: function update(_ref11) {
       var token = _ref11.token,
           jwtToken = _ref11.jwtToken,

package/lib/endpoints/inventory/seatclasses.js

@@ -4,10 +4,27 @@
 var _require = require("./../endpoints_helpers"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -23,6 +40,15 @@ function seatClassesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -39,6 +65,16 @@ function seatClassesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -57,6 +93,15 @@ function seatClassesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -73,6 +118,15 @@ function seatClassesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,

package/lib/endpoints/inventory/seatfees.js

@@ -1,13 +1,37 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -20,6 +44,14 @@ function seatfeesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var seatfeeId = _ref3.seatfeeId,
         token = _ref3.token,
@@ -30,6 +62,15 @@ function seatfeesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -46,6 +87,16 @@ function seatfeesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var jwtToken = _ref5.jwtToken,
         token = _ref5.token,

package/lib/endpoints/inventory/seatmaps.js

@@ -1,12 +1,63 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+/* eslint-disable max-len */
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -18,6 +69,19 @@ function seatmapsFactory(_ref) {
       headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, headers: 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(_ref3) {
     var seatmapId = _ref3.seatmapId,
         routeId = _ref3.routeId,
@@ -34,6 +98,16 @@ function seatmapsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var seatmapId = _ref4.seatmapId,
         token = _ref4.token,
@@ -48,6 +122,15 @@ function seatmapsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -64,6 +147,16 @@ function seatmapsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,
@@ -81,6 +174,15 @@ function seatmapsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref7) {
     var token = _ref7.token,
         jwtToken = _ref7.jwtToken,
@@ -94,6 +196,16 @@ function seatmapsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref8) {
     var token = _ref8.token,
         jwtToken = _ref8.jwtToken,

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

@@ -3,10 +3,35 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

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

@@ -3,10 +3,35 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -20,6 +45,15 @@ function segmentsInformationFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var segmentInformationId = _ref3.segmentInformationId,
         token = _ref3.token,
@@ -31,6 +65,15 @@ function segmentsInformationFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -47,6 +90,15 @@ function segmentsInformationFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var jwtToken = _ref5.jwtToken,
         segmentInformationId = _ref5.segmentInformationId,
@@ -60,6 +112,16 @@ function segmentsInformationFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref6) {
     var jwtToken = _ref6.jwtToken,
         token = _ref6.token,