btrz-api-client 8.34.0 → 8.35.0

package/lib/endpoints/operations/pago-express.js

@@ -0,0 +1,96 @@
+"use strict";
+
+var _require = require("../endpoints_helpers.js"),
+    authorizationHeaders = _require.authorizationHeaders;
+
+/**
+ * Pago Express (Datalogic) endpoints for the Operations API.
+ * Used to get info, pay, and reverse reference payments.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} pagoExpress API methods
+ */
+
+
+function pagoExpressFactory(_ref) {
+  var client = _ref.client,
+      internalAuthTokenProvider = _ref.internalAuthTokenProvider;
+
+  /**
+   * POST /pago-express/info - get transaction information for a Pago Express reference.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key (x-api-key)
+   * @param {string} [opts.jwtToken] - JWT or internal auth
+   * @param {Object} opts.payment - Request body: folio (20-digit string), id_terminal (number), local_date (string DD/MM/YYYY HH:mm:ss), trx_no (number)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>} 200 PostInfoResponse (code, message, result with folio, id_terminal, local_date, saldo, trx_no, responsecode, descriptioncode)
+   */
+  function info(_ref2) {
+    var token = _ref2.token,
+        jwtToken = _ref2.jwtToken,
+        payment = _ref2.payment,
+        headers = _ref2.headers;
+
+    return client({
+      method: "post",
+      url: "/pago-express/info",
+      data: { payment: payment },
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  /**
+   * POST /pago-express/pay - pay a Pago Express reference payment.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key (x-api-key)
+   * @param {string} [opts.jwtToken] - JWT or internal auth
+   * @param {Object} opts.payment - Request body: folio, id_terminal, local_date, trx_no, amount (string)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>} 200 PostPayResponse (code, message, result with folio, id_terminal, local_date, trx_no, noauto, amount, responsecode, descriptioncode)
+   */
+  function pay(_ref3) {
+    var token = _ref3.token,
+        jwtToken = _ref3.jwtToken,
+        payment = _ref3.payment,
+        headers = _ref3.headers;
+
+    return client({
+      method: "post",
+      url: "/pago-express/pay",
+      data: { payment: payment },
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  /**
+   * POST /pago-express/reverse - reverse (cancel) a Pago Express reference payment. Emits transaction.reversed webhook.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key (x-api-key)
+   * @param {string} [opts.jwtToken] - JWT or internal auth
+   * @param {Object} opts.reversePayment - Request body: folio, id_terminal, local_date, trx_no, amount (string)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>} 200 PostReverseResponse (code, message, result)
+   */
+  function reverse(_ref4) {
+    var token = _ref4.token,
+        jwtToken = _ref4.jwtToken,
+        reversePayment = _ref4.reversePayment,
+        headers = _ref4.headers;
+
+    return client({
+      method: "post",
+      url: "/pago-express/reverse",
+      data: { reversePayment: reversePayment },
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  return {
+    info: info,
+    pay: pay,
+    reverse: reverse
+  };
+}
+
+module.exports = pagoExpressFactory;

package/lib/endpoints/operations/parcels.js

@@ -38,13 +38,13 @@ function parcelFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /parcels/:id - get parcel by id. API does not accept query params.
+   * GET /parcels/{parcelId} - get parcel by id. Requires JwtAuth. No 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.id - Parcel id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse>} 200 { parcel }; 400 INVALID_PARCEL_ID; 401 Unauthorized; 404 PARCEL_NOT_FOUND; 500
    */
   function get(_ref2) {
     var token = _ref2.token,
@@ -112,14 +112,14 @@ function parcelFactory(_ref) {
   }
 
   /**
-   * POST /parcels/:id/user-comments - add comment to parcel. API does not accept query params.
+   * POST /parcels/{parcelId}/user-comments - add user comment to parcel. Requires JwtAuth. Body: { comment } (string).
    * @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 {string} opts.id - Parcel id (path parcelId)
+   * @param {string} opts.comment - Comment text (sent as body.comment)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse>} 200 ParcelUserComment; 400 MISSING_*; 401; 403; 404 PARCEL_NOT_FOUND; 409
    */
   function addComment(_ref5) {
     var token = _ref5.token,
@@ -137,14 +137,14 @@ function parcelFactory(_ref) {
   }
 
   /**
-   * DELETE /parcels/:id/user-comments/:commentId - delete parcel comment. API does not accept query params.
+   * DELETE /parcels/{parcelId}/user-comments/{commentId} - delete user comment from parcel. Requires JwtAuth.
    * @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 {string} opts.id - Parcel id (path parcelId)
+   * @param {string} opts.commentId - Comment id (path)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse>} 200 deleted ParcelUserComment; 400 MISSING_*; 401; 403; 404 PARCEL_NOT_FOUND, COMMENT_NOT_FOUND; 409
    */
   function deleteComment(_ref6) {
     var token = _ref6.token,

package/lib/endpoints/operations/parcels_manifests.js

@@ -53,24 +53,27 @@ function parcelsManifestsFactory(_ref) {
   }
 
   /**
-   * GET /parcels-manifests/:id - get parcels manifest by id. API does not accept query params.
+   * 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 {string} opts.id - Parcel manifest id (ObjectId, 24 hex chars)
+   * @param {"standard"|"webhook"} [opts.format="standard"] - Response format (standard | webhook)
    * @param {Object} [opts.headers] - Optional request headers
-   * @returns {Promise<import("axios").AxiosResponse>} response.data parcel manifest; 404 PARCELMANIFEST_NOT_FOUND
+   * @returns {Promise<import("axios").AxiosResponse>} response.data parcel manifest; 400 WRONG_DATA; 404 MANIFEST_NOT_FOUND, PARCELMANIFEST_NOT_FOUND
    */
   function get(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
         id = _ref3.id,
+        format = _ref3.format,
         headers = _ref3.headers;
 
     return client({
       url: "/parcels-manifests/" + id,
       method: "get",
-      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      params: format != null ? { format: format } : undefined
     });
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "btrz-api-client",
-  "version": "8.34.0",
+  "version": "8.35.0",
   "description": "Api client for Betterez endpoints",
   "main": "index.js",
   "scripts": {

package/src/client.js

@@ -85,6 +85,7 @@ function createInventory({baseURL, headers, timeout, overrideFn, internalAuthTok
     getnetTerminals: require("./endpoints/inventory/getnet-terminals.js")({client, internalAuthTokenProvider}),
     giftCertificateDefinitions: require("./endpoints/inventory/gift-certificate-definitions.js")({client, internalAuthTokenProvider}),
     healthCheck: require("./endpoints/inventory/healthcheck.js")({client, internalAuthTokenProvider}),
+    holidays: require("./endpoints/inventory/holidays.js")({client, internalAuthTokenProvider}),
     insurances: require("./endpoints/inventory/insurances.js")({client, internalAuthTokenProvider}),
     insurancesCost: require("./endpoints/inventory/insurancesCost.js")({client, internalAuthTokenProvider}),
     items: require("./endpoints/inventory/items.js")({client, internalAuthTokenProvider}),
@@ -293,11 +294,13 @@ function createOperations({baseURL, headers, timeout, overrideFn, internalAuthTo
     calendarEntries: require("./endpoints/operations/calendar_entries.js")({client, internalAuthTokenProvider}),
     externalBookings: require("./endpoints/operations/external-bookings.js")({client, internalAuthTokenProvider}),
     flexpasses: require("./endpoints/operations/flexpasses.js")({client, internalAuthTokenProvider}),
+    giftCertificates: require("./endpoints/operations/gift-certificates.js")({client, internalAuthTokenProvider}),
     loans: require("./endpoints/operations/loans.js")({client, internalAuthTokenProvider}),
     manifest: require("./endpoints/operations/manifest.js")({client, internalAuthTokenProvider}),
     manifestLegForTickets: require("./endpoints/operations/manifest_leg_for_tickets.js")({client, internalAuthTokenProvider}),
     movements: require("./endpoints/operations/movements.js")({client, internalAuthTokenProvider}),
     outlookTrips: require("./endpoints/operations/outlook-trips.js")({client, internalAuthTokenProvider}),
+    pagoExpress: require("./endpoints/operations/pago-express.js")({client, internalAuthTokenProvider}),
     parcel: require("./endpoints/operations/parcels.js")({client, internalAuthTokenProvider}),
     parcelManifests: require("./endpoints/operations/parcels_manifests.js")({client, internalAuthTokenProvider}),
     passengerCheckInInfo: require("./endpoints/operations/passenger_check_in_info.js")({client, internalAuthTokenProvider}),
@@ -356,6 +359,7 @@ function createNotifications({baseURL, headers, timeout, overrideFn, internalAut
     pdfData: require("./endpoints/notifications/pdf-data.js")({client, internalAuthTokenProvider}),
     email: require("./endpoints/notifications/email.js")({client, internalAuthTokenProvider}),
     customers: require("./endpoints/notifications/customers.js")({client, internalAuthTokenProvider}),
+    externalCustomers: require("./endpoints/notifications/external-customers.js")({client, internalAuthTokenProvider}),
     twilio: require("./endpoints/notifications/twilio.js")({client, internalAuthTokenProvider}),
     salesforce: require("./endpoints/notifications/salesforce.js")({client, internalAuthTokenProvider}),
     notify: require("./endpoints/notifications/notify.js")({client, internalAuthTokenProvider}),

package/src/endpoints/inventory/banks.js

@@ -11,12 +11,15 @@ const {
  */
 function banksFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /banks - list banks. API does not accept query params.
+   * GET /banks — List banks for the account. Paginated; optional page query param (1-based).
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization: Bearer)
+   * @param {Object} [opts.query] - Query params: page (1-based page number)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ banks: Object[], count: number, next: string, previous: string }>>}
+   * @throws 401 Unauthorized
+   * @throws 500 Internal server error
    */
   function all({
     token,
@@ -31,13 +34,17 @@ function banksFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /banks/:bankId - get bank by id. API does not accept query params.
+   * GET /banks/:bankId — Get a single bank by ID (24 hex characters).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.bankId - Bank id
+   * @param {string} [opts.jwtToken] - JWT or internal auth
+   * @param {string} opts.bankId - Bank id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ bank: Object }>>}
+   * @throws 400 INVALID_BANK_ID
+   * @throws 401 Unauthorized
+   * @throws 404 BANK_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function get({bankId, token, headers, jwtToken}) {
     return client.get(`/banks/${bankId}`, {
@@ -46,13 +53,16 @@ function banksFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /banks - create bank. API does not accept query params.
+   * POST /banks — Create a bank. Body: BankPostData (name, accountNumbers required; optional depositAlgorithmCode).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.bank - Bank payload
+   * @param {string} [opts.jwtToken] - JWT or internal auth
+   * @param {Object} opts.bank - Bank payload (name, accountNumbers; each accountNumber: number, currency, alias)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ bank: Object }>>}
+   * @throws 400 WRONG_DATA, STATION_INVALID_COST_CENTER
+   * @throws 401 Unauthorized
+   * @throws 500 Internal server error
    */
   function create({jwtToken, token, bank, headers}) {
     return client({
@@ -66,13 +76,17 @@ function banksFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /banks/:bankId - remove bank. API does not accept query params.
+   * DELETE /banks/:bankId — Delete a bank by ID.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.bankId - Bank id
+   * @param {string} [opts.jwtToken] - JWT or internal auth
+   * @param {string} opts.bankId - Bank id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ bankId: string }>>}
+   * @throws 400 BANK_ID
+   * @throws 401 Unauthorized
+   * @throws 404 BANK_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function remove({jwtToken, bankId, token, headers}) {
     return client({
@@ -83,14 +97,18 @@ function banksFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /banks/:bankId - update bank. API does not accept query params.
+   * PUT /banks/:bankId — Update a bank by ID. Body: BankPostData (name, accountNumbers required).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.bankId - Bank id
-   * @param {Object} opts.bank - Bank payload
+   * @param {string} [opts.jwtToken] - JWT or internal auth
+   * @param {string} opts.bankId - Bank id (24 hex characters)
+   * @param {Object} opts.bank - Bank payload (name, accountNumbers; each accountNumber: number, currency, alias)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ bank: Object }>>}
+   * @throws 400 WRONG_DATA, STATION_INVALID_COST_CENTER
+   * @throws 401 Unauthorized
+   * @throws 404 BANK_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function update({jwtToken, token, bankId, bank, headers}) {
     return client({

package/src/endpoints/inventory/change-requests.js

@@ -25,13 +25,16 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function changeRequestsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /change-requests - list change requests.
+   * GET /change-requests — List change requests with optional filters and pagination.
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {ChangeRequestsListQuery} [opts.query] - Query params
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization: Bearer)
+   * @param {ChangeRequestsListQuery} [opts.query] - Query params (type, status, createdBy, from, to, etc.)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ changeRequests: Object[], count: number, next: string, previous: string }>>}
+   * @throws 400 INVALID_PAGE, INVALID_TYPE_PARAMETER, INVALID_STATUS_PARAMETER, etc.
+   * @throws 401 Unauthorized
+   * @throws 500 Internal server error
    */
   function all({token, jwtToken, query = {}, headers}) {
     return client.get("/change-requests", {
@@ -41,13 +44,18 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /change-requests/:changerequestId/manifests - get change request manifests. API does not accept query params.
+   * GET /change-requests/:changerequestId/manifests — Get manifest change request by ID. Requires multipleManifestEditing.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.changerequestId - Change request id
+   * @param {string} [opts.jwtToken] - JWT or internal auth
+   * @param {string} opts.changerequestId - Change request id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ changeRequest: Object }>>}
+   * @throws 400 INVALID_CHANGEREQUEST_ID, FAILED_TO_FETCH_OPERATION_SETTINGS
+   * @throws 401 Unauthorized
+   * @throws 403 MULTIPLE_MANIFEST_EDIT_NOT_ALLOWED
+   * @throws 404 CHANGEREQUEST_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function get({changerequestId, token, jwtToken, query = {}, headers}) {
     return client({
@@ -58,13 +66,17 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /change-requests/manifests - create change request manifest. API does not accept query params.
+   * POST /change-requests/manifests — Create manifest change request. Emits changeRequests.manifests.created.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.data - Manifest payload
+   * @param {string} [opts.jwtToken] - JWT or internal auth
+   * @param {Object} opts.data - Manifest change request payload (manifestId, request, routeId, scheduleId, date, etc.)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ changeRequest: Object }>>}
+   * @throws 400 WRONG_DATA, FAILED_TO_FETCH_OPERATION_SETTINGS, MANIFEST_NOT_FOUND, etc.
+   * @throws 401 Unauthorized
+   * @throws 403 MULTIPLE_MANIFEST_EDIT_NOT_ALLOWED
+   * @throws 500 Internal server error
    */
   function create({data, token, jwtToken, headers}) {
     return client({
@@ -76,14 +88,19 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /change-requests/:changerequestId/manifests - update change request manifest. API does not accept query params.
+   * PUT /change-requests/:changerequestId/manifests — Update manifest change request. Emits changeRequests.manifests.updated.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.changerequestId - Change request id
-   * @param {Object} opts.data - Manifest payload
+   * @param {string} [opts.jwtToken] - JWT or internal auth
+   * @param {string} opts.changerequestId - Change request id (24 hex characters)
+   * @param {Object} opts.data - Update payload (status: 'approved' or 'rejected')
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ changeRequest: Object }>>}
+   * @throws 400 WRONG_DATA, CHANGEREQUEST_STATUS_NOT_PENDING, etc.
+   * @throws 401 Unauthorized
+   * @throws 403 MULTIPLE_MANIFEST_EDIT_NOT_ALLOWED
+   * @throws 404 CHANGEREQUEST_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function update({changerequestId, data, token, jwtToken, headers}) {
     return client({
@@ -97,13 +114,17 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
   /** @type {{ get: function, create: function, update: function }} */
   const schedules = {
     /**
-     * GET /change-requests/:changeRequestId/schedules - get change request schedules. API does not accept query params.
+     * GET /change-requests/:changeRequestId/schedules — Get schedule change request by ID.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
-     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {string} opts.changeRequestId - Change request id
+     * @param {string} [opts.jwtToken] - JWT or internal auth
+     * @param {string} opts.changeRequestId - Change request id (24 hex characters)
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ changeRequest: Object }>>}
+     * @throws 400 INVALID_CHANGEREQUEST_ID, FAILED_TO_FETCH_OPERATION_SETTINGS, etc.
+     * @throws 401 Unauthorized
+     * @throws 404 CHANGEREQUEST_NOT_FOUND
+     * @throws 500 Internal server error
      */
     get({changeRequestId, token, jwtToken, query = {}, headers}) {
       return client({
@@ -114,13 +135,16 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
     },
 
     /**
-     * POST /change-requests/schedules - create change request schedule. API does not accept query params.
+     * POST /change-requests/schedules — Create a schedule change request. Emits webhook changeRequests.schedules.created.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
-     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {Object} opts.data - Schedule payload
+     * @param {string} [opts.jwtToken] - JWT or internal auth
+     * @param {Object} opts.data - Schedule change request payload (request, routeId, scheduleId, legs, etc.)
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ changeRequest: Object }>>}
+     * @throws 400 WRONG_DATA, FAILED_TO_FETCH_OPERATION_SETTINGS, etc.
+     * @throws 401 Unauthorized
+     * @throws 500 Internal server error
      */
     create({data, token, jwtToken, headers}) {
       return client({
@@ -132,14 +156,18 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
     },
 
     /**
-     * PUT /change-requests/:changeRequestId/schedules - update change request schedule. API does not accept query params.
+     * PUT .../schedules — Update schedule change request (approve/reject). Emits changeRequests.schedules.updated.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
-     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {string} opts.changeRequestId - Change request id
-     * @param {Object} opts.data - Schedule payload
+     * @param {string} [opts.jwtToken] - JWT or internal auth
+     * @param {string} opts.changeRequestId - Change request id (24 hex characters)
+     * @param {Object} opts.data - Update payload (status: 'approved' or 'rejected')
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ changeRequest: Object }>>}
+     * @throws 400 WRONG_DATA, CHANGEREQUEST_STATUS_NOT_PENDING, etc.
+     * @throws 401 Unauthorized
+     * @throws 404 CHANGEREQUEST_NOT_FOUND
+     * @throws 500 Internal server error
      */
     update({changeRequestId, data, token, jwtToken, headers}) {
       return client({

package/src/endpoints/inventory/control-classes.js

@@ -41,13 +41,17 @@ const {
  */
 function controlClassesFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /control-classes - list control classes.
+   * GET /control-classes — List control class roots (paginated). Emits no webhooks.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.jwtToken] - JWT or internal auth
    * @param {ControlClassesListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ controlClasses: Object[], authorizationsEnabled?: boolean }>>}
+   * @throws 400 INVALID_PAGE, INVALID_SCHEDULE_ID, INVALID_ASSIGNED_SCHEDULE_ID
+   * @throws 401 Unauthorized
+   * @throws 404 SCHEDULE_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function all({
     token,
@@ -62,14 +66,18 @@ function controlClassesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /control-classes/:controlClassId - get control class by id.
+   * GET /control-classes/:controlClassId — Get one control class (optional tree, schedules).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.controlClassId - Control class id
+   * @param {string} [opts.jwtToken] - JWT or internal auth
+   * @param {string} opts.controlClassId - Control class id (24 hex)
    * @param {ControlClassGetQuery} [opts.query] - Query params (tree, scheduleId, etc.)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ controlClass, root?, parent?, siblings?, children?, schedules?, tree? }>>}
+   * @throws 400 INVALID_CONTROLCLASS_ID
+   * @throws 401 Unauthorized
+   * @throws 404 CONTROLCLASS_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function get({controlClassId, token, headers, jwtToken, query = {}}) {
     return client.get(`/control-classes/${controlClassId}`, {
@@ -79,13 +87,16 @@ function controlClassesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /control-classes - create control class. API does not accept query params.
+   * POST /control-classes — Create control class. Body: { controlClass }. Emits controlclasses.created.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.controlClass - Control class payload
+   * @param {string} [opts.jwtToken] - JWT or internal auth
+   * @param {Object} opts.controlClass - ControlClassData (name, props required)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ controlClass: Object }>>}
+   * @throws 400 WRONG_DATA, DUPLICATE_CLASS_NAME, NO_ROOT_PROPS, PARENT_CLASS_NOT_FOUND, etc.
+   * @throws 401 Unauthorized
+   * @throws 500 Internal server error
    */
   function create({jwtToken, token, controlClass, headers}) {
     return client({
@@ -99,13 +110,17 @@ function controlClassesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /control-classes/:controlClassId - remove control class.
+   * DELETE /control-classes/:controlClassId — Delete control class. Emits controlclasses.deleted.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.controlClassId - Control class id
+   * @param {string} [opts.jwtToken] - JWT or internal auth
+   * @param {string} opts.controlClassId - Control class id (24 hex)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ controlClassId: string }>>}
+   * @throws 400 INVALID_CONTROLCLASS_ID, CANNOT_DELETE_CLASS_WITH_CHILDREN
+   * @throws 401 Unauthorized
+   * @throws 404 CONTROLCLASS_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function remove({jwtToken, controlClassId, token, headers}) {
     return client({
@@ -116,14 +131,18 @@ function controlClassesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /control-classes/:controlClassId - update control class. API does not accept query params.
+   * PUT /control-classes/:controlClassId — Update control class. Body: { controlClass }. Emits controlclasses.updated.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.controlClassId - Control class id
-   * @param {Object} opts.controlClass - Control class payload
+   * @param {string} [opts.jwtToken] - JWT or internal auth
+   * @param {string} opts.controlClassId - Control class id (24 hex)
+   * @param {Object} opts.controlClass - ControlClassData (name, props required)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ controlClass: Object }>>}
+   * @throws 400 WRONG_DATA, INVALID_CONTROLCLASS_ID, DUPLICATE_CLASS_NAME, etc.
+   * @throws 401 Unauthorized
+   * @throws 404 CONTROLCLASS_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function update({jwtToken, token, controlClassId, controlClass, headers}) {
     return client({