btrz-api-client 8.29.0 → 8.31.0

package/lib/endpoints/btrzpay/terminalPayments.js

@@ -3,11 +3,46 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /terminal-payments/mit/:id (btrz-api-payments). See get-mit-by-id-handler getSpec().
+ * @typedef {Object} TerminalPaymentsMitGetQuery
+ * @property {string} [providerId] - Account provider (operator) ID; used by agencies/sellers
+ * @property {string} [branchId] - Branch id where payment started (required for GET)
+ * @property {string} [companyId] - Company id where payment started (required for GET)
+ * @property {string} [date] - Date when payment started; format dd/mm/yyyy (required for GET)
+ */
+
+/**
+ * Query params for PUT /terminal-payments/mit/:id (btrz-api-payments). See put-mit-handler getSpec().
+ * @typedef {Object} TerminalPaymentsMitPutQuery
+ * @property {string} [providerId] - Account provider (operator) ID; used by agencies/sellers
+ */
+
+/**
+ * Factory for terminal payments API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ mit: Object, webhooks: Object }}
+ */
+
+
 function terminalPaymentsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   var mit = {
+    /**
+     * PUT /terminal-payments/mit/:id - update MIT terminal payment.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.id - Terminal payment id
+     * @param {Object} opts.terminalPayment - Terminal payment payload
+     * @param {TerminalPaymentsMitPutQuery} [opts.query] - Query params (providerId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref2) {
       var token = _ref2.token,
           jwtToken = _ref2.jwtToken,
@@ -25,6 +60,17 @@ function terminalPaymentsFactory(_ref) {
         data: { terminalPayment: terminalPayment }
       });
     },
+
+    /**
+     * GET /terminal-payments/mit/:id - get MIT terminal payment.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.id - Terminal payment id
+     * @param {TerminalPaymentsMitGetQuery} [opts.query] - Query params (providerId, branchId, companyId, date)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref3) {
       var token = _ref3.token,
           jwtToken = _ref3.jwtToken,
@@ -41,6 +87,16 @@ function terminalPaymentsFactory(_ref) {
   };
 
   var webhooks = {
+    /**
+     * POST /terminal-payments/webhooks/getnet/:providerId - Getnet webhook. API does not accept query params.
+     * @param {Object} opts
+     * @param {Object} opts.data - Request body
+     * @param {string} opts.providerId - Provider id
+     * @param {Object} [opts.headers] - Optional headers
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     getnet: function getnet(_ref4) {
       var data = _ref4.data,
           providerId = _ref4.providerId,

package/lib/endpoints/coltrane/docs.js

@@ -1,8 +1,18 @@
 "use strict";
 
+/**
+ * Factory for Coltrane API docs (btrz-api-coltrane).
+ * @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 documentation.
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get() {
     return client.get("/api-docs-v2", {});
   }

package/lib/endpoints/coltrane/merged-fare-tables.js

@@ -1,12 +1,32 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for Coltrane merged fare tables API (btrz-api-coltrane).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
+
+
 function mergedFareTablesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /coltrane/routes/:routeId/merged-fare-tables/:productId - get merged fare table. 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.routeId - Route id
+   * @param {string} opts.productId - Product id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

package/lib/endpoints/coltrane/paths.js

@@ -1,12 +1,42 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /paths (btrz-api-coltrane). See get-paths getSpec().
+ * @typedef {Object} ColtranePathsListQuery
+ * @property {string} [providerId] - Account ID of the travel provider (required by API)
+ * @property {string} [productId] - Product ID belonging to the provider (required by API)
+ * @property {string} [originId] - Origin station id (required by API)
+ * @property {string} [destinationId] - Destination station id (required by API)
+ * @property {string} [departureFromDate] - Start of search interval; ISO 8601 (e.g. 2021-10-07T17:30:00.000-0400)
+ * @property {string} [departureToDate] - End of search interval; ISO 8601; interval max 25h
+ * @property {string} [metrics] - If true, response includes metrics (debugging)
+ */
+
+/**
+ * Factory for Coltrane paths API (btrz-api-coltrane).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
+
+
 function coltraneFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /paths - list Coltrane paths.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {ColtranePathsListQuery} [opts.query] - Query params (providerId, productId, originId, destinationId, etc.)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,

package/lib/endpoints/endpoints_helpers.js

@@ -4,8 +4,18 @@ var _slicedToArray = function () { function sliceIterator(arr, i) { var _arr = [
 
 var _typeof = typeof Symbol === "function" && typeof Symbol.iterator === "symbol" ? function (obj) { return typeof obj; } : function (obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; };
 
-var constants = require("../constants");
+/* eslint-disable max-len */
+var constants = require("../constants.js");
 
+/**
+ * Builds authorization and forwarding headers for API requests.
+ * @param {Object} opts - Options for authorization
+ * @param {string} [opts.token] - API key; sets x-api-key header when provided
+ * @param {string} [opts.jwtToken] - JWT or internal auth symbol; sets Authorization Bearer when provided
+ * @param {{ getToken: function(): string }} [opts.internalAuthTokenProvider] - When jwtToken is INTERNAL_AUTH_TOKEN_SYMBOL, getToken() is used for the Bearer token
+ * @param {Object} [opts.headers] - Optional request headers; x-amzn-trace-id and x-elevation-token are forwarded when present; cookie with "btrz-trusted" is forwarded for trusted machine
+ * @returns {Object} Headers object suitable for axios (x-api-key, Authorization, cookie, x-amzn-trace-id, x-elevation-token as applicable)
+ */
 function authorizationHeaders(_ref) {
   var token = _ref.token,
       jwtToken = _ref.jwtToken,

package/lib/endpoints/gps/scanner-app-location.js

@@ -3,12 +3,36 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
-//TODO: add docs function when docs published
+/**
+ * Query params for GET /scanner-app-location (GPS API). API is external (not in workspace);
+ * shape from btrz-vue-websales and client usage.
+ * @typedef {Object} ScannerAppLocationQuery
+ * @property {string} [scheduleId] - Schedule id
+ * @property {string} [routeId] - Route id
+ * @property {string} [date] - Date (e.g. YYYY-MM-DD); defaults to today when omitted in websales
+ * @property {boolean} [includeTravelledPath] - Whether to include travelled path
+ */
+
+/**
+ * Factory for scanner app location API (GPS).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
 
 
 function scannerAppLocationFactory(_ref) {
   var client = _ref.client;
 
+  /**
+   * GET /scanner-app-location - get scanner app location.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {ScannerAppLocationQuery} [opts.query] - Query params (scheduleId, routeId, date, includeTravelledPath)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>} response.data may contain location
+   */
   function get(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,

package/lib/endpoints/inventory/amenities.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 /amenities (btrz-api-inventory). See get-amenities getSpec().
+ * @typedef {Object} AmenitiesListQuery
+ * @property {string} [name] - Filter by name
+ * @property {string} [amenityId] - Filter by amenity ID
+ * @property {string} [enabled] - Filter by enabled status
+ * @property {number} [page] - Page for pagination
+ */
+
+/**
+ * Factory for amenities API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function }}
+ */
+
+
 function amenitiesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /amenities - list amenities.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {AmenitiesListQuery} [opts.query] - Query params (name, amenityId, enabled, page)
+   * @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 amenitiesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /amenities/:amenityId - get amenity 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.amenityId - Amenity id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         amenityId = _ref3.amenityId,
@@ -33,6 +68,15 @@ function amenitiesFactory(_ref) {
     });
   }
 
+  /**
+   * POST /amenities - create amenity. 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.amenity - Amenity payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -47,6 +91,16 @@ function amenitiesFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /amenities/:amenityId - update amenity. 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.amenityId - Amenity id
+   * @param {Object} opts.amenity - Amenity payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,

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

@@ -1,13 +1,40 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /amenity-groups (btrz-api-inventory). See get-amenity-groups getSpec().
+ * @typedef {Object} AmenityGroupsListQuery
+ * @property {string} [name] - Filter by name
+ * @property {string} [amenityId] - Filter by amenity ID
+ * @property {string} [enabled] - Filter by enabled status
+ * @property {number} [page] - Page for pagination
+ * @property {number} [pageSize] - Results per page
+ */
+
+/**
+ * Factory for amenity-groups API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function }}
+ */
+
+
 function amenityGroupsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /amenity-groups - list amenity groups.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {AmenityGroupsListQuery} [opts.query] - Query params (name, amenityId, enabled, page, pageSize)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -20,6 +47,15 @@ function amenityGroupsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /amenity-groups/:amenityGroupId - get amenity group 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.amenityGroupId - Amenity group id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         amenityGroupId = _ref3.amenityGroupId,
@@ -33,6 +69,15 @@ function amenityGroupsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /amenity-groups - create amenity group. 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.amenityGroup - Amenity group payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -47,6 +92,16 @@ function amenityGroupsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /amenity-groups/:amenityGroupId - update amenity group. 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.amenityGroupId - Amenity group id
+   * @param {Object} opts.amenityGroup - Amenity group payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,

package/lib/endpoints/inventory/banks.js

@@ -3,10 +3,27 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for banks API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, remove: function }}
+ */
+
+
 function banksFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /banks - list banks. 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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -20,6 +37,15 @@ function banksFactory(_ref) {
     });
   }
 
+  /**
+   * GET /banks/:bankId - get bank 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.bankId - Bank id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var bankId = _ref3.bankId,
         token = _ref3.token,
@@ -31,6 +57,15 @@ function banksFactory(_ref) {
     });
   }
 
+  /**
+   * POST /banks - create bank. 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.bank - Bank payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -47,6 +82,15 @@ function banksFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /banks/:bankId - remove bank. 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.bankId - Bank id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref5) {
     var jwtToken = _ref5.jwtToken,
         bankId = _ref5.bankId,
@@ -60,6 +104,16 @@ function banksFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /banks/:bankId - update bank. 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.bankId - Bank id
+   * @param {Object} opts.bank - Bank 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/bare-routes.js

@@ -1,12 +1,43 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /bare-routes (btrz-api-inventory). See get-bare-routes getSpec().
+ * @typedef {Object} BareRoutesListQuery
+ * @property {string} [providerIds] - Comma-separated provider IDs
+ * @property {string} [productIds] - Comma-separated product IDs
+ */
+
+/**
+ * Query params for GET /bare-routes/:routeId (btrz-api-inventory). See get-bare-routes-id getSpec().
+ * @typedef {Object} BareRoutesGetQuery
+ * @property {string} [providerIds] - Comma-separated provider IDs
+ */
+
+/**
+ * Factory for bare-routes API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function }}
+ */
+
+
 function bareRoutesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /bare-routes - list bare routes.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {BareRoutesListQuery} [opts.query] - Query params (providerIds, productIds)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -20,6 +51,16 @@ function bareRoutesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /bare-routes/:routeId - get bare route by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.routeId - Route id
+   * @param {BareRoutesGetQuery} [opts.query] - Query params (providerIds)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var routeId = _ref3.routeId,
         token = _ref3.token,

package/lib/endpoints/inventory/brands.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 /brands (btrz-api-inventory). See get-brands getSpec().
+ * @typedef {Object} BrandsListQuery
+ * @property {string} [providerIds] - Comma-separated provider IDs
+ * @property {string} [enabled] - Filter by enabled status
+ * @property {number} [page] - Page for pagination
+ * @property {number} [pageSize] - Results per page
+ */
+
+/**
+ * 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 {BrandsListQuery} [opts.query] - Query params (providerIds, enabled, page, pageSize)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -22,6 +48,15 @@ function brandsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /brands - create brand. 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.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 +71,16 @@ function brandsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /brands/:brandId - update brand. 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.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 +96,15 @@ function brandsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /brands/:brandId - get brand 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.brandId - Brand id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref5) {
     var token = _ref5.token,
         brandId = _ref5.brandId,