btrz-api-client 8.28.0 → 8.30.0

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

@@ -3,10 +3,34 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var jwtToken = _ref2.jwtToken,
         token = _ref2.token,
@@ -24,6 +48,15 @@ function externalBookingsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var jwtToken = _ref3.jwtToken,
         token = _ref3.token,

package/lib/endpoints/operations/flexpasses.js

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

package/lib/endpoints/operations/loans.js

@@ -1,12 +1,34 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -23,6 +45,14 @@ function loansFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var loanId = _ref3.loanId,
         token = _ref3.token,

package/lib/endpoints/operations/manifest.js

@@ -2,13 +2,37 @@
 
 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;
 
+/**
+ * @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(_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 +47,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 +72,17 @@ function manifestFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -55,6 +100,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 {ManifestQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -70,6 +124,16 @@ function manifestFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,
@@ -88,6 +152,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 +175,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 +202,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 {ManifestQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function outlook(_ref9) {
     var token = _ref9.token,
         jwtToken = _ref9.jwtToken,
@@ -136,6 +228,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 {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(_ref10) {
     var token = _ref10.token,
         jwtToken = _ref10.jwtToken,
@@ -155,6 +257,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
+   * @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(_ref11) {
     var token = _ref11.token,
         jwtToken = _ref11.jwtToken,
@@ -173,6 +286,17 @@ 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 {ManifestQuery} [opts.query] - Query params
+   * @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 +317,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 +343,17 @@ 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 {ManifestQuery} [opts.query] - Query params
+   * @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 +374,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 +400,17 @@ 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 {ManifestQuery} [opts.query] - Query params
+   * @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 +431,17 @@ 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 {ManifestQuery} [opts.query] - Query params
+   * @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 +462,16 @@ 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 {ManifestQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getSalesAuthorizations(_ref18) {
     var token = _ref18.token,
         jwtToken = _ref18.jwtToken,
@@ -303,7 +490,20 @@ 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 {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: function create(_ref19) {
       var token = _ref19.token,
           jwtToken = _ref19.jwtToken,
@@ -324,6 +524,18 @@ 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 {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: function open(_ref20) {
       var token = _ref20.token,
           jwtToken = _ref20.jwtToken,
@@ -347,6 +559,18 @@ 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 {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: function close(_ref21) {
       var token = _ref21.token,
           jwtToken = _ref21.jwtToken,
@@ -372,7 +596,20 @@ 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 {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: function update(_ref22) {
       var token = _ref22.token,
           jwtToken = _ref22.jwtToken,
@@ -393,6 +630,19 @@ 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 {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: function update(_ref23) {
         var token = _ref23.token,
             jwtToken = _ref23.jwtToken,
@@ -412,6 +662,19 @@ 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 {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: function noshow(_ref24) {
         var token = _ref24.token,
             jwtToken = _ref24.jwtToken,
@@ -433,6 +696,17 @@ 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 {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: function get(_ref25) {
       var token = _ref25.token,
           jwtToken = _ref25.jwtToken,
@@ -454,6 +728,17 @@ 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 {ManifestQuery} [opts.query] - Query params
+     * @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 +756,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 +783,16 @@ 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 {ManifestQuery} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     add: function add(_ref28) {
       var token = _ref28.token,
           jwtToken = _ref28.jwtToken,
@@ -505,6 +811,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 {ManifestQuery} [opts.query] - Query params
+     * @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 +842,17 @@ 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
+     * @param {ManifestQuery} [opts.query] - Query params
+     * @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,31 @@
 "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.
+   * @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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,