btrz-api-client 8.28.0 → 8.30.0

package/src/endpoints/inventory/amenity-groups.js

@@ -1,36 +1,85 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function amenityGroupsFactory({ client, internalAuthTokenProvider }) {
+/**
+ * @typedef {Object} AmenityGroupsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
 
-  function all({ token, query = {}, headers }) {
+/**
+ * Factory for amenity-groups 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 amenityGroupsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /amenity-groups - list amenity groups.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {AmenityGroupsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, query = {}, headers}) {
     return client.get("/amenity-groups", {
       params: query,
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
-  function get({ token, amenityGroupId, query = {}, headers }) {
+  /**
+   * GET /amenity-groups/:amenityGroupId - get amenity group by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.amenityGroupId - Amenity group id
+   * @param {AmenityGroupsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function get({token, amenityGroupId, query = {}, headers}) {
     return client.get(`/amenity-groups/${amenityGroupId}`, {
       params: query,
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
-  function create({ token, jwtToken, amenityGroup, headers }) {
+  /**
+   * POST /amenity-groups - create amenity group.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.amenityGroup - Amenity group payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, jwtToken, amenityGroup, headers}) {
     return client({
       url: "/amenity-groups",
       method: "post",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { amenityGroup }
+      data: {amenityGroup}
     });
   }
 
-  function update({ token, jwtToken, amenityGroupId, amenityGroup, headers }) {
+  /**
+   * PUT /amenity-groups/:amenityGroupId - update amenity group.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.amenityGroupId - Amenity group id
+   * @param {Object} opts.amenityGroup - Amenity group payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function update({token, jwtToken, amenityGroupId, amenityGroup, headers}) {
     return client({
       url: `/amenity-groups/${amenityGroupId}`,
       method: "put",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { amenityGroup }
+      data: {amenityGroup}
     });
   }
 

package/src/endpoints/inventory/banks.js

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

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

@@ -1,6 +1,27 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} BareRoutesQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for bare-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 }}
+ */
 function bareRoutesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /bare-routes - list bare routes.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {BareRoutesQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, query = {}, headers}) {
     return client({
       url: "/bare-routes",
@@ -9,6 +30,16 @@ function bareRoutesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /bare-routes/:routeId - get bare route by 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 {BareRoutesQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({routeId, token, query = {}, headers}) {
     return client({
       url: `/bare-routes/${routeId}`,

package/src/endpoints/inventory/brands.js

@@ -1,38 +1,86 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function brandsFactory({ client, internalAuthTokenProvider }) {
+/**
+ * @typedef {Object} BrandsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
 
-  function all({ token, jwtToken, query = {}, headers }) {
+/**
+ * Factory for brands 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 brandsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /brands - list brands.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {BrandsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/brands",
       params: query,
-      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
-  function create({ token, jwtToken, brand, headers }) {
+  /**
+   * POST /brands - create brand.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.brand - Brand payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, jwtToken, brand, headers}) {
     return client({
       url: "/brands",
       method: "post",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { brand }
+      data: {brand}
     });
   }
 
-  function update({ jwtToken, token, brandId, brand, headers }) {
-    return client({ 
+  /**
+   * PUT /brands/:brandId - update brand.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.brandId - Brand id
+   * @param {Object} opts.brand - Brand payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function update({jwtToken, token, brandId, brand, headers}) {
+    return client({
       url: `/brands/${brandId}`,
       method: "put",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { brand }
+      data: {brand}
     });
   }
 
+  /**
+   * GET /brands/:brandId - get brand by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.brandId - Brand id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, brandId, jwtToken, headers}) {
     return client({
       url: `/brands/${brandId}`,
       method: "get",
-      headers: authorizationHeaders({token, internalAuthTokenProvider, jwtToken, headers}),
+      headers: authorizationHeaders({token, internalAuthTokenProvider, jwtToken, headers})
     });
   }
 

package/src/endpoints/inventory/bundle-fares.js

@@ -1,8 +1,30 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function bundleFaresFactory({client, internalAuthTokenProvider}) {
+/**
+ * @typedef {Object} BundleFaresQuery
+ * @property {string} [providerId] - Provider account ID
+ */
 
-  function all({ token, bundleId, productId, query = {}, headers }) {
+/**
+ * Factory for bundle-fares API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
+function bundleFaresFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /bundle/:bundleId/product/:productId - list bundle fares.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.bundleId - Bundle id
+   * @param {string} opts.productId - Product id
+   * @param {BundleFaresQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, bundleId, productId, query = {}, headers}) {
     return client.get(`/bundle/${bundleId}/product/${productId}`, {
       params: query,
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
@@ -12,7 +34,6 @@ function bundleFaresFactory({client, internalAuthTokenProvider}) {
   return {
     all
   };
-
 }
 
 module.exports = bundleFaresFactory;

package/src/endpoints/inventory/bundles.js

@@ -1,15 +1,44 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function bundlesFactory({ client, internalAuthTokenProvider }) {
+/**
+ * @typedef {Object} InventoryBundlesQuery
+ * @property {string} [providerId] - Provider account ID
+ */
 
-  function all({ token, jwtToken, query = {}, headers }) {
+/**
+ * Factory for bundles 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 bundlesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /bundles - list bundles.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {InventoryBundlesQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/bundles",
       params: query,
-      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * GET /bundles/:bundleId - get bundle by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.bundleId - Bundle id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, bundleId, headers}) {
     return client({
       url: `/bundles/${bundleId}`,
@@ -24,4 +53,4 @@ function bundlesFactory({ client, internalAuthTokenProvider }) {
   };
 }
 
-module.exports = bundlesFactory;
+module.exports = bundlesFactory;

package/src/endpoints/inventory/change-requests.js

@@ -1,6 +1,22 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for change-requests 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, schedules: object }}
+ */
 function changeRequestsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /change-requests - list change requests.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, headers}) {
     return client.get("/change-requests", {
       params: query,
@@ -8,6 +24,16 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /change-requests/:changerequestId/manifests - get change request manifests.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.changerequestId - Change request id
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({changerequestId, token, jwtToken, query = {}, headers}) {
     return client({
       url: `/change-requests/${changerequestId}/manifests`,
@@ -16,6 +42,15 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /change-requests/manifests - create change request manifest.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - Manifest payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({data, token, jwtToken, headers}) {
     return client({
       url: "/change-requests/manifests",
@@ -25,6 +60,16 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /change-requests/:changerequestId/manifests - update change request manifest.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.changerequestId - Change request id
+   * @param {Object} opts.data - Manifest payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({changerequestId, data, token, jwtToken, headers}) {
     return client({
       url: `/change-requests/${changerequestId}/manifests`,
@@ -34,7 +79,18 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /** @type {{ get: function, create: function, update: function }} */
   const schedules = {
+    /**
+     * GET /change-requests/:changeRequestId/schedules - get change request schedules.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.changeRequestId - Change request id
+     * @param {Object} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({changeRequestId, token, jwtToken, query = {}, headers}) {
       return client({
         url: `/change-requests/${changeRequestId}/schedules`,
@@ -43,6 +99,15 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
       });
     },
 
+    /**
+     * POST /change-requests/schedules - create change request schedule.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} opts.data - Schedule payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create({data, token, jwtToken, headers}) {
       return client({
         url: "/change-requests/schedules",
@@ -52,6 +117,16 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
       });
     },
 
+    /**
+     * PUT /change-requests/:changeRequestId/schedules - update change request schedule.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.changeRequestId - Change request id
+     * @param {Object} opts.data - Schedule payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update({changeRequestId, data, token, jwtToken, headers}) {
       return client({
         url: `/change-requests/${changeRequestId}/schedules`,

package/src/endpoints/inventory/companies.js

@@ -1,12 +1,32 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function companiesFactory({ client, internalAuthTokenProvider }) {
+/**
+ * Query params for companies endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryCompaniesQuery
+ */
 
-  function all({ token, jwtToken, query = {}, headers }) {
+/**
+ * Factory for companies API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
+function companiesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /companies - list companies.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {InventoryCompaniesQuery} [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: "/companies",
       params: query,
-      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 

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

@@ -2,7 +2,23 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for control-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, create: function, update: function, remove: function }}
+ */
 function controlClassesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /control-classes - list control classes.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     jwtToken,
@@ -15,6 +31,16 @@ function controlClassesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /control-classes/:controlClassId - get control class by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.controlClassId - Control class id
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({controlClassId, token, headers, jwtToken, query = {}}) {
     return client.get(`/control-classes/${controlClassId}`, {
       params: query,
@@ -22,6 +48,15 @@ function controlClassesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /control-classes - create control class.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.controlClass - Control class payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, controlClass, headers}) {
     return client({
       url: "/control-classes",
@@ -33,6 +68,15 @@ function controlClassesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /control-classes/:controlClassId - remove control class.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.controlClassId - Control class id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({jwtToken, controlClassId, token, headers}) {
     return client({
       url: `/control-classes/${controlClassId}`,
@@ -41,6 +85,16 @@ function controlClassesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /control-classes/:controlClassId - update control class.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.controlClassId - Control class id
+   * @param {Object} opts.controlClass - Control class payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, controlClassId, controlClass, headers}) {
     return client({
       url: `/control-classes/${controlClassId}`,