btrz-api-client 8.29.0 → 8.31.0

package/src/endpoints/inventory/fallback-codes.js

@@ -1,6 +1,29 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /fallback-codes (btrz-api-inventory). See get-fallback-codes getSpec().
+ * @typedef {Object} FallbackCodesListQuery
+ * @property {string} [enabled] - Filter by enabled [true, false]
+ * @property {string} [lastUpdatedAt] - Filter by last updated (yyyy-mm-ddTHH:mm:ss.SSSZ)
+ */
+
+/**
+ * Factory for fallback-codes API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function }}
+ */
 function fallbackCodesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /fallback-codes - list fallback codes.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {FallbackCodesListQuery} [opts.query] - Query params (enabled, lastUpdatedAt)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, headers}) {
     return client.get("/fallback-codes", {
       params: query,
@@ -8,12 +31,29 @@ function fallbackCodesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /fallback-code/:id - get fallback code by id. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.id - Fallback code id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, id, headers}) {
     return client.get(`/fallback-code/${id}`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * POST /fallback-codes - create fallback code. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.fallbackCode - Fallback code payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, fallbackCode, headers}) {
     return client({
       url: "/fallback-codes",
@@ -23,6 +63,16 @@ function fallbackCodesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /fallback-code/:fallbackCodeId - update fallback code. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.fallbackCodeId - Fallback code id
+   * @param {Object} opts.fallbackCode - Fallback code payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, fallbackCodeId, fallbackCode, headers}) {
     return client({
       url: `/fallback-code/${fallbackCodeId}`,

package/src/endpoints/inventory/fare-classes.js

@@ -1,30 +1,72 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function fareClassesFactory({ client, internalAuthTokenProvider }) {
+/**
+ * Query params for GET /fare-classes (btrz-api-inventory). See get-fare-classes getSpec().
+ * @typedef {Object} InventoryFareClassesQuery
+ * @property {string} [providerId] - Provider whose fare classes to return
+ * @property {string} [productIds] - Comma-separated product IDs to get fare classes for
+ */
 
-  function all({ token, jwtToken, query = {}, headers }) {
+/**
+ * Factory for fare-classes 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 }}
+ */
+function fareClassesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /fare-classes - list fare classes.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {InventoryFareClassesQuery} [opts.query] - Query params (providerId, productIds)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/fare-classes",
       params: query,
-      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
-  function create({ token, jwtToken, fareClass, headers }) {
+  /**
+   * POST /fare-classes - create fare class. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.fareClass - Fare class payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, jwtToken, fareClass, headers}) {
     return client({
       url: "/fare-classes",
       method: "post",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { fareClass }
+      data: {fareClass}
     });
   }
 
-  function update({ token, jwtToken, fareClassId, update, headers }) {
+  /**
+   * PATCH /fare-classes/:fareClassId - update fare class. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.fareClassId - Fare class id
+   * @param {Object} opts.update - Update payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  // eslint-disable-next-line no-shadow -- param name matches API
+  function update({token, jwtToken, fareClassId, update, headers}) {
     return client({
       url: `/fare-classes/${fareClassId}`,
       method: "patch",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { update }
+      data: {update}
     });
   }
 

package/src/endpoints/inventory/fares.js

@@ -1,51 +1,123 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function faresFactory({client, internalAuthTokenProvider}) {
+/**
+ * Query params for GET /fares (btrz-api-inventory). See get-fares getSpec().
+ * @typedef {Object} InventoryFaresQuery
+ * @property {string} [providerIds] - Comma-separated provider IDs to get fares for
+ * @property {string} [productIds] - Comma-separated product IDs to get fares for
+ * @property {string} [productTypes] - Product type names to get fares for
+ * @property {string} [channels] - Filter by channels (must be allowed channel values)
+ * @property {string} [isBaseFare] - Filter by base fare [true, false]
+ * @property {string} [enabled] - Filter by enabled [true, false]
+ */
 
-  function all({ token, query = {}, headers }) {
+/**
+ * Factory for fares API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, update: function, create: function, adjustments: { create: function, remove: function } }}
+ */
+function faresFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /fares - list fares.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {InventoryFaresQuery} [opts.query] - Query params (providerIds, productIds, productTypes, channels, isBaseFare, enabled)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, query = {}, headers}) {
     return client.get("/fares", {
       params: query,
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
-  function get({ token, id, headers }) {
+  /**
+   * GET /fare/:id - get fare by id. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.id - Fare id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function get({token, id, headers}) {
     return client.get(`/fare/${id}`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
-  function create({ token, jwtToken, fare, headers }) {
+  /**
+   * POST /fares - create fare. 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.fare - Fare payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, jwtToken, fare, headers}) {
     return client({
       url: "/fares",
       method: "post",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { fare }
+      data: {fare}
     });
   }
 
-  function update({ token, jwtToken, fareId, fare, headers }) {
+  /**
+   * PUT /fare/:fareId - update fare. 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.fareId - Fare id
+   * @param {Object} opts.fare - Fare payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function update({token, jwtToken, fareId, fare, headers}) {
     return client({
-      url: "/fare/" + fareId,
+      url: `/fare/${fareId}`,
       method: "put",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { fare }
+      data: {fare}
     });
   }
 
   const adjustments = {
-    create({ token, jwtToken, fareId, adjustmentsOverride, headers }) {
+    /**
+     * POST /fares/:fareId/adjustments-overrides - create adjustments override. 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.fareId - Fare id
+     * @param {Object} opts.adjustmentsOverride - Adjustments override payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
+    create({token, jwtToken, fareId, adjustmentsOverride, headers}) {
       return client({
-        url: "/fares/" + fareId + "/adjustments-overrides",
+        url: `/fares/${fareId}/adjustments-overrides`,
         method: "post",
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-        data: { adjustmentsOverride }
+        data: {adjustmentsOverride}
       });
     },
 
-    remove({ token, jwtToken, fareId, adjustmentId, headers}) {
+    /**
+     * DELETE /fares/:fareId/adjustments-override/:adjustmentId - remove adjustments override. 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.fareId - Fare id
+     * @param {string} opts.adjustmentId - Adjustment id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
+    remove({token, jwtToken, fareId, adjustmentId, headers}) {
       return client({
-        url: "/fares/" + fareId + "/adjustments-override/" + adjustmentId,
+        url: `/fares/${fareId}/adjustments-override/${adjustmentId}`,
         method: "delete",
         headers: authorizationHeaders({
           token, jwtToken, internalAuthTokenProvider, headers
@@ -62,7 +134,6 @@ function faresFactory({client, internalAuthTokenProvider}) {
     create,
     adjustments
   };
-
 }
 
 module.exports = faresFactory;

package/src/endpoints/inventory/fees.js

@@ -1,45 +1,95 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function feesFactory({client, internalAuthTokenProvider}) {
+/**
+ * Query params for GET /fees (btrz-api-inventory). See fees get-handler getSpec().
+ * @typedef {Object} InventoryFeesQuery
+ * @property {string} [providerIds] - Provider IDs to get fees for
+ * @property {string} [rules] - Rules where the fees apply
+ * @property {string} [productId] - Product ID for the fee
+ * @property {string} [internalId] - Fee internal id
+ */
 
-  function all({ token, query = {}, headers }) {
+/**
+ * Factory for fees 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 feesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /fees - list fees.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {InventoryFeesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, query = {}, headers}) {
     return client.get("/fees", {
-      params: query,   
+      params: query,
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
-  function get({ token, jwtToken, feeId, headers }) {
+  /**
+   * GET /fees/:feeId - get fee 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.feeId - Fee id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function get({token, jwtToken, feeId, headers}) {
     return client.get(`/fees/${feeId}`, {
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
-  function create({ token, jwtToken, fee, headers }) {
+  /**
+   * POST /fees - create fee. 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.fee - Fee payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, jwtToken, fee, headers}) {
     return client({
       url: "/fees",
       method: "post",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { fee }
+      data: {fee}
     });
   }
 
-  function update({ token, jwtToken, feeId, fee, headers }) {
+  /**
+   * PUT /fees/:feeId - update fee. 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.feeId - Fee id
+   * @param {Object} opts.fee - Fee payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function update({token, jwtToken, feeId, fee, headers}) {
     return client({
       url: `/fees/${feeId}`,
       method: "put",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { fee }
+      data: {fee}
     });
   }
 
-  return { 
+  return {
     all,
     get,
     create,
     update
   };
-
 }
 
-module.exports = feesFactory;
+module.exports = feesFactory;

package/src/endpoints/inventory/filtered-trips-v2.js

@@ -1,7 +1,22 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for filtered-trips-v2 API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function }}
+ */
 function filteredTripsV2Factory({client, internalAuthTokenProvider}) {
-
+  /**
+   * POST /v2/filtered-trips - create filtered trip. 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.filteredTrip - Filtered trip payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, filteredTrip, headers}) {
     return client({
       url: "/v2/filtered-trips",

package/src/endpoints/inventory/filtered-trips.js

@@ -1,6 +1,34 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /filtered-trips (btrz-api-inventory). See get-filtered-trips getSpec().
+ * @typedef {Object} FilteredTripsListQuery
+ * @property {string} [providerIds] - Comma-separated provider IDs
+ * @property {string} [productId] - Product ID to filter by
+ * @property {string} [originId] - Origin station ID to filter by
+ * @property {string} [destinationId] - Destination station ID to filter by
+ * @property {number} [page] - Page for pagination
+ * @property {string} [orderBy] - Field to order by
+ * @property {string} [orderDir] - asc (1) or desc (-1)
+ */
+
+/**
+ * Factory for filtered-trips API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function }}
+ */
 function filteredTripsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /filtered-trips - list filtered trips.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {FilteredTripsListQuery} [opts.query] - Query params (providerIds, productId, originId, destinationId, page, orderBy, orderDir)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, headers}) {
     return client.get("/filtered-trips", {
       params: query,
@@ -8,6 +36,15 @@ function filteredTripsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /filtered-trips - create filtered trip. 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.tripSegmentsId - Trip segments id payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, tripSegmentsId, headers}) {
     return client({
       url: "/filtered-trips",

package/src/endpoints/inventory/financing-costs.js

@@ -2,7 +2,36 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /financing-costs (btrz-api-inventory). See get-financing-costs getSpec().
+ * @typedef {Object} FinancingCostsListQuery
+ * @property {number} [page] - Page number
+ * @property {string} [providerId] - Provider to get financing costs for
+ */
+
+/**
+ * Query params for GET /financing-costs/:id (btrz-api-inventory). See get-financing-cost-by-id getSpec().
+ * @typedef {Object} FinancingCostGetQuery
+ * @property {string} [providerId] - Provider to get financing cost for
+ */
+
+/**
+ * Factory for financing-costs 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 financingCostsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /financing-costs - list financing costs.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {FinancingCostsListQuery} [opts.query] - Query params (page, providerId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     jwtToken,
@@ -15,6 +44,16 @@ function financingCostsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /financing-costs/:id - get financing cost by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Financing cost id
+   * @param {FinancingCostGetQuery} [opts.query] - Query params (providerId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({
     id,
     token,
@@ -28,6 +67,15 @@ function financingCostsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /financing-costs - create financing cost. 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.financingCost - Financing cost payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, financingCost, headers}) {
     return client({
       url: "/financing-costs",
@@ -39,6 +87,15 @@ function financingCostsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /financing-costs/:id - remove financing cost. 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 - Financing cost id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({jwtToken, id, token, headers, query = {}}) {
     return client({
       url: `/financing-costs/${id}`,
@@ -48,6 +105,16 @@ function financingCostsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /financing-costs/:id - update financing cost. 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 - Financing cost id
+   * @param {Object} opts.financingCost - Financing cost payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, id, financingCost, headers}) {
     return client({
       url: `/financing-costs/${id}`,

package/src/endpoints/inventory/garages.js

@@ -1,6 +1,29 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /garages (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} GaragesQuery
+ * @property {string} [location] - The garage's location
+ * @property {string} [stationId] - The id of the station associated to the garage
+ */
+
+/**
+ * Factory for garages 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 garagesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /garages - list garages.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {GaragesQuery} [opts.query] - Query params (location, stationId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, headers}) {
     return client.get("/garages", {
       params: query,
@@ -8,12 +31,30 @@ function garagesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /garages/:garageId - get garage 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.garageId - Garage id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, garageId, headers}) {
     return client.get(`/garages/${garageId}`, {
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * POST /garages - create garage. 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 - Garage payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, data, headers}) {
     return client({
       url: "/garages",
@@ -25,6 +66,16 @@ function garagesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /garages/:garageId - update garage.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.garageId - Garage id
+   * @param {Object} opts.data - Garage payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, garageId, data, headers}) {
     return client({
       url: `/garages/${garageId}`,
@@ -36,6 +87,15 @@ function garagesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /garages/:garageId - remove garage. 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.garageId - Garage id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({token, jwtToken, garageId, headers}) {
     return client({
       url: `/garages/${garageId}`,