btrz-api-client 8.34.0 → 8.36.0

package/lib/endpoints/inventory/labels.js

@@ -24,13 +24,14 @@ function labelsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /labels - list labels.
+   * GET /labels - list labels (paginated).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {LabelsQuery} [opts.query] - Query params (name, page)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ labels: Object[], count: number, next?: string, previous?: string }>>}
+   * @throws 401; 500.
    */
   function all(_ref2) {
     var token = _ref2.token,
@@ -50,9 +51,10 @@ function labelsFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.labelId - Label id (ObjectId format)
+   * @param {string} opts.labelId - Label id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ label: Object }>>}
+   * @throws 400 WRONG_DATA, INVALID_LABEL_ID; 401; 404 LABEL_NOT_FOUND; 500.
    */
   function get(_ref3) {
     var labelId = _ref3.labelId,
@@ -73,9 +75,10 @@ function labelsFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.label - Label payload
+   * @param {Object} opts.label - Label payload (name, description, color required; type: ticket|manifest)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ label: Object }>>}
+   * @throws 400 WRONG_DATA (name/description/color required), INVALID_TYPE; 401; 500.
    */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
@@ -96,10 +99,11 @@ function labelsFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.labelId - Label id
-   * @param {Object} opts.label - Label payload
+   * @param {string} opts.labelId - Label id (24 hex characters)
+   * @param {Object} opts.label - Label payload (LabelData)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ label: Object }>>}
+   * @throws 400 WRONG_DATA, INVALID_TYPE, LABEL_ALREADY_USED; 401; 404 LABEL_NOT_FOUND; 500.
    */
   function update(_ref5) {
     var jwtToken = _ref5.jwtToken,
@@ -121,9 +125,10 @@ function labelsFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.labelId - Label id
+   * @param {string} opts.labelId - Label id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ labelId: string }>>}
+   * @throws 400 LABEL_ID (invalid format), LABEL_ALREADY_USED; 401; 404 LABEL_NOT_FOUND; 500.
    */
   function remove(_ref6) {
     var jwtToken = _ref6.jwtToken,

package/lib/endpoints/inventory/marital-status.js

@@ -23,13 +23,14 @@ function maritalStatusFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /marital-status - list marital statuses.
+   * GET /marital-status - list marital statuses (paginated).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {MaritalStatusListQuery} [opts.query] - Query params (providerIds)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ maritalstatus: Object[], next?: string, previous?: string, count: number }>>}
+   * @throws 401; 500.
    */
   function all(_ref2) {
     var token = _ref2.token,
@@ -51,9 +52,10 @@ function maritalStatusFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Marital status id
+   * @param {string} opts.id - Marital status id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ maritalstatus: Object }>>}
+   * @throws 400 WRONG_DATA, INVALID_MARITALSTATUS_ID; 401; 404 MARITALSTATUS_NOT_FOUND; 500.
    */
   function get(_ref3) {
     var token = _ref3.token,
@@ -76,10 +78,11 @@ function maritalStatusFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Marital status id
-   * @param {Object} opts.data - Request body
+   * @param {string} opts.id - Marital status id (24 hex characters)
+   * @param {Object} opts.data - Request body (MaritalStatusPutData: name, ord, lexiconKeys)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ maritalstatus: Object }>>}
+   * @throws 400 WRONG_DATA; 401; 404 MARITALSTATUS_NOT_FOUND; 409 CANNOT_UPDATE_LEXICON_ENTRIES; 500.
    */
   function update(_ref4) {
     var token = _ref4.token,
@@ -104,9 +107,10 @@ function maritalStatusFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Marital status id
+   * @param {string} opts.id - Marital status id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ maritalstatusId: string }>>}
+   * @throws 400 WRONG_DATA, INVALID_MARITALSTATUS_ID; 401; 404 MARITALSTATUS_NOT_FOUND; 500.
    */
   function remove(_ref5) {
     var token = _ref5.token,
@@ -129,9 +133,10 @@ function maritalStatusFactory(_ref) {
    * @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.data - Request body (MaritalStatusPostData: name, ord, lexiconKeys required)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ maritalstatus: Object }>>}
+   * @throws 400 WRONG_DATA (maritalstatus/name/ord/lexiconKeys required); 401; 409 CANNOT_CREATE_LEXICON_ENTRIES; 500.
    */
   function create(_ref6) {
     var token = _ref6.token,

package/lib/endpoints/inventory/marketplace-modifiers.js

@@ -31,12 +31,13 @@ function marketplaceModifierFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /marketplace-modifiers - list marketplace modifiers.
+   * GET /marketplace-modifiers - list marketplace modifiers (paginated).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {MarketplaceModifiersListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ marketplaceModifiers: Object[], next?: string, previous?: string, count: number }>>}
+   * @throws 401; 500 MISSING_ACCOUNT.
    */
   function all(_ref2) {
     var token = _ref2.token,
@@ -53,10 +54,11 @@ function marketplaceModifierFactory(_ref) {
   /**
    * GET /marketplace-modifiers/:marketplaceModifierId - get marketplace modifier by id. API does not accept query params.
    * @param {Object} opts
-   * @param {string} opts.marketplaceModifierId - Marketplace modifier id
+   * @param {string} opts.marketplaceModifierId - Marketplace modifier id (24 hex characters)
    * @param {string} [opts.token] - API key
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ marketplaceModifier: Object }>>}
+   * @throws 400 WRONG_DATA, INVALID_MARKETPLACEMODIFIER_ID; 401; 404 MARKETPLACE_MODIFIER_NOT_FOUND; 500.
    */
   function get(_ref3) {
     var marketplaceModifierId = _ref3.marketplaceModifierId,
@@ -73,9 +75,10 @@ function marketplaceModifierFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.token] - API key
-   * @param {Object} opts.marketplaceModifier - Marketplace modifier payload
+   * @param {Object} opts.marketplaceModifier - Marketplace modifier payload (MarketplaceModifierPostData)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ marketplaceModifier: Object }>>}
+   * @throws 400 WRONG_DATA, *_NOT_FOUND, INVALID_*, MODIFIER_*, OANDDS_STATION_NOT_FOUND; 401; 404; 500.
    */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
@@ -97,10 +100,11 @@ function marketplaceModifierFactory(_ref) {
    * DELETE /marketplace-modifiers/:marketplaceModifierId - remove marketplace modifier. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.marketplaceModifierId - Marketplace modifier id
+   * @param {string} opts.marketplaceModifierId - Marketplace modifier id (24 hex characters)
    * @param {string} [opts.token] - API key
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ marketplaceModifierId: string }>>}
+   * @throws 400 MARKETPLACE_MODIFIER_ID (invalid format); 401; 404 MARKETPLACE_MODIFIER_NOT_FOUND; 500.
    */
   function remove(_ref5) {
     var jwtToken = _ref5.jwtToken,
@@ -120,10 +124,11 @@ function marketplaceModifierFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.token] - API key
-   * @param {string} opts.marketplaceModifierId - Marketplace modifier id
-   * @param {Object} opts.marketplaceModifier - Marketplace modifier payload
+   * @param {string} opts.marketplaceModifierId - Marketplace modifier id (24 hex characters)
+   * @param {Object} opts.marketplaceModifier - Marketplace modifier payload (MarketplaceModifierPutData)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ marketplaceModifier: Object }>>}
+   * @throws 400 WRONG_DATA, INVALID_MARKETPLACEMODIFIER_ID, *_NOT_FOUND, INVALID_*, MODIFIER_*; 401; 404; 500.
    */
   function update(_ref6) {
     var jwtToken = _ref6.jwtToken,

package/lib/endpoints/inventory/mit-terminal-settings.js

@@ -22,7 +22,8 @@ function mitTerminalFactory(_ref) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ mitTerminalsSettings: Object[], next?: string, previous?: string, count: number }>>}
+   * @throws When the request fails (e.g. 401 Unauthorized, 500 Internal Server Error)
    */
   function all(_ref2) {
     var token = _ref2.token,
@@ -42,9 +43,10 @@ function mitTerminalFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - MIT terminal setting id
+   * @param {string} opts.id - MIT terminal setting id (24-char hex ObjectId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ mitTerminalSettings: Object }>>}
+   * @throws When the request fails (e.g. 400 INVALID_ID, 401 Unauthorized, 404 MITTERMINALSETTING_NOT_FOUND, 500 Internal Server Error)
    */
   function get(_ref3) {
     var id = _ref3.id,
@@ -62,9 +64,10 @@ function mitTerminalFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.mitTerminalSettings - MIT terminal settings payload
+   * @param {Object} opts.mitTerminalSettings - MIT terminal settings payload (name, operatingCompanyId, shiftLocationId, user, password)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ mitTerminalSettings: Object }>>}
+   * @throws When the request fails (e.g. 400 WRONG_DATA, 401 Unauthorized, 500 Internal Server Error)
    */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
@@ -87,9 +90,10 @@ function mitTerminalFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - MIT terminal setting id
+   * @param {string} opts.id - MIT terminal setting id (24-char hex ObjectId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ mitterminalsettingId: string }>>}
+   * @throws When the request fails (e.g. 400 INVALID_ID, 401 Unauthorized, 404 MITTERMINALSETTING_NOT_FOUND, 500 Internal Server Error)
    */
   function remove(_ref5) {
     var jwtToken = _ref5.jwtToken,
@@ -109,10 +113,11 @@ function mitTerminalFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - MIT terminal setting id
-   * @param {Object} opts.mitTerminalSettings - MIT terminal settings payload
+   * @param {string} opts.id - MIT terminal setting id (24-char hex ObjectId)
+   * @param {Object} opts.mitTerminalSettings - MIT terminal settings payload (name, operatingCompanyId, shiftLocationId, user, password)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ mitTerminalSettings: Object }>>}
+   * @throws When the request fails (e.g. 400 WRONG_DATA/INVALID_ID, 401, 404 MITTERMINALSETTING_NOT_FOUND, 500)
    */
   function update(_ref6) {
     var jwtToken = _ref6.jwtToken,

package/lib/endpoints/inventory/mit-terminals.js

@@ -17,12 +17,13 @@ function mitTerminalFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /mit-terminals - list MIT terminals. API does not accept query params.
+   * GET /mit-terminals - list MIT terminals (paginated). API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ mitTerminals: Object[], next?: string, previous?: string, count: number }>>}
+   * @throws 401; 500.
    */
   function all(_ref2) {
     var token = _ref2.token,
@@ -41,9 +42,10 @@ function mitTerminalFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.mitTerminalId - MIT terminal id
+   * @param {string} opts.mitTerminalId - MIT terminal id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ mitTerminal: Object }>>}
+   * @throws 400 INVALID_MIT_TERMINAL_ID; 401; 404 MIT_TERMINAL_NOT_FOUND; 500.
    */
   function get(_ref3) {
     var mitTerminalId = _ref3.mitTerminalId,
@@ -60,9 +62,10 @@ function mitTerminalFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.mitTerminal - MIT terminal payload
+   * @param {Object} opts.mitTerminal - MIT terminal payload (name, serialNumber required; user, password per API)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ mitTerminal: Object }>>}
+   * @throws 400 WRONG_DATA (mitTerminal, name, serialNumber, user, password); 401; 404 MIT_TERMINAL_NOT_FOUND; 500.
    */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
@@ -85,9 +88,10 @@ function mitTerminalFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.mitTerminalId - MIT terminal id
+   * @param {string} opts.mitTerminalId - MIT terminal id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ mitTerminalId: string }>>}
+   * @throws 400 INVALID_MIT_TERMINAL_ID; 401; 404 MIT_TERMINAL_NOT_FOUND; 500.
    */
   function remove(_ref5) {
     var jwtToken = _ref5.jwtToken,
@@ -107,10 +111,11 @@ function mitTerminalFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.mitTerminalId - MIT terminal id
-   * @param {Object} opts.mitTerminal - MIT terminal payload
+   * @param {string} opts.mitTerminalId - MIT terminal id (24 hex characters)
+   * @param {Object} opts.mitTerminal - MIT terminal payload (MitTerminalPost)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ mitTerminal: Object }>>}
+   * @throws 400 WRONG_DATA; 401; 404 MIT_TERMINAL_NOT_FOUND; 500.
    */
   function update(_ref6) {
     var jwtToken = _ref6.jwtToken,

package/lib/endpoints/inventory/operation-messages.js

@@ -36,7 +36,8 @@ function operationMessagesFactory(_ref) {
    * @param {string} [opts.token] - API key
    * @param {OperationMessagesListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ operationMessages: Object[], count?: number, next?: string, previous?: string }>>}
+   * @throws When the request fails (e.g. 401 Unauthorized, 500 Internal Server Error)
    */
   function all(_ref2) {
     var token = _ref2.token,
@@ -57,9 +58,10 @@ function operationMessagesFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.opMsgData - Operation message payload
+   * @param {Object} opts.opMsgData - Operation message payload (message, name, type, effectiveDateTimeStart/End, etc.)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<Object>>} Created OperationMessage
+   * @throws When the request fails (400, 401, 409 duplicate key, 500)
    */
   function create(_ref3) {
     var token = _ref3.token,
@@ -80,10 +82,11 @@ function operationMessagesFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.operationMessageId - Operation message id
-   * @param {Object} opts.opMsgData - Operation message payload
+   * @param {string} opts.operationMessageId - Operation message id (24-char hex ObjectId)
+   * @param {Object} opts.opMsgData - Operation message payload (message, name, type, etc.)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<Object>>} Updated OperationMessage
+   * @throws When the request fails (400, 401, 404 NOT_FOUND, 500)
    */
   function update(_ref4) {
     var token = _ref4.token,
@@ -104,9 +107,10 @@ function operationMessagesFactory(_ref) {
    * GET /operation-messages/:operationMessageId - get operation message by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} opts.operationMessageId - Operation message id
+   * @param {string} opts.operationMessageId - Operation message id (24-char hex ObjectId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<Object>>} Response body is the OperationMessage
+   * @throws When the request fails (e.g. 401 Unauthorized, 404 NOT_FOUND, 500 Internal Server Error)
    */
   function get(_ref5) {
     var token = _ref5.token,
@@ -124,10 +128,11 @@ function operationMessagesFactory(_ref) {
    * DELETE /operation-messages/:operationMessageId - remove operation message. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.operationMessageId - Operation message id
+   * @param {string} opts.operationMessageId - Operation message id (24-char hex ObjectId)
    * @param {string} [opts.token] - API key
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<void>>} 204 No Content on success
+   * @throws When the request fails (e.g. 401 Unauthorized, 404 NOT_FOUND, 500 Internal Server Error)
    */
   function remove(_ref6) {
     var jwtToken = _ref6.jwtToken,
@@ -147,9 +152,10 @@ function operationMessagesFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.opMsgData - Request body (station criteria)
+   * @param {Object} opts.opMsgData - Request body (OperationMessagesStationsQuery: station criteria and dates)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<Object>>} Response body matches OperationMessagesStations schema
+   * @throws When the request fails (e.g. 400 INVALID_DATE_RANGE/INVALID_STATION, 401, 500)
    */
   function getByStation(_ref7) {
     var token = _ref7.token,

package/lib/endpoints/inventory/operation-reasons.js

@@ -29,7 +29,8 @@ function operationReasonFactory(_ref) {
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {OperationReasonsListQuery} [opts.query] - Query params (page)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ operationReasons: Object[], next?: string, previous?: string, count: number }>>}
+   * @throws When the request fails (e.g. 400 INVALID_PAGE, 401 Unauthorized, 500)
    */
   function all(_ref2) {
     var token = _ref2.token,
@@ -51,9 +52,10 @@ function operationReasonFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Operation reason id
+   * @param {string} opts.id - Operation reason id (24-char hex ObjectId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ operationReason: Object }>>}
+   * @throws When the request fails (400 INVALID_OPERATION_REASON_ID, 401, 404 OPERATION_REASON_NOT_FOUND, 500)
    */
   function get(_ref3) {
     var token = _ref3.token,
@@ -76,10 +78,11 @@ function operationReasonFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Operation reason id
-   * @param {Object} opts.operationReason - Operation reason payload
+   * @param {string} opts.id - Operation reason id (24-char hex ObjectId)
+   * @param {Object} opts.operationReason - Operation reason payload (name, type, lexiconKeys, etc.)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ operationReason: Object }>>}
+   * @throws When the request fails (400 WRONG_DATA/INVALID_OPERATION_REASON_ID, 401, 404, 500)
    */
   function update(_ref4) {
     var token = _ref4.token,
@@ -104,9 +107,10 @@ function operationReasonFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Operation reason id
+   * @param {string} opts.id - Operation reason id (24-char hex ObjectId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ _id: string }>>}
+   * @throws When the request fails (400 INVALID_OPERATION_REASON_ID, 401, 404 OPERATION_REASON_NOT_FOUND, 500)
    */
   function remove(_ref5) {
     var token = _ref5.token,
@@ -129,9 +133,10 @@ function operationReasonFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.operationReason - Operation reason payload
+   * @param {Object} opts.operationReason - Operation reason payload (name, type, lexiconKeys required)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ operationReason: Object }>>}
+   * @throws When the request fails (400 WRONG_DATA, 401, 409 CANNOT_CREATE_LEXICON_ENTRIES, 500)
    */
   function create(_ref6) {
     var token = _ref6.token,

package/lib/endpoints/inventory/pay-on-accounts.js

@@ -28,14 +28,15 @@ function payOnAccountsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /pay-on-accounts - list pay-on accounts.
+   * GET /pay-on-accounts - list pay-on accounts. When format=csv returns CSV (text/csv); otherwise JSON with pagination.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {PayOnAccountsListQuery} [opts.query] - Query params
-   * @param {string} [opts.responseType] - Response type (e.g. json)
+   * @param {PayOnAccountsListQuery} [opts.query] - Query params (page, format, disabled, term, fareIds, providerId)
+   * @param {string} [opts.responseType] - Response type (e.g. json); use for CSV when format=csv
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ payOnAccounts: Object[], next?: string, previous?: string, count: number }|string>>}
+   * @throws When the request fails (400 INVALID_PAGE/INVALID_FARE_IDS/INVALID_PROVIDER_ID/INVALID_SEARCH_TERM, 401, 500)
    */
   function all(_ref2) {
     var token = _ref2.token,

package/lib/endpoints/inventory/payment-terminals.js

@@ -21,7 +21,8 @@ function paymentTerminalFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ paymentTerminals: Object[], next?: string, previous?: string, count: number }>>}
+   * @throws When the request fails (401 Unauthorized, 500 Internal Server Error)
    */
   function all(_ref2) {
     var token = _ref2.token,
@@ -38,10 +39,11 @@ function paymentTerminalFactory(_ref) {
   /**
    * GET /payment-terminals/:paymentTerminalId - get payment terminal by id. API does not accept query params.
    * @param {Object} opts
-   * @param {string} opts.paymentTerminalId - Payment terminal id
+   * @param {string} opts.paymentTerminalId - Payment terminal id (24-char hex ObjectId)
    * @param {string} [opts.token] - API key
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ paymentTerminal: Object }>>}
+   * @throws When the request fails (400 INVALID_PAYMENT_TERMINAL_ID, 401, 404 PAYMENT_TERMINAL_NOT_FOUND, 500)
    */
   function get(_ref3) {
     var paymentTerminalId = _ref3.paymentTerminalId,
@@ -58,9 +60,10 @@ function paymentTerminalFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.token] - API key
-   * @param {Object} opts.paymentTerminal - Payment terminal payload
+   * @param {Object} opts.paymentTerminal - Payment terminal payload (name, protocol, ip, locationId, partNumber, serialNumber)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ paymentTerminal: Object }>>}
+   * @throws When the request fails (400 WRONG_DATA, 401, 500)
    */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
@@ -82,10 +85,11 @@ function paymentTerminalFactory(_ref) {
    * DELETE /payment-terminals/:paymentTerminalId - remove payment terminal. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.paymentTerminalId - Payment terminal id
+   * @param {string} opts.paymentTerminalId - Payment terminal id (24-char hex ObjectId)
    * @param {string} [opts.token] - API key
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ paymentTerminalId: string }>>}
+   * @throws When the request fails (400 INVALID_PAYMENT_TERMINAL_ID, 401, 404 PAYMENT_TERMINAL_NOT_FOUND, 500)
    */
   function remove(_ref5) {
     var jwtToken = _ref5.jwtToken,
@@ -105,10 +109,11 @@ function paymentTerminalFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.token] - API key
-   * @param {string} opts.paymentTerminalId - Payment terminal id
-   * @param {Object} opts.paymentTerminal - Payment terminal payload
+   * @param {string} opts.paymentTerminalId - Payment terminal id (24-char hex ObjectId)
+   * @param {Object} opts.paymentTerminal - Payment terminal payload (name, protocol, ip, locationId, partNumber, serialNumber)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ paymentTerminal: Object }>>}
+   * @throws When the request fails (400 WRONG_DATA, 401, 404 PAYMENT_TERMINAL_NOT_FOUND, 500)
    */
   function update(_ref6) {
     var jwtToken = _ref6.jwtToken,