btrz-api-client 8.34.0 → 8.36.0

package/src/endpoints/inventory/labels.js

@@ -16,13 +16,14 @@ const {authorizationHeaders} = require("../endpoints_helpers.js");
  */
 function labelsFactory({client, 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({token, jwtToken, query = {}, headers}) {
     return client.get("/labels", {
@@ -36,9 +37,10 @@ function labelsFactory({client, internalAuthTokenProvider}) {
    * @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({labelId, token, jwtToken, query = {}, headers}) {
     return client.get(`/labels/${labelId}`, {
@@ -52,9 +54,10 @@ function labelsFactory({client, internalAuthTokenProvider}) {
    * @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({jwtToken, label, token, headers}) {
     return client({
@@ -70,10 +73,11 @@ function labelsFactory({client, internalAuthTokenProvider}) {
    * @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({jwtToken, token, labelId, label, headers}) {
     return client({
@@ -90,9 +94,10 @@ function labelsFactory({client, internalAuthTokenProvider}) {
    * @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({jwtToken, token, labelId, headers}) {
     return client({

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

@@ -15,13 +15,14 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function maritalStatusFactory({client, 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({token, jwtToken, query = {}, headers}) {
     return client({
@@ -37,9 +38,10 @@ function maritalStatusFactory({client, internalAuthTokenProvider}) {
    * @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({token, jwtToken, id, query = {}, headers}) {
     return client({
@@ -55,10 +57,11 @@ function maritalStatusFactory({client, internalAuthTokenProvider}) {
    * @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({token, jwtToken, id, data, query = {}, headers}) {
     return client({
@@ -75,9 +78,10 @@ function maritalStatusFactory({client, internalAuthTokenProvider}) {
    * @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({token, jwtToken, id, query = {}, headers}) {
     return client({
@@ -93,9 +97,10 @@ function maritalStatusFactory({client, internalAuthTokenProvider}) {
    * @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({token, jwtToken, data, query = {}, headers}) {
     return client({

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

@@ -25,12 +25,13 @@ const {
  */
 function marketplaceModifierFactory({client, 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({
     token,
@@ -46,10 +47,11 @@ function marketplaceModifierFactory({client, internalAuthTokenProvider}) {
   /**
    * 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({marketplaceModifierId, token, headers}) {
     return client.get(`/marketplace-modifiers/${marketplaceModifierId}`, {
@@ -62,9 +64,10 @@ function marketplaceModifierFactory({client, internalAuthTokenProvider}) {
    * @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({jwtToken, token, marketplaceModifier, headers}) {
     return client({
@@ -81,10 +84,11 @@ function marketplaceModifierFactory({client, internalAuthTokenProvider}) {
    * 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({jwtToken, marketplaceModifierId, token, headers}) {
     return client({
@@ -99,10 +103,11 @@ function marketplaceModifierFactory({client, internalAuthTokenProvider}) {
    * @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({jwtToken, token, marketplaceModifierId, marketplaceModifier, headers}) {
     return client({

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

@@ -16,7 +16,8 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
    * @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({
     token,
@@ -35,9 +36,10 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
    * @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({id, token, jwtToken, headers}) {
     return client.get(`/mit-terminals-settings/${id}`, {
@@ -50,9 +52,10 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
    * @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({jwtToken, token, mitTerminalSettings, headers}) {
     return client({
@@ -70,9 +73,10 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
    * @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({jwtToken, id, token, headers}) {
     return client({
@@ -87,10 +91,11 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
    * @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({jwtToken, token, id, mitTerminalSettings, headers}) {
     return client({

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

@@ -11,12 +11,13 @@ const {
  */
 function mitTerminalFactory({client, 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({
     token,
@@ -34,9 +35,10 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
    * @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({mitTerminalId, token, headers}) {
     return client.get(`/mit-terminals/${mitTerminalId}`, {
@@ -49,9 +51,10 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
    * @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({jwtToken, token, mitTerminal, headers}) {
     return client({
@@ -69,9 +72,10 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
    * @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({jwtToken, mitTerminalId, token, headers}) {
     return client({
@@ -86,10 +90,11 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
    * @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({jwtToken, token, mitTerminalId, mitTerminal, headers}) {
     return client({

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

@@ -28,7 +28,8 @@ function operationMessagesFactory({client, internalAuthTokenProvider}) {
    * @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({token, query = {}, headers}) {
     return client({
@@ -44,9 +45,10 @@ function operationMessagesFactory({client, internalAuthTokenProvider}) {
    * @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({token, jwtToken, opMsgData, headers}) {
     return client({
@@ -62,10 +64,11 @@ function operationMessagesFactory({client, internalAuthTokenProvider}) {
    * @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({token, jwtToken, operationMessageId, opMsgData, headers}) {
     return client({
@@ -80,9 +83,10 @@ function operationMessagesFactory({client, internalAuthTokenProvider}) {
    * 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({token, operationMessageId, headers}) {
     return client({
@@ -96,10 +100,11 @@ function operationMessagesFactory({client, internalAuthTokenProvider}) {
    * 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({jwtToken, operationMessageId, token, headers}) {
     return client({
@@ -114,9 +119,10 @@ function operationMessagesFactory({client, internalAuthTokenProvider}) {
    * @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({token, jwtToken, opMsgData, headers}) {
     return client({

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

@@ -21,7 +21,8 @@ function operationReasonFactory({client, internalAuthTokenProvider}) {
    * @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({token, jwtToken, query = {}, headers}) {
     return client({
@@ -37,9 +38,10 @@ function operationReasonFactory({client, internalAuthTokenProvider}) {
    * @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({token, jwtToken, id, query = {}, headers}) {
     return client({
@@ -55,10 +57,11 @@ function operationReasonFactory({client, internalAuthTokenProvider}) {
    * @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({token, jwtToken, id, operationReason, query = {}, headers}) {
     return client({
@@ -75,9 +78,10 @@ function operationReasonFactory({client, internalAuthTokenProvider}) {
    * @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({token, jwtToken, id, query = {}, headers}) {
     return client({
@@ -93,9 +97,10 @@ function operationReasonFactory({client, internalAuthTokenProvider}) {
    * @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({token, jwtToken, operationReason, query = {}, headers}) {
     return client({

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

@@ -20,14 +20,15 @@ const {authorizationHeaders} = require("../endpoints_helpers.js");
  */
 function payOnAccountsFactory({client, 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({token, jwtToken, query = {}, responseType = "json", headers}) {
     return client.get("/pay-on-accounts", {

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

@@ -15,7 +15,8 @@ function paymentTerminalFactory({client, internalAuthTokenProvider}) {
    * @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({
     token,
@@ -31,10 +32,11 @@ function paymentTerminalFactory({client, internalAuthTokenProvider}) {
   /**
    * 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({paymentTerminalId, token, headers}) {
     return client.get(`/payment-terminals/${paymentTerminalId}`, {
@@ -47,9 +49,10 @@ function paymentTerminalFactory({client, internalAuthTokenProvider}) {
    * @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({jwtToken, token, paymentTerminal, headers}) {
     return client({
@@ -66,10 +69,11 @@ function paymentTerminalFactory({client, internalAuthTokenProvider}) {
    * 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({jwtToken, paymentTerminalId, token, headers}) {
     return client({
@@ -84,10 +88,11 @@ function paymentTerminalFactory({client, internalAuthTokenProvider}) {
    * @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({jwtToken, token, paymentTerminalId, paymentTerminal, headers}) {
     return client({