btrz-api-client 8.30.0 → 8.31.0

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>}
    */

package/src/endpoints/inventory/bundles.js

@@ -1,8 +1,11 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
+ * 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
  */
 
 /**
@@ -18,7 +21,7 @@ function bundlesFactory({client, internalAuthTokenProvider}) {
    * @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>}
    */
@@ -31,7 +34,7 @@ function bundlesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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/src/endpoints/inventory/change-requests.js

@@ -1,5 +1,21 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * 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
@@ -13,7 +29,7 @@ function changeRequestsFactory({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 {ChangeRequestsListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -25,12 +41,11 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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>}
    */
@@ -43,7 +58,7 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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
@@ -61,7 +76,7 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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
@@ -82,12 +97,11 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
   /** @type {{ get: function, create: function, update: function }} */
   const 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>}
      */
@@ -100,7 +114,7 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
     },
 
     /**
-     * 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
@@ -118,7 +132,7 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
     },
 
     /**
-     * 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/src/endpoints/inventory/companies.js

@@ -1,8 +1,11 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * 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
  */
 
 /**
@@ -18,7 +21,7 @@ function companiesFactory({client, internalAuthTokenProvider}) {
    * @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/src/endpoints/inventory/control-classes.js

@@ -2,6 +2,36 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * 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
@@ -15,7 +45,7 @@ function controlClassesFactory({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 {ControlClassesListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -37,7 +67,7 @@ function controlClassesFactory({client, internalAuthTokenProvider}) {
    * @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>}
    */
@@ -49,7 +79,7 @@ function controlClassesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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
@@ -86,7 +116,7 @@ function controlClassesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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/src/endpoints/inventory/countries.js

@@ -1,5 +1,11 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * 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
@@ -13,7 +19,7 @@ function countriesFactory({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 {CountriesListQuery} [opts.query] - Query params (isoCode)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -26,12 +32,11 @@ function countriesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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/src/endpoints/inventory/custom-content.js

@@ -3,8 +3,10 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
- * 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
  */
 
 /**
@@ -20,7 +22,7 @@ function customContentFactory({client, internalAuthTokenProvider}) {
    * @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>}
    */
@@ -36,7 +38,7 @@ function customContentFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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
@@ -51,7 +53,7 @@ function customContentFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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
@@ -71,7 +73,7 @@ function customContentFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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
@@ -88,7 +90,7 @@ function customContentFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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/src/endpoints/inventory/custom-fields.js

@@ -1,8 +1,11 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * 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)
  */
 
 /**
@@ -18,7 +21,7 @@ function customFieldsFactory({client, internalAuthTokenProvider}) {
    * @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>}
    */
@@ -31,12 +34,11 @@ function customFieldsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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>}
    */
@@ -49,7 +51,7 @@ function customFieldsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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
@@ -67,7 +69,7 @@ function customFieldsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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
@@ -88,7 +90,7 @@ function customFieldsFactory({client, internalAuthTokenProvider}) {
   /** @type {{ all: function }} */
   const 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