btrz-api-client 8.28.0 → 8.30.0

package/src/endpoints/inventory/seatclasses.js

@@ -1,7 +1,28 @@
 /* eslint-disable import/extensions */
 const {authorizationHeaders} = require("./../endpoints_helpers");
 
+/**
+ * Query params for seat-classes endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventorySeatclassesQuery
+ */
+
+/**
+ * Factory for seat-classes 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, remove: function, create: function }}
+ */
 function seatClassesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /seat-classes - list seat classes.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {InventorySeatclassesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/seat-classes",
@@ -11,6 +32,16 @@ function seatClassesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /seat-classes/:id - get seat class by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Seat class id
+   * @param {InventorySeatclassesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, id, query = {}, headers}) {
     return client({
       url: `/seat-classes/${id}`,
@@ -20,6 +51,17 @@ function seatClassesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /seat-classes/:id - update seat class.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Seat class id
+   * @param {Object} opts.data - Request body
+   * @param {InventorySeatclassesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, id, data, query = {}, headers}) {
     return client({
       url: `/seat-classes/${id}`,
@@ -30,6 +72,16 @@ function seatClassesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /seat-classes/:id - remove seat class.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Seat class id
+   * @param {InventorySeatclassesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({token, jwtToken, id, query = {}, headers}) {
     return client({
       url: `/seat-classes/${id}`,
@@ -39,6 +91,16 @@ function seatClassesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /seat-classes - create seat class.
+   * @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 {InventorySeatclassesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, data, query = {}, headers}) {
     return client({
       url: "/seat-classes",

package/src/endpoints/inventory/seatfees.js

@@ -1,9 +1,28 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for seatfees endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventorySeatfeesQuery
+ */
+
+/**
+ * Factory for seat-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 seatfeesFactory({client, internalAuthTokenProvider}) {
-  
+  /**
+   * GET /seat-fees - list seat fees.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {InventorySeatfeesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     query = {},
@@ -15,13 +34,30 @@ function seatfeesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /seat-fees/:seatfeeId - get seat fee by id.
+   * @param {Object} opts
+   * @param {string} opts.seatfeeId - Seat fee id
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({seatfeeId, token, headers}) {
     return client.get(`/seat-fees/${seatfeeId}`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
-  function create({ jwtToken, token, seatfee, headers }) {
+  /**
+   * POST /seat-fees - create seat fee.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {Object} opts.seatfee - Seat fee payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({jwtToken, token, seatfee, headers}) {
     return client({
       url: "/seat-fees",
       method: "post",
@@ -32,6 +68,16 @@ function seatfeesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /seat-fees/:seatfeeId - update seat fee.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.seatfeeId - Seat fee id
+   * @param {Object} opts.seatfee - Seat fee payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, seatfeeId, seatfee, headers}) {
     return client({
       url: `/seat-fees/${seatfeeId}`,

package/src/endpoints/inventory/seatmaps.js

@@ -1,12 +1,47 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} SeatmapsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for seatmaps API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, getById: function, create: function, remove: function, update: function, getOccupiedSeats: function }}
+ */
 function seatmapsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /seatmaps - list seatmaps.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {SeatmapsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, query = {}, headers}) {
     return client.get("/seatmaps", {
       params: query,
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
+  /**
+   * GET /seatmaps/:seatmapId/available-seats/:routeId/:scheduleId/:manifestDate - get available seats.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.seatmapId - Seatmap id
+   * @param {string} opts.routeId - Route id
+   * @param {string} opts.scheduleId - Schedule id
+   * @param {string} opts.manifestDate - Manifest date
+   * @param {SeatmapsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({seatmapId, routeId, scheduleId, manifestDate, query = {}, token, headers}) {
     return client.get(`/seatmaps/${seatmapId}/available-seats/${routeId}/${scheduleId}/${manifestDate}`, {
       params: query,
@@ -14,6 +49,16 @@ function seatmapsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /seatmaps/:seatmapId - get seatmap by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.seatmapId - Seatmap id
+   * @param {SeatmapsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getById({seatmapId, token, jwtToken, query = {}, headers}) {
     return client.get(`/seatmaps/${seatmapId}`, {
       params: query,
@@ -21,6 +66,15 @@ function seatmapsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /seatmaps - create seatmap.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.seatmap - Seatmap payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, seatmap, headers}) {
     return client({
       url: "/seatmaps",
@@ -32,6 +86,16 @@ function seatmapsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /seatmaps/:seatmapId - update seatmap.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.seatmapId - Seatmap id
+   * @param {Object} opts.seatmap - Seatmap payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, seatmapId, seatmap, headers}) {
     return client({
       url: `/seatmaps/${seatmapId}`,
@@ -43,6 +107,15 @@ function seatmapsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /seatmaps/:seatmapId - remove seatmap.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.seatmapId - Seatmap id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({token, jwtToken, seatmapId, headers}) {
     return client({
       url: `/seatmaps/${seatmapId}`,
@@ -51,6 +124,16 @@ function seatmapsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /seatmaps/:seatmapId/occupied-seats - get occupied seats.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.seatmapId - Seatmap id
+   * @param {SeatmapsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getOccupiedSeats({token, jwtToken, seatmapId, query = {}, headers}) {
     return client.get(`/seatmaps/${seatmapId}/occupied-seats`, {
       params: query,

package/src/endpoints/inventory/segments-information-tables.js

@@ -2,7 +2,29 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} SegmentsInformationTablesQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for segments-information-tables API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
 function segmentInformationTableFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /segments-information-tables/:routeId - get segments information table by route id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.routeId - Route id
+   * @param {SegmentsInformationTablesQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, routeId, query = {}, headers}) {
     return client({
       url: `/segments-information-tables/${routeId}`,

package/src/endpoints/inventory/segments-information.js

@@ -2,7 +2,28 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} SegmentsInformationQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for segments-information 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 segmentsInformationFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /segments-information - list segments information.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {SegmentsInformationQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     jwtToken,
@@ -15,12 +36,30 @@ function segmentsInformationFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /segments-information/:segmentInformationId - get segment information by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.segmentInformationId - Segment information id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({segmentInformationId, token, headers, jwtToken}) {
     return client.get(`/segments-information/${segmentInformationId}`, {
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * POST /segments-information - create segment information.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.segmentInformation - Segment information payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, segmentInformation, headers}) {
     return client({
       url: "/segments-information",
@@ -32,6 +71,15 @@ function segmentsInformationFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /segments-information/:segmentInformationId - remove segment information.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.segmentInformationId - Segment information id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({jwtToken, segmentInformationId, token, headers}) {
     return client({
       url: `/segments-information/${segmentInformationId}`,
@@ -40,6 +88,16 @@ function segmentsInformationFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /segments-information/:segmentInformationId - update segment information.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.segmentInformationId - Segment information id
+   * @param {Object} opts.segmentInformation - Segment information payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, segmentInformationId, segmentInformation, headers}) {
     return client({
       url: `/segments-information/${segmentInformationId}`,

package/src/endpoints/inventory/service-numbers.js

@@ -1,21 +1,51 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for service-numbers endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryServiceNumbersQuery
+ */
+
+/**
+ * Factory for service-numbers 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 serviceNumbersFactory({
   client,
   internalAuthTokenProvider
 }) {
+  /**
+   * GET /service-numbers - list service numbers.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {InventoryServiceNumbersQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token, jwtToken, query = {}, headers
   }) {
     return client({
       url: "/service-numbers",
       params: query,
-      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * POST /service-numbers - create service number.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.serviceNumber - Service number payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({
     token, jwtToken, serviceNumber, headers
   }) {
@@ -29,6 +59,16 @@ function serviceNumbersFactory({
     });
   }
 
+  /**
+   * PUT /service-numbers/:serviceNumberId - update service number.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.serviceNumberId - Service number id
+   * @param {Object} opts.serviceNumber - Service number payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({
     jwtToken, token, serviceNumberId, serviceNumber, headers
   }) {
@@ -42,11 +82,20 @@ function serviceNumbersFactory({
     });
   }
 
+  /**
+   * GET /service-numbers/:serviceNumberId - get service number by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.serviceNumberId - Service number id
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, serviceNumberId, jwtToken, headers}) {
     return client({
       url: `/service-numbers/${serviceNumberId}`,
       method: "get",
-      headers: authorizationHeaders({token, internalAuthTokenProvider, jwtToken, headers}),
+      headers: authorizationHeaders({token, internalAuthTokenProvider, jwtToken, headers})
     });
   }
 

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

@@ -1,9 +1,28 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
-function serviceTypesFactory({client, internalAuthTokenProvider}) {
+/**
+ * Query params for GET /service-types (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryServiceTypesListQuery
+ */
 
+/**
+ * Factory for service-types 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 serviceTypesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /service-types - list service types.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {InventoryServiceTypesListQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     query = {},
@@ -15,12 +34,29 @@ function serviceTypesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /service-types/:serviceTypeId - get service type by id.
+   * @param {Object} opts
+   * @param {string} opts.serviceTypeId - Service type id
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({serviceTypeId, token, headers}) {
     return client.get(`/service-types/${serviceTypeId}`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * POST /service-types - create service type.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {Object} opts.serviceType - Service type payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, serviceType, headers}) {
     return client({
       url: "/service-types",
@@ -32,7 +68,16 @@ function serviceTypesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
-  function remove({ jwtToken, serviceTypeId, token, headers }) {
+  /**
+   * DELETE /service-types/:serviceTypeId - remove service type.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.serviceTypeId - Service type id
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function remove({jwtToken, serviceTypeId, token, headers}) {
     return client({
       url: `/service-types/${serviceTypeId}`,
       method: "delete",
@@ -40,6 +85,16 @@ function serviceTypesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /service-types/:serviceTypeId - update service type.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.serviceTypeId - Service type id
+   * @param {Object} opts.serviceType - Service type payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, serviceTypeId, serviceType, headers}) {
     return client({
       url: `/service-types/${serviceTypeId}`,

package/src/endpoints/inventory/ssrs.js

@@ -1,18 +1,36 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function ssrsFactory({client, internalAuthTokenProvider}) {
+/**
+ * Query params for ssrs endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventorySsrsQuery
+ */
 
-  function all({ token, query = {}, headers }) {
+/**
+ * Factory for ssrs API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
+function ssrsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /ssrs - list SSRs.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {InventorySsrsQuery} [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("/ssrs", {
-      params: query,   
+      params: query,
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
-  return { 
+  return {
     all
   };
-
 }
 
-module.exports = ssrsFactory;
+module.exports = ssrsFactory;