btrz-api-client 8.33.0 → 8.35.0

package/lib/endpoints/btrzpay/stripe3ds.js

@@ -0,0 +1,54 @@
+"use strict";
+
+/* eslint-disable max-len */
+var _require = require("../endpoints_helpers.js"),
+    authorizationHeaders = _require.authorizationHeaders;
+
+/**
+ * Request body for POST /stripe-payment-intent (btrz-api-payments). PaymentIntentPostData.
+ * @typedef {Object} PaymentIntentPostData
+ * @property {string} providerName - Provider name (e.g. "stripe") used to resolve the payment method with Stripe 3DS
+ * @property {Object} data - Payment data: card details, amount, currency, transactionId, customer info, etc.
+ */
+
+/**
+ * Factory for Stripe 3DS API (btrz-api-payments): create Stripe Payment Intent for 3DS flows.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ createPaymentIntent: function }}
+ */
+
+
+function stripe3dsFactory(_ref) {
+  var client = _ref.client,
+      internalAuthTokenProvider = _ref.internalAuthTokenProvider;
+
+  /**
+   * POST /stripe-payment-intent - creates a Stripe Payment Intent for 3DS; returns requires_action and payment_intent_client_secret.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.providerName - Provider name (e.g. "stripe")
+   * @param {Object} opts.data - Payment data (card, amount, currency, transactionId, etc.)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse<{ requires_action: boolean, payment_intent_client_secret: string }>>} PaymentIntentResponse. Rejects with 400 (WRONG_DATA, PAYMENT_INTENT_MISSING_PAYMENT_DATA, PAYMENT_INTENT_MISSING_PROVIDER, PROVIDER_NOT_FOUND, MISSING_PAYMENT_METHOD_PARAMS, PAYMENT_METHOD_NOT_FOUND, STRIPE_MISSING_PRIVATE_KEY, MISSING_PAYMENT_DATA), 401, 500.
+   */
+  function createPaymentIntent(_ref2) {
+    var token = _ref2.token,
+        jwtToken = _ref2.jwtToken,
+        providerName = _ref2.providerName,
+        data = _ref2.data,
+        headers = _ref2.headers;
+
+    return client.post("/stripe-payment-intent", { providerName: providerName, data: data }, {
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  return {
+    createPaymentIntent: createPaymentIntent
+  };
+}
+
+module.exports = stripe3dsFactory;

package/lib/endpoints/btrzpay/terminalPayments.js

@@ -6,10 +6,10 @@ var _require = require("../endpoints_helpers.js"),
 /**
  * Query params for GET /terminal-payments/mit/:id (btrz-api-payments). See get-mit-by-id-handler getSpec().
  * @typedef {Object} TerminalPaymentsMitGetQuery
- * @property {string} [providerId] - Account provider (operator) ID; used by agencies/sellers
- * @property {string} [branchId] - Branch id where payment started (required for GET)
- * @property {string} [companyId] - Company id where payment started (required for GET)
- * @property {string} [date] - Date when payment started; format dd/mm/yyyy (required for GET)
+ * @property {string} [providerId] - Account provider (operator) ID; used by agencies/sellers; when omitted, authenticated account is used
+ * @property {string} branchId - Branch id where payment started (required). Example: 00676
+ * @property {string} companyId - Company id where payment started (required). Example: Z890
+ * @property {string} date - Date when payment started; format dd/mm/yyyy (required)
  */
 
 /**
@@ -33,15 +33,15 @@ function terminalPaymentsFactory(_ref) {
 
   var mit = {
     /**
-     * PUT /terminal-payments/mit/:id - update MIT terminal payment.
+     * PUT /terminal-payments/mit/:terminalPaymentId - complete MIT terminal payment with result from terminal.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {string} opts.id - Terminal payment id
-     * @param {Object} opts.terminalPayment - Terminal payment payload
-     * @param {TerminalPaymentsMitPutQuery} [opts.query] - Query params (providerId)
+     * @param {string} opts.id - Terminal payment ID (UUID)
+     * @param {{ result?: Object, paymentRequest: Object, orderId: string }} opts.terminalPayment - Terminal payment data (result, paymentRequest, orderId)
+     * @param {TerminalPaymentsMitPutQuery} [opts.query] - Optional providerId
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ terminalPayment: Object }>>} Rejects with 400 (WRONG_DATA, INVALID_TERMINALPAYMENT_ID, INVALID_RESULT_OBJECT, MIT_*), 401, 404 (TERMINALPAYMENT_NOT_FOUND, MIT_PAYMENT_NOT_FOUND), 409 (CANT_UPDATE_ORDER), 500.
      */
     update: function update(_ref2) {
       var token = _ref2.token,
@@ -62,14 +62,14 @@ function terminalPaymentsFactory(_ref) {
     },
 
     /**
-     * GET /terminal-payments/mit/:id - get MIT terminal payment.
+     * GET /terminal-payments/mit/:terminalPaymentId - get MIT terminal payment result from MIT servers.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {string} opts.id - Terminal payment id
-     * @param {TerminalPaymentsMitGetQuery} [opts.query] - Query params (providerId, branchId, companyId, date)
+     * @param {string} opts.id - Terminal payment ID (UUID)
+     * @param {TerminalPaymentsMitGetQuery} opts.query - branchId, companyId, date (required); optional providerId
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ terminalPayment: Object }>>} Rejects with 400 (WRONG_DATA, INVALID_TERMINALPAYMENT_ID, INVALID_DATE, MIT_*), 401, 404 (TERMINALPAYMENT_NOT_FOUND, MIT_PAYMENT_NOT_FOUND), 500.
      */
     get: function get(_ref3) {
       var token = _ref3.token,
@@ -88,14 +88,14 @@ function terminalPaymentsFactory(_ref) {
 
   var webhooks = {
     /**
-     * POST /terminal-payments/webhooks/getnet/:providerId - Getnet webhook. API does not accept query params.
+     * POST /terminal-payments/webhooks/getnet/:providerId - Getnet Terminal webhook (inbound). API does not accept query params.
      * @param {Object} opts
-     * @param {Object} opts.data - Request body
-     * @param {string} opts.providerId - Provider id
+     * @param {Object} opts.data - Getnet webhook payload (e.g. TrxResult, TrxReference, userId)
+     * @param {string} opts.providerId - Provider (account) ID for getnet_terminal payment method
      * @param {Object} [opts.headers] - Optional headers
-     * @param {string} [opts.token] - API key
-     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @param {string} [opts.token] - API key (optional when no userId in payload)
+     * @param {string} [opts.jwtToken] - JWT or internal auth (required when userId is in payload)
+     * @returns {Promise<import("axios").AxiosResponse<{ status: string }>>} Rejects with 400 (INVALID_WEBHOOK_PAYLOAD), 401 (when userId present but not authenticated), 404 (PAYMENT_NOT_FOUND_FOR_WEBHOOK_EVENT, PAYMENT_METHOD_NOT_FOUND, USER_NOT_FOUND), 409 (CANT_UPDATE_ORDER), 500.
      */
     getnet: function getnet(_ref4) {
       var data = _ref4.data,

package/lib/endpoints/inventory/banks.js

@@ -17,12 +17,15 @@ function banksFactory(_ref) {
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
@@ -38,13 +41,17 @@ function banksFactory(_ref) {
   }
 
   /**
-   * 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(_ref3) {
     var bankId = _ref3.bankId,
@@ -58,13 +65,16 @@ function banksFactory(_ref) {
   }
 
   /**
-   * 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(_ref4) {
     var jwtToken = _ref4.jwtToken,
@@ -83,13 +93,17 @@ function banksFactory(_ref) {
   }
 
   /**
-   * 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(_ref5) {
     var jwtToken = _ref5.jwtToken,
@@ -105,14 +119,18 @@ function banksFactory(_ref) {
   }
 
   /**
-   * 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(_ref6) {
     var jwtToken = _ref6.jwtToken,

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

@@ -33,13 +33,16 @@ function changeRequestsFactory(_ref) {
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
@@ -55,13 +58,18 @@ function changeRequestsFactory(_ref) {
   }
 
   /**
-   * 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(_ref3) {
     var changerequestId = _ref3.changerequestId,
@@ -79,13 +87,17 @@ function changeRequestsFactory(_ref) {
   }
 
   /**
-   * 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(_ref4) {
     var data = _ref4.data,
@@ -102,14 +114,19 @@ function changeRequestsFactory(_ref) {
   }
 
   /**
-   * 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(_ref5) {
     var changerequestId = _ref5.changerequestId,
@@ -129,13 +146,17 @@ function changeRequestsFactory(_ref) {
   /** @type {{ get: function, create: function, update: function }} */
   var 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: function get(_ref6) {
       var changeRequestId = _ref6.changeRequestId,
@@ -154,13 +175,16 @@ function changeRequestsFactory(_ref) {
 
 
     /**
-     * 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: function create(_ref7) {
       var data = _ref7.data,
@@ -178,14 +202,18 @@ function changeRequestsFactory(_ref) {
 
 
     /**
-     * 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: function update(_ref8) {
       var changeRequestId = _ref8.changeRequestId,

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

@@ -47,13 +47,17 @@ function controlClassesFactory(_ref) {
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
@@ -69,14 +73,18 @@ function controlClassesFactory(_ref) {
   }
 
   /**
-   * 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(_ref3) {
     var controlClassId = _ref3.controlClassId,
@@ -93,13 +101,16 @@ function controlClassesFactory(_ref) {
   }
 
   /**
-   * 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(_ref4) {
     var jwtToken = _ref4.jwtToken,
@@ -118,13 +129,17 @@ function controlClassesFactory(_ref) {
   }
 
   /**
-   * 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(_ref5) {
     var jwtToken = _ref5.jwtToken,
@@ -140,14 +155,18 @@ function controlClassesFactory(_ref) {
   }
 
   /**
-   * 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(_ref6) {
     var jwtToken = _ref6.jwtToken,

package/lib/endpoints/inventory/countries.js

@@ -6,7 +6,14 @@ var _require = require("./../endpoints_helpers.js"),
 /**
  * Query params for GET /countries (btrz-api-inventory). See get-countries getSpec().
  * @typedef {Object} CountriesListQuery
- * @property {string} [isoCode] - Country 2 or 3 letter ISO code
+ * @property {string} [isoCode] - Country 2- or 3-letter ISO code (must be 2 or 3 chars if provided)
+ */
+
+/**
+ * Query params for GET /countries/:countryId (btrz-api-inventory). See getCountryById getSpec().
+ * @typedef {Object} CountryGetQuery
+ * @property {string} [include] - Address level to include: "provinces" (default), "counties", "cities", "neighborhoods"
+ * @property {string} [parentKey] - Parent address level to filter by when include is not provinces
  */
 
 /**
@@ -23,16 +30,20 @@ function countriesFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /countries - list countries.
+   * GET /countries — List countries. Optional filter by isoCode (2 or 3 characters).
    * @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 {CountriesListQuery} [opts.query] - Query params (isoCode)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ countries: Object[] }>>}
+   * @throws 400 Validation failure (e.g. invalid isoCode length)
+   * @throws 401 Unauthorized
+   * @throws 500 Internal server error
    */
   function all(_ref2) {
     var token = _ref2.token,
+        jwtToken = _ref2.jwtToken,
         _ref2$query = _ref2.query,
         query = _ref2$query === undefined ? {} : _ref2$query,
         headers = _ref2.headers;
@@ -40,18 +51,23 @@ function countriesFactory(_ref) {
     return client({
       url: "/countries",
       params: query,
-      headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
     });
   }
 
   /**
-   * GET /countries/:id - get country by id. API does not accept query params.
+   * GET /countries/:id — Get country by id. Optional include (provinces/counties/cities/neighborhoods) and parentKey.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Country id
+   * @param {string} [opts.jwtToken] - JWT or internal auth
+   * @param {string} opts.id - Country id (24 hex)
+   * @param {CountryGetQuery} [opts.query] - Query params (include, parentKey)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ country: Object }>>}
+   * @throws 400 INVALID_COUNTRY_ID
+   * @throws 401 Unauthorized
+   * @throws 404 COUNTRY_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function get(_ref3) {
     var token = _ref3.token,