btrz-api-client 8.28.0 → 8.30.0

package/src/endpoints/operations/external-bookings.js

@@ -1,6 +1,28 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} ExternalBookingsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for external-bookings API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} external-bookings API methods
+ */
 function externalBookingsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /external-bookings - create external booking.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.externalBooking - External booking payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @param {ExternalBookingsQuery} [opts.query] - Query params
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, externalBooking, headers, query = {}}) {
     return client({
       url: "/external-bookings",
@@ -11,6 +33,15 @@ function externalBookingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /external-bookings/:ticketId - remove external booking.
+   * @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 remove({jwtToken, token, ticketId, headers}) {
     return client({
       url: `/external-bookings/${ticketId}`,

package/src/endpoints/operations/flexpasses.js

@@ -1,6 +1,23 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for flexpasses API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} flexpasses API methods
+ */
 function flexpassesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * DELETE /flexpasses/:flexpassId/scannings/:tripId - delete scan by trip id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.flexpassId - Flexpass id
+   * @param {string} opts.tripId - Trip id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function deleteScanBytripId({jwtToken, token, flexpassId, tripId, headers}) {
     return client({
       url: `/flexpasses/${flexpassId}/scannings/${tripId}`,

package/src/endpoints/operations/loans.js

@@ -1,10 +1,30 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} LoansQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for loans API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} loans API methods
+ */
 function loansFactory({
   client, internalAuthTokenProvider
 }) {
+  /**
+   * GET /loans - list loans.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {LoansQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     query = {},
@@ -20,6 +40,14 @@ function loansFactory({
     });
   }
 
+  /**
+   * GET /loans/:loanId - get loan by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.loanId - Loan id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({
     loanId, token, headers
   }) {

package/src/endpoints/operations/manifest.js

@@ -1,10 +1,32 @@
+/* eslint-disable max-len */
 const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} ManifestQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * 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 +36,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 +55,17 @@ function manifestFactory({
     });
   }
 
+  /**
+   * POST manifests/:manifestId/dispatches - dispatch manifest.
+   * @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
+   * @param {ManifestQuery} [opts.query] - Query params
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function dispatch({token, jwtToken, headers, manifestId, data, query}) {
     return client({
       url: `manifests/${manifestId}/dispatches`,
@@ -33,6 +76,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 {ManifestQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/manifests",
@@ -42,6 +94,16 @@ function manifestFactory({
     });
   }
 
+  /**
+   * GET /manifests/:manifestId - get manifest by id.
+   * @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 {ManifestQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getById({
     token, jwtToken, manifestId, query = {}, headers
   }) {
@@ -55,6 +117,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 +137,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 +158,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 {ManifestQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function outlook({
     token, jwtToken, query = {}, headers
   }) {
@@ -90,6 +180,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 {ManifestQuery} [opts.query] - Query params
+   * @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 +204,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
+   * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @param {ManifestQuery} [opts.query] - Query params
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function save({
     token, jwtToken, providerId, data, headers, query = {}
   }) {
@@ -116,6 +227,17 @@ 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 {ManifestQuery} [opts.query] - Query params
+   * @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 +252,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 +274,17 @@ 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 {ManifestQuery} [opts.query] - Query params
+   * @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 +300,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 +322,17 @@ 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 {ManifestQuery} [opts.query] - Query params
+   * @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 +347,17 @@ 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 {ManifestQuery} [opts.query] - Query params
+   * @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 +372,16 @@ 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 {ManifestQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getSalesAuthorizations({
     token, jwtToken, manifestKey, query = {}, headers
   }) {
@@ -210,7 +395,20 @@ 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 {ManifestQuery} [opts.query] - Query params
+     * @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 +420,17 @@ 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 {ManifestQuery} [opts.query] - Query params
+     * @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 +446,17 @@ 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 {ManifestQuery} [opts.query] - Query params
+     * @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 +474,20 @@ 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 {ManifestQuery} [opts.query] - Query params
+     * @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 +498,19 @@ 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 {ManifestQuery} [opts.query] - Query params
+       * @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 +520,18 @@ 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 {ManifestQuery} [opts.query] - Query params
+       * @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 +544,17 @@ 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 {ManifestQuery} [opts.query] - Query params
+     * @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 +567,17 @@ 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 {ManifestQuery} [opts.query] - Query params
+     * @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 +587,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 +607,16 @@ 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 {ManifestQuery} [opts.query] - Query params
+     * @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 +628,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 {ManifestQuery} [opts.query] - Query params
+     * @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 +651,17 @@ 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
+     * @param {ManifestQuery} [opts.query] - Query params
+     * @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,27 @@
-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.
+   * @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.params] - Query params (forwarded to API)
+   * @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
     });
   }