btrz-api-client 8.29.0 → 8.31.0

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

@@ -1,13 +1,39 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /bundle/:bundleId/product/:productId (btrz-api-inventory). See get-bundle-fares getSpec().
+ * @typedef {Object} BundleFaresQuery
+ * @property {string} [providerIds] - Comma-separated provider IDs
+ * @property {string} [channel] - Channel filter
+ */
+
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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 (providerIds, channel)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         bundleId = _ref2.bundleId,

package/lib/endpoints/inventory/bundles.js

@@ -1,13 +1,38 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /bundles (btrz-api-inventory). See get-bundles getSpec().
+ * @typedef {Object} InventoryBundlesQuery
+ * @property {string} [providerId] - Provider account ID
+ * @property {string} [type] - Bundle type filter
+ * @property {string} [disabled] - Filter by disabled status
+ */
+
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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 (providerId, type, disabled)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -22,6 +47,15 @@ function bundlesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /bundles/:bundleId - get bundle 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.bundleId - Bundle id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,

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

@@ -3,10 +3,44 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /change-requests (btrz-api-inventory). See get-change-requests getSpec().
+ * @typedef {Object} ChangeRequestsListQuery
+ * @property {string} [type] - Filter by change request type
+ * @property {string} [status] - Filter by status
+ * @property {string} [createdBy] - Filter by user id
+ * @property {string} [from] - Filter by creation date from (YYYY-MM-DD)
+ * @property {string} [to] - Filter by creation date to (YYYY-MM-DD)
+ * @property {string} [operationId] - Filter by operation ID
+ * @property {string} [operationType] - Filter by operation type
+ * @property {number} [page] - Page number
+ * @property {string} [orderBy] - Field to order by
+ * @property {string} [orderDir] - asc (1) or desc (-1)
+ * @property {number} [pageSize] - Results per page
+ */
+
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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 {ChangeRequestsListQuery} [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 +54,15 @@ function changeRequestsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /change-requests/:changerequestId/manifests - get change request manifests. 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.changerequestId - Change request id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var changerequestId = _ref3.changerequestId,
         token = _ref3.token,
@@ -35,6 +78,15 @@ function changeRequestsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /change-requests/manifests - create change request manifest. 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 - Manifest payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var data = _ref4.data,
         token = _ref4.token,
@@ -49,6 +101,16 @@ function changeRequestsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /change-requests/:changerequestId/manifests - update change request manifest. 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.changerequestId - Change request id
+   * @param {Object} opts.data - Manifest payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref5) {
     var changerequestId = _ref5.changerequestId,
         data = _ref5.data,
@@ -64,7 +126,17 @@ function changeRequestsFactory(_ref) {
     });
   }
 
+  /** @type {{ get: function, create: function, update: function }} */
   var schedules = {
+    /**
+     * GET /change-requests/:changeRequestId/schedules - get change request schedules. 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.changeRequestId - Change request id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref6) {
       var changeRequestId = _ref6.changeRequestId,
           token = _ref6.token,
@@ -79,6 +151,17 @@ function changeRequestsFactory(_ref) {
         headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, jwtToken: jwtToken, headers: headers })
       });
     },
+
+
+    /**
+     * POST /change-requests/schedules - create change request schedule. 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 - Schedule payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref7) {
       var data = _ref7.data,
           token = _ref7.token,
@@ -92,6 +175,18 @@ function changeRequestsFactory(_ref) {
         data: data
       });
     },
+
+
+    /**
+     * PUT /change-requests/:changeRequestId/schedules - update change request schedule. 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.changeRequestId - Change request id
+     * @param {Object} opts.data - Schedule payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref8) {
       var changeRequestId = _ref8.changeRequestId,
           data = _ref8.data,

package/lib/endpoints/inventory/companies.js

@@ -1,13 +1,38 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /companies (btrz-api-inventory). See get-companies getSpec().
+ * @typedef {Object} InventoryCompaniesQuery
+ * @property {string} [search] - Term to find companies (required by API for getBySearch)
+ * @property {string} [disabled] - Filter by disabled [true, false]
+ * @property {string} [providerId] - Get items from the provider
+ */
+
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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] - Query params (search, disabled, providerId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

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

@@ -3,10 +3,58 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /control-classes (btrz-api-inventory). See get-control-classes getSpec().
+ * @typedef {Object} ControlClassesListQuery
+ * @property {number} [page] - Page number
+ * @property {boolean} [root] - Filter roots only
+ * @property {string} [productId] - Filter by product ID
+ * @property {string} [name] - Filter by name
+ * @property {string} [scheduleId] - Only roots that could apply to this schedule (UUID)
+ * @property {string} [assignedScheduleId] - Only roots assigned to this schedule (UUID)
+ * @property {string} [amenityGroupId] - Filter by amenity group ID(s), comma-separated
+ * @property {string} [brandId] - Filter by brand ID(s), comma-separated
+ * @property {string} [fareId] - Filter by fare ID(s), comma-separated
+ * @property {string} [fareClassId] - Filter by fare class ID(s), comma-separated
+ * @property {string} [seatClassId] - Filter by seat class ID(s), comma-separated
+ * @property {string} [operatingCompanyId] - Filter by operating company ID(s), comma-separated
+ * @property {string} [channel] - Filter by channel(s), comma-separated
+ * @property {number} [advancePurchaseFrom] - Filter by advance purchase from (hours)
+ * @property {number} [advancePurchaseTo] - Filter by advance purchase to (hours)
+ */
+
+/**
+ * Query params for GET /control-classes/:controlClassId (btrz-api-inventory). See get-control-class-by-id getSpec().
+ * @typedef {Object} ControlClassGetQuery
+ * @property {boolean} [tree] - Include the full tree
+ * @property {string} [scheduleId] - When tree requested, filter by schedule
+ * @property {string} [scheduleBrandId] - When tree requested, filter by schedule brand
+ * @property {string} [scheduleOperatingCompanyId] - When tree requested, filter by operating company
+ * @property {string} [scheduleAmenityGroupId] - When tree requested, filter by amenity group
+ */
+
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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 {ControlClassesListQuery} [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 +68,16 @@ function controlClassesFactory(_ref) {
     });
   }
 
+  /**
+   * 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 {ControlClassGetQuery} [opts.query] - Query params (tree, scheduleId, etc.)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var controlClassId = _ref3.controlClassId,
         token = _ref3.token,
@@ -34,6 +92,15 @@ function controlClassesFactory(_ref) {
     });
   }
 
+  /**
+   * POST /control-classes - create control 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.controlClass - Control class payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -50,6 +117,15 @@ function controlClassesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var jwtToken = _ref5.jwtToken,
         controlClassId = _ref5.controlClassId,
@@ -63,6 +139,16 @@ function controlClassesFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /control-classes/:controlClassId - update control 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.controlClassId - Control class id
+   * @param {Object} opts.controlClass - Control class 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/countries.js

@@ -3,10 +3,34 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /countries (btrz-api-inventory). See get-countries getSpec().
+ * @typedef {Object} CountriesListQuery
+ * @property {string} [isoCode] - Country 2 or 3 letter ISO code
+ */
+
+/**
+ * Factory for countries 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 countriesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /countries - list countries.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {CountriesListQuery} [opts.query] - Query params (isoCode)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -20,6 +44,15 @@ function countriesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /countries/:id - get country 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.id - Country id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,

package/lib/endpoints/inventory/custom-content.js

@@ -1,12 +1,37 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /custom-content (btrz-api-inventory). See get-custom-contents getSpec().
+ * @typedef {Object} InventoryCustomContentQuery
+ * @property {string} [enabled] - Filter by enabled (true, false)
+ * @property {string} [pageId] - The page for the content
+ */
+
+/**
+ * Factory for custom-content 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 customContentFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /custom-content - list custom content.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {InventoryCustomContentQuery} [opts.query] - Query params (enabled, pageId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -19,6 +44,15 @@ function customContentFactory(_ref) {
     });
   }
 
+  /**
+   * GET /custom-content/:customContentId - get custom content 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.customContentId - Custom content id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var customContentId = _ref3.customContentId,
         token = _ref3.token,
@@ -29,6 +63,15 @@ function customContentFactory(_ref) {
     });
   }
 
+  /**
+   * POST /custom-content - create custom content. 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.customContent - Custom content payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -45,6 +88,15 @@ function customContentFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /custom-content/:customContentId - remove custom content. 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.customContentId - Custom content id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref5) {
     var jwtToken = _ref5.jwtToken,
         customContentId = _ref5.customContentId,
@@ -58,6 +110,16 @@ function customContentFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /custom-content/:customContentId - update custom content. 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.customContentId - Custom content id
+   * @param {Object} opts.customContent - Custom content 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/custom-fields.js

@@ -1,12 +1,38 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /custom-fields (btrz-api-inventory). See get-custom-fields getSpec().
+ * @typedef {Object} InventoryCustomFieldsQuery
+ * @property {string} [enabled] - Required value of the disabled field
+ * @property {string} [required] - Required value of the required field
+ * @property {string} [modelName] - Filter by model (Transactions, Stations)
+ */
+
+/**
+ * Factory for custom-fields 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, types: object }}
+ */
+
+
 function customFieldsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /custom-fields - list custom fields.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {InventoryCustomFieldsQuery} [opts.query] - Query params (enabled, required, modelName)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -20,6 +46,15 @@ function customFieldsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /custom-fields/:fieldId - get custom field 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.fieldId - Field id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var fieldId = _ref3.fieldId,
         token = _ref3.token,
@@ -35,6 +70,15 @@ function customFieldsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /custom-fields - create custom field. 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.field - Field payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -49,6 +93,16 @@ function customFieldsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /custom-fields/:fieldId - update custom field. 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.fieldId - Field id
+   * @param {Object} opts.field - Field payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -64,7 +118,15 @@ function customFieldsFactory(_ref) {
     });
   }
 
+  /** @type {{ all: function }} */
   var types = {
+    /**
+     * GET /custom-fields/types - list custom field types. API does not accept query params.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     all: function all(_ref6) {
       var token = _ref6.token,
           headers = _ref6.headers;

package/lib/endpoints/inventory/docs.js

@@ -1,8 +1,18 @@
 "use strict";
 
+/**
+ * Factory for API docs (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @returns {{ get: function }}
+ */
 function docsFactory(_ref) {
   var client = _ref.client;
 
+  /**
+   * GET /api-docs-v2 - get API docs.
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get() {
     return client.get("/api-docs-v2", {});
   }