btrz-api-client 8.29.0 → 8.31.0

package/lib/endpoints/operations/parcels.js

@@ -2,14 +2,50 @@
 
 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; };
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /parcels list (btrz-api-operations). See get-parcel-handler getSpec().
+ * @typedef {Object} ParcelsListQuery
+ * @property {string} [trxId] - Transaction ID
+ * @property {string} [transactionId] - Transaction ID (alias)
+ * @property {string} [parcelId] - Parcel ID
+ * @property {string} [dateFrom] - Filter from date
+ * @property {string} [dateTo] - Filter to date
+ * @property {string} [originId] - Origin station ID
+ * @property {string} [destinationId] - Destination station ID
+ * @property {string} [trackingStatus] - Tracking status
+ * @property {boolean} [notInManifest] - Exclude parcels already in a manifest
+ * @property {string} [providerId] - Provider account ID (also set via opts.providerId)
+ * @property {string} [lookupSearchParams] - Search for lookup
+ * @property {number} [page] - Page number
+ * @property {number} [recordsPerPage] - Records per page
+ * @property {boolean} [assignableToManifest] - Only parcels assignable to manifest
+ */
+
+/**
+ * Factory for parcels API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} parcels API methods
+ */
+
+
 function parcelFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /parcels/:id - get parcel by id. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Parcel id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -22,6 +58,16 @@ function parcelFactory(_ref) {
     });
   }
 
+  /**
+   * GET /parcels - list parcels.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {ParcelsListQuery} [opts.query] - Query params (providerId merged if opts.providerId set)
+   * @param {string} [opts.providerId] - Provider id (merged into query)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -38,6 +84,17 @@ function parcelFactory(_ref) {
     });
   }
 
+  /**
+   * POST /parcels/:id/scans - add scan to parcel. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Parcel id
+   * @param {string} opts.operationType - Operation type
+   * @param {Object} opts.locationData - Location data payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function addScan(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -54,6 +111,16 @@ function parcelFactory(_ref) {
     });
   }
 
+  /**
+   * POST /parcels/:id/user-comments - add comment to parcel. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Parcel id
+   * @param {Object} opts.comment - Comment payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function addComment(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -69,6 +136,16 @@ function parcelFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /parcels/:id/user-comments/:commentId - delete parcel comment. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Parcel id
+   * @param {string} opts.commentId - Comment id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function deleteComment(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,

package/lib/endpoints/operations/parcels_manifests.js

@@ -1,12 +1,44 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /parcels-manifests (btrz-api-operations getSpec).
+ * @typedef {Object} ParcelsManifestsListQuery
+ * @property {string} [date] - Date of manifests (ParcelsManifests.DATE_FORMAT)
+ * @property {string} [dateFrom] - Start date range (same format)
+ * @property {string} [dateTo] - End date range (same format)
+ * @property {string} [originId] - Origin (departure) station ID (24 hex chars)
+ * @property {string} [destinationId] - Destination station ID (24 hex chars)
+ * @property {string} [externalId] - External id associated
+ * @property {number} [page] - Page to return
+ * @property {number} [recordsPerPage] - Records per page (max 100)
+ */
+
+/**
+ * Factory for parcels-manifests API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} parcels-manifests API (all, get, create, parcels, vehicles)
+ */
+
+
 function parcelsManifestsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /parcels-manifests - list parcels manifests for the account.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {ParcelsManifestsListQuery} [opts.query] - List filters: date, dateFrom, dateTo, originId, destinationId, externalId, page, recordsPerPage
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} GetParcelManifestsResponse; 400 WRONG_DATA, 401 Unauthorized
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -20,6 +52,15 @@ function parcelsManifestsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /parcels-manifests/:id - get parcels 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.id - Parcel manifest id (ObjectId)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} response.data parcel manifest; 404 PARCELMANIFEST_NOT_FOUND
+   */
   function get(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -32,6 +73,18 @@ function parcelsManifestsFactory(_ref) {
       headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
     });
   }
+
+  /**
+   * POST /parcels-manifests - create parcels manifest. Body: ParcelManifestPostData.
+   * Backend getSpec does not define query params; query is passed through as-is if provided.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {ParcelsManifestsPostQuery} [opts.query] - Optional query params (backend getSpec has none; forwarded as-is)
+   * @param {Object} opts.data - Parcel manifest payload (parcelmanifest / ParcelManifestPostData)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} response.data NewParcelManifestResponse; 404, 409 on validation errors
+   */
   function create(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -50,6 +103,16 @@ function parcelsManifestsFactory(_ref) {
   }
 
   var parcels = {
+    /**
+     * DELETE /parcels-manifests/:manifestId/parcels/:parcelId - remove parcel from 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 {string} opts.manifestId - Parcel manifest id (ObjectId)
+     * @param {string} opts.parcelId - Parcel id (ObjectId)
+     * @param {Object} [opts.headers] - Optional request headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     remove: function remove(_ref5) {
       var token = _ref5.token,
           jwtToken = _ref5.jwtToken,
@@ -63,6 +126,17 @@ function parcelsManifestsFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * POST /parcels-manifests/:manifestId/parcels - create parcel on 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 {string} opts.manifestId - Parcel manifest id (ObjectId)
+     * @param {Object} opts.data - Parcel payload (parcels, optional overrideOandD)
+     * @param {Object} [opts.headers] - Optional request headers
+     * @returns {Promise<import("axios").AxiosResponse>} PostParcelsManifestsResponse; 400 WRONG_DATA, 404, 409 CAN_ADD_PARCEL_TO_MANIFEST_BECAUSE_OF_CUTOFF
+     */
     create: function create(_ref6) {
       var token = _ref6.token,
           jwtToken = _ref6.jwtToken,
@@ -83,6 +157,16 @@ function parcelsManifestsFactory(_ref) {
   };
 
   var vehicles = {
+    /**
+     * POST /parcels-manifests/:manifestId/vehicles - create or update vehicle on 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 {string} opts.manifestId - Parcel manifest id (ObjectId)
+     * @param {Object} opts.data - Vehicle payload (vehicleId required)
+     * @param {Object} [opts.headers] - Optional request headers
+     * @returns {Promise<import("axios").AxiosResponse>} PostVehicleManifestsResponse; 400 WRONG_DATA, 404 MANIFEST_NOT_FOUND, 409 MANIFEST_HAS_PASSENGERS
+     */
     createOrUpdate: function createOrUpdate(_ref7) {
       var token = _ref7.token,
           jwtToken = _ref7.jwtToken,

package/lib/endpoints/operations/passenger_check_in_info.js

@@ -1,12 +1,38 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /passenger-check-in-info (btrz-api-operations getSpec).
+ * @typedef {Object} PassengerCheckInInfoListQuery
+ * @property {string} documentType - Document type id (ObjectId; required)
+ * @property {string} documentNumber - Document number of the passenger (required)
+ * @property {string} [providerId] - Provider/account id; defaults to authenticated account when omitted
+ */
+
+/**
+ * Factory for passenger-check-in-info API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} passenger-check-in-info API methods
+ */
+
+
 function passengerCheckInInfoFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /passenger-check-in-info - list passenger check-in info by document.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {PassengerCheckInInfoListQuery} opts.query - documentType, documentNumber, optional providerId
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} GetPassengerCheckInInfoResponse; 400 WRONG_DATA, INVALID_DOCUMENTTYPE_ID
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -20,6 +46,15 @@ function passengerCheckInInfoFactory(_ref) {
     });
   }
 
+  /**
+   * GET /passenger-check-in-info/:id - get passenger check-in info by id. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Passenger check-in info id (ObjectId)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -33,6 +68,16 @@ function passengerCheckInInfoFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /passenger-check-in-info/:id - update passenger check-in info. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Passenger check-in info id (ObjectId)
+   * @param {Object} opts.data - PassengerCheckInInfoPutData
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} 404 PASSENGERCHECKININFO_NOT_FOUND
+   */
   function update(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -58,6 +103,15 @@ function passengerCheckInInfoFactory(_ref) {
   //   });
   // }
 
+  /**
+   * POST /passenger-check-in-info - create passenger check-in info. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - PassengerCheckInInfoPostData (passengercheckininfo: ticketId, trxId, information, type)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,

package/lib/endpoints/operations/redemption.js

@@ -1,12 +1,30 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for redemptions API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} redemptions API methods
+ */
+
+
 function redemptionFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * POST /redemptions - create redemption. 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.redemption - Redemption payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -21,6 +39,16 @@ function redemptionFactory(_ref) {
     });
   }
 
+  /**
+   * GET /redemptions/validate/:passId - validate redemption. Query: timezone (required per getSpec).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.passId - Pass id
+   * @param {string} opts.timezone - Timezone (required query param per btrz-api-operations getSpec)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getValidate(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -36,6 +64,15 @@ function redemptionFactory(_ref) {
     });
   }
 
+  /**
+   * POST /unredeem - unredeem. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function unredeem(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,

package/lib/endpoints/operations/rms.js

@@ -3,11 +3,60 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /rms/manifest-forecast (btrz-api-operations). See get-handler getSpec() and handlers-common parameters().
+ * @typedef {Object} RmsManifestForecastListQuery
+ * @property {string} date - Manifest forecast date (required; YYYY-MM-DD)
+ * @property {string} [time] - Time (HH:mm)
+ * @property {string} [brandId] - Brand id (ObjectId)
+ * @property {string} [productId] - Product id (ObjectId)
+ * @property {string} [routeId] - Route id
+ * @property {string} [amenityGroupId] - Amenity group id
+ * @property {string} [scheduleGroupId] - Schedule group id
+ * @property {string} [originId] - Origin station id (ObjectId)
+ * @property {string} [destinationId] - Destination station id (ObjectId)
+ * @property {string[]} [status] - Manifest status filter (valid manifest status values)
+ * @property {number} [forecastMin] - Minimum forecast value
+ * @property {number} [forecastMax] - Maximum forecast value
+ * @property {number} [loadMin] - Minimum load value
+ * @property {number} [loadMax] - Maximum load value
+ */
+
+/**
+ * Query params for GET /rms/manifest-forecast/:scheduleId (btrz-api-operations). Only common params (no date).
+ * @typedef {Object} RmsManifestForecastGetQuery
+ * @property {string} [originId] - Origin station id (ObjectId)
+ * @property {string} [destinationId] - Destination station id (ObjectId)
+ * @property {string[]} [status] - Manifest status filter
+ * @property {number} [forecastMin] - Minimum forecast value
+ * @property {number} [forecastMax] - Maximum forecast value
+ * @property {number} [loadMin] - Minimum load value
+ * @property {number} [loadMax] - Maximum load value
+ */
+
+/**
+ * Factory for RMS API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} rms API methods (manifestForecasts)
+ */
+
+
 function rmsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   var manifestForecasts = {
+    /**
+     * GET /rms/manifest-forecast - list manifest forecasts. Query: date required.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {RmsManifestForecastListQuery} [opts.query] - Query params (date required)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     all: function all(_ref2) {
       var token = _ref2.token,
           jwtToken = _ref2.jwtToken,
@@ -20,6 +69,18 @@ function rmsFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * GET /rms/manifest-forecast/:scheduleId - get manifest forecast by schedule id.
+     * Optional query: originId, destinationId, status, forecastMin/Max, loadMin/Max.
+     * @param {Object} opts
+     * @param {string} opts.scheduleId - Schedule id (UUID4)
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {RmsManifestForecastGetQuery} [opts.query] - Optional query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref3) {
       var scheduleId = _ref3.scheduleId,
           token = _ref3.token,

package/lib/endpoints/operations/scheduled_notifications.js

@@ -1,12 +1,36 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /scheduled-notifications (btrz-api-operations getSpec).
+ * @typedef {Object} ScheduledNotificationsListQuery
+ * @property {string} [groupId] - Group id to retrieve
+ */
+
+/**
+ * Factory for scheduled-notifications API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} scheduled-notifications API methods
+ */
+
+
 function scheduledNotificationsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /scheduled-notifications - list scheduled notifications.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {ScheduledNotificationsListQuery} [opts.query] - groupId
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} GetScheduledNotificationsResponse
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -20,6 +44,15 @@ function scheduledNotificationsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /scheduled-notifications/:id - get scheduled notification by id. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Scheduled notification id (ObjectId)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} 404 SCHEDULEDNOTIFICATION_NOT_FOUND
+   */
   function get(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -33,6 +66,16 @@ function scheduledNotificationsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /scheduled-notifications/:id - update scheduled notification. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Scheduled notification id (ObjectId)
+   * @param {Object} opts.data - ScheduledNotificationPostData
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} 404 SCHEDULEDNOTIFICATION_NOT_FOUND, 409 SCHEDULED_NOTIFICATION_EXISTS
+   */
   function update(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -50,6 +93,15 @@ function scheduledNotificationsFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /scheduled-notifications/:id - remove scheduled notification. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Scheduled notification id (ObjectId)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -63,6 +115,15 @@ function scheduledNotificationsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /scheduled-notifications - create scheduled notification. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - ScheduledNotificationPostData
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} 409 SCHEDULED_NOTIFICATION_EXISTS
+   */
   function create(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,

package/lib/endpoints/operations/segments.js

@@ -1,13 +1,38 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query param for GET /products/:productId/segments/:ticketId (btrz-api-operations getSpec). Client passes via opts.providerId.
+ * @typedef {Object} SegmentsListQuery
+ * @property {string} [providerId] - Provider/account id (Id of the provider account)
+ */
+
+/**
+ * Factory for segments API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} segments API methods
+ */
+
+
 function segmentsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /products/:productId/segments/:ticketId - list segments for product/ticket.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.productId - Product id
+   * @param {string} opts.ticketId - Ticket id
+   * @param {string} [opts.providerId] - Provider id (sent as query param)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

package/lib/endpoints/operations/sold-items-fulfillment.js

@@ -3,10 +3,34 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /sold-items/fulfillment (btrz-api-operations). See 01-get-fulfillment-handler getSpec().
+ * @typedef {Object} SoldItemsFulfillmentListQuery
+ * @property {string} soldItemIds - Comma-separated sold item IDs (required)
+ */
+
+/**
+ * Factory for sold-items fulfillment API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} sold-items fulfillment API methods
+ */
+
+
 function soldItemsFulfillmentFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /sold-items/fulfillment - list sold items fulfillment.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {SoldItemsFulfillmentListQuery} [opts.query] - Query params (soldItemIds required)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,