btrz-api-client 8.30.0 → 8.32.0

package/src/endpoints/btrzpay/prismaTerminals.js

@@ -3,8 +3,9 @@ const {
 } = require("../endpoints_helpers.js");
 
 /**
+ * Query params for GET payment/reversal/refund and PUT refund (btrz-api-payments). See get-by-id-* and put-refunds getSpec().
  * @typedef {Object} PrismaTerminalsQuery
- * @property {string} [providerId] - Account provider/operator ID for agencies/sellers
+ * @property {string} [providerId] - Account provider (operator) ID; used by agencies/sellers
  * @property {boolean} [validateRefund] - (PUT refunds only) If true, fetch current state from Prisma before applying
  */
 
@@ -23,7 +24,7 @@ function prismaTerminalsFactory({client, internalAuthTokenProvider}) {
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.id - Reversal id
-     * @param {PrismaTerminalsQuery} [opts.query] - Query params
+     * @param {PrismaTerminalsQuery} [opts.query] - Query params (providerId)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -34,13 +35,12 @@ function prismaTerminalsFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * POST /prisma-terminals/payments/:id/reversals - create reversal.
+     * POST /prisma-terminals/payments/:id/reversals - create reversal. 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 {string} opts.id - Payment id
      * @param {Object} opts.prismaReversal - Prisma reversal payload
-     * @param {PrismaTerminalsQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -54,12 +54,11 @@ function prismaTerminalsFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * DELETE /prisma-terminals/reversals/:id - delete reversal.
+     * DELETE /prisma-terminals/reversals/:id - delete reversal. 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 {string} opts.id - Reversal id
-     * @param {PrismaTerminalsQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -80,7 +79,7 @@ function prismaTerminalsFactory({client, internalAuthTokenProvider}) {
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.id - Refund id
-     * @param {PrismaTerminalsQuery} [opts.query] - Query params
+     * @param {PrismaTerminalsQuery} [opts.query] - Query params (providerId)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -91,13 +90,12 @@ function prismaTerminalsFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * POST /prisma-terminals/payments/:id/refunds - create refund.
+     * POST /prisma-terminals/payments/:id/refunds - create refund. 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 {string} opts.id - Payment id
      * @param {Object} opts.prismaRefund - Prisma refund payload
-     * @param {PrismaTerminalsQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -111,12 +109,11 @@ function prismaTerminalsFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * DELETE /prisma-terminals/refunds/:id - delete refund.
+     * DELETE /prisma-terminals/refunds/:id - delete refund. 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 {string} opts.id - Refund id
-     * @param {PrismaTerminalsQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -135,7 +132,7 @@ function prismaTerminalsFactory({client, internalAuthTokenProvider}) {
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.id - Refund id
      * @param {Object} opts.prismaRefund - Prisma refund payload
-     * @param {PrismaTerminalsQuery} [opts.query] - Query params
+     * @param {PrismaTerminalsQuery} [opts.query] - Query params (providerId, validateRefund)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -157,7 +154,7 @@ function prismaTerminalsFactory({client, internalAuthTokenProvider}) {
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.id - Payment id
-     * @param {PrismaTerminalsQuery} [opts.query] - Query params
+     * @param {PrismaTerminalsQuery} [opts.query] - Query params (providerId)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -168,12 +165,11 @@ function prismaTerminalsFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * POST /prisma-terminals/payments - create payment.
+     * POST /prisma-terminals/payments - create payment. 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.prismaPayment - Prisma payment payload
-     * @param {PrismaTerminalsQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -187,12 +183,11 @@ function prismaTerminalsFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * DELETE /prisma-terminals/payments/:id - delete payment.
+     * DELETE /prisma-terminals/payments/:id - delete payment. 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 {string} opts.id - Payment id
-     * @param {PrismaTerminalsQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -205,13 +200,12 @@ function prismaTerminalsFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /prisma-terminals/payments/:id - update payment.
+     * PUT /prisma-terminals/payments/:id - update payment. 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 {string} opts.id - Payment id
      * @param {Object} opts.prismaPayment - Prisma payment payload
-     * @param {PrismaTerminalsQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -230,12 +224,11 @@ function prismaTerminalsFactory({client, internalAuthTokenProvider}) {
 
   const settlements = {
     /**
-     * POST /prisma-terminals/settlements - create settlement.
+     * POST /prisma-terminals/settlements - create settlement. 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.settlement - Settlement payload
-     * @param {PrismaTerminalsQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */

package/src/endpoints/btrzpay/reference-numbers.js

@@ -9,7 +9,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function referenceNumbersFactory({client, internalAuthTokenProvider}) {
   /**
-   * POST /reference-numbers - create reference number.
+   * POST /reference-numbers - create reference number. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/src/endpoints/btrzpay/referenced-payments.js

@@ -1,5 +1,11 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query for POST .../referenced-payments/:type/:referenceNumber/results (btrz-api-payments). See post-referenced-payments getSpec().
+ * @typedef {Object} ReferencedPaymentsUpdateQuery
+ * @property {string} [includePaidOrExpired] - Update beyond paid/expired for completion [true, false]
+ */
+
 /**
  * Factory for referenced payments API (btrz-api-payments).
  * @param {Object} deps
@@ -9,7 +15,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function referencedPaymentsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /referenced-payments/:transactionId/:referenceNumber/status - get status.
+   * GET /referenced-payments/:transactionId/:referenceNumber/status - get status. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -33,13 +39,15 @@ function referencedPaymentsFactory({client, internalAuthTokenProvider}) {
    * @param {string} opts.externalType - External type
    * @param {string} opts.referenceNumber - Reference number
    * @param {Object} opts.paymentResult - Payment result payload
+   * @param {ReferencedPaymentsUpdateQuery} [opts.query] - Query params (includePaidOrExpired)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
-  function update({token, jwtToken, externalType, referenceNumber, paymentResult, headers}) {
+  function update({token, jwtToken, externalType, referenceNumber, paymentResult, query = {}, headers}) {
     return client({
       url: `/referenced-payments/${externalType}/${referenceNumber}/results`,
       method: "post",
+      params: query,
       headers: authorizationHeaders({token, jwtToken, headers}),
       data: {paymentResult}
     });

package/src/endpoints/btrzpay/square.js

@@ -11,7 +11,7 @@ const {
  */
 function squareWebhooksFactory({client, internalAuthTokenProvider}) {
   /**
-   * POST /square-webhooks/:providerId - create Square webhook.
+   * POST /square-webhooks/:providerId - create Square webhook. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -43,7 +43,7 @@ function squareWebhooksFactory({client, internalAuthTokenProvider}) {
  */
 function squareTerminalsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /square-terminals - get Square terminals.
+   * GET /square-terminals - get Square terminals. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/src/endpoints/btrzpay/stripe-terminals.js

@@ -3,8 +3,9 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} StripeTerminalsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /stripe-terminals (btrz-api-payments). See get-handler getSpec().
+ * @typedef {Object} StripeTerminalsListQuery
+ * @property {string} [providerId] - Account provider (operator) ID; used by agencies/sellers
  */
 
 /**
@@ -20,8 +21,8 @@ function stripeTerminalsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {StripeTerminalsListQuery} [opts.query] - Query params (providerId)
    * @param {Object} [opts.headers] - Optional headers
-   * @param {StripeTerminalsQuery} [opts.query] - Query params
    * @returns {Promise<import("axios").AxiosResponse>}
    */
   function all({token, jwtToken, headers, query = {}}) {
@@ -34,13 +35,12 @@ function stripeTerminalsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /stripe-terminals/:id/simulate - simulate Stripe payment.
+   * POST /stripe-terminals/:id/simulate - simulate Stripe payment. 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 {string} opts.id - Terminal id
    * @param {Object} opts.stripePayment - Stripe payment payload
-   * @param {StripeTerminalsQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/btrzpay/terminalPayments.js

@@ -3,8 +3,18 @@ const {
 } = require("../endpoints_helpers.js");
 
 /**
- * @typedef {Object} TerminalPaymentsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /terminal-payments/mit/:id (btrz-api-payments). See get-mit-by-id-handler getSpec().
+ * @typedef {Object} TerminalPaymentsMitGetQuery
+ * @property {string} [providerId] - Account provider (operator) ID; used by agencies/sellers
+ * @property {string} [branchId] - Branch id where payment started (required for GET)
+ * @property {string} [companyId] - Company id where payment started (required for GET)
+ * @property {string} [date] - Date when payment started; format dd/mm/yyyy (required for GET)
+ */
+
+/**
+ * Query params for PUT /terminal-payments/mit/:id (btrz-api-payments). See put-mit-handler getSpec().
+ * @typedef {Object} TerminalPaymentsMitPutQuery
+ * @property {string} [providerId] - Account provider (operator) ID; used by agencies/sellers
  */
 
 /**
@@ -23,7 +33,7 @@ function terminalPaymentsFactory({client, internalAuthTokenProvider}) {
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.id - Terminal payment id
      * @param {Object} opts.terminalPayment - Terminal payment payload
-     * @param {TerminalPaymentsQuery} [opts.query] - Query params
+     * @param {TerminalPaymentsMitPutQuery} [opts.query] - Query params (providerId)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -42,7 +52,7 @@ function terminalPaymentsFactory({client, internalAuthTokenProvider}) {
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.id - Terminal payment id
-     * @param {TerminalPaymentsQuery} [opts.query] - Query params
+     * @param {TerminalPaymentsMitGetQuery} [opts.query] - Query params (providerId, branchId, companyId, date)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -56,7 +66,7 @@ function terminalPaymentsFactory({client, internalAuthTokenProvider}) {
 
   const webhooks = {
     /**
-     * POST /terminal-payments/webhooks/getnet/:providerId - Getnet webhook.
+     * POST /terminal-payments/webhooks/getnet/:providerId - Getnet webhook. API does not accept query params.
      * @param {Object} opts
      * @param {Object} opts.data - Request body
      * @param {string} opts.providerId - Provider id

package/src/endpoints/coltrane/merged-fare-tables.js

@@ -10,7 +10,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function mergedFareTablesFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /coltrane/routes/:routeId/merged-fare-tables/:productId - get merged fare table.
+   * GET /coltrane/routes/:routeId/merged-fare-tables/:productId - get merged fare table. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/src/endpoints/coltrane/paths.js

@@ -2,12 +2,15 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for GET /paths (btrz-api-coltrane).
+ * Query params for GET /paths (btrz-api-coltrane). See get-paths getSpec().
  * @typedef {Object} ColtranePathsListQuery
- * @property {string} [providerId] - Provider id
- * @property {string} [productId] - Product id
- * @property {string} [originId] - Origin station id
- * @property {string} [destinationId] - Destination station id
+ * @property {string} [providerId] - Account ID of the travel provider (required by API)
+ * @property {string} [productId] - Product ID belonging to the provider (required by API)
+ * @property {string} [originId] - Origin station id (required by API)
+ * @property {string} [destinationId] - Destination station id (required by API)
+ * @property {string} [departureFromDate] - Start of search interval; ISO 8601 (e.g. 2021-10-07T17:30:00.000-0400)
+ * @property {string} [departureToDate] - End of search interval; ISO 8601; interval max 25h
+ * @property {string} [metrics] - If true, response includes metrics (debugging)
  */
 
 /**
@@ -22,7 +25,7 @@ function coltraneFactory({client, internalAuthTokenProvider}) {
    * GET /paths - list Coltrane paths.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {ColtranePathsListQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {ColtranePathsListQuery} [opts.query] - Query params (providerId, productId, originId, destinationId, etc.)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/gps/scanner-app-location.js

@@ -1,7 +1,8 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for GET /scanner-app-location (used by websales; GPS API).
+ * Query params for GET /scanner-app-location (GPS API). API is external (not in workspace);
+ * shape from btrz-vue-websales and client usage.
  * @typedef {Object} ScannerAppLocationQuery
  * @property {string} [scheduleId] - Schedule id
  * @property {string} [routeId] - Route id
@@ -22,7 +23,7 @@ function scannerAppLocationFactory({client}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {ScannerAppLocationQuery} [opts.query] - Query params (scheduleId, routeId, date, includeTravelledPath)
-   * @param {Object} [opts.headers] - Optional request headers
+   * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>} response.data may contain location
    */
   function get({token, query = {}, headers}) {

package/src/endpoints/inventory/amenities.js

@@ -1,8 +1,12 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} AmenitiesQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /amenities (btrz-api-inventory). See get-amenities getSpec().
+ * @typedef {Object} AmenitiesListQuery
+ * @property {string} [name] - Filter by name
+ * @property {string} [amenityId] - Filter by amenity ID
+ * @property {string} [enabled] - Filter by enabled status
+ * @property {number} [page] - Page for pagination
  */
 
 /**
@@ -18,7 +22,7 @@ function amenitiesFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {AmenitiesQuery} [opts.query] - Query params
+   * @param {AmenitiesListQuery} [opts.query] - Query params (name, amenityId, enabled, page)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -30,12 +34,11 @@ function amenitiesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /amenities/:amenityId - get amenity by id.
+   * GET /amenities/:amenityId - get amenity by id. 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 {string} opts.amenityId - Amenity id
-   * @param {AmenitiesQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -47,7 +50,7 @@ function amenitiesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /amenities - create amenity.
+   * POST /amenities - create amenity. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -65,7 +68,7 @@ function amenitiesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /amenities/:amenityId - update amenity.
+   * PUT /amenities/:amenityId - update amenity. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

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

@@ -1,8 +1,13 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} AmenityGroupsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /amenity-groups (btrz-api-inventory). See get-amenity-groups getSpec().
+ * @typedef {Object} AmenityGroupsListQuery
+ * @property {string} [name] - Filter by name
+ * @property {string} [amenityId] - Filter by amenity ID
+ * @property {string} [enabled] - Filter by enabled status
+ * @property {number} [page] - Page for pagination
+ * @property {number} [pageSize] - Results per page
  */
 
 /**
@@ -18,7 +23,7 @@ function amenityGroupsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {AmenityGroupsQuery} [opts.query] - Query params
+   * @param {AmenityGroupsListQuery} [opts.query] - Query params (name, amenityId, enabled, page, pageSize)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -30,12 +35,11 @@ function amenityGroupsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /amenity-groups/:amenityGroupId - get amenity group by id.
+   * GET /amenity-groups/:amenityGroupId - get amenity group by id. 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 {string} opts.amenityGroupId - Amenity group id
-   * @param {AmenityGroupsQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -47,7 +51,7 @@ function amenityGroupsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /amenity-groups - create amenity group.
+   * POST /amenity-groups - create amenity group. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -65,7 +69,7 @@ function amenityGroupsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /amenity-groups/:amenityGroupId - update amenity group.
+   * PUT /amenity-groups/:amenityGroupId - update amenity group. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/src/endpoints/inventory/banks.js

@@ -2,11 +2,6 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
-/**
- * @typedef {Object} BanksQuery
- * @property {string} [providerId] - Provider account ID
- */
-
 /**
  * Factory for banks API (btrz-api-inventory).
  * @param {Object} deps
@@ -16,11 +11,10 @@ const {
  */
 function banksFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /banks - list banks.
+   * GET /banks - list banks. 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 {BanksQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -37,7 +31,7 @@ function banksFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /banks/:bankId - get bank by id.
+   * GET /banks/:bankId - get bank by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -52,7 +46,7 @@ function banksFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /banks - create bank.
+   * POST /banks - create bank. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -72,7 +66,7 @@ function banksFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /banks/:bankId - remove bank.
+   * DELETE /banks/:bankId - remove bank. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -89,7 +83,7 @@ function banksFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /banks/:bankId - update bank.
+   * PUT /banks/:bankId - update bank. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/src/endpoints/inventory/bare-routes.js

@@ -1,8 +1,16 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} BareRoutesQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /bare-routes (btrz-api-inventory). See get-bare-routes getSpec().
+ * @typedef {Object} BareRoutesListQuery
+ * @property {string} [providerIds] - Comma-separated provider IDs
+ * @property {string} [productIds] - Comma-separated product IDs
+ */
+
+/**
+ * Query params for GET /bare-routes/:routeId (btrz-api-inventory). See get-bare-routes-id getSpec().
+ * @typedef {Object} BareRoutesGetQuery
+ * @property {string} [providerIds] - Comma-separated provider IDs
  */
 
 /**
@@ -18,7 +26,7 @@ function bareRoutesFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {BareRoutesQuery} [opts.query] - Query params
+   * @param {BareRoutesListQuery} [opts.query] - Query params (providerIds, productIds)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -36,7 +44,7 @@ function bareRoutesFactory({client, internalAuthTokenProvider}) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.routeId - Route id
-   * @param {BareRoutesQuery} [opts.query] - Query params
+   * @param {BareRoutesGetQuery} [opts.query] - Query params (providerIds)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/inventory/brands.js

@@ -1,8 +1,12 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} BrandsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /brands (btrz-api-inventory). See get-brands getSpec().
+ * @typedef {Object} BrandsListQuery
+ * @property {string} [providerIds] - Comma-separated provider IDs
+ * @property {string} [enabled] - Filter by enabled status
+ * @property {number} [page] - Page for pagination
+ * @property {number} [pageSize] - Results per page
  */
 
 /**
@@ -18,7 +22,7 @@ function brandsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {BrandsQuery} [opts.query] - Query params
+   * @param {BrandsListQuery} [opts.query] - Query params (providerIds, enabled, page, pageSize)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -31,7 +35,7 @@ function brandsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /brands - create brand.
+   * POST /brands - create brand. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -49,7 +53,7 @@ function brandsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /brands/:brandId - update brand.
+   * PUT /brands/:brandId - update brand. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -68,7 +72,7 @@ function brandsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /brands/:brandId - get brand by id.
+   * GET /brands/:brandId - get brand by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/src/endpoints/inventory/bundle-fares.js

@@ -1,8 +1,10 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
+ * Query params for GET /bundle/:bundleId/product/:productId (btrz-api-inventory). See get-bundle-fares getSpec().
  * @typedef {Object} BundleFaresQuery
- * @property {string} [providerId] - Provider account ID
+ * @property {string} [providerIds] - Comma-separated provider IDs
+ * @property {string} [channel] - Channel filter
  */
 
 /**
@@ -20,7 +22,7 @@ function bundleFaresFactory({client, internalAuthTokenProvider}) {
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.bundleId - Bundle id
    * @param {string} opts.productId - Product id
-   * @param {BundleFaresQuery} [opts.query] - Query params
+   * @param {BundleFaresQuery} [opts.query] - Query params (providerIds, channel)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */