btrz-api-client 8.29.0 → 8.31.0

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

@@ -1,8 +1,31 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /travel-routes (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} TravelRoutesQuery
+ * @property {number} [page] - The page number to retrieve (positive integer)
+ * @property {string} [externalId] - The external id of the travel route
+ */
+
+/**
+ * Factory for travel-routes API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function }}
+ */
 function travelRoutesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /travel-routes - list travel routes.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {TravelRoutesQuery} [opts.query] - Query params (page, externalId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     jwtToken,
@@ -15,12 +38,30 @@ function travelRoutesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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 (ObjectId format)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({travelRouteId, jwtToken, token, headers}) {
     return client.get(`/travel-routes/${travelRouteId}`, {
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * POST /travel-routes - create travel route.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.travelRoute - Travel route payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, travelRoute, headers}) {
     return client({
       url: "/travel-routes",
@@ -32,6 +73,16 @@ function travelRoutesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /travel-routes/:travelRouteId - update travel route.
+   * @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 {Object} opts.travelRoute - Travel route payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, travelRouteId, travelRoute, headers}) {
     return client({
       url: `/travel-routes/${travelRouteId}`,

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

@@ -1,6 +1,20 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for traveller-card-providers types API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
 function travellerCardProvidersTypesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * 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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, query = {}, headers}) {
     return client.get("/traveller-card-providers/types", {
       params: query,

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

@@ -1,14 +1,38 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for traveller-card-providers API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function, update: function, get: function }}
+ */
 function travellerCardProvidersFactory({client, internalAuthTokenProvider}) {
+  /**
+   * 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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/traveller-card-providers",
       params: query,
-      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * POST /traveller-card-providers - create traveller card provider.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.travellerCardProvider - Traveller card provider payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, travellerCardProvider, headers}) {
     return client({
       url: "/traveller-card-providers",
@@ -18,6 +42,16 @@ function travellerCardProvidersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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
+   * @param {string} opts.travellerCardProviderId - Traveller card provider id
+   * @param {Object} opts.travellerCardProvider - Traveller card provider payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, travellerCardProviderId, travellerCardProvider, headers}) {
     return client({
       url: `/traveller-card-providers/${travellerCardProviderId}`,
@@ -27,6 +61,15 @@ function travellerCardProvidersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, travellerCardProviderId, jwtToken, headers}) {
     return client({
       url: `/traveller-card-providers/${travellerCardProviderId}`,

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

@@ -1,6 +1,28 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * 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
+ */
+
+/**
+ * Factory for traveller-card-types API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function, update: function, get: function, remove: function }}
+ */
 function travellerCardTypesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /traveller-card-types - list traveller card types.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {TravellerCardTypesListQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/traveller-card-types",
@@ -9,6 +31,15 @@ function travellerCardTypesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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
+   * @param {Object} opts.travellerCardType - Traveller card type payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, travellerCardType, headers}) {
     return client({
       url: "/traveller-card-types",
@@ -18,6 +49,16 @@ function travellerCardTypesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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
+   * @param {string} opts.travellerCardTypeId - Traveller card type id
+   * @param {Object} opts.travellerCardType - Traveller card type payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, travellerCardTypeId, travellerCardType, headers}) {
     return client({
       url: `/traveller-card-types/${travellerCardTypeId}`,
@@ -27,6 +68,15 @@ function travellerCardTypesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /traveller-card-types/:travellerCardTypeId - get traveller card type by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.travellerCardTypeId - Traveller card type id
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, travellerCardTypeId, jwtToken, headers}) {
     return client({
       url: `/traveller-card-types/${travellerCardTypeId}`,
@@ -35,6 +85,15 @@ function travellerCardTypesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({token, travellerCardTypeId, jwtToken, headers}) {
     return client({
       url: `/traveller-card-types/${travellerCardTypeId}`,

package/src/endpoints/inventory/trips.js

@@ -1,7 +1,22 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function tripsFactory({ client, internalAuthTokenProvider }) {
-  function all({ token, jwtToken, query = {}, headers }) {
+/**
+ * Factory for trips API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function }}
+ */
+function tripsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * 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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/trips",
       params: query,
@@ -9,6 +24,14 @@ function tripsFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
+  /**
+   * 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
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, id, headers}) {
     return client.get(`/trip/${id}`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})

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

@@ -2,15 +2,21 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * Factory for vehicle-types API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
 function vehicleTypesFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET all vehicle types (e.g. Bus, Shuttle, Van, Train, Ferry, Tram).
-   * Used when configuring schedule vehicle type or displaying vehicle type in trips/manifests.
+   * GET /vehicle-types - list vehicle types (e.g. Bus, Shuttle, Van, Train, Ferry, Tram).
    * @param {Object} opts
-   * @param {string} opts.token - API key token
-   * @param {Object} [opts.query] - Optional query params
-   * @param {Object} [opts.headers] - Optional request headers
-   * @returns {Promise<{data: {vehicleTypes: Array<{_id: string, name: string}>}}>}
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
    */
   function all({token, jwtToken, query = {}, headers}) {
     return client.get("/vehicle-types", {

package/src/endpoints/inventory/vehicles.js

@@ -1,8 +1,44 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /vehicles (btrz-api-inventory). See API get-handler getSpec().
+ * @typedef {Object} VehiclesQuery
+ * @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)
+ */
+
+/**
+ * Factory for vehicles API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, remove: function, seatmaps: object }}
+ */
 function vehiclesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /vehicles - list vehicles.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {VehiclesQuery} [opts.query] - Query params (disabled, page, name, garageId, brandId, etc.)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     query = {},
@@ -14,12 +50,30 @@ function vehiclesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /vehicles/:vehicleId - get vehicle by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.vehicleId - Vehicle id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({vehicleId, token, headers}) {
     return client.get(`/vehicles/${vehicleId}`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * POST /vehicles - create vehicle.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.vehicle - Vehicle payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, vehicle, headers}) {
     return client({
       url: "/vehicles",
@@ -31,6 +85,15 @@ function vehiclesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /vehicles/:vehicleId - remove vehicle.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.vehicleId - Vehicle id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({jwtToken, vehicleId, token, headers}) {
     return client({
       url: `/vehicles/${vehicleId}`,
@@ -39,6 +102,16 @@ function vehiclesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /vehicles/:vehicleId - update vehicle.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.vehicleId - Vehicle id
+   * @param {Object} opts.vehicle - Vehicle payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, vehicleId, vehicle, headers}) {
     return client({
       url: `/vehicles/${vehicleId}`,
@@ -50,7 +123,19 @@ function vehiclesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /** @type {{ create: function, remove: function }} */
   const seatmaps = {
+    /**
+     * POST /vehicles/:vehicleId/seatmaps - create vehicle seatmap.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.vehicleId - Vehicle id
+     * @param {Object} opts.seatmap - Seatmap payload
+     * @param {boolean} [opts.newdesign] - New design flag
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create({jwtToken, token, vehicleId, seatmap, headers, newdesign}) {
       return client({
         url: `/vehicles/${vehicleId}/seatmaps`,
@@ -62,6 +147,17 @@ function vehiclesFactory({client, internalAuthTokenProvider}) {
         }
       });
     },
+    /**
+     * DELETE /vehicles/:vehicleId/seatmaps/:seatMapId - remove vehicle seatmap.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.vehicleId - Vehicle id
+     * @param {string} opts.seatMapId - Seat map id
+     * @param {boolean} [opts.newdesign] - New design flag
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     remove({jwtToken, vehicleId, seatMapId, token, headers, newdesign}) {
       return client({
         url: `/vehicles/${vehicleId}/seatmaps/${seatMapId}`,

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

@@ -1,9 +1,22 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for zone-price-overages API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, remove: function }}
+ */
 function zonePriceOverageFactory({client, internalAuthTokenProvider}) {
-
+  /**
+   * GET /zone-price-overages - list zone price overages. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     query = {},
@@ -15,12 +28,29 @@ function zonePriceOverageFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({zonePriceOverageId, token, headers}) {
     return client.get(`/zone-price-overages/${zonePriceOverageId}`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * 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
+   * @param {Object} opts.zonePriceOverages - Zone price overages payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, zonePriceOverages, headers}) {
     return client({
       url: "/zone-price-overages",
@@ -32,6 +62,15 @@ function zonePriceOverageFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /zone-price-overages/:zonePriceOverageId - remove zone price overage.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.zonePriceOverageId - Zone price overage id
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({jwtToken, zonePriceOverageId, token, headers}) {
     return client({
       url: `/zone-price-overages/${zonePriceOverageId}`,
@@ -40,6 +79,16 @@ function zonePriceOverageFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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
+   * @param {string} opts.zonePriceOverageId - Zone price overage id
+   * @param {Object} opts.zonePriceOverages - Zone price overages payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, zonePriceOverageId, zonePriceOverages, headers}) {
     return client({
       url: `/zone-price-overages/${zonePriceOverageId}`,

package/src/endpoints/inventory/zone-prices.js

@@ -1,9 +1,33 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
-function zonePriceFactory({client, internalAuthTokenProvider}) {
+/**
+ * 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
+ */
 
+/**
+ * Factory for zone-prices API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, remove: function }}
+ */
+function zonePriceFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /zone-prices - list zone prices.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {ZonePricesListQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     query = {},
@@ -15,12 +39,29 @@ function zonePriceFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({zonePriceId, token, headers}) {
     return client.get(`/zone-prices/${zonePriceId}`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * 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
+   * @param {Object} opts.zonePrice - Zone price payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, zonePrice, headers}) {
     return client({
       url: "/zone-prices",
@@ -32,6 +73,15 @@ function zonePriceFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({jwtToken, zonePriceId, token, headers}) {
     return client({
       url: `/zone-prices/${zonePriceId}`,
@@ -40,6 +90,16 @@ function zonePriceFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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
+   * @param {string} opts.zonePriceId - Zone price id
+   * @param {Object} opts.zonePrice - Zone price payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, zonePriceId, zonePrice, headers}) {
     return client({
       url: `/zone-prices/${zonePriceId}`,