btrz-api-client 8.30.0 → 8.31.0

package/src/endpoints/inventory/document-types.js

@@ -1,8 +1,9 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} DocumentTypesQuery
- * @property {string} [providerId] - Provider account ID (also set via opts.providerId)
+ * Query params for GET /document-types (btrz-api-inventory). See get-document-types getSpec().
+ * @typedef {Object} DocumentTypesListQuery
+ * @property {string} [providerIds] - Comma-separated provider IDs to get document types for
  */
 
 /**
@@ -18,7 +19,7 @@ function documentTypesFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {DocumentTypesQuery} [opts.query] - Query params
+   * @param {DocumentTypesListQuery} [opts.query] - Query params (providerIds); opts.providerId merged into query if set
    * @param {string} [opts.providerId] - Provider id (added to query if set)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
@@ -34,12 +35,11 @@ function documentTypesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /document-types/:id - get document type by id.
+   * GET /document-types/:id - get document type 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.id - Document type id
-   * @param {DocumentTypesQuery} [opts.query] - Query params
    * @param {string} [opts.providerId] - Provider id (added to query if set)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
@@ -55,13 +55,12 @@ function documentTypesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /document-types/:id - update document type.
+   * PUT /document-types/:id - update document type. 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 - Document type id
    * @param {Object} opts.data - Document type payload
-   * @param {DocumentTypesQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -76,12 +75,11 @@ function documentTypesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /document-types/:id - remove document type.
+   * DELETE /document-types/:id - remove document type. 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 - Document type id
-   * @param {DocumentTypesQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -95,12 +93,11 @@ function documentTypesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /document-types - create document type.
+   * POST /document-types - create document type. 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.data - Document type payload
-   * @param {DocumentTypesQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/inventory/external-passes.js

@@ -3,8 +3,17 @@ const {
 } = require("../endpoints_helpers.js");
 
 /**
- * @typedef {Object} ExternalPassesQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /external-passes (btrz-api-inventory). See get-external-passes getSpec().
+ * @typedef {Object} ExternalPassesListQuery
+ * @property {string} [passNumber] - Filter by pass number
+ * @property {string} [accountDisplayName] - Filter by Pay On Account name
+ * @property {string} [expirationDateFrom] - Filter by expiration date >= (yyyy-mm-dd)
+ * @property {string} [expirationDateTo] - Filter by expiration date <= (yyyy-mm-dd)
+ * @property {string} [lastUpdatedAt] - Filter by last updated (ISO format)
+ * @property {number} [page] - Page for pagination
+ * @property {string} [orderBy] - Field to order by
+ * @property {string} [orderDir] - asc (1) or desc (-1)
+ * @property {number} [pageSize] - Results per page
  */
 
 /**
@@ -20,7 +29,7 @@ function externalPassesFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {ExternalPassesQuery} [opts.query] - Query params
+   * @param {ExternalPassesListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -37,7 +46,7 @@ function externalPassesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /external-passes/:externalPassId - get external pass by id.
+   * GET /external-passes/:externalPassId - get external pass 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/external-wallets.js

@@ -13,11 +13,10 @@ function externalWalletsFactory({client, internalAuthTokenProvider}) {
   /** @type {{ all: function, create: function, get: function, update: function, movements: object }} */
   const saldoMax = {
     /**
-     * GET /external-wallets/saldo-max - list saldo max wallets.
+     * GET /external-wallets/saldo-max - list saldo max wallets. 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.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -28,7 +27,7 @@ function externalWalletsFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * POST /external-wallets/saldo-max - create saldo max wallet.
+     * POST /external-wallets/saldo-max - create saldo max wallet. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -45,7 +44,7 @@ function externalWalletsFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * GET /external-wallets/saldo-max/:walletId - get saldo max wallet.
+     * GET /external-wallets/saldo-max/:walletId - get saldo max wallet. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -59,7 +58,7 @@ function externalWalletsFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /external-wallets/saldo-max/:externalWallet._id - update saldo max wallet.
+     * PUT /external-wallets/saldo-max/:externalWallet._id - update saldo max wallet. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -86,7 +85,7 @@ function externalWalletsFactory({client, internalAuthTokenProvider}) {
     /** @type {{ create: function }} */
     movements: {
       /**
-       * PUT /external-wallets/saldo-max/:walletId/movements - create movement.
+       * PUT /external-wallets/saldo-max/:walletId/movements - create movement. 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/fallback-codes.js

@@ -1,5 +1,12 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /fallback-codes (btrz-api-inventory). See get-fallback-codes getSpec().
+ * @typedef {Object} FallbackCodesListQuery
+ * @property {string} [enabled] - Filter by enabled [true, false]
+ * @property {string} [lastUpdatedAt] - Filter by last updated (yyyy-mm-ddTHH:mm:ss.SSSZ)
+ */
+
 /**
  * Factory for fallback-codes API (btrz-api-inventory).
  * @param {Object} deps
@@ -13,7 +20,7 @@ function fallbackCodesFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} [opts.query] - Query params
+   * @param {FallbackCodesListQuery} [opts.query] - Query params (enabled, lastUpdatedAt)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -25,7 +32,7 @@ function fallbackCodesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /fallback-code/:id - get fallback code by id.
+   * GET /fallback-code/:id - get fallback code by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.id - Fallback code id
@@ -39,7 +46,7 @@ function fallbackCodesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /fallback-codes - create fallback code.
+   * POST /fallback-codes - create fallback code. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -57,7 +64,7 @@ function fallbackCodesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /fallback-code/:fallbackCodeId - update fallback code.
+   * PUT /fallback-code/:fallbackCodeId - update fallback code. 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/fare-classes.js

@@ -1,8 +1,10 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for fare-classes endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * Query params for GET /fare-classes (btrz-api-inventory). See get-fare-classes getSpec().
  * @typedef {Object} InventoryFareClassesQuery
+ * @property {string} [providerId] - Provider whose fare classes to return
+ * @property {string} [productIds] - Comma-separated product IDs to get fare classes for
  */
 
 /**
@@ -18,7 +20,7 @@ function fareClassesFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InventoryFareClassesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {InventoryFareClassesQuery} [opts.query] - Query params (providerId, productIds)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -31,7 +33,7 @@ function fareClassesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /fare-classes - create fare class.
+   * POST /fare-classes - create fare class. 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 +51,7 @@ function fareClassesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PATCH /fare-classes/:fareClassId - update fare class.
+   * PATCH /fare-classes/:fareClassId - update fare class. 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/fares.js

@@ -1,8 +1,14 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for fares endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * Query params for GET /fares (btrz-api-inventory). See get-fares getSpec().
  * @typedef {Object} InventoryFaresQuery
+ * @property {string} [providerIds] - Comma-separated provider IDs to get fares for
+ * @property {string} [productIds] - Comma-separated product IDs to get fares for
+ * @property {string} [productTypes] - Product type names to get fares for
+ * @property {string} [channels] - Filter by channels (must be allowed channel values)
+ * @property {string} [isBaseFare] - Filter by base fare [true, false]
+ * @property {string} [enabled] - Filter by enabled [true, false]
  */
 
 /**
@@ -17,7 +23,7 @@ function faresFactory({client, internalAuthTokenProvider}) {
    * GET /fares - list fares.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {InventoryFaresQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {InventoryFaresQuery} [opts.query] - Query params (providerIds, productIds, productTypes, channels, isBaseFare, enabled)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -29,7 +35,7 @@ function faresFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /fare/:id - get fare by id.
+   * GET /fare/:id - get fare by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.id - Fare id
@@ -43,7 +49,7 @@ function faresFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /fares - create fare.
+   * POST /fares - create fare. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -61,7 +67,7 @@ function faresFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /fare/:fareId - update fare.
+   * PUT /fare/:fareId - update fare. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -81,7 +87,7 @@ function faresFactory({client, internalAuthTokenProvider}) {
 
   const adjustments = {
     /**
-     * POST /fares/:fareId/adjustments-overrides - create adjustments override.
+     * POST /fares/:fareId/adjustments-overrides - create adjustments override. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -100,7 +106,7 @@ function faresFactory({client, internalAuthTokenProvider}) {
     },
 
     /**
-     * DELETE /fares/:fareId/adjustments-override/:adjustmentId - remove adjustments override.
+     * DELETE /fares/:fareId/adjustments-override/:adjustmentId - remove adjustments override. 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/fees.js

@@ -1,8 +1,12 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for fees endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * Query params for GET /fees (btrz-api-inventory). See fees get-handler getSpec().
  * @typedef {Object} InventoryFeesQuery
+ * @property {string} [providerIds] - Provider IDs to get fees for
+ * @property {string} [rules] - Rules where the fees apply
+ * @property {string} [productId] - Product ID for the fee
+ * @property {string} [internalId] - Fee internal id
  */
 
 /**
@@ -29,7 +33,7 @@ function feesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /fees/:feeId - get fee by id.
+   * GET /fees/:feeId - get fee 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
@@ -44,7 +48,7 @@ function feesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /fees - create fee.
+   * POST /fees - create fee. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -62,7 +66,7 @@ function feesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /fees/:feeId - update fee.
+   * PUT /fees/:feeId - update fee. 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/filtered-trips-v2.js

@@ -9,7 +9,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function filteredTripsV2Factory({client, internalAuthTokenProvider}) {
   /**
-   * POST /v2/filtered-trips - create filtered trip.
+   * POST /v2/filtered-trips - create filtered trip. 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/filtered-trips.js

@@ -1,5 +1,17 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /filtered-trips (btrz-api-inventory). See get-filtered-trips getSpec().
+ * @typedef {Object} FilteredTripsListQuery
+ * @property {string} [providerIds] - Comma-separated provider IDs
+ * @property {string} [productId] - Product ID to filter by
+ * @property {string} [originId] - Origin station ID to filter by
+ * @property {string} [destinationId] - Destination station ID to filter by
+ * @property {number} [page] - Page for pagination
+ * @property {string} [orderBy] - Field to order by
+ * @property {string} [orderDir] - asc (1) or desc (-1)
+ */
+
 /**
  * Factory for filtered-trips API (btrz-api-inventory).
  * @param {Object} deps
@@ -13,7 +25,7 @@ function filteredTripsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} [opts.query] - Query params
+   * @param {FilteredTripsListQuery} [opts.query] - Query params (providerIds, productId, originId, destinationId, page, orderBy, orderDir)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -25,7 +37,7 @@ function filteredTripsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /filtered-trips - create filtered trip.
+   * POST /filtered-trips - create filtered trip. 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/financing-costs.js

@@ -3,8 +3,16 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} FinancingCostsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /financing-costs (btrz-api-inventory). See get-financing-costs getSpec().
+ * @typedef {Object} FinancingCostsListQuery
+ * @property {number} [page] - Page number
+ * @property {string} [providerId] - Provider to get financing costs for
+ */
+
+/**
+ * Query params for GET /financing-costs/:id (btrz-api-inventory). See get-financing-cost-by-id getSpec().
+ * @typedef {Object} FinancingCostGetQuery
+ * @property {string} [providerId] - Provider to get financing cost for
  */
 
 /**
@@ -20,7 +28,7 @@ function financingCostsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {FinancingCostsQuery} [opts.query] - Query params
+   * @param {FinancingCostsListQuery} [opts.query] - Query params (page, providerId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -42,7 +50,7 @@ function financingCostsFactory({client, internalAuthTokenProvider}) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.id - Financing cost id
-   * @param {FinancingCostsQuery} [opts.query] - Query params
+   * @param {FinancingCostGetQuery} [opts.query] - Query params (providerId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -60,7 +68,7 @@ function financingCostsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /financing-costs - create financing cost.
+   * POST /financing-costs - create financing cost. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -80,12 +88,11 @@ function financingCostsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /financing-costs/:id - remove financing cost.
+   * DELETE /financing-costs/:id - remove financing cost. 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 - Financing cost id
-   * @param {FinancingCostsQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -99,7 +106,7 @@ function financingCostsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /financing-costs/:id - update financing cost.
+   * PUT /financing-costs/:id - update financing cost. 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/garages.js

@@ -1,8 +1,10 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
+ * Query params for GET /garages (btrz-api-inventory). See get-handler getSpec().
  * @typedef {Object} GaragesQuery
- * @property {string} [providerId] - Provider account ID
+ * @property {string} [location] - The garage's location
+ * @property {string} [stationId] - The id of the station associated to the garage
  */
 
 /**
@@ -18,7 +20,7 @@ function garagesFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {GaragesQuery} [opts.query] - Query params
+   * @param {GaragesQuery} [opts.query] - Query params (location, stationId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -30,7 +32,7 @@ function garagesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /garages/:garageId - get garage by id.
+   * GET /garages/:garageId - get garage 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
@@ -45,7 +47,7 @@ function garagesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /garages - create garage.
+   * POST /garages - create garage. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -86,7 +88,7 @@ function garagesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /garages/:garageId - remove garage.
+   * DELETE /garages/:garageId - remove garage. 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/getnet-terminals.js

@@ -2,6 +2,14 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * Query params for GET /getnet-terminals (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} GetnetTerminalsQuery
+ * @property {number} [page] - The page number to retrieve
+ * @property {string} [stationId] - Filter terminals by station (location) ID
+ * @property {string} [serialNumber] - Filter terminals by serial number
+ */
+
 /**
  * Factory for getnet-terminals API (btrz-api-inventory).
  * @param {Object} deps
@@ -15,7 +23,7 @@ function getnetTerminalFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} [opts.query] - Query params
+   * @param {GetnetTerminalsQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -32,7 +40,7 @@ function getnetTerminalFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /getnet-terminals/:getnetTerminalId - get a getnet terminal.
+   * GET /getnet-terminals/:getnetTerminalId - get a getnet terminal. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -77,7 +85,7 @@ function getnetTerminalFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /getnet-terminals/:getnetTerminalId - remove getnet terminal.
+   * DELETE /getnet-terminals/:getnetTerminalId - remove getnet terminal. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -99,7 +107,7 @@ function getnetTerminalFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /getnet-terminals/:getnetTerminalId - update getnet terminal.
+   * PUT /getnet-terminals/:getnetTerminalId - update getnet terminal. 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/gift-certificate-definitions.js

@@ -1,8 +1,11 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for gift-certificate-definitions endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryGiftCertificateDefinitionsQuery
+ * Query params for GET /gift-certificate-definitions (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} GiftCertificateDefinitionsListQuery
+ * @property {string[]} [channels] - Filter by channels
+ * @property {string[]} [currencies] - Filter by currencies
+ * @property {string} providerId - Provider id (required by API)
  */
 
 /**
@@ -17,7 +20,7 @@ function giftCertificateDefinitionsFactory({client, internalAuthTokenProvider})
    * GET /gift-certificate-definitions - list gift certificate definitions.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {InventoryGiftCertificateDefinitionsQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {GiftCertificateDefinitionsListQuery} [opts.query] - Query params (channels, currencies, providerId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -29,12 +32,11 @@ function giftCertificateDefinitionsFactory({client, internalAuthTokenProvider})
   }
 
   /**
-   * GET /gift-certificate-definitions/:giftcertificateId - get gift certificate definition by id.
+   * GET /gift-certificate-definitions/:giftcertificateId - get gift certificate definition 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.giftcertificateId - Gift certificate definition id
-   * @param {InventoryGiftCertificateDefinitionsQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -48,12 +50,11 @@ function giftCertificateDefinitionsFactory({client, internalAuthTokenProvider})
   }
 
   /**
-   * POST /gift-certificate-definitions - create gift certificate definition.
+   * POST /gift-certificate-definitions - create gift certificate definition. 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.giftcertificate - Gift certificate payload
-   * @param {InventoryGiftCertificateDefinitionsQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -68,13 +69,12 @@ function giftCertificateDefinitionsFactory({client, internalAuthTokenProvider})
   }
 
   /**
-   * PUT /gift-certificate-definitions/:giftcertificateId - update gift certificate definition.
+   * PUT /gift-certificate-definitions/:giftcertificateId - update gift certificate definition. 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.giftcertificateId - Gift certificate definition id
    * @param {Object} opts.giftcertificate - Gift certificate payload
-   * @param {InventoryGiftCertificateDefinitionsQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -89,12 +89,11 @@ function giftCertificateDefinitionsFactory({client, internalAuthTokenProvider})
   }
 
   /**
-   * DELETE /gift-certificate-definitions/:giftcertificateId - remove gift certificate definition.
+   * DELETE /gift-certificate-definitions/:giftcertificateId - remove gift certificate definition. 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.giftcertificateId - Gift certificate definition id
-   * @param {InventoryGiftCertificateDefinitionsQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */