btrz-api-client 8.29.0 → 8.31.0

package/lib/endpoints/operations/manifest.js

@@ -2,13 +2,104 @@
 
 var _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; };
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /manifests (btrz-api-operations). See get-manifests getSpec().
+ * @typedef {Object} ManifestsListQuery
+ * @property {string} [providerIds] - Provider IDs of the manifests
+ * @property {string} [routeIds] - Route IDs
+ * @property {string} [scheduleIds] - Schedule IDs
+ * @property {string} [date] - Date (yyyy-mm-dd)
+ * @property {string} [dateFrom] - Start date range (yyyy-mm-dd)
+ * @property {string} [dateTo] - End date range (yyyy-mm-dd)
+ * @property {string} [seatmapId] - Seatmap ID
+ * @property {string} [vehicleId] - Vehicle ID
+ * @property {string} [assignedUserId] - Assigned user ID
+ * @property {boolean} [dispatched] - If manifest was dispatched
+ * @property {boolean} [reviewed] - If manifest was reviewed
+ * @property {string} [sendToSAP] - If manifest should be sent to SAP
+ * @property {string} [operatingCompanyId] - Operating company ID
+ * @property {number} [vehicleFrom] - First vehicle id (range)
+ * @property {number} [vehicleTo] - Last vehicle id (range)
+ * @property {string} [dispatchedStatus] - Filter by dispatched status
+ * @property {boolean} [manifestOnly] - If only manifest (no ticket info)
+ * @property {string} [status] - Comma-separated manifest statuses
+ */
+
+/**
+ * Query params for PUT /manifests (btrz-api-operations). See put-manifest getSpec().
+ * @typedef {Object} ManifestSaveQuery
+ * @property {string} providerId - Provider ID (required)
+ * @property {string} [manifestId] - Manifest ID to update (omit to create)
+ * @property {boolean} [bypassBusValidation] - Bypass bus validation
+ */
+
+/**
+ * Query params for PATCH /manifests (btrz-api-operations). See patch-manifest getSpec().
+ * @typedef {Object} ManifestPatchQuery
+ * @property {string} providerId - Provider ID (required)
+ * @property {string} [routeId] - Route ID for update_schedule
+ * @property {string} [scheduleId] - New schedule ID for update_schedule
+ * @property {string} [oldScheduleId] - Old schedule ID for update_schedule
+ * @property {string} [accommodateOnAnySeat] - "true" to assign missing seats to any available
+ * @property {string} [newdesign] - "true" when using new seatmap design
+ */
+
+/**
+ * Query params for GET /outlook-manifests (btrz-api-operations). See get-outlook-manifests getSpec().
+ * @typedef {Object} OutlookManifestsListQuery
+ * @property {string} providerId - Provider ID (required)
+ * @property {string} productId - Product ID (required)
+ * @property {string} from - Start date (required, yyyy-mm-dd)
+ * @property {string} to - End date (required, yyyy-mm-dd, max 1 month range)
+ * @property {string} [scheduleName] - Schedule name filter
+ * @property {string} [loadFactorFrom] - Min load factor
+ * @property {string} [loadFactorTo] - Max load factor
+ * @property {string} [timeFrom] - Min time filter
+ * @property {string} [timeTo] - Max time filter
+ * @property {string} [originId] - Origin station id
+ * @property {string} [destinationId] - Destination station id
+ * @property {string} [amenityGroupId] - Amenity group id
+ * @property {string} [userId] - Only manifests with this user assigned
+ * @property {string} [withAssignedUsers] - Filter by assigned users (true/false)
+ * @property {string} [status] - Comma-separated statuses (published, paused, planned, canceled)
+ * @property {boolean} [isExtraRun] - Only extra run trips
+ * @property {boolean} [minimalPayload] - Minimal data for five day outlook
+ * @property {string} [labelId] - Label id filter
+ * @property {boolean} [dispatched] - Only dispatched manifests
+ */
+
+/**
+ * Query params for PUT /manifests/:manifestKey/driver-relays (btrz-api-operations). See put-driver-relays-handler getSpec().
+ * @typedef {Object} ManifestDriverRelaysQuery
+ * @property {boolean} [bypassValidations] - If true, bypass driver validations
+ */
+
+/**
+ * Factory for manifests API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} manifest API methods
+ */
+
+
 function manifestFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * POST /manifests/dispatch/reporting - create dispatch reporting.
+   * @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 {Object} opts.data - Request body
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function createDispatchReporting(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -23,6 +114,16 @@ function manifestFactory(_ref) {
     });
   }
 
+  /**
+   * PUT manifests/:manifestId/dispatch/reporting - update dispatch reporting.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @param {string} opts.manifestId - Manifest id
+   * @param {Object} opts.data - Request body
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function updateDispatchReporting(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -38,6 +139,16 @@ function manifestFactory(_ref) {
     });
   }
 
+  /**
+   * POST manifests/:manifestId/dispatches - dispatch manifest. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @param {string} opts.manifestId - Manifest id
+   * @param {Object} opts.data - Request body
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function dispatch(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -55,6 +166,15 @@ function manifestFactory(_ref) {
     });
   }
 
+  /**
+   * GET /manifests - list manifests.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {ManifestsListQuery} [opts.query] - Query params (all optional)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -70,6 +190,15 @@ function manifestFactory(_ref) {
     });
   }
 
+  /**
+   * GET /manifests/:manifestId - get manifest by id. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.manifestId - Manifest id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getById(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,
@@ -88,6 +217,15 @@ function manifestFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /manifests/status - bulk update manifest status.
+   * @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 statusBulkUpdate(_ref7) {
     var token = _ref7.token,
         jwtToken = _ref7.jwtToken,
@@ -102,6 +240,16 @@ function manifestFactory(_ref) {
     });
   }
 
+  /**
+   * POST /all-manifests - get all manifests (POST body for large query).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.providerId] - Provider id
+   * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getAll(_ref8) {
     var token = _ref8.token,
         jwtToken = _ref8.jwtToken,
@@ -119,6 +267,15 @@ function manifestFactory(_ref) {
     });
   }
 
+  /**
+   * GET /outlook-manifests - outlook manifests.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {OutlookManifestsListQuery} [opts.query] - Query params (providerId, productId, from, to required)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function outlook(_ref9) {
     var token = _ref9.token,
         jwtToken = _ref9.jwtToken,
@@ -136,6 +293,16 @@ function manifestFactory(_ref) {
     });
   }
 
+  /**
+   * PATCH /manifests - patch manifests.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {ManifestPatchQuery} [opts.query] - Query params (providerId required)
+   * @param {Object} opts.operations - JSON Patch operations
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function patch(_ref10) {
     var token = _ref10.token,
         jwtToken = _ref10.jwtToken,
@@ -155,6 +322,17 @@ function manifestFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /manifests - save manifest.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.providerId] - Provider id (required by API as query)
+   * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @param {ManifestSaveQuery} [opts.query] - Query params (providerId required; manifestId, bypassBusValidation optional)
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function save(_ref11) {
     var token = _ref11.token,
         jwtToken = _ref11.jwtToken,
@@ -173,6 +351,16 @@ function manifestFactory(_ref) {
     });
   }
 
+  /**
+   * POST /manifests/:manifestId/users - add user to manifest.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.manifestId - Manifest id
+       * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function addUser(_ref12) {
     var token = _ref12.token,
         jwtToken = _ref12.jwtToken,
@@ -193,6 +381,16 @@ function manifestFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /manifests/:manifestId/users/:userId - remove user from manifest.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.manifestId - Manifest id
+   * @param {string} opts.userId - User id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function removeUser(_ref13) {
     var token = _ref13.token,
         jwtToken = _ref13.jwtToken,
@@ -209,6 +407,16 @@ function manifestFactory(_ref) {
     });
   }
 
+  /**
+   * POST /manifests/:manifestId/capacity-exceptions - add capacity exception.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.manifestId - Manifest id
+       * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function addCapacityException(_ref14) {
     var token = _ref14.token,
         jwtToken = _ref14.jwtToken,
@@ -229,6 +437,16 @@ function manifestFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /manifests/:manifestId/capacity-exceptions/:exceptionId - remove capacity exception.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.manifestId - Manifest id
+   * @param {string} opts.exceptionId - Exception id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function removeCapacityException(_ref15) {
     var token = _ref15.token,
         jwtToken = _ref15.jwtToken,
@@ -245,6 +463,16 @@ function manifestFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /manifests/:manifestId/comments - update comment.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.manifestId - Manifest id
+       * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function updateComment(_ref16) {
     var token = _ref16.token,
         jwtToken = _ref16.jwtToken,
@@ -265,6 +493,16 @@ function manifestFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /manifests/:manifestId/status - update manifest status.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.manifestId - Manifest id
+       * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function updateStatus(_ref17) {
     var token = _ref17.token,
         jwtToken = _ref17.jwtToken,
@@ -285,6 +523,15 @@ function manifestFactory(_ref) {
     });
   }
 
+  /**
+   * GET /manifests/:manifestKey/sales-authorizations - get sales authorizations.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.manifestKey - Manifest key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getSalesAuthorizations(_ref18) {
     var token = _ref18.token,
         jwtToken = _ref18.jwtToken,
@@ -303,7 +550,19 @@ function manifestFactory(_ref) {
     });
   }
 
+  /** @type {{ create: function, open: function, close: function }} */
   var checkIn = {
+    /**
+     * POST /manifests/:manifestId/checkin/:legFromId - create check-in.
+     * @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 {Object} opts.data - Request body
+     * @param {string} opts.manifestId - Manifest id
+     * @param {string} opts.legFromId - Leg from id
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref19) {
       var token = _ref19.token,
           jwtToken = _ref19.jwtToken,
@@ -324,6 +583,17 @@ function manifestFactory(_ref) {
         data: data
       });
     },
+
+    /**
+     * PATCH /manifests/:manifestId/checkin/:legFromId (open_check_in) - open check-in.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} [opts.headers] - Optional headers
+     * @param {string} opts.manifestId - Manifest id
+     * @param {string} opts.legFromId - Leg from id
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     open: function open(_ref20) {
       var token = _ref20.token,
           jwtToken = _ref20.jwtToken,
@@ -347,6 +617,17 @@ function manifestFactory(_ref) {
         }
       });
     },
+
+    /**
+     * PATCH /manifests/:manifestId/checkin/:legFromId (close_check_in) - close check-in.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} [opts.headers] - Optional headers
+     * @param {string} opts.manifestId - Manifest id
+     * @param {string} opts.legFromId - Leg from id
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     close: function close(_ref21) {
       var token = _ref21.token,
           jwtToken = _ref21.jwtToken,
@@ -372,7 +653,19 @@ function manifestFactory(_ref) {
     }
   };
 
+  /** @type {{ update: function, tickets: { update: function, noshow: function } }} */
   var legs = {
+    /**
+     * PUT /manifests/:manifestId/legs/:legFromId - update leg.
+     * @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
+     * @param {string} opts.manifestId - Manifest id
+     * @param {string} opts.legFromId - Leg from id
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref22) {
       var token = _ref22.token,
           jwtToken = _ref22.jwtToken,
@@ -393,6 +686,18 @@ function manifestFactory(_ref) {
     },
 
     tickets: {
+      /**
+       * PUT /manifests/:manifestId/legs/:legFromId/tickets/:ticketId - update leg ticket.
+       * @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
+       * @param {string} opts.manifestId - Manifest id
+       * @param {string} opts.legFromId - Leg from id
+       * @param {string} opts.ticketId - Ticket id
+       * @returns {Promise<import("axios").AxiosResponse>}
+       */
       update: function update(_ref23) {
         var token = _ref23.token,
             jwtToken = _ref23.jwtToken,
@@ -412,6 +717,18 @@ function manifestFactory(_ref) {
           data: data
         });
       },
+
+      /**
+       * PUT /manifests/:manifestId/legs/:legFromId/tickets/:ticketId/noshow - mark ticket noshow.
+       * @param {Object} opts
+       * @param {string} [opts.token] - API key
+       * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+      * @param {Object} [opts.headers] - Optional headers
+       * @param {string} opts.manifestId - Manifest id
+       * @param {string} opts.legFromId - Leg from id
+       * @param {string} opts.ticketId - Ticket id
+       * @returns {Promise<import("axios").AxiosResponse>}
+       */
       noshow: function noshow(_ref24) {
         var token = _ref24.token,
             jwtToken = _ref24.jwtToken,
@@ -433,6 +750,16 @@ function manifestFactory(_ref) {
   };
 
   var reports = {
+    /**
+     * GET /manifests/:id/reports - get manifest reports.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} [opts.responseType] - Response type (e.g. "json")
+     * @param {string} opts.id - Manifest id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref25) {
       var token = _ref25.token,
           jwtToken = _ref25.jwtToken,
@@ -454,6 +781,16 @@ function manifestFactory(_ref) {
   };
 
   var labels = {
+    /**
+     * POST /manifests/:manifestId/labels - add label.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.manifestId - Manifest id
+     * @param {Object} [opts.headers] - Optional headers
+     * @param {Object} opts.data - Request body
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     add: function add(_ref26) {
       var token = _ref26.token,
           jwtToken = _ref26.jwtToken,
@@ -471,6 +808,17 @@ function manifestFactory(_ref) {
         data: data
       });
     },
+
+    /**
+     * DELETE /manifests/:manifestId/labels/:labelId - remove label.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.manifestId - Manifest id
+     * @param {string} opts.labelId - Label id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     remove: function remove(_ref27) {
       var token = _ref27.token,
           jwtToken = _ref27.jwtToken,
@@ -487,6 +835,15 @@ function manifestFactory(_ref) {
   };
 
   var tripClose = {
+    /**
+     * POST /manifests/:manifestId/trip-close - add trip close.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.manifestId - Manifest id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     add: function add(_ref28) {
       var token = _ref28.token,
           jwtToken = _ref28.jwtToken,
@@ -505,6 +862,17 @@ function manifestFactory(_ref) {
   };
 
   var driverRelays = {
+    /**
+     * PUT /manifests/:manifestId/driver-relays - update driver relays.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.manifestId - Manifest id
+     * @param {ManifestDriverRelaysQuery} [opts.query] - Query params (bypassValidations optional)
+     * @param {Object} [opts.headers] - Optional headers
+     * @param {Object} opts.data - Request body
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref29) {
       var token = _ref29.token,
           jwtToken = _ref29.jwtToken,
@@ -525,6 +893,16 @@ function manifestFactory(_ref) {
   };
 
   var manifestsExceptions = {
+    /**
+     * PUT /manifests/:manifestKey/manifests-exceptions - update manifest exceptions.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.manifestKey - Manifest key
+     * @param {Object} opts.manifestException - Manifest exception payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref30) {
       var token = _ref30.token,
           jwtToken = _ref30.jwtToken,

package/lib/endpoints/operations/manifest_leg_for_tickets.js

@@ -1,13 +1,30 @@
 "use strict";
 
-var _require = require("../endpoints_helpers"),
+var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for manifest-leg-for-tickets API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} manifest-leg-for-tickets API methods
+ */
+
+
 function manifestLegForTicketsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /manifest-leg-for-tickets/:ticketId - get manifest leg for ticket. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.ticketId - Ticket id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

package/lib/endpoints/operations/movements.js

@@ -1,12 +1,30 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for movements API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} movements API methods
+ */
+
+
 function movementsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * POST /movements - create movement. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.movement - Movement payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

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

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