btrz-api-client 8.29.0 → 8.31.0

package/src/endpoints/operations/manifest.js

@@ -1,10 +1,99 @@
+/* eslint-disable max-len */
 const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * 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({
   client, 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({token, jwtToken, headers, data}) {
     return client({
       url: "/manifests/dispatch/reporting",
@@ -14,6 +103,16 @@ function manifestFactory({
     });
   }
 
+  /**
+   * 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({token, jwtToken, headers, manifestId, data}) {
     return client({
       url: `manifests/${manifestId}/dispatch/reporting`,
@@ -23,6 +122,16 @@ function manifestFactory({
     });
   }
 
+  /**
+   * 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({token, jwtToken, headers, manifestId, data, query}) {
     return client({
       url: `manifests/${manifestId}/dispatches`,
@@ -33,6 +142,15 @@ function manifestFactory({
     });
   }
 
+  /**
+   * 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({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/manifests",
@@ -42,6 +160,15 @@ function manifestFactory({
     });
   }
 
+  /**
+   * 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({
     token, jwtToken, manifestId, query = {}, headers
   }) {
@@ -55,6 +182,15 @@ function manifestFactory({
     });
   }
 
+  /**
+   * 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({
     token, jwtToken, data, headers
   }) {
@@ -66,6 +202,16 @@ function manifestFactory({
     });
   }
 
+  /**
+   * 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({token, jwtToken, providerId, data, headers}) {
     // an HTTP POST request is used to send the query data in the request body because the query may be very large.
     return client({
@@ -77,6 +223,15 @@ function manifestFactory({
     });
   }
 
+  /**
+   * 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({
     token, jwtToken, query = {}, headers
   }) {
@@ -90,6 +245,16 @@ function manifestFactory({
     });
   }
 
+  /**
+   * 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({
     token, jwtToken, query = {}, operations, headers
   }) {
@@ -104,6 +269,17 @@ function manifestFactory({
     });
   }
 
+  /**
+   * 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({
     token, jwtToken, providerId, data, headers, query = {}
   }) {
@@ -116,6 +292,16 @@ function manifestFactory({
     });
   }
 
+  /**
+   * 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({
     token, jwtToken, manifestId, query = {}, data, headers
   }) {
@@ -130,6 +316,16 @@ function manifestFactory({
     });
   }
 
+  /**
+   * 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({
     token, jwtToken, manifestId, userId, headers
   }) {
@@ -142,6 +338,16 @@ function manifestFactory({
     });
   }
 
+  /**
+   * 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({
     token, jwtToken, manifestId, query = {}, data, headers
   }) {
@@ -157,6 +363,16 @@ function manifestFactory({
   }
 
 
+  /**
+   * 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({
     token, jwtToken, manifestId, exceptionId, headers
   }) {
@@ -169,6 +385,16 @@ function manifestFactory({
     });
   }
 
+  /**
+   * 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({
     token, jwtToken, manifestId, query = {}, data, headers
   }) {
@@ -183,6 +409,16 @@ function manifestFactory({
     });
   }
 
+  /**
+   * 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({
     token, jwtToken, manifestId, query = {}, data, headers
   }) {
@@ -197,6 +433,15 @@ function manifestFactory({
     });
   }
 
+  /**
+   * 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({
     token, jwtToken, manifestKey, query = {}, headers
   }) {
@@ -210,7 +455,19 @@ function manifestFactory({
     });
   }
 
+  /** @type {{ create: function, open: function, close: function }} */
   const 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({token, jwtToken, query = {}, headers, data, manifestId, legFromId}) {
       return client({
         url: `/manifests/${manifestId}/checkin/${legFromId}`,
@@ -222,6 +479,16 @@ function manifestFactory({
         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({token, jwtToken, query = {}, headers, manifestId, legFromId}) {
       return client({
         url: `/manifests/${manifestId}/checkin/${legFromId}`,
@@ -237,6 +504,16 @@ function manifestFactory({
         }
       });
     },
+    /**
+     * 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({token, jwtToken, query = {}, headers, manifestId, legFromId}) {
       return client({
         url: `/manifests/${manifestId}/checkin/${legFromId}`,
@@ -254,7 +531,19 @@ function manifestFactory({
     }
   };
 
+  /** @type {{ update: function, tickets: { update: function, noshow: function } }} */
   const 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({token, jwtToken, data, query = {}, headers, manifestId, legFromId}) {
       return client({
         url: `/manifests/${manifestId}/legs/${legFromId}`,
@@ -265,6 +554,18 @@ function manifestFactory({
       });
     },
     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({token, jwtToken, data, query = {}, headers, manifestId, legFromId, ticketId}) {
         return client({
           url: `/manifests/${manifestId}/legs/${legFromId}/tickets/${ticketId}`,
@@ -274,6 +575,17 @@ function manifestFactory({
           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({token, jwtToken, query = {}, headers, manifestId, legFromId, ticketId}) {
         return client({
           url: `/manifests/${manifestId}/legs/${legFromId}/tickets/${ticketId}/noshow`,
@@ -286,6 +598,16 @@ function manifestFactory({
   };
 
   const 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({token, jwtToken, query = {}, responseType = "json", id, headers}) {
       return client({
         url: `/manifests/${id}/reports`,
@@ -298,6 +620,16 @@ function manifestFactory({
   };
 
   const 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({token, jwtToken, manifestId, query = {}, headers, data}) {
       return client({
         url: `/manifests/${manifestId}/labels`,
@@ -307,6 +639,16 @@ function manifestFactory({
         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({token, jwtToken, manifestId, labelId, headers}) {
       return client({
         url: `/manifests/${manifestId}/labels/${labelId}`,
@@ -317,6 +659,15 @@ function manifestFactory({
   };
 
   const 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({token, jwtToken, manifestId, query = {}, headers}) {
       return client({
         url: `/manifests/${manifestId}/trip-close`,
@@ -328,6 +679,17 @@ function manifestFactory({
   };
 
   const 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({token, jwtToken, manifestId, query = {bypassValidation: false}, headers, data}) {
       return client({
         url: `/manifests/${manifestId}/driver-relays`,
@@ -340,6 +702,16 @@ function manifestFactory({
   };
 
   const 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({token, jwtToken, manifestKey, manifestException, headers, query = {}}) {
       return client({
         url: `/manifests/${manifestKey}/manifests-exceptions`,

package/src/endpoints/operations/manifest_leg_for_tickets.js

@@ -1,11 +1,26 @@
-const { authorizationHeaders } = require("../endpoints_helpers");
+const {authorizationHeaders} = require("../endpoints_helpers.js");
 
-function manifestLegForTicketsFactory({ client, internalAuthTokenProvider }) {
-
-  function get({ token, jwtToken, ticketId, params, headers}) {
+/**
+ * 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({client, 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({token, jwtToken, ticketId, params, headers}) {
     return client({
       url: `/manifest-leg-for-tickets/${ticketId}`,
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers }),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
       params
     });
   }

package/src/endpoints/operations/movements.js

@@ -1,9 +1,25 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function movementsFactory({ client, internalAuthTokenProvider }) {
-  function create({ token, jwtToken, movement, query = {}, headers }) {
+/**
+ * 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({client, 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({token, jwtToken, movement, query = {}, headers}) {
     return client({
-      url: `/movements`,
+      url: "/movements",
       method: "post",
       params: query,
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
@@ -14,7 +30,6 @@ function movementsFactory({ client, internalAuthTokenProvider }) {
   return {
     create
   };
-
 }
 
 module.exports = movementsFactory;

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

@@ -1,10 +1,41 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function outlookTripsFactory({client}) {
-  function get({token, query = {}, headers}) {
+/**
+ * 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({client, 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({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/outlook-trips",
-      headers: authorizationHeaders({token, headers}),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
       params: query
     });
   }