btrz-api-client 8.30.0 → 8.32.0

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

@@ -3,8 +3,10 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
+ * Query params for GET /travel-routes (btrz-api-inventory). See get-handler getSpec().
  * @typedef {Object} TravelRoutesQuery
- * @property {string} [providerId] - Provider account ID
+ * @property {number} [page] - The page number to retrieve (positive integer)
+ * @property {string} [externalId] - The external id of the travel route
  */
 
 /**
@@ -20,7 +22,7 @@ function travelRoutesFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {TravelRoutesQuery} [opts.query] - Query params
+   * @param {TravelRoutesQuery} [opts.query] - Query params (page, externalId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -37,11 +39,11 @@ function travelRoutesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /travel-routes/:travelRouteId - get travel route by id.
+   * GET /travel-routes/:travelRouteId - get travel route 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.travelRouteId - Travel route id
+   * @param {string} opts.travelRouteId - Travel route id (ObjectId format)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/inventory/traveller-card-providers-types.js

@@ -1,10 +1,5 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-/**
- * Query params for traveller-card-providers-types endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryTravellerCardProvidersTypesQuery
- */
-
 /**
  * Factory for traveller-card-providers types API (btrz-api-inventory).
  * @param {Object} deps
@@ -14,10 +9,9 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function travellerCardProvidersTypesFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /traveller-card-providers/types - list traveller card provider types.
+   * GET /traveller-card-providers/types - list traveller card provider types. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {InventoryTravellerCardProvidersTypesQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/inventory/traveller-card-providers.js

@@ -1,10 +1,5 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-/**
- * Query params for GET /traveller-card-providers (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryTravellerCardProvidersListQuery
- */
-
 /**
  * Factory for traveller-card-providers API (btrz-api-inventory).
  * @param {Object} deps
@@ -14,11 +9,10 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function travellerCardProvidersFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /traveller-card-providers - list traveller card providers.
+   * GET /traveller-card-providers - list traveller card providers. 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 {InventoryTravellerCardProvidersListQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -49,7 +43,7 @@ function travellerCardProvidersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /traveller-card-providers/:travellerCardProviderId - update traveller card provider.
+   * PUT /traveller-card-providers/:travellerCardProviderId - update traveller card provider. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.token] - API key
@@ -68,7 +62,7 @@ function travellerCardProvidersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /traveller-card-providers/:travellerCardProviderId - get traveller card provider by id.
+   * GET /traveller-card-providers/:travellerCardProviderId - get traveller card provider by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.travellerCardProviderId - Traveller card provider id

package/src/endpoints/inventory/traveller-card-types.js

@@ -1,8 +1,9 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for GET /traveller-card-types (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryTravellerCardTypesListQuery
+ * Query params for GET /traveller-card-types (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} TravellerCardTypesListQuery
+ * @property {string} [providerIds] - Provider ids to get traveller card types for
  */
 
 /**
@@ -18,7 +19,7 @@ function travellerCardTypesFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InventoryTravellerCardTypesListQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {TravellerCardTypesListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -31,7 +32,7 @@ function travellerCardTypesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /traveller-card-types - create traveller card type.
+   * POST /traveller-card-types - create traveller card 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
@@ -49,7 +50,7 @@ function travellerCardTypesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /traveller-card-types/:travellerCardTypeId - update traveller card type.
+   * PUT /traveller-card-types/:travellerCardTypeId - update traveller card type. 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 +86,7 @@ function travellerCardTypesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /traveller-card-types/:travellerCardTypeId - remove traveller card type.
+   * DELETE /traveller-card-types/:travellerCardTypeId - remove traveller card type. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.travellerCardTypeId - Traveller card type id

package/src/endpoints/inventory/trips.js

@@ -1,10 +1,5 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-/**
- * Query params for GET /trips (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryTripsListQuery
- */
-
 /**
  * Factory for trips API (btrz-api-inventory).
  * @param {Object} deps
@@ -14,11 +9,10 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function tripsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /trips - list trips.
+   * GET /trips - list trips. API source of truth in btrz-api-inventory-trips; query not documented here.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InventoryTripsListQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -31,7 +25,7 @@ function tripsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /trip/:id - get trip by id.
+   * GET /trip/:id - get trip by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.id - Trip id

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

@@ -15,7 +15,6 @@ function vehicleTypesFactory({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 {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/inventory/vehicles.js

@@ -3,8 +3,23 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
+ * Query params for GET /vehicles (btrz-api-inventory). See API get-handler getSpec().
  * @typedef {Object} VehiclesQuery
- * @property {string} [providerId] - Provider account ID
+ * @property {string} [disabled] - Filter by disabled status: "true" | "false"
+ * @property {boolean} [newdesign] - With singleSeatmap: consider new design seatmaps
+ * @property {boolean} [nopaging] - If true, return all matching vehicles (no page/limit)
+ * @property {number} [page] - 1-based page (20 per page); ignored when singleSeatmap or nopaging
+ * @property {boolean} [singleSeatmap] - If true, only vehicles with exactly one original seatmap (or zero if allowed)
+ * @property {string} [name] - Case-insensitive partial match on vehicle name (max 50 chars)
+ * @property {string} [internalId] - Exact match on internalId
+ * @property {string} [garageId] - Exact match on garage ID (ObjectId)
+ * @property {string} [brandId] - Exact match on brand ID (ObjectId)
+ * @property {string} [amenityGroupId] - Exact match on amenity group ID (ObjectId)
+ * @property {string} [brand] - Exact match on brand name; use "none" for empty
+ * @property {number} [capacity] - Exact match on capacity (0–10000)
+ * @property {number} [numberFrom] - Vehicles with number >= this value
+ * @property {number} [numberTo] - Vehicles with number <= this value (must be >= numberFrom)
+ * @property {string} [providerIds] - Provider IDs to scope the request (internal use)
  */
 
 /**
@@ -20,7 +35,7 @@ function vehiclesFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {VehiclesQuery} [opts.query] - Query params
+   * @param {VehiclesQuery} [opts.query] - Query params (disabled, page, name, garageId, brandId, etc.)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/inventory/zone-price-overages.js

@@ -2,11 +2,6 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
-/**
- * Query params for zone-price-overages endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryZonePriceOveragesQuery
- */
-
 /**
  * Factory for zone-price-overages API (btrz-api-inventory).
  * @param {Object} deps
@@ -16,10 +11,9 @@ const {
  */
 function zonePriceOverageFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /zone-price-overages - list zone price overages.
+   * GET /zone-price-overages - list zone price overages. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {InventoryZonePriceOveragesQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -35,7 +29,7 @@ function zonePriceOverageFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /zone-price-overages/:zonePriceOverageId - get zone price overage by id.
+   * GET /zone-price-overages/:zonePriceOverageId - get zone price overage by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} opts.zonePriceOverageId - Zone price overage id
    * @param {string} [opts.token] - API key
@@ -49,7 +43,7 @@ function zonePriceOverageFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /zone-price-overages - create zone price overage(s).
+   * POST /zone-price-overages - create zone price overage(s). API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.token] - API key
@@ -86,7 +80,7 @@ function zonePriceOverageFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /zone-price-overages/:zonePriceOverageId - update zone price overage.
+   * PUT /zone-price-overages/:zonePriceOverageId - update zone price overage. 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/src/endpoints/inventory/zone-prices.js

@@ -3,8 +3,13 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
- * Query params for zone-prices endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryZonePricesQuery
+ * Query params for GET /zone-prices (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} ZonePricesListQuery
+ * @property {number} [page] - Page number (20 records per page)
+ * @property {number} [weight] - Weight in grams
+ * @property {string} [serviceTypeIds] - Service type id(s), comma-separated
+ * @property {string} [departureZones] - Departure zone(s), comma-separated
+ * @property {string} [arrivalZones] - Arrival zone(s), comma-separated
  */
 
 /**
@@ -19,7 +24,7 @@ function zonePriceFactory({client, internalAuthTokenProvider}) {
    * GET /zone-prices - list zone prices.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {InventoryZonePricesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {ZonePricesListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -35,7 +40,7 @@ function zonePriceFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /zone-prices/:zonePriceId - get zone price by id.
+   * GET /zone-prices/:zonePriceId - get zone price by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} opts.zonePriceId - Zone price id
    * @param {string} [opts.token] - API key
@@ -49,7 +54,7 @@ function zonePriceFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /zone-prices - create zone price.
+   * POST /zone-prices - create zone price. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.token] - API key
@@ -69,7 +74,7 @@ function zonePriceFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /zone-prices/:zonePriceId - remove zone price.
+   * DELETE /zone-prices/:zonePriceId - remove zone price. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.zonePriceId - Zone price id
@@ -86,7 +91,7 @@ function zonePriceFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /zone-prices/:zonePriceId - update zone price.
+   * PUT /zone-prices/:zonePriceId - update zone price. 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/src/endpoints/invoices/dlink.js

@@ -2,9 +2,10 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for POST /dlink (btrz-api-invoices). onlyValidateRequest optional.
+ * Query params for POST /dlink (btrz-api-invoices). See post-dlink-handler getSpec().
  * @typedef {Object} InvoiceDlinkPostQuery
- * @property {string} [onlyValidateRequest] - If true, only validates the payload and does not process it
+ * @property {string|boolean} [onlyValidateRequest] - If true, only validates the payload and does not process it
+ * @property {string} [providerId] - Invoice provider id to use
  */
 
 /**

package/src/endpoints/invoices/emails.js

@@ -1,11 +1,6 @@
 /* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-/**
- * Query params for POST /emails (btrz-api-invoices). Forwarded to API as-is.
- * @typedef {Object} InvoiceEmailsPostQuery
- */
-
 /**
  * Factory for invoice emails API (btrz-api-invoices).
  * @param {Object} deps
@@ -15,12 +10,11 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function emailsFactory({client, internalAuthTokenProvider}) {
   /**
-   * POST /emails - create/send invoice email.
+   * POST /emails - create/send invoice email. 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 {InvoiceEmailsPostQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/invoices/gti.js

@@ -2,9 +2,9 @@
 const {authorizationHeaders} = require("../endpoints_helpers.js");
 
 /**
- * Query params for POST /gti (btrz-api-invoices). onlyValidateRequest optional.
+ * Query params for POST /gti (btrz-api-invoices). See post-gti-handler getSpec().
  * @typedef {Object} InvoiceGtiPostQuery
- * @property {string} [onlyValidateRequest] - If true, only validates the payload and does not process it
+ * @property {string|boolean} [onlyValidateRequest] - If true, only validates the payload and does not process it
  */
 
 /**

package/src/endpoints/invoices/infile.js

@@ -2,9 +2,9 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for POST /infile (btrz-api-invoices). onlyValidateRequest optional.
+ * Query params for POST /infile (btrz-api-invoices). See post-infile-handler getSpec().
  * @typedef {Object} InvoiceInfilePostQuery
- * @property {string} [onlyValidateRequest] - If true, only validates the payload and does not process it
+ * @property {string|boolean} [onlyValidateRequest] - If true, only validates the payload and does not process it
  */
 
 /**

package/src/endpoints/invoices/infileJson.js

@@ -2,9 +2,9 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for POST /infile-json (btrz-api-invoices). onlyValidateRequest optional.
+ * Query params for POST /infile-json (btrz-api-invoices). See post-infile-json-handler getSpec().
  * @typedef {Object} InvoiceInfileJsonPostQuery
- * @property {string} [onlyValidateRequest] - If true, only validates the payload and does not process it
+ * @property {string|boolean} [onlyValidateRequest] - If true, only validates the payload and does not process it
  */
 
 /**

package/src/endpoints/invoices/invoices.js

@@ -2,8 +2,15 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for invoices endpoints (btrz-api-invoices). Forwarded to API as-is.
- * @typedef {Object} InvoicesQuery
+ * Query params for GET /invoices (btrz-api-invoices). See get-handler getSpec().
+ * @typedef {Object} InvoicesListQuery
+ * @property {string} transactionId - Transaction id of the invoice (required)
+ */
+
+/**
+ * Query params for GET /failures (btrz-api-invoices). See get-failures-handler getSpec().
+ * @typedef {Object} InvoicesFailuresQuery
+ * @property {string} [transactionId] - Transaction id of the invoice failure
  */
 
 /**
@@ -19,7 +26,7 @@ function invoicesFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InvoicesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {InvoicesListQuery} [opts.query] - Query params (transactionId required)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -33,12 +40,11 @@ function invoicesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /invoices/:id - get invoice by id.
+   * GET /invoices/:id - get invoice 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 - Invoice id
-   * @param {InvoicesQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -56,7 +62,7 @@ function invoicesFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InvoicesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {InvoicesFailuresQuery} [opts.query] - Query params (transactionId optional)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -70,12 +76,11 @@ function invoicesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /retry - retry invoicing.
+   * POST /retry - retry invoicing. 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 {InvoicesQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -90,12 +95,11 @@ function invoicesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /retry - override buyer and retry invoicing.
+   * PUT /retry - override buyer and retry invoicing. 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 {InvoicesQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/invoices/pdfs.js

@@ -2,8 +2,9 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for GET /pdfs (btrz-api-invoices). Forwarded to API as-is.
- * @typedef {Object} InvoicePdfsListQuery
+ * Query params for GET /pdfs (btrz-api-invoices). See pdfs get-handler getSpec().
+ * @typedef {Object} PdfsListQuery
+ * @property {string} transactionId - Transaction id of the invoice (required)
  */
 
 /**
@@ -19,7 +20,7 @@ function pdfsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InvoicePdfsListQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {PdfsListQuery} [opts.query] - Query params (transactionId required)
    * @param {string} [opts.responseType] - Response type (e.g. "json", "blob")
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}

package/src/endpoints/invoices/providers.js

@@ -2,8 +2,13 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for invoice providers endpoints (btrz-api-invoices). Forwarded to API as-is.
- * @typedef {Object} InvoiceProvidersQuery
+ * Query params for GET /providers (btrz-api-invoices). See providers get-handler getSpec().
+ * @typedef {Object} ProvidersListQuery
+ * @property {boolean} [enabled] - If the provider is enabled or not
+ * @property {string} [invoiceProviderType] - The type of the provider
+ * @property {string} [channel] - Filter by channel (must be one of the allowed channels)
+ * @property {string} [country] - ISO code of the provider's country
+ * @property {string} [operatingCompany] - Operating company id associated with the provider
  */
 
 /**
@@ -19,7 +24,7 @@ function providersFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InvoiceProvidersQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {ProvidersListQuery} [opts.query] - Query params (all optional)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -33,12 +38,11 @@ function providersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /providers/:id - get invoice provider by id.
+   * GET /providers/:id - get invoice provider 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 - Provider id
-   * @param {InvoiceProvidersQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -52,13 +56,12 @@ function providersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /providers/:id - update invoice provider.
+   * PUT /providers/:id - update invoice provider. 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 - Provider id
    * @param {Object} opts.data - Request body
-   * @param {InvoiceProvidersQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -73,12 +76,11 @@ function providersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /providers/:id - remove invoice provider.
+   * DELETE /providers/:id - remove invoice provider. 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 - Provider id
-   * @param {InvoiceProvidersQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -92,12 +94,11 @@ function providersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /providers - create invoice provider.
+   * POST /providers - create invoice provider. 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 {InvoiceProvidersQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */