btrz-api-client 8.29.0 → 8.30.0

package/lib/endpoints/inventory/seatclasses.js

@@ -4,10 +4,33 @@
 var _require = require("./../endpoints_helpers"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -23,6 +46,16 @@ function seatClassesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -39,6 +72,17 @@ function seatClassesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -57,6 +101,16 @@ function seatClassesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -73,6 +127,16 @@ function seatClassesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,

package/lib/endpoints/inventory/seatfees.js

@@ -1,13 +1,34 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -20,6 +41,14 @@ function seatfeesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var seatfeeId = _ref3.seatfeeId,
         token = _ref3.token,
@@ -30,6 +59,15 @@ function seatfeesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -46,6 +84,16 @@ function seatfeesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var jwtToken = _ref5.jwtToken,
         token = _ref5.token,

package/lib/endpoints/inventory/seatmaps.js

@@ -1,12 +1,36 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+/* eslint-disable max-len */
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -18,6 +42,19 @@ function seatmapsFactory(_ref) {
       headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, headers: 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(_ref3) {
     var seatmapId = _ref3.seatmapId,
         routeId = _ref3.routeId,
@@ -34,6 +71,16 @@ function seatmapsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var seatmapId = _ref4.seatmapId,
         token = _ref4.token,
@@ -48,6 +95,15 @@ function seatmapsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -64,6 +120,16 @@ function seatmapsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,
@@ -81,6 +147,15 @@ function seatmapsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref7) {
     var token = _ref7.token,
         jwtToken = _ref7.jwtToken,
@@ -94,6 +169,16 @@ function seatmapsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref8) {
     var token = _ref8.token,
         jwtToken = _ref8.jwtToken,

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

@@ -3,10 +3,34 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

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

@@ -3,10 +3,33 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -20,6 +43,15 @@ function segmentsInformationFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var segmentInformationId = _ref3.segmentInformationId,
         token = _ref3.token,
@@ -31,6 +63,15 @@ function segmentsInformationFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -47,6 +88,15 @@ function segmentsInformationFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var jwtToken = _ref5.jwtToken,
         segmentInformationId = _ref5.segmentInformationId,
@@ -60,6 +110,16 @@ function segmentsInformationFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref6) {
     var jwtToken = _ref6.jwtToken,
         token = _ref6.token,

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

@@ -1,12 +1,35 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -21,6 +44,15 @@ function serviceNumbersFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -37,6 +69,16 @@ function serviceNumbersFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -54,6 +96,15 @@ function serviceNumbersFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var token = _ref5.token,
         serviceNumberId = _ref5.serviceNumberId,

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

@@ -1,13 +1,34 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -20,6 +41,14 @@ function serviceTypesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var serviceTypeId = _ref3.serviceTypeId,
         token = _ref3.token,
@@ -30,6 +59,15 @@ function serviceTypesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -46,6 +84,15 @@ function serviceTypesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var jwtToken = _ref5.jwtToken,
         serviceTypeId = _ref5.serviceTypeId,
@@ -59,6 +106,16 @@ function serviceTypesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref6) {
     var jwtToken = _ref6.jwtToken,
         token = _ref6.token,

package/lib/endpoints/inventory/ssrs.js

@@ -1,13 +1,34 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for ssrs endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventorySsrsQuery
+ */
+
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,