btrz-api-client 8.28.0 → 8.30.0

package/src/endpoints/operations/movements.js

@@ -1,9 +1,31 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function movementsFactory({ client, internalAuthTokenProvider }) {
-  function create({ token, jwtToken, movement, query = {}, headers }) {
+/**
+ * @typedef {Object} MovementsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * 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.
+   * @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 {MovementsQuery} [opts.query] - Query params
+   * @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 +36,6 @@ function movementsFactory({ client, internalAuthTokenProvider }) {
   return {
     create
   };
-
 }
 
 module.exports = movementsFactory;

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

@@ -1,10 +1,31 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function outlookTripsFactory({client}) {
-  function get({token, query = {}, headers}) {
+/**
+ * @typedef {Object} OutlookTripsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * 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 {OutlookTripsQuery} [opts.query] - Query params
+   * @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
     });
   }

package/src/endpoints/operations/parcels.js

@@ -1,15 +1,45 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function parcelFactory({ client, internalAuthTokenProvider }) {
+/**
+ * @typedef {Object} ParcelsQuery
+ * @property {string} [providerId] - Provider account ID (also set via opts.providerId)
+ */
 
-  function get({ token, jwtToken, id, headers }) {
+/**
+ * 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({client, internalAuthTokenProvider}) {
+  /**
+   * GET /parcels/:id - get parcel by id.
+   * @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({token, jwtToken, id, headers}) {
     return client({
       url: `/parcels/${id}`,
-      headers: authorizationHeaders({ token , jwtToken, internalAuthTokenProvider, headers })
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
-  function all({ token, jwtToken, query = {}, headers, providerId }) {
+  /**
+   * GET /parcels - list parcels.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {ParcelsQuery} [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({token, jwtToken, query = {}, headers, providerId}) {
     const query_ = providerId ? {...query, providerId} : query;
     return client({
       url: "/parcels",
@@ -18,15 +48,36 @@ function parcelFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
-  function addScan({ token, jwtToken, id, operationType, locationData, headers }) {
+  /**
+   * POST /parcels/:id/scans - add scan to parcel.
+   * @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({token, jwtToken, id, operationType, locationData, headers}) {
     return client({
       url: `/parcels/${id}/scans`,
       method: "post",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { operationType, locationData }
+      data: {operationType, locationData}
     });
   }
 
+  /**
+   * POST /parcels/:id/user-comments - add comment to parcel.
+   * @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({token, jwtToken, headers, id, comment}) {
     return client({
       url: `/parcels/${id}/user-comments`,
@@ -36,6 +87,16 @@ function parcelFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
+  /**
+   * DELETE /parcels/:id/user-comments/:commentId - delete parcel comment.
+   * @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({token, jwtToken, headers, id, commentId}) {
     return client({
       url: `/parcels/${id}/user-comments/${commentId}`,

package/src/endpoints/operations/parcels_manifests.js

@@ -1,6 +1,42 @@
+/* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * 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)
+ */
+
+/**
+ * POST /parcels-manifests, POST .../parcels, POST .../vehicles do not define query params in backend getSpec.
+ * Use for optional query keys forwarded as-is.
+ * @typedef {Object} ParcelsManifestsPostQuery
+ */
+
+/**
+ * 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({client, 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({token, jwtToken, query, headers}) {
     return client({
       url: "/parcels-manifests",
@@ -9,6 +45,15 @@ function parcelsManifestsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /parcels-manifests/:id - get parcels manifest by id.
+   * @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({token, jwtToken, id, headers}) {
     return client({
       url: `/parcels-manifests/${id}`,
@@ -16,6 +61,18 @@ function parcelsManifestsFactory({client, internalAuthTokenProvider}) {
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, 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({token, jwtToken, query = {}, data, headers}) {
     return client({
       url: "/parcels-manifests",
@@ -27,6 +84,16 @@ function parcelsManifestsFactory({client, internalAuthTokenProvider}) {
   }
 
   const parcels = {
+    /**
+     * DELETE /parcels-manifests/:manifestId/parcels/:parcelId - remove parcel from manifest.
+     * @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({token, jwtToken, manifestId, parcelId, headers}) {
       return client({
         url: `/parcels-manifests/${manifestId}/parcels/${parcelId}`,
@@ -34,6 +101,18 @@ function parcelsManifestsFactory({client, internalAuthTokenProvider}) {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
       });
     },
+    /**
+     * POST /parcels-manifests/:manifestId/parcels - create parcel on manifest. Body: ParcelsManifestsPostData.
+     * 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 {string} opts.manifestId - Parcel manifest id (ObjectId)
+     * @param {ParcelsManifestsPostQuery} [opts.query] - Optional query params (backend getSpec has none; forwarded as-is)
+     * @param {Object} opts.data - Parcel payload (parcelsmanifests / ParcelsManifestsPostData: 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({token, jwtToken, manifestId, query = {}, data, headers}) {
       return client({
         url: `/parcels-manifests/${manifestId}/parcels`,
@@ -46,6 +125,18 @@ function parcelsManifestsFactory({client, internalAuthTokenProvider}) {
   };
 
   const vehicles = {
+    /**
+     * POST /parcels-manifests/:manifestId/vehicles - create or update vehicle on manifest. Body: ParcelManifestVehiclePostData.
+     * 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 {string} opts.manifestId - Parcel manifest id (ObjectId)
+     * @param {ParcelsManifestsPostQuery} [opts.query] - Optional query params (backend getSpec has none; forwarded as-is)
+     * @param {Object} opts.data - Vehicle payload (sent as parcelManifestVehicle in body; 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({token, jwtToken, manifestId, query = {}, data, headers}) {
       return client({
         url: `/parcels-manifests/${manifestId}/vehicles`,

package/src/endpoints/operations/passenger_check_in_info.js

@@ -1,6 +1,35 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * 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
+ */
+
+/**
+ * PUT and POST /passenger-check-in-info do not define query params in backend getSpec. Use for optional query keys forwarded as-is.
+ * @typedef {Object} PassengerCheckInInfoPostQuery
+ */
+
+/**
+ * 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({client, 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({token, jwtToken, query, headers}) {
     return client({
       url: "/passenger-check-in-info",
@@ -9,6 +38,15 @@ function passengerCheckInInfoFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /passenger-check-in-info/:id - get passenger check-in info by id.
+   * @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({token, jwtToken, id, headers}) {
     return client({
       url: `/passenger-check-in-info/${id}`,
@@ -17,6 +55,17 @@ function passengerCheckInInfoFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /passenger-check-in-info/:id - update passenger check-in info. Backend getSpec has no query params; query is passed through.
+   * @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 {PassengerCheckInInfoPostQuery} [opts.query] - Optional query params (backend getSpec has none; forwarded as-is)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} 404 PASSENGERCHECKININFO_NOT_FOUND
+   */
   function update({token, jwtToken, id, data, headers, query}) {
     return client({
       url: `/passenger-check-in-info/${id}`,
@@ -35,6 +84,16 @@ function passengerCheckInInfoFactory({client, internalAuthTokenProvider}) {
   //   });
   // }
 
+  /**
+   * POST /passenger-check-in-info - create passenger check-in info. Backend getSpec has no query params; query is passed through.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {PassengerCheckInInfoPostQuery} [opts.query] - Optional query params (backend getSpec has none; forwarded as-is)
+   * @param {Object} opts.data - PassengerCheckInInfoPostData (passengercheckininfo: ticketId, trxId, information, type)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, query = {}, data, headers}) {
     return client({
       url: "/passenger-check-in-info",

package/src/endpoints/operations/redemption.js

@@ -1,6 +1,22 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * 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({client, internalAuthTokenProvider}) {
+  /**
+   * POST /redemptions - create redemption.
+   * @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({token, jwtToken, redemption, headers}) {
     return client({
       url: "/redemptions",
@@ -10,6 +26,16 @@ function redemptionFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /redemptions/validate/:passId - validate redemption.
+   * @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 (query param)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getValidate({token, jwtToken, passId, timezone, headers}) {
     return client({
       url: `/redemptions/validate/${passId}`,
@@ -19,6 +45,15 @@ function redemptionFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /unredeem - unredeem.
+   * @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({token, jwtToken, data, headers}) {
     return client({
       url: "/unredeem",

package/src/endpoints/operations/rms.js

@@ -2,10 +2,31 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} RmsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * 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({
   client, internalAuthTokenProvider
 }) {
   const manifestForecasts = {
+    /**
+     * GET /rms/manifest-forecast - list manifest forecasts.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {RmsQuery} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     all({
       token,
       jwtToken,
@@ -17,6 +38,16 @@ function rmsFactory({
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
       });
     },
+    /**
+     * GET /rms/manifest-forecast/:scheduleId - get manifest forecast by schedule id.
+     * @param {Object} opts
+     * @param {string} opts.scheduleId - Schedule id
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {RmsQuery} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({
       scheduleId,
       token,

package/src/endpoints/operations/scheduled_notifications.js

@@ -1,6 +1,33 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /scheduled-notifications (btrz-api-operations getSpec).
+ * @typedef {Object} ScheduledNotificationsListQuery
+ * @property {string} [groupId] - Group id to retrieve
+ */
+
+/**
+ * PUT and POST /scheduled-notifications do not define query params in backend getSpec. Use for optional query keys forwarded as-is.
+ * @typedef {Object} ScheduledNotificationsPostQuery
+ */
+
+/**
+ * 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({client, 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({token, jwtToken, query, headers}) {
     return client({
       url: "/scheduled-notifications",
@@ -9,6 +36,15 @@ function scheduledNotificationsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /scheduled-notifications/:id - get scheduled notification by id.
+   * @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({token, jwtToken, id, headers}) {
     return client({
       url: `/scheduled-notifications/${id}`,
@@ -17,7 +53,18 @@ function scheduledNotificationsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
-  function update({ token, jwtToken, id, data, headers, query }) {
+  /**
+   * PUT /scheduled-notifications/:id - update scheduled notification. Backend getSpec has no query params; query is passed through.
+   * @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 {ScheduledNotificationsPostQuery} [opts.query] - Optional query params (backend getSpec has none; forwarded as-is)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} 404 SCHEDULEDNOTIFICATION_NOT_FOUND, 409 SCHEDULED_NOTIFICATION_EXISTS
+   */
+  function update({token, jwtToken, id, data, headers, query}) {
     return client({
       url: `/scheduled-notifications/${id}`,
       method: "put",
@@ -27,19 +74,38 @@ function scheduledNotificationsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
-  function remove({ token, jwtToken, id, headers }) {
+  /**
+   * DELETE /scheduled-notifications/:id - remove scheduled notification.
+   * @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({token, jwtToken, id, headers}) {
     return client({
       url: `/scheduled-notifications/${id}`,
       method: "delete",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers })
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
-  function create({ token, jwtToken, query = {}, data, headers }) {  
+  /**
+   * POST /scheduled-notifications - create scheduled notification. Backend getSpec has no query params; query is passed through.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {ScheduledNotificationsPostQuery} [opts.query] - Optional query params (backend getSpec has none; forwarded as-is)
+   * @param {Object} opts.data - ScheduledNotificationPostData
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} 409 SCHEDULED_NOTIFICATION_EXISTS
+   */
+  function create({token, jwtToken, query = {}, data, headers}) {
     return client({
       url: "/scheduled-notifications",
       method: "post",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers }),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
       params: query,
       data
     });

package/src/endpoints/operations/segments.js

@@ -1,11 +1,34 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function segmentsFactory({ client, internalAuthTokenProvider }) {
+/**
+ * Query params for GET /products/:productId/segments/:ticketId (btrz-api-operations). Client passes providerId as query.
+ * @typedef {Object} SegmentsListQuery
+ * @property {string} [providerId] - Provider/account id
+ */
 
-  function all({ token, jwtToken, productId, ticketId, providerId, headers}) {
+/**
+ * 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({client, 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({token, jwtToken, productId, ticketId, providerId, headers}) {
     return client({
       url: `/products/${productId}/segments/${ticketId}`,
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers }),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
       params: {
         providerId
       }