btrz-api-client 8.28.0 → 8.30.0

package/lib/endpoints/operations/movements.js

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

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

@@ -3,18 +3,43 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @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(_ref) {
-  var client = _ref.client;
+  var client = _ref.client,
+      internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
+        jwtToken = _ref2.jwtToken,
         _ref2$query = _ref2.query,
         query = _ref2$query === undefined ? {} : _ref2$query,
         headers = _ref2.headers;
 
     return client({
       url: "/outlook-trips",
-      headers: authorizationHeaders({ token: token, headers: headers }),
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
       params: query
     });
   }

package/lib/endpoints/operations/parcels.js

@@ -2,14 +2,36 @@
 
 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;
 
+/**
+ * @typedef {Object} ParcelsQuery
+ * @property {string} [providerId] - Provider account ID (also set via opts.providerId)
+ */
+
+/**
+ * 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.
+   * @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 +44,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 {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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -38,6 +70,17 @@ function parcelFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -54,6 +97,16 @@ function parcelFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -69,6 +122,16 @@ function parcelFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,

package/lib/endpoints/operations/parcels_manifests.js

@@ -1,12 +1,50 @@
 "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)
+ */
+
+/**
+ * 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(_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 +58,15 @@ function parcelsManifestsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -32,6 +79,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 +109,16 @@ function parcelsManifestsFactory(_ref) {
   }
 
   var 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: function remove(_ref5) {
       var token = _ref5.token,
           jwtToken = _ref5.jwtToken,
@@ -63,6 +132,19 @@ function parcelsManifestsFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: 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: function create(_ref6) {
       var token = _ref6.token,
           jwtToken = _ref6.jwtToken,
@@ -83,6 +165,18 @@ function parcelsManifestsFactory(_ref) {
   };
 
   var 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: function createOrUpdate(_ref7) {
       var token = _ref7.token,
           jwtToken = _ref7.jwtToken,

package/lib/endpoints/operations/passenger_check_in_info.js

@@ -1,12 +1,43 @@
 "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
+ */
+
+/**
+ * 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(_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 +51,15 @@ function passengerCheckInInfoFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -33,6 +73,17 @@ function passengerCheckInInfoFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -58,6 +109,16 @@ function passengerCheckInInfoFactory(_ref) {
   //   });
   // }
 
+  /**
+   * 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(_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.
+   * @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.
+   * @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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -36,6 +64,15 @@ function redemptionFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,

package/lib/endpoints/operations/rms.js

@@ -3,11 +3,34 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   var 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: function all(_ref2) {
       var token = _ref2.token,
           jwtToken = _ref2.jwtToken,
@@ -20,6 +43,17 @@ function rmsFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: 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: function get(_ref3) {
       var scheduleId = _ref3.scheduleId,
           token = _ref3.token,

package/lib/endpoints/operations/scheduled_notifications.js

@@ -1,12 +1,41 @@
 "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
+ */
+
+/**
+ * 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(_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 +49,15 @@ function scheduledNotificationsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -33,6 +71,17 @@ function scheduledNotificationsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -50,6 +99,15 @@ function scheduledNotificationsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -63,6 +121,16 @@ function scheduledNotificationsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,