btrz-api-client 8.28.0 → 8.30.0

package/lib/endpoints/inventory/brands.js

@@ -1,13 +1,35 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} BrandsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -22,6 +44,15 @@ function brandsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -36,6 +67,16 @@ function brandsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -51,6 +92,15 @@ function brandsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var token = _ref5.token,
         brandId = _ref5.brandId,

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

@@ -1,13 +1,37 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} BundleFaresQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * 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
+   * @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,35 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} InventoryBundlesQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * 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
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -22,6 +44,15 @@ function bundlesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,

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

@@ -3,10 +3,28 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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 {Object} [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 +38,16 @@ function changeRequestsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var changerequestId = _ref3.changerequestId,
         token = _ref3.token,
@@ -35,6 +63,15 @@ function changeRequestsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var data = _ref4.data,
         token = _ref4.token,
@@ -49,6 +86,16 @@ function changeRequestsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var changerequestId = _ref5.changerequestId,
         data = _ref5.data,
@@ -64,7 +111,18 @@ function changeRequestsFactory(_ref) {
     });
   }
 
+  /** @type {{ get: function, create: function, update: function }} */
   var 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: function get(_ref6) {
       var changeRequestId = _ref6.changeRequestId,
           token = _ref6.token,
@@ -79,6 +137,17 @@ function changeRequestsFactory(_ref) {
         headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, jwtToken: jwtToken, headers: headers })
       });
     },
+
+
+    /**
+     * 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: function create(_ref7) {
       var data = _ref7.data,
           token = _ref7.token,
@@ -92,6 +161,18 @@ function changeRequestsFactory(_ref) {
         data: data
       });
     },
+
+
+    /**
+     * 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: function update(_ref8) {
       var changeRequestId = _ref8.changeRequestId,
           data = _ref8.data,

package/lib/endpoints/inventory/companies.js

@@ -1,13 +1,35 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for companies endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryCompaniesQuery
+ */
+
+/**
+ * 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] - 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,

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

@@ -3,10 +3,28 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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 {Object} [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 +38,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 {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var controlClassId = _ref3.controlClassId,
         token = _ref3.token,
@@ -34,6 +62,15 @@ function controlClassesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -50,6 +87,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 +109,16 @@ function controlClassesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref6) {
     var jwtToken = _ref6.jwtToken,
         token = _ref6.token,

package/lib/endpoints/inventory/countries.js

@@ -3,10 +3,28 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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 {Object} [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,
@@ -20,6 +38,16 @@ function countriesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /countries/:id - get country by id.
+   * @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.query] - Query params
+   * @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,35 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for custom-content endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryCustomContentQuery
+ */
+
+/**
+ * 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] - 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,
@@ -19,6 +42,15 @@ function customContentFactory(_ref) {
     });
   }
 
+  /**
+   * GET /custom-content/:customContentId - get custom content by id.
+   * @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 +61,15 @@ function customContentFactory(_ref) {
     });
   }
 
+  /**
+   * POST /custom-content - create custom content.
+   * @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 +86,15 @@ function customContentFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /custom-content/:customContentId - remove custom content.
+   * @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 +108,16 @@ function customContentFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /custom-content/:customContentId - update custom content.
+   * @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,35 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for custom-fields endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryCustomFieldsQuery
+ */
+
+/**
+ * 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] - 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 +43,16 @@ function customFieldsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /custom-fields/:fieldId - get custom field by id.
+   * @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 {InventoryCustomFieldsQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var fieldId = _ref3.fieldId,
         token = _ref3.token,
@@ -35,6 +68,15 @@ function customFieldsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /custom-fields - create custom field.
+   * @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 +91,16 @@ function customFieldsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /custom-fields/:fieldId - update custom field.
+   * @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 +116,15 @@ function customFieldsFactory(_ref) {
     });
   }
 
+  /** @type {{ all: function }} */
   var types = {
+    /**
+     * GET /custom-fields/types - list custom field types.
+     * @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;