btrz-api-client 8.30.0 → 8.31.0

package/lib/endpoints/inventory/marital-status.js

@@ -4,8 +4,9 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Query params for marital-status endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryMaritalStatusQuery
+ * Query params for GET /marital-status (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} MaritalStatusListQuery
+ * @property {string} [providerIds] - Provider IDs to get marital status for
  */
 
 /**
@@ -26,7 +27,7 @@ function maritalStatusFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InventoryMaritalStatusQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {MaritalStatusListQuery} [opts.query] - Query params (providerIds)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -46,12 +47,11 @@ function maritalStatusFactory(_ref) {
   }
 
   /**
-   * GET /marital-status/:id - get marital status by id.
+   * GET /marital-status/:id - get marital status 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 - Marital status id
-   * @param {InventoryMaritalStatusQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -72,13 +72,12 @@ function maritalStatusFactory(_ref) {
   }
 
   /**
-   * PUT /marital-status/:id - update marital status.
+   * PUT /marital-status/:id - update marital 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
    * @param {string} opts.id - Marital status id
    * @param {Object} opts.data - Request body
-   * @param {InventoryMaritalStatusQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -101,12 +100,11 @@ function maritalStatusFactory(_ref) {
   }
 
   /**
-   * DELETE /marital-status/:id - remove marital status.
+   * DELETE /marital-status/:id - remove marital 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
    * @param {string} opts.id - Marital status id
-   * @param {InventoryMaritalStatusQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -127,12 +125,11 @@ function maritalStatusFactory(_ref) {
   }
 
   /**
-   * POST /marital-status - create marital status.
+   * POST /marital-status - create marital 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
    * @param {Object} opts.data - Request body
-   * @param {InventoryMaritalStatusQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/lib/endpoints/inventory/marketplace-modifiers.js

@@ -4,8 +4,17 @@ var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Query params for marketplace-modifiers endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryMarketplaceModifiersQuery
+ * Query params for GET /marketplace-modifiers (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} MarketplaceModifiersListQuery
+ * @property {string} [externalField1] - Filter by externalField1
+ * @property {string} [externalField2] - Filter by externalField2
+ * @property {string} [externalField3] - Filter by externalField3
+ * @property {string} [createdBy] - Comma-separated user IDs (created by)
+ * @property {string} [updatedBy] - Comma-separated user IDs (updated by)
+ * @property {string} [earliestPurchaseDate] - ISO 8601 datetime (purchase on or after)
+ * @property {string} [latestPurchaseDate] - ISO 8601 datetime (purchase on or before)
+ * @property {string} [earliestTravelDate] - ISO 8601 datetime (trip depart on or after)
+ * @property {string} [latestTravelDate] - ISO 8601 datetime (trip depart on or before)
  */
 
 /**
@@ -25,7 +34,7 @@ function marketplaceModifierFactory(_ref) {
    * GET /marketplace-modifiers - list marketplace modifiers.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {InventoryMarketplaceModifiersQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {MarketplaceModifiersListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -42,7 +51,7 @@ function marketplaceModifierFactory(_ref) {
   }
 
   /**
-   * GET /marketplace-modifiers/:marketplaceModifierId - get marketplace modifier by id.
+   * GET /marketplace-modifiers/:marketplaceModifierId - get marketplace modifier by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} opts.marketplaceModifierId - Marketplace modifier id
    * @param {string} [opts.token] - API key
@@ -60,7 +69,7 @@ function marketplaceModifierFactory(_ref) {
   }
 
   /**
-   * POST /marketplace-modifiers - create marketplace modifier.
+   * POST /marketplace-modifiers - create marketplace modifier. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.token] - API key
@@ -85,7 +94,7 @@ function marketplaceModifierFactory(_ref) {
   }
 
   /**
-   * DELETE /marketplace-modifiers/:marketplaceModifierId - remove marketplace modifier.
+   * DELETE /marketplace-modifiers/:marketplaceModifierId - remove marketplace modifier. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.marketplaceModifierId - Marketplace modifier id
@@ -107,7 +116,7 @@ function marketplaceModifierFactory(_ref) {
   }
 
   /**
-   * PUT /marketplace-modifiers/:marketplaceModifierId - update marketplace modifier.
+   * PUT /marketplace-modifiers/:marketplaceModifierId - update marketplace modifier. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.token] - API key

package/lib/endpoints/inventory/mit-terminal-settings.js

@@ -3,11 +3,6 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
-/**
- * @typedef {Object} MitTerminalSettingsQuery
- * @property {string} [providerId] - Provider account ID
- */
-
 /**
  * Factory for mit-terminals-settings API (btrz-api-inventory).
  * @param {Object} deps
@@ -22,11 +17,10 @@ function mitTerminalFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /mit-terminals-settings - list MIT terminal settings.
+   * GET /mit-terminals-settings - list MIT terminal settings. 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 {MitTerminalSettingsQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -44,7 +38,7 @@ function mitTerminalFactory(_ref) {
   }
 
   /**
-   * GET /mit-terminals-settings/:id - get MIT terminal setting by id.
+   * GET /mit-terminals-settings/:id - get MIT terminal setting 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
@@ -64,7 +58,7 @@ function mitTerminalFactory(_ref) {
   }
 
   /**
-   * POST /mit-terminals-settings - create MIT terminal settings.
+   * POST /mit-terminals-settings - create MIT terminal settings. 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 mitTerminalFactory(_ref) {
   }
 
   /**
-   * DELETE /mit-terminals-settings/:id - remove MIT terminal settings.
+   * DELETE /mit-terminals-settings/:id - remove MIT terminal settings. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -111,7 +105,7 @@ function mitTerminalFactory(_ref) {
   }
 
   /**
-   * PUT /mit-terminals-settings/:id - update MIT terminal settings.
+   * PUT /mit-terminals-settings/:id - update MIT terminal settings. 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/mit-terminals.js

@@ -3,11 +3,6 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
-/**
- * @typedef {Object} MitTerminalsQuery
- * @property {string} [providerId] - Provider account ID
- */
-
 /**
  * Factory for mit-terminals API (btrz-api-inventory).
  * @param {Object} deps
@@ -22,11 +17,10 @@ function mitTerminalFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /mit-terminals - list MIT terminals.
+   * GET /mit-terminals - list MIT 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
-   * @param {MitTerminalsQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -43,7 +37,7 @@ function mitTerminalFactory(_ref) {
   }
 
   /**
-   * GET /mit-terminals/:mitTerminalId - get MIT terminal by id.
+   * GET /mit-terminals/:mitTerminalId - get MIT terminal 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 +56,7 @@ function mitTerminalFactory(_ref) {
   }
 
   /**
-   * POST /mit-terminals - create MIT terminal.
+   * POST /mit-terminals - create MIT 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
@@ -87,7 +81,7 @@ function mitTerminalFactory(_ref) {
   }
 
   /**
-   * DELETE /mit-terminals/:mitTerminalId - remove MIT terminal.
+   * DELETE /mit-terminals/:mitTerminalId - remove MIT 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
@@ -109,7 +103,7 @@ function mitTerminalFactory(_ref) {
   }
 
   /**
-   * PUT /mit-terminals/:mitTerminalId - update MIT terminal.
+   * PUT /mit-terminals/:mitTerminalId - update MIT 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/lib/endpoints/inventory/operating-companies.js

@@ -4,8 +4,11 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * @typedef {Object} OperatingCompaniesQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /operating-companies (btrz-api-inventory). See get-operating-companies getSpec().
+ * @typedef {Object} OperatingCompaniesListQuery
+ * @property {string} [providerIds] - Provider IDs to get operating companies for
+ * @property {string} [enabled] - Filter by enabled [true, false]
+ * @property {number} [page] - Page number (1-based); null for unpaginated
  */
 
 /**
@@ -26,7 +29,7 @@ function operatingCompaniesFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {OperatingCompaniesQuery} [opts.query] - Query params
+   * @param {OperatingCompaniesListQuery} [opts.query] - Query params (providerIds, enabled, page)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -45,7 +48,7 @@ function operatingCompaniesFactory(_ref) {
   }
 
   /**
-   * POST /operating-companies - create operating company.
+   * POST /operating-companies - create operating company. 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 +71,7 @@ function operatingCompaniesFactory(_ref) {
   }
 
   /**
-   * PUT /operating-companies/:operatingCompanyId - update operating company.
+   * PUT /operating-companies/:operatingCompanyId - update operating company. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -93,7 +96,7 @@ function operatingCompaniesFactory(_ref) {
   }
 
   /**
-   * GET /operating-companies/:operatingCompanyId - get operating company by id.
+   * GET /operating-companies/:operatingCompanyId - get operating company 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
@@ -117,7 +120,7 @@ function operatingCompaniesFactory(_ref) {
   /** @type {{ create: function, all: function, get: function, update: function }} */
   var sequences = {
     /**
-     * POST /operating-companies/:operatingCompanyId/sequences - create sequence.
+     * POST /operating-companies/:operatingCompanyId/sequences - create sequence. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -142,7 +145,7 @@ function operatingCompaniesFactory(_ref) {
     },
 
     /**
-     * GET /operating-companies/:operatingCompanyId/sequences - list sequences.
+     * GET /operating-companies/:operatingCompanyId/sequences - list sequences. 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 +167,7 @@ function operatingCompaniesFactory(_ref) {
     },
 
     /**
-     * GET /operating-companies/:operatingCompanyId/sequences/:sequenceId - get sequence.
+     * GET /operating-companies/:operatingCompanyId/sequences/:sequenceId - get sequence. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -188,7 +191,7 @@ function operatingCompaniesFactory(_ref) {
     },
 
     /**
-     * PUT /operating-companies/:operatingCompanyId/sequences/:sequenceId - update sequence.
+     * PUT /operating-companies/:operatingCompanyId/sequences/:sequenceId - update sequence. 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/operation-messages.js

@@ -4,8 +4,17 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Query params for operation-messages endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryOperationMessagesQuery
+ * Query params for GET /operation-messages (btrz-api-inventory). See get-operation-messages getSpec().
+ * @typedef {Object} OperationMessagesListQuery
+ * @property {string} [providerId] - Provider id to get operation messages for
+ * @property {number} [page] - Page number (default 1)
+ * @property {string} [name] - Full or partial name (non case sensitive)
+ * @property {string} [type] - Operation message type
+ * @property {string} [stationId] - Station id of the operation message
+ * @property {string} [avoidPagination] - Any value = true to avoid pagination
+ * @property {string} [active] - Filter active/inactive [true, false]
+ * @property {string} [effectiveDateTimeStartBefore] - ISO datetime (start before/at)
+ * @property {string} [effectiveDateTimeEndAfter] - ISO datetime (end after/at)
  */
 
 /**
@@ -25,7 +34,7 @@ function operationMessagesFactory(_ref) {
    * GET /operation-messages - list operation messages.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {InventoryOperationMessagesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {OperationMessagesListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -44,7 +53,7 @@ function operationMessagesFactory(_ref) {
   }
 
   /**
-   * POST /operation-messages - create operation message.
+   * POST /operation-messages - create operation message. 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 +76,7 @@ function operationMessagesFactory(_ref) {
   }
 
   /**
-   * PUT /operation-messages/:operationMessageId - update operation message.
+   * PUT /operation-messages/:operationMessageId - update operation message. 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 +101,7 @@ function operationMessagesFactory(_ref) {
   }
 
   /**
-   * GET /operation-messages/:operationMessageId - get operation message by id.
+   * GET /operation-messages/:operationMessageId - get operation message by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.operationMessageId - Operation message id
@@ -112,7 +121,7 @@ function operationMessagesFactory(_ref) {
   }
 
   /**
-   * DELETE /operation-messages/:operationMessageId - remove operation message.
+   * DELETE /operation-messages/:operationMessageId - remove operation message. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.operationMessageId - Operation message id

package/lib/endpoints/inventory/operation-reasons.js

@@ -3,6 +3,12 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /operation-reasons (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} OperationReasonsListQuery
+ * @property {number} [page] - The page number to retrieve
+ */
+
 /**
  * Factory for operation-reasons API (btrz-api-inventory).
  * @param {Object} deps
@@ -21,7 +27,7 @@ function operationReasonFactory(_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 {OperationReasonsListQuery} [opts.query] - Query params (page)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -41,12 +47,11 @@ function operationReasonFactory(_ref) {
   }
 
   /**
-   * GET /operation-reasons/:id - get operation reason by id.
+   * GET /operation-reasons/:id - get operation reason 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 - Operation reason id
-   * @param {Object} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -67,13 +72,12 @@ function operationReasonFactory(_ref) {
   }
 
   /**
-   * PUT /operation-reasons/:id - update operation reason.
+   * PUT /operation-reasons/:id - update operation reason. 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 - Operation reason id
    * @param {Object} opts.operationReason - Operation reason payload
-   * @param {Object} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -96,12 +100,11 @@ function operationReasonFactory(_ref) {
   }
 
   /**
-   * DELETE /operation-reasons/:id - remove operation reason.
+   * DELETE /operation-reasons/:id - remove operation reason. 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 - Operation reason id
-   * @param {Object} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -122,12 +125,11 @@ function operationReasonFactory(_ref) {
   }
 
   /**
-   * POST /operation-reasons - create operation reason.
+   * POST /operation-reasons - create operation reason. 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.operationReason - Operation reason payload
-   * @param {Object} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/lib/endpoints/inventory/parcel-zones.js

@@ -4,8 +4,9 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Query params for parcel-zones endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryParcelZonesQuery
+ * Query params for GET /parcel-zones (btrz-api-inventory). See get-parcel-zones getSpec().
+ * @typedef {Object} ParcelZonesListQuery
+ * @property {string} [providerIds] - Provider IDs to get parcel zones for
  */
 
 /**
@@ -25,7 +26,7 @@ function parcelZonesFactory(_ref) {
    * GET /parcel-zones - list parcel zones.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {InventoryParcelZonesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {ParcelZonesListQuery} [opts.query] - Query params (providerIds)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -42,7 +43,7 @@ function parcelZonesFactory(_ref) {
   }
 
   /**
-   * POST /parcel-zones - create parcel zone.
+   * POST /parcel-zones - create parcel zone. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {Object} opts.parcelZone - Parcel zone payload
@@ -65,7 +66,7 @@ function parcelZonesFactory(_ref) {
   }
 
   /**
-   * PUT /parcel-zone/:parcelZoneId - update parcel zone.
+   * PUT /parcel-zone/:parcelZoneId - update parcel zone. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.token] - API key

package/lib/endpoints/inventory/pay-on-accounts.js

@@ -4,8 +4,14 @@ var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * @typedef {Object} PayOnAccountsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /pay-on-accounts (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} PayOnAccountsListQuery
+ * @property {number} [page] - Page number
+ * @property {string} [format] - Format to retrieve the data
+ * @property {string} [disabled] - Filter by disabled [true, false]
+ * @property {string} [term] - Search term to filter PayOnAccounts
+ * @property {string} [fareIds] - Fare ids to filter
+ * @property {string} [providerId] - Provider id to filter
  */
 
 /**
@@ -26,7 +32,7 @@ function payOnAccountsFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {PayOnAccountsQuery} [opts.query] - Query params
+   * @param {PayOnAccountsListQuery} [opts.query] - Query params
    * @param {string} [opts.responseType] - Response type (e.g. json)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}

package/lib/endpoints/inventory/payment-terminals.js

@@ -3,11 +3,6 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
-/**
- * Query params for payment-terminals endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryPaymentTerminalsQuery
- */
-
 /**
  * Factory for payment-terminals API (btrz-api-inventory).
  * @param {Object} deps
@@ -22,10 +17,9 @@ function paymentTerminalFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /payment-terminals - list payment terminals.
+   * GET /payment-terminals - list payment terminals. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {InventoryPaymentTerminalsQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -42,7 +36,7 @@ function paymentTerminalFactory(_ref) {
   }
 
   /**
-   * GET /payment-terminals/:paymentTerminalId - get payment terminal by id.
+   * GET /payment-terminals/:paymentTerminalId - get payment terminal by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} opts.paymentTerminalId - Payment terminal id
    * @param {string} [opts.token] - API key
@@ -60,7 +54,7 @@ function paymentTerminalFactory(_ref) {
   }
 
   /**
-   * POST /payment-terminals - create payment terminal.
+   * POST /payment-terminals - create payment terminal. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.token] - API key
@@ -85,7 +79,7 @@ function paymentTerminalFactory(_ref) {
   }
 
   /**
-   * DELETE /payment-terminals/:paymentTerminalId - remove payment terminal.
+   * DELETE /payment-terminals/:paymentTerminalId - remove payment terminal. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.paymentTerminalId - Payment terminal id
@@ -107,7 +101,7 @@ function paymentTerminalFactory(_ref) {
   }
 
   /**
-   * PUT /payment-terminals/:paymentTerminalId - update payment terminal.
+   * PUT /payment-terminals/:paymentTerminalId - update payment terminal. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.token] - API key

package/lib/endpoints/inventory/prisma-terminals.js

@@ -4,8 +4,12 @@ var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * @typedef {Object} InventoryPrismaTerminalsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /prisma-terminals (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} PrismaTerminalsListQuery
+ * @property {number} [page] - Page number
+ * @property {string} [providerId] - Account provider (operator) ID
+ * @property {string} [name] - Filter by terminal name (exact match)
+ * @property {string} [externalId] - Filter by terminal externalId (exact match)
  */
 
 /**
@@ -26,7 +30,7 @@ function prismaTerminalFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InventoryPrismaTerminalsQuery} [opts.query] - Query params
+   * @param {PrismaTerminalsListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -64,7 +68,7 @@ function prismaTerminalFactory(_ref) {
   }
 
   /**
-   * POST /prisma-terminals - create prisma terminal.
+   * POST /prisma-terminals - create prisma 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
@@ -89,7 +93,7 @@ function prismaTerminalFactory(_ref) {
   }
 
   /**
-   * DELETE /prisma-terminals/:prismaTerminalId - remove prisma terminal.
+   * DELETE /prisma-terminals/:prismaTerminalId - remove prisma 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
@@ -111,7 +115,7 @@ function prismaTerminalFactory(_ref) {
   }
 
   /**
-   * PUT /prisma-terminals/:prismaTerminalId - update prisma terminal.
+   * PUT /prisma-terminals/:prismaTerminalId - update prisma 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