btrz-api-client 8.33.0 → 8.35.0

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({

package/src/endpoints/inventory/products.js

@@ -40,7 +40,9 @@ function productsFactory({client, internalAuthTokenProvider}) {
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {ProductsListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ products: Array<object> }>>}
+   *   Resolves with list of products; response.data has Products shape.
+   * @throws When the request fails (400 invalid channels, 401 unauthorized, 500). ErrorResponse body.
    */
   function all({token, query = {}, headers}) {
     return client({
@@ -58,7 +60,9 @@ function productsFactory({client, internalAuthTokenProvider}) {
    * @param {string} opts.productId - Product id
    * @param {ProductGetQuery} [opts.query] - Query params (providerIds, channels, enabled)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ product: object }>>}
+   *   Resolves with single product; response.data.product is the Product.
+   * @throws When the request fails (400/401/404/500). Body: INVALID_PRODUCTID, WRONG_DATA, PRODUCT_NOTFOUND.
    */
   function get({productId, token, jwtToken, query = {}, headers}) {
     return client({
@@ -69,13 +73,16 @@ function productsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /products - create product. API does not accept query params.
+   * POST /products - create product. No query params. Requires BETTEREZ_APP JWT or API key.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.data - Product payload
+   * @param {Object} opts.data - Product payload (PostedProduct); must not include _id.
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ product: object }>>}
+   *   Resolves with the created product.
+   * @throws When the request fails (400/401/500). Body: DUPLICATE_PRODUCT, CANNOT_CREATE_PRODUCT_WITH_ID,
+   *   INVALID_PAYMENT_METHODS, INVALID_PARENT_PRODUCT_ID, INVALID_JOURNEY_RESTRICTIONS, INVALID_PRODUCT_NAME, etc.
    */
   function create({data, token, jwtToken, headers}) {
     return client({
@@ -87,14 +94,17 @@ function productsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /products/:productId - update product. API does not accept query params.
+   * PUT /products/:productId - update product. No query params. Requires BETTEREZ_APP JWT or API key.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.productId - Product id
-   * @param {Object} opts.data - Product payload
+   * @param {Object} opts.data - Product payload (PostedProduct).
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ product: object }>>}
+   *   Resolves with the updated product. Emits product.updated webhook.
+   * @throws When the request fails (400/401/404/500). Body: NOT_FOUND, INVALID_PAYMENT_METHODS,
+   *   CANNOT_SET_PARENT_AS_CHILD, INVALID_JOURNEY_RESTRICTIONS, INVALID_PRODUCT_NAME, etc.
    */
   function update({productId, data, token, jwtToken, headers}) {
     return client({
@@ -114,7 +124,8 @@ function productsFactory({client, internalAuthTokenProvider}) {
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.domain - Domain
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse>} Resolves on success. May emit product.updated.
+     * @throws When the request fails (401, 404, 500).
      */
     remove: ({token, jwtToken, domain, headers}) => {
       return client({
@@ -133,7 +144,8 @@ function productsFactory({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>} Resolves with list of product families.
+     * @throws When the request fails (401, 500).
      */
     all: ({token, query = {}, headers}) => {
       return client({

package/src/endpoints/inventory/promos.js

@@ -40,7 +40,9 @@ function promosFactory({client, internalAuthTokenProvider}) {
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {PromosListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ promos: Array<object>, total: number }>>}
+   *   Resolves with paginated promos; response.data has Promos shape.
+   * @throws When the request fails (400/401/404/500). Body: WRONG_DATA, PROMO_NOT_FOUND.
    */
   function all({token, query = {}, headers}) {
     return client.get("/promos", {
@@ -66,13 +68,15 @@ function promosFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /promos - create promo. API does not accept query params.
+   * POST /promos - create promo. No query params. Requires BETTEREZ_APP JWT or API key. Emits promo.created.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.promo - Promo payload
+   * @param {Object} opts.promo - Promo payload (PromoUpdateRequest); must not include _id.
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<object>>} Resolves with created Promo.
+   * @throws When the request fails (400/401/500). Body: WRONG_DATA, INTERNALID_USED,
+   *   CANNOT_CREATE_PROMO_WITH_ID, INVALID_PAYMENT_METHOD_TYPE, etc.
    */
   function create({jwtToken, promo, token, headers}) {
     return client({
@@ -84,13 +88,14 @@ function promosFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /promos/:promoId - remove promo. API does not accept query params.
+   * DELETE /promos/:promoId - disable promo (soft delete). No query params. Requires BETTEREZ_APP. Emits promo.deleted.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.promoId - Promo id
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse>} Resolves with disabled promo.
+   * @throws When the request fails (400/401/404/500). Body: WRONG_DATA, INVALID_PROMO_ID, PROMO_NOT_FOUND.
    */
   function remove({jwtToken, promoId, token, headers}) {
     return client({
@@ -101,14 +106,15 @@ function promosFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PATCH /promos/:promoId - update promo. API does not accept query params.
+   * PATCH /promos/:promoId - update promo (partial). No query params. Requires BETTEREZ_APP. Emits promo.updated.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.promoId - Promo id
-   * @param {Object} opts.update - Update payload
+   * @param {Object} opts.update - Partial update (PromoUpdateRequest).
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<object>>} Resolves with updated Promo.
+   * @throws When the request fails (400/401/404/500). Body: WRONG_DATA, INTERNALID_USED, PROMO_NOT_FOUND, etc.
    */
   // eslint-disable-next-line no-shadow
   function update({jwtToken, token, promoId, update, headers}) {
@@ -121,14 +127,15 @@ function promosFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PATCH /promo/:promoId - patch promo with operations. API does not accept query params.
+   * PATCH /promo/:promoId - update rule availability (add/subtract). No query params. Emits promo.updated.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.promoId - Promo id
-   * @param {Object} opts.operations - Patch operations
+   * @param {Object} opts.operations - Array of PromoUpdateOperation (op, path, value).
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<object>>} Resolves with PatchedPromos.
+   * @throws When the request fails (400/401/404/500).
    */
   function patch({jwtToken, token, promoId, operations, headers}) {
     return client({
@@ -140,14 +147,15 @@ function promosFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /promos/:promoId/rules - add promo rule. API does not accept query params.
+   * POST /promos/:promoId/rules - add promo rule. No query params. Requires BETTEREZ_APP. May emit promo.updated.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.promoId - Promo id
-   * @param {Object} opts.rule - Rule payload
+   * @param {Object} opts.rule - Rule payload (PromoRule).
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<object>>} Resolves with Promo including new rule.
+   * @throws When the request fails (400/401/404/500). Body: WRONG_DATA, INVALID_PRODUCT_ID, INVALID_FARE_ID, etc.
    */
   function addRule({jwtToken, token, promoId, rule, headers}) {
     return client({
@@ -159,15 +167,16 @@ function promosFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /promos/:promoId/rules/:ruleId - update promo rule. API does not accept query params.
+   * PUT /promos/:promoId/rules/:ruleId - update promo rule. No query params. Requires BETTEREZ_APP. Emits promo.updated.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.promoId - Promo id
    * @param {string} opts.ruleId - Rule id
-   * @param {Object} opts.rule - Rule payload
+   * @param {Object} opts.rule - Full rule payload (PromoRule).
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<object>>} Resolves with updated Promo.
+   * @throws When the request fails (400/401/404/500). Body: WRONG_DATA, INVALID_PRODUCT_ID, INVALID_FARE_ID, etc.
    */
   function updateRule({jwtToken, token, promoId, ruleId, rule, headers}) {
     return client({

package/src/endpoints/inventory/segments-information-tables.js

@@ -1,3 +1,4 @@
+/* eslint-disable max-len */
 const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
@@ -5,7 +6,7 @@ const {
 /**
  * Query params for GET /segments-information-tables/:routeId (btrz-api-inventory-trips). See get-by-id-handler getSpec().
  * @typedef {Object} SegmentsInformationTablesQuery
- * @property {string} [providerId] - Provider id of the route if not the same as the user making the request (ObjectId format)
+ * @property {string} [providerId] - Provider/account id of the route when different from the authenticated user (24-char hex ObjectId)
  */
 
 /**
@@ -17,18 +18,23 @@ const {
  */
 function segmentInformationTableFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /segments-information-tables/:routeId - get segments information table by route id.
+   * GET /segments-information-tables/:routeId — Returns segment information tables for the route (distances, durations, durationsHHMM between stops). Requires BETTEREZ_APP audience.
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.routeId - Route id (ObjectId format)
-   * @param {SegmentsInformationTablesQuery} [opts.query] - Query params (providerId)
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization: Bearer)
+   * @param {string} opts.routeId - Route id (24-char hex ObjectId)
+   * @param {SegmentsInformationTablesQuery} [opts.query] - Optional providerId
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ segmentInformationTables: { distances: Object, durations: Object, durationsHHMM: Object } }>>}
+   * @throws 400 INVALID_ROUTE_ID — routeId not 24 hex characters
+   * @throws 401 Unauthorized
+   * @throws 404 ROUTE_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function get({token, jwtToken, routeId, query = {}, headers}) {
     return client({
       url: `/segments-information-tables/${routeId}`,
+      method: "get",
       params: query,
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });

package/src/endpoints/inventory/station-groups.js

@@ -20,14 +20,12 @@ function stationGroupsFactory({client, internalAuthTokenProvider}) {
    * GET /station-groups - list station groups.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {StationGroupsListQuery} [opts.query] - Query params
+   * @param {StationGroupsListQuery} [opts.query] - Query params (e.g. providerIds)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
   function all({token, query = {}, headers}) {
-    return client({
-      url: "/station-groups",
+    return client.get("/station-groups", {
       params: query,
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });