btrz-api-client 8.33.0 → 8.35.0

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

@@ -25,13 +25,16 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function changeRequestsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /change-requests - list change requests.
+   * GET /change-requests — List change requests with optional filters and pagination.
    * @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 {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization: Bearer)
+   * @param {ChangeRequestsListQuery} [opts.query] - Query params (type, status, createdBy, from, to, etc.)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ changeRequests: Object[], count: number, next: string, previous: string }>>}
+   * @throws 400 INVALID_PAGE, INVALID_TYPE_PARAMETER, INVALID_STATUS_PARAMETER, etc.
+   * @throws 401 Unauthorized
+   * @throws 500 Internal server error
    */
   function all({token, jwtToken, query = {}, headers}) {
     return client.get("/change-requests", {
@@ -41,13 +44,18 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /change-requests/:changerequestId/manifests - get change request manifests. API does not accept query params.
+   * GET /change-requests/:changerequestId/manifests — Get manifest change request by ID. Requires multipleManifestEditing.
    * @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 {string} [opts.jwtToken] - JWT or internal auth
+   * @param {string} opts.changerequestId - Change request id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ changeRequest: Object }>>}
+   * @throws 400 INVALID_CHANGEREQUEST_ID, FAILED_TO_FETCH_OPERATION_SETTINGS
+   * @throws 401 Unauthorized
+   * @throws 403 MULTIPLE_MANIFEST_EDIT_NOT_ALLOWED
+   * @throws 404 CHANGEREQUEST_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function get({changerequestId, token, jwtToken, query = {}, headers}) {
     return client({
@@ -58,13 +66,17 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /change-requests/manifests - create change request manifest. API does not accept query params.
+   * POST /change-requests/manifests — Create manifest change request. Emits changeRequests.manifests.created.
    * @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 {string} [opts.jwtToken] - JWT or internal auth
+   * @param {Object} opts.data - Manifest change request payload (manifestId, request, routeId, scheduleId, date, etc.)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ changeRequest: Object }>>}
+   * @throws 400 WRONG_DATA, FAILED_TO_FETCH_OPERATION_SETTINGS, MANIFEST_NOT_FOUND, etc.
+   * @throws 401 Unauthorized
+   * @throws 403 MULTIPLE_MANIFEST_EDIT_NOT_ALLOWED
+   * @throws 500 Internal server error
    */
   function create({data, token, jwtToken, headers}) {
     return client({
@@ -76,14 +88,19 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /change-requests/:changerequestId/manifests - update change request manifest. API does not accept query params.
+   * PUT /change-requests/:changerequestId/manifests — Update manifest change request. Emits changeRequests.manifests.updated.
    * @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 {string} [opts.jwtToken] - JWT or internal auth
+   * @param {string} opts.changerequestId - Change request id (24 hex characters)
+   * @param {Object} opts.data - Update payload (status: 'approved' or 'rejected')
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ changeRequest: Object }>>}
+   * @throws 400 WRONG_DATA, CHANGEREQUEST_STATUS_NOT_PENDING, etc.
+   * @throws 401 Unauthorized
+   * @throws 403 MULTIPLE_MANIFEST_EDIT_NOT_ALLOWED
+   * @throws 404 CHANGEREQUEST_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function update({changerequestId, data, token, jwtToken, headers}) {
     return client({
@@ -97,13 +114,17 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
   /** @type {{ get: function, create: function, update: function }} */
   const schedules = {
     /**
-     * GET /change-requests/:changeRequestId/schedules - get change request schedules. API does not accept query params.
+     * GET /change-requests/:changeRequestId/schedules — Get schedule change request by ID.
      * @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 {string} [opts.jwtToken] - JWT or internal auth
+     * @param {string} opts.changeRequestId - Change request id (24 hex characters)
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ changeRequest: Object }>>}
+     * @throws 400 INVALID_CHANGEREQUEST_ID, FAILED_TO_FETCH_OPERATION_SETTINGS, etc.
+     * @throws 401 Unauthorized
+     * @throws 404 CHANGEREQUEST_NOT_FOUND
+     * @throws 500 Internal server error
      */
     get({changeRequestId, token, jwtToken, query = {}, headers}) {
       return client({
@@ -114,13 +135,16 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
     },
 
     /**
-     * POST /change-requests/schedules - create change request schedule. API does not accept query params.
+     * POST /change-requests/schedules — Create a schedule change request. Emits webhook changeRequests.schedules.created.
      * @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 {string} [opts.jwtToken] - JWT or internal auth
+     * @param {Object} opts.data - Schedule change request payload (request, routeId, scheduleId, legs, etc.)
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ changeRequest: Object }>>}
+     * @throws 400 WRONG_DATA, FAILED_TO_FETCH_OPERATION_SETTINGS, etc.
+     * @throws 401 Unauthorized
+     * @throws 500 Internal server error
      */
     create({data, token, jwtToken, headers}) {
       return client({
@@ -132,14 +156,18 @@ function changeRequestsFactory({client, internalAuthTokenProvider}) {
     },
 
     /**
-     * PUT /change-requests/:changeRequestId/schedules - update change request schedule. API does not accept query params.
+     * PUT .../schedules — Update schedule change request (approve/reject). Emits changeRequests.schedules.updated.
      * @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 {string} [opts.jwtToken] - JWT or internal auth
+     * @param {string} opts.changeRequestId - Change request id (24 hex characters)
+     * @param {Object} opts.data - Update payload (status: 'approved' or 'rejected')
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ changeRequest: Object }>>}
+     * @throws 400 WRONG_DATA, CHANGEREQUEST_STATUS_NOT_PENDING, etc.
+     * @throws 401 Unauthorized
+     * @throws 404 CHANGEREQUEST_NOT_FOUND
+     * @throws 500 Internal server error
      */
     update({changeRequestId, data, token, jwtToken, headers}) {
       return client({

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

@@ -41,13 +41,17 @@ const {
  */
 function controlClassesFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /control-classes - list control classes.
+   * GET /control-classes — List control class roots (paginated). Emits no webhooks.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.jwtToken] - JWT or internal auth
    * @param {ControlClassesListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ controlClasses: Object[], authorizationsEnabled?: boolean }>>}
+   * @throws 400 INVALID_PAGE, INVALID_SCHEDULE_ID, INVALID_ASSIGNED_SCHEDULE_ID
+   * @throws 401 Unauthorized
+   * @throws 404 SCHEDULE_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function all({
     token,
@@ -62,14 +66,18 @@ function controlClassesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /control-classes/:controlClassId - get control class by id.
+   * GET /control-classes/:controlClassId — Get one control class (optional tree, schedules).
    * @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 {string} [opts.jwtToken] - JWT or internal auth
+   * @param {string} opts.controlClassId - Control class id (24 hex)
    * @param {ControlClassGetQuery} [opts.query] - Query params (tree, scheduleId, etc.)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ controlClass, root?, parent?, siblings?, children?, schedules?, tree? }>>}
+   * @throws 400 INVALID_CONTROLCLASS_ID
+   * @throws 401 Unauthorized
+   * @throws 404 CONTROLCLASS_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function get({controlClassId, token, headers, jwtToken, query = {}}) {
     return client.get(`/control-classes/${controlClassId}`, {
@@ -79,13 +87,16 @@ function controlClassesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /control-classes - create control class. API does not accept query params.
+   * POST /control-classes — Create control class. Body: { controlClass }. Emits controlclasses.created.
    * @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 {string} [opts.jwtToken] - JWT or internal auth
+   * @param {Object} opts.controlClass - ControlClassData (name, props required)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ controlClass: Object }>>}
+   * @throws 400 WRONG_DATA, DUPLICATE_CLASS_NAME, NO_ROOT_PROPS, PARENT_CLASS_NOT_FOUND, etc.
+   * @throws 401 Unauthorized
+   * @throws 500 Internal server error
    */
   function create({jwtToken, token, controlClass, headers}) {
     return client({
@@ -99,13 +110,17 @@ function controlClassesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /control-classes/:controlClassId - remove control class.
+   * DELETE /control-classes/:controlClassId — Delete control class. Emits controlclasses.deleted.
    * @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 {string} [opts.jwtToken] - JWT or internal auth
+   * @param {string} opts.controlClassId - Control class id (24 hex)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ controlClassId: string }>>}
+   * @throws 400 INVALID_CONTROLCLASS_ID, CANNOT_DELETE_CLASS_WITH_CHILDREN
+   * @throws 401 Unauthorized
+   * @throws 404 CONTROLCLASS_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function remove({jwtToken, controlClassId, token, headers}) {
     return client({
@@ -116,14 +131,18 @@ function controlClassesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /control-classes/:controlClassId - update control class. API does not accept query params.
+   * PUT /control-classes/:controlClassId — Update control class. Body: { controlClass }. Emits controlclasses.updated.
    * @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 {string} [opts.jwtToken] - JWT or internal auth
+   * @param {string} opts.controlClassId - Control class id (24 hex)
+   * @param {Object} opts.controlClass - ControlClassData (name, props required)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ controlClass: Object }>>}
+   * @throws 400 WRONG_DATA, INVALID_CONTROLCLASS_ID, DUPLICATE_CLASS_NAME, etc.
+   * @throws 401 Unauthorized
+   * @throws 404 CONTROLCLASS_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function update({jwtToken, token, controlClassId, controlClass, headers}) {
     return client({

package/src/endpoints/inventory/countries.js

@@ -3,7 +3,14 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
 /**
  * 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
+ * @property {string} [isoCode] - Country 2- or 3-letter ISO code (must be 2 or 3 chars if provided)
+ */
+
+/**
+ * Query params for GET /countries/:countryId (btrz-api-inventory). See getCountryById getSpec().
+ * @typedef {Object} CountryGetQuery
+ * @property {string} [include] - Address level to include: "provinces" (default), "counties", "cities", "neighborhoods"
+ * @property {string} [parentKey] - Parent address level to filter by when include is not provinces
  */
 
 /**
@@ -15,30 +22,38 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function countriesFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /countries - list countries.
+   * GET /countries — List countries. Optional filter by isoCode (2 or 3 characters).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.jwtToken] - JWT or internal auth
    * @param {CountriesListQuery} [opts.query] - Query params (isoCode)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ countries: Object[] }>>}
+   * @throws 400 Validation failure (e.g. invalid isoCode length)
+   * @throws 401 Unauthorized
+   * @throws 500 Internal server error
    */
-  function all({token, query = {}, headers}) {
+  function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/countries",
       params: query,
-      headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
   /**
-   * GET /countries/:id - get country by id. API does not accept query params.
+   * GET /countries/:id — Get country by id. Optional include (provinces/counties/cities/neighborhoods) and parentKey.
    * @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 {string} [opts.jwtToken] - JWT or internal auth
+   * @param {string} opts.id - Country id (24 hex)
+   * @param {CountryGetQuery} [opts.query] - Query params (include, parentKey)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ country: Object }>>}
+   * @throws 400 INVALID_COUNTRY_ID
+   * @throws 401 Unauthorized
+   * @throws 404 COUNTRY_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function get({token, jwtToken, id, query = {}, headers}) {
     return client({

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

@@ -18,13 +18,15 @@ const {
  */
 function customContentFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /custom-content - list custom content.
+   * GET /custom-content — List custom content (paginated). Query: enabled, pageId.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.jwtToken] - JWT or internal auth
    * @param {InventoryCustomContentQuery} [opts.query] - Query params (enabled, pageId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ customContent: Object[] }>>}
+   * @throws 401 Unauthorized
+   * @throws 500 Internal server error
    */
   function all({
     token,
@@ -38,28 +40,35 @@ function customContentFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /custom-content/:customContentId - get custom content by id. API does not accept query params.
+   * 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 {string} [opts.jwtToken] - JWT or internal auth
+   * @param {string} opts.customContentId - Custom content id (24 hex)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ customContent: Object }>>}
+   * @throws 400 INVALID_CUSTOMCONTENT_ID
+   * @throws 401 Unauthorized
+   * @throws 404 CUSTOMCONTENT_NOT_FOUND
+   * @throws 500 Internal server error
    */
-  function get({customContentId, token, headers}) {
+  function get({customContentId, token, jwtToken, headers}) {
     return client.get(`/custom-content/${customContentId}`, {
-      headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
   /**
-   * POST /custom-content - create custom content. API does not accept query params.
+   * POST /custom-content — Create custom content. Body: { customContent }. Emits customContent.created.
    * @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 {string} [opts.jwtToken] - JWT or internal auth
+   * @param {Object} opts.customContent - CustomContentPost (name, pageId, lang required; at least one of title, text, imgUrl, mainUrl)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ customContent: Object }>>}
+   * @throws 400 WRONG_DATA, INVALID_CUSTOMCONTENT
+   * @throws 401 Unauthorized
+   * @throws 500 Internal server error
    */
   function create({jwtToken, token, customContent, headers}) {
     return client({
@@ -73,13 +82,17 @@ function customContentFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /custom-content/:customContentId - remove custom content. API does not accept query params.
+   * DELETE /custom-content/:customContentId — Delete custom content. Emits customContent.deleted.
    * @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 {string} [opts.jwtToken] - JWT or internal auth
+   * @param {string} opts.customContentId - Custom content id (24 hex)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ customContentId: string }>>}
+   * @throws 400 CUSTOMCONTENT_TERMINAL_ID, WRONG_DATA
+   * @throws 401 Unauthorized
+   * @throws 404 CUSTOMCONTENT_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function remove({jwtToken, customContentId, token, headers}) {
     return client({
@@ -90,14 +103,18 @@ function customContentFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /custom-content/:customContentId - update custom content. API does not accept query params.
+   * PUT /custom-content/:customContentId — Update custom content. Body: { customContent }. Emits customContent.updated.
    * @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 {string} [opts.jwtToken] - JWT or internal auth
+   * @param {string} opts.customContentId - Custom content id (24 hex)
+   * @param {Object} opts.customContent - CustomContentPost (at least one of title, text, imgUrl for update)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ customContent: Object }>>}
+   * @throws 400 WRONG_DATA, INVALID_CUSTOMCONTENT_UPDATE
+   * @throws 401 Unauthorized
+   * @throws 404 CUSTOMCONTENT_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function update({jwtToken, token, customContentId, customContent, headers}) {
     return client({

package/src/endpoints/inventory/custom-fields.js

@@ -13,34 +13,36 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  * @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 }}
+ * @returns {{ all: function, get: function, create: function, update: function, types: { all: function } }}
  */
 function customFieldsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /custom-fields - list custom fields.
+   * GET /custom-fields - list custom fields (btrz-api-inventory).
    * @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>}
+   * @returns {Promise<import("axios").AxiosResponse<{ customfields: Array }>>}
+   * @throws When response is 4xx/5xx (e.g. 400 INVALID_MODEL_NAME, 401 Unauthorized, 500)
    */
-  function all({token, query = {}, headers}) {
+  function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/custom-fields",
       params: query,
-      headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
   /**
-   * GET /custom-fields/:fieldId - get custom field by id. API does not accept query params.
+   * GET /custom-fields/:customfieldId - get custom field by id (btrz-api-inventory). No 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 {string} opts.fieldId - Custom field id (24 hex chars; must start with accountId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ customfield: Object }>>}
+   * @throws When response is 4xx/5xx (400, 401, 404 CUSTOMFIELD_NOT_FOUND, 500)
    */
   function get({fieldId, token, jwtToken, query = {}, headers}) {
     return client({
@@ -51,13 +53,14 @@ function customFieldsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /custom-fields - create custom field. API does not accept query params.
+   * POST /custom-fields - create custom field (btrz-api-inventory). No 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.field - Field payload (FieldPutData: text, type, required, disabled, options when type List)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ customfield: Object }>>}
+   * @throws When response is 4xx/5xx (400, 401, 404 CUSTOMFIELD_NOT_FOUND/FIELD_NOT_FOUND, 500)
    */
   function create({token, jwtToken, field, headers}) {
     return client({
@@ -69,14 +72,15 @@ function customFieldsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /custom-fields/:fieldId - update custom field. API does not accept query params.
+   * PUT /custom-fields/:fieldId - update custom field (btrz-api-inventory). No 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 {string} opts.fieldId - Field id (24 hex chars)
+   * @param {Object} opts.field - Field payload (FieldPutData)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ customfield: Object }>>}
+   * @throws When response is 4xx/5xx (400, 401, 404 CUSTOMFIELD_NOT_FOUND/FIELD_NOT_FOUND/WRONG_DATA_OPTIONS, 500)
    */
   function update({token, jwtToken, fieldId, field, headers}) {
     return client({
@@ -90,16 +94,18 @@ function customFieldsFactory({client, internalAuthTokenProvider}) {
   /** @type {{ all: function }} */
   const types = {
     /**
-     * GET /custom-fields/types - list custom field types. API does not accept query params.
+     * GET /custom-fields/types - list custom field types (btrz-api-inventory). No query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ types: Array }>>}
+     * @throws When response is 4xx/5xx (e.g. 401 Unauthorized, 500)
      */
-    all({token, headers}) {
+    all({token, jwtToken, headers}) {
       return client({
         url: "/custom-fields/types",
-        headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
+        headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
       });
     }
   };