btrz-api-client 8.30.0 → 8.31.0

package/lib/endpoints/inventory/bundles.js

@@ -4,8 +4,11 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
+ * Query params for GET /bundles (btrz-api-inventory). See get-bundles getSpec().
  * @typedef {Object} InventoryBundlesQuery
  * @property {string} [providerId] - Provider account ID
+ * @property {string} [type] - Bundle type filter
+ * @property {string} [disabled] - Filter by disabled status
  */
 
 /**
@@ -26,7 +29,7 @@ function bundlesFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InventoryBundlesQuery} [opts.query] - Query params
+   * @param {InventoryBundlesQuery} [opts.query] - Query params (providerId, type, disabled)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -45,7 +48,7 @@ function bundlesFactory(_ref) {
   }
 
   /**
-   * GET /bundles/:bundleId - get bundle by id.
+   * GET /bundles/:bundleId - get bundle 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/lib/endpoints/inventory/change-requests.js

@@ -3,6 +3,22 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /change-requests (btrz-api-inventory). See get-change-requests getSpec().
+ * @typedef {Object} ChangeRequestsListQuery
+ * @property {string} [type] - Filter by change request type
+ * @property {string} [status] - Filter by status
+ * @property {string} [createdBy] - Filter by user id
+ * @property {string} [from] - Filter by creation date from (YYYY-MM-DD)
+ * @property {string} [to] - Filter by creation date to (YYYY-MM-DD)
+ * @property {string} [operationId] - Filter by operation ID
+ * @property {string} [operationType] - Filter by operation type
+ * @property {number} [page] - Page number
+ * @property {string} [orderBy] - Field to order by
+ * @property {string} [orderDir] - asc (1) or desc (-1)
+ * @property {number} [pageSize] - Results per page
+ */
+
 /**
  * Factory for change-requests API (btrz-api-inventory).
  * @param {Object} deps
@@ -21,7 +37,7 @@ function changeRequestsFactory(_ref) {
    * @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 {ChangeRequestsListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -39,12 +55,11 @@ function changeRequestsFactory(_ref) {
   }
 
   /**
-   * GET /change-requests/:changerequestId/manifests - get change request manifests.
+   * GET /change-requests/:changerequestId/manifests - get change request manifests. 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.changerequestId - Change request id
-   * @param {Object} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -64,7 +79,7 @@ function changeRequestsFactory(_ref) {
   }
 
   /**
-   * POST /change-requests/manifests - create change request manifest.
+   * POST /change-requests/manifests - create change request manifest. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -87,7 +102,7 @@ function changeRequestsFactory(_ref) {
   }
 
   /**
-   * PUT /change-requests/:changerequestId/manifests - update change request manifest.
+   * PUT /change-requests/:changerequestId/manifests - update change request manifest. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -114,12 +129,11 @@ function changeRequestsFactory(_ref) {
   /** @type {{ get: function, create: function, update: function }} */
   var schedules = {
     /**
-     * GET /change-requests/:changeRequestId/schedules - get change request schedules.
+     * GET /change-requests/:changeRequestId/schedules - get change request schedules. 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.changeRequestId - Change request id
-     * @param {Object} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -140,7 +154,7 @@ function changeRequestsFactory(_ref) {
 
 
     /**
-     * POST /change-requests/schedules - create change request schedule.
+     * POST /change-requests/schedules - create change request schedule. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -164,7 +178,7 @@ function changeRequestsFactory(_ref) {
 
 
     /**
-     * PUT /change-requests/:changeRequestId/schedules - update change request schedule.
+     * PUT /change-requests/:changeRequestId/schedules - update change request schedule. 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/lib/endpoints/inventory/companies.js

@@ -4,8 +4,11 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Query params for companies endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * Query params for GET /companies (btrz-api-inventory). See get-companies getSpec().
  * @typedef {Object} InventoryCompaniesQuery
+ * @property {string} [search] - Term to find companies (required by API for getBySearch)
+ * @property {string} [disabled] - Filter by disabled [true, false]
+ * @property {string} [providerId] - Get items from the provider
  */
 
 /**
@@ -26,7 +29,7 @@ function companiesFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InventoryCompaniesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {InventoryCompaniesQuery} [opts.query] - Query params (search, disabled, providerId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/lib/endpoints/inventory/control-classes.js

@@ -3,6 +3,36 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /control-classes (btrz-api-inventory). See get-control-classes getSpec().
+ * @typedef {Object} ControlClassesListQuery
+ * @property {number} [page] - Page number
+ * @property {boolean} [root] - Filter roots only
+ * @property {string} [productId] - Filter by product ID
+ * @property {string} [name] - Filter by name
+ * @property {string} [scheduleId] - Only roots that could apply to this schedule (UUID)
+ * @property {string} [assignedScheduleId] - Only roots assigned to this schedule (UUID)
+ * @property {string} [amenityGroupId] - Filter by amenity group ID(s), comma-separated
+ * @property {string} [brandId] - Filter by brand ID(s), comma-separated
+ * @property {string} [fareId] - Filter by fare ID(s), comma-separated
+ * @property {string} [fareClassId] - Filter by fare class ID(s), comma-separated
+ * @property {string} [seatClassId] - Filter by seat class ID(s), comma-separated
+ * @property {string} [operatingCompanyId] - Filter by operating company ID(s), comma-separated
+ * @property {string} [channel] - Filter by channel(s), comma-separated
+ * @property {number} [advancePurchaseFrom] - Filter by advance purchase from (hours)
+ * @property {number} [advancePurchaseTo] - Filter by advance purchase to (hours)
+ */
+
+/**
+ * Query params for GET /control-classes/:controlClassId (btrz-api-inventory). See get-control-class-by-id getSpec().
+ * @typedef {Object} ControlClassGetQuery
+ * @property {boolean} [tree] - Include the full tree
+ * @property {string} [scheduleId] - When tree requested, filter by schedule
+ * @property {string} [scheduleBrandId] - When tree requested, filter by schedule brand
+ * @property {string} [scheduleOperatingCompanyId] - When tree requested, filter by operating company
+ * @property {string} [scheduleAmenityGroupId] - When tree requested, filter by amenity group
+ */
+
 /**
  * Factory for control-classes API (btrz-api-inventory).
  * @param {Object} deps
@@ -21,7 +51,7 @@ function controlClassesFactory(_ref) {
    * @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 {ControlClassesListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -44,7 +74,7 @@ function controlClassesFactory(_ref) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.controlClassId - Control class id
-   * @param {Object} [opts.query] - Query params
+   * @param {ControlClassGetQuery} [opts.query] - Query params (tree, scheduleId, etc.)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -63,7 +93,7 @@ function controlClassesFactory(_ref) {
   }
 
   /**
-   * POST /control-classes - create control class.
+   * POST /control-classes - create control 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
@@ -110,7 +140,7 @@ function controlClassesFactory(_ref) {
   }
 
   /**
-   * PUT /control-classes/:controlClassId - update control class.
+   * PUT /control-classes/:controlClassId - update control 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/lib/endpoints/inventory/countries.js

@@ -3,6 +3,12 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /countries (btrz-api-inventory). See get-countries getSpec().
+ * @typedef {Object} CountriesListQuery
+ * @property {string} [isoCode] - Country 2 or 3 letter ISO code
+ */
+
 /**
  * Factory for countries API (btrz-api-inventory).
  * @param {Object} deps
@@ -21,7 +27,7 @@ function countriesFactory(_ref) {
    * @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 {CountriesListQuery} [opts.query] - Query params (isoCode)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -39,12 +45,11 @@ function countriesFactory(_ref) {
   }
 
   /**
-   * GET /countries/:id - get country by id.
+   * GET /countries/:id - get country 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 - Country id
-   * @param {Object} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/lib/endpoints/inventory/custom-content.js

@@ -4,8 +4,10 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Query params for custom-content endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * Query params for GET /custom-content (btrz-api-inventory). See get-custom-contents getSpec().
  * @typedef {Object} InventoryCustomContentQuery
+ * @property {string} [enabled] - Filter by enabled (true, false)
+ * @property {string} [pageId] - The page for the content
  */
 
 /**
@@ -26,7 +28,7 @@ function customContentFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InventoryCustomContentQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {InventoryCustomContentQuery} [opts.query] - Query params (enabled, pageId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -43,7 +45,7 @@ function customContentFactory(_ref) {
   }
 
   /**
-   * GET /custom-content/:customContentId - get custom content by id.
+   * GET /custom-content/:customContentId - get custom content 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
@@ -62,7 +64,7 @@ function customContentFactory(_ref) {
   }
 
   /**
-   * POST /custom-content - create custom content.
+   * POST /custom-content - create custom content. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -87,7 +89,7 @@ function customContentFactory(_ref) {
   }
 
   /**
-   * DELETE /custom-content/:customContentId - remove custom content.
+   * DELETE /custom-content/:customContentId - remove custom content. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -109,7 +111,7 @@ function customContentFactory(_ref) {
   }
 
   /**
-   * PUT /custom-content/:customContentId - update custom content.
+   * PUT /custom-content/:customContentId - update custom content. 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/lib/endpoints/inventory/custom-fields.js

@@ -4,8 +4,11 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Query params for custom-fields endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * Query params for GET /custom-fields (btrz-api-inventory). See get-custom-fields getSpec().
  * @typedef {Object} InventoryCustomFieldsQuery
+ * @property {string} [enabled] - Required value of the disabled field
+ * @property {string} [required] - Required value of the required field
+ * @property {string} [modelName] - Filter by model (Transactions, Stations)
  */
 
 /**
@@ -26,7 +29,7 @@ function customFieldsFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InventoryCustomFieldsQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {InventoryCustomFieldsQuery} [opts.query] - Query params (enabled, required, modelName)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -44,12 +47,11 @@ function customFieldsFactory(_ref) {
   }
 
   /**
-   * GET /custom-fields/:fieldId - get custom field by id.
+   * GET /custom-fields/:fieldId - get custom field 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.fieldId - Field id
-   * @param {InventoryCustomFieldsQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -69,7 +71,7 @@ function customFieldsFactory(_ref) {
   }
 
   /**
-   * POST /custom-fields - create custom field.
+   * POST /custom-fields - create custom field. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -92,7 +94,7 @@ function customFieldsFactory(_ref) {
   }
 
   /**
-   * PUT /custom-fields/:fieldId - update custom field.
+   * PUT /custom-fields/:fieldId - update custom field. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -119,7 +121,7 @@ function customFieldsFactory(_ref) {
   /** @type {{ all: function }} */
   var types = {
     /**
-     * GET /custom-fields/types - list custom field types.
+     * GET /custom-fields/types - list custom field types. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {Object} [opts.headers] - Optional headers

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

@@ -6,8 +6,9 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * @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
  */
 
 /**
@@ -28,7 +29,7 @@ function documentTypesFactory(_ref) {
    * @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>}
@@ -51,12 +52,11 @@ function documentTypesFactory(_ref) {
   }
 
   /**
-   * 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>}
@@ -80,13 +80,12 @@ function documentTypesFactory(_ref) {
   }
 
   /**
-   * 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>}
    */
@@ -109,12 +108,11 @@ function documentTypesFactory(_ref) {
   }
 
   /**
-   * 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>}
    */
@@ -135,12 +133,11 @@ function documentTypesFactory(_ref) {
   }
 
   /**
-   * 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/lib/endpoints/inventory/external-passes.js

@@ -4,8 +4,17 @@ var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * @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
  */
 
 /**
@@ -26,7 +35,7 @@ function externalPassesFactory(_ref) {
    * @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>}
    */
@@ -44,7 +53,7 @@ function externalPassesFactory(_ref) {
   }
 
   /**
-   * 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/lib/endpoints/inventory/external-wallets.js

@@ -19,11 +19,10 @@ function externalWalletsFactory(_ref) {
   /** @type {{ all: function, create: function, get: function, update: function, movements: object }} */
   var 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>}
      */
@@ -40,7 +39,7 @@ function externalWalletsFactory(_ref) {
       });
     },
     /**
-     * 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
@@ -62,7 +61,7 @@ function externalWalletsFactory(_ref) {
       });
     },
     /**
-     * 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
@@ -81,7 +80,7 @@ function externalWalletsFactory(_ref) {
       });
     },
     /**
-     * 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
@@ -113,7 +112,7 @@ function externalWalletsFactory(_ref) {
     /** @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/lib/endpoints/inventory/fallback-codes.js

@@ -3,6 +3,13 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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
@@ -21,7 +28,7 @@ function fallbackCodesFactory(_ref) {
    * @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>}
    */
@@ -39,7 +46,7 @@ function fallbackCodesFactory(_ref) {
   }
 
   /**
-   * 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
@@ -57,7 +64,7 @@ function fallbackCodesFactory(_ref) {
   }
 
   /**
-   * 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
@@ -80,7 +87,7 @@ function fallbackCodesFactory(_ref) {
   }
 
   /**
-   * 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/lib/endpoints/inventory/fare-classes.js

@@ -4,8 +4,10 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * 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
  */
 
 /**
@@ -26,7 +28,7 @@ function fareClassesFactory(_ref) {
    * @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>}
    */
@@ -45,7 +47,7 @@ function fareClassesFactory(_ref) {
   }
 
   /**
-   * 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
@@ -68,7 +70,7 @@ function fareClassesFactory(_ref) {
   }
 
   /**
-   * 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