btrz-api-client 8.29.0 → 8.31.0

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

@@ -1,21 +1,54 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /service-numbers (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} ServiceNumbersListQuery
+ * @property {string} [name] - Filter by service number name
+ * @property {boolean} [enabled] - Filter enabled/disabled
+ * @property {number} [page] - Page for pagination
+ */
+
+/**
+ * Factory for service-numbers API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function, update: function, get: function }}
+ */
 function serviceNumbersFactory({
   client,
   internalAuthTokenProvider
 }) {
+  /**
+   * GET /service-numbers - list service numbers.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {ServiceNumbersListQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token, jwtToken, query = {}, headers
   }) {
     return client({
       url: "/service-numbers",
       params: query,
-      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * POST /service-numbers - create service number. 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.serviceNumber - Service number payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({
     token, jwtToken, serviceNumber, headers
   }) {
@@ -29,6 +62,16 @@ function serviceNumbersFactory({
     });
   }
 
+  /**
+   * PUT /service-numbers/:serviceNumberId - update service number. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.serviceNumberId - Service number id
+   * @param {Object} opts.serviceNumber - Service number payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({
     jwtToken, token, serviceNumberId, serviceNumber, headers
   }) {
@@ -42,11 +85,20 @@ function serviceNumbersFactory({
     });
   }
 
+  /**
+   * GET /service-numbers/:serviceNumberId - get service number by id. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.serviceNumberId - Service number id
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, serviceNumberId, jwtToken, headers}) {
     return client({
       url: `/service-numbers/${serviceNumberId}`,
       method: "get",
-      headers: authorizationHeaders({token, internalAuthTokenProvider, jwtToken, headers}),
+      headers: authorizationHeaders({token, internalAuthTokenProvider, jwtToken, headers})
     });
   }
 

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

@@ -1,9 +1,22 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for service-types API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, remove: function }}
+ */
 function serviceTypesFactory({client, internalAuthTokenProvider}) {
-
+  /**
+   * GET /service-types - list service types. API does not accept query params (getSpec has no query parameters).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     query = {},
@@ -15,12 +28,29 @@ function serviceTypesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /service-types/:serviceTypeId - get service type by id. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} opts.serviceTypeId - Service type id
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({serviceTypeId, token, headers}) {
     return client.get(`/service-types/${serviceTypeId}`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * POST /service-types - create service type. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {Object} opts.serviceType - Service type payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, serviceType, headers}) {
     return client({
       url: "/service-types",
@@ -32,7 +62,16 @@ function serviceTypesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
-  function remove({ jwtToken, serviceTypeId, token, headers }) {
+  /**
+   * DELETE /service-types/:serviceTypeId - remove service type. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.serviceTypeId - Service type id
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function remove({jwtToken, serviceTypeId, token, headers}) {
     return client({
       url: `/service-types/${serviceTypeId}`,
       method: "delete",
@@ -40,6 +79,16 @@ function serviceTypesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /service-types/:serviceTypeId - update service type. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.serviceTypeId - Service type id
+   * @param {Object} opts.serviceType - Service type payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, serviceTypeId, serviceType, headers}) {
     return client({
       url: `/service-types/${serviceTypeId}`,

package/src/endpoints/inventory/ssrs.js

@@ -1,18 +1,44 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function ssrsFactory({client, internalAuthTokenProvider}) {
+/**
+ * Query params for GET /ssrs (btrz-api-inventory). See get-ssrs getSpec().
+ * @typedef {Object} SsrsListQuery
+ * @property {string} [providerIds] - Provider ids to get SSRs for
+ * @property {string} [travelDate] - Travel date (yyyy-mm-dd)
+ * @property {string} [travelTime] - Travel time (HH:MM); required if travelDate provided
+ * @property {string} [tripId] - Trip id to get SSRs for
+ * @property {string} [productIds] - Product type ids
+ * @property {string} [enabled] - Filter enabled/disabled [true, false]
+ * @property {string} [currency] - Currency ISO code
+ * @property {string} [brandIds] - Trip brand ids
+ */
 
-  function all({ token, query = {}, headers }) {
+/**
+ * Factory for ssrs API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
+function ssrsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /ssrs - list SSRs.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {SsrsListQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, query = {}, headers}) {
     return client.get("/ssrs", {
-      params: query,   
+      params: query,
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
-  return { 
+  return {
     all
   };
-
 }
 
-module.exports = ssrsFactory;
+module.exports = ssrsFactory;

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

@@ -1,6 +1,29 @@
 const {authorizationHeaders} = require("../endpoints_helpers.js");
 
+/**
+ * Query params for GET /station-classes (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} StationClassesListQuery
+ * @property {number} [page] - Page number to retrieve
+ * @property {string} [name] - Filter by station class name
+ */
+
+/**
+ * Factory for station-classes API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, update: function, remove: function, create: function }}
+ */
 function stationClassFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /station-classes - list station classes.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {StationClassesListQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/station-classes",
@@ -10,6 +33,15 @@ function stationClassFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /station-classes/:stationClassId - get station class 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.stationClassId - Station class id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, stationClassId, query = {}, headers}) {
     return client({
       url: `/station-classes/${stationClassId}`,
@@ -19,6 +51,16 @@ function stationClassFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /station-classes/:stationClassId - update station 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.stationClassId - Station class id
+   * @param {Object} opts.data - Station class payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, stationClassId, data, headers}) {
     return client({
       url: `/station-classes/${stationClassId}`,
@@ -28,6 +70,15 @@ function stationClassFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /station-classes/:stationClassId - remove station 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.stationClassId - Station class id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({token, jwtToken, stationClassId, headers}) {
     return client({
       url: `/station-classes/${stationClassId}`,
@@ -36,6 +87,15 @@ function stationClassFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /station-classes - create station 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.data - Station class payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, data, headers}) {
     return client({
       url: "/station-classes",

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

@@ -2,7 +2,29 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /station-groups (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} StationGroupsListQuery
+ * @property {string} [providerIds] - Provider ids to get station groups for
+ */
+
+/**
+ * Factory for station-groups API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
 function stationGroupsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /station-groups - list station groups.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {StationGroupsListQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, query = {}, headers}) {
     return client({
       url: "/station-groups",

package/src/endpoints/inventory/stations-provinces.js

@@ -2,7 +2,22 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * Factory for stations/provinces API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
 function stationsProvincesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /stations/provinces - list station provinces. 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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, query = {}, headers}) {
     return client({
       url: "/stations/provinces",

package/src/endpoints/inventory/stations-zones.js

@@ -2,7 +2,29 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /stations/zones (btrz-api-inventory). See 01-get-stations-zones getSpec().
+ * @typedef {Object} StationsZonesQuery
+ * @property {string} [accountIds] - Comma-separated account ids to get zones for (agency accounts)
+ */
+
+/**
+ * Factory for stations/zones API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
 function stationsZonesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /stations/zones - get station zones.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {StationsZonesQuery} [opts.query] - Query params (accountIds)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, query = {}, headers}) {
     return client.get("/stations/zones", {
       params: query,

package/src/endpoints/inventory/stations.js

@@ -1,12 +1,60 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /stations (btrz-api-inventory). See get-stations getSpec().
+ * @typedef {Object} StationsQuery
+ * @property {string} [providerId] - The id of the provider to get stations for
+ * @property {string} [providerIds] - The ids of the providers to get stations for
+ * @property {string} [productId] - The id of the product
+ * @property {string} [departure] - The id of the origin station
+ * @property {string} [province] - The province of the station
+ * @property {string} [zone] - The zone of the station
+ * @property {string} [type] - The type name of the station
+ * @property {string} [name] - The full name of the station
+ * @property {string} [partialName] - Full or partial name (case-insensitive match)
+ * @property {string} [enabled] - Filter by enabled: "true" | "false"
+ * @property {number} [page] - Page for pagination
+ * @property {string} [orderBy] - Field to order by
+ * @property {string} [orderDir] - Order direction: asc (1) or desc (-1), default 1
+ * @property {string} [stationIds] - Comma-separated station ids to return
+ * @property {string} [filterHeadStations] - Filter stations that are grouping any station
+ * @property {string} [includesStationsGroupFor] - Include stations that group/include the sent station id
+ * @property {string} [externalId] - The id of the station in the external system
+ * @property {string} [shortcode] - The shortcode of the station to filter by
+ */
+
+/**
+ * Factory for stations API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, all: function, create: function, update: function }}
+ */
 function stationsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /stations/:id - get station 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 - Station id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, id, headers}) {
     return client.get(`/stations/${id}`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * GET /stations - list stations.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {StationsQuery} [opts.query] - Query params (providerId, productId, name, page, etc.)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, query = {}, headers}) {
     return client.get("/stations", {
       params: query,
@@ -14,6 +62,15 @@ function stationsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /stations - create station. 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 - Station payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, data, headers}) {
     return client({
       url: "/stations",
@@ -25,12 +82,22 @@ function stationsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
-  function update({ token, jwtToken, stationId, station, headers}) {
+  /**
+   * PUT /station/:stationId - update station. 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.stationId - Station id
+   * @param {Object} opts.station - Station payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function update({token, jwtToken, stationId, station, headers}) {
     return client({
-      url: "/station/" + stationId,
+      url: `/station/${stationId}`,
       method: "put",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { station }
+      data: {station}
     });
   }
 

package/src/endpoints/inventory/taxes.js

@@ -1,7 +1,28 @@
-const {authorizationHeaders} = require("../endpoints_helpers");
+const {authorizationHeaders} = require("../endpoints_helpers.js");
 
-function taxesFactory({client, internalAuthTokenProvider}) {
+/**
+ * Query params for GET /taxes (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} TaxesQuery
+ * @property {string} [providerIds] - The id of the providers to get taxes for
+ */
 
+/**
+ * Factory for taxes 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, exceptions: object }}
+ */
+function taxesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /taxes - list taxes.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {TaxesQuery} [opts.query] - Query params (providerIds)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, query = {}, headers}) {
     return client.get("/taxes", {
       params: query,
@@ -9,6 +30,15 @@ function taxesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /taxes/:taxId - get tax 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.taxId - Tax id (ObjectId format)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({taxId, token, query = {}, headers}) {
     return client.get(`/taxes/${taxId}`, {
       params: query,
@@ -16,6 +46,15 @@ function taxesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /taxes - create tax.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.tax - Tax payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, tax, token, headers}) {
     return client({
       url: "/taxes",
@@ -25,6 +64,16 @@ function taxesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /taxes/:taxId - update tax.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.taxId - Tax id
+   * @param {Object} opts.tax - Tax payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, taxId, tax, headers}) {
     return client({
       url: `/taxes/${taxId}`,
@@ -34,7 +83,17 @@ function taxesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /** @type {{ create: function, update: function, get: function, all: function, delete: function }} */
   const exceptions = {
+    /**
+     * POST /taxes/exceptions - create tax exception.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} opts.taxException - Tax exception payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create({jwtToken, token, taxException, headers}) {
       return client({
         url: "/taxes/exceptions",
@@ -43,6 +102,16 @@ function taxesFactory({client, internalAuthTokenProvider}) {
         data: taxException
       });
     },
+    /**
+     * PUT /taxes/exceptions/:taxExceptionId - update tax exception.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.taxExceptionId - Tax exception id
+     * @param {Object} opts.taxException - Tax exception payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update({jwtToken, token, taxExceptionId, taxException, headers}) {
       return client({
         url: `/taxes/exceptions/${taxExceptionId}`,
@@ -51,12 +120,29 @@ function taxesFactory({client, internalAuthTokenProvider}) {
         data: taxException
       });
     },
+    /**
+     * GET /taxes/exceptions/:taxExceptionId - get tax exception.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.taxExceptionId - Tax exception id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({jwtToken, token, taxExceptionId, headers}) {
       return client({
         url: `/taxes/exceptions/${taxExceptionId}`,
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
       });
     },
+    /**
+     * GET /taxes/exceptions - list tax exceptions.
+     * @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>}
+     */
     all({jwtToken, token, query = {}, headers}) {
       return client({
         url: "/taxes/exceptions",
@@ -64,6 +150,15 @@ function taxesFactory({client, internalAuthTokenProvider}) {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
       });
     },
+    /**
+     * DELETE /taxes/exceptions/:taxExceptionId - delete tax exception.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.taxExceptionId - Tax exception id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     delete({jwtToken, token, taxExceptionId, headers}) {
       return client({
         url: `/taxes/exceptions/${taxExceptionId}`,