btrz-api-client 8.29.0 → 8.31.0

package/lib/endpoints/inventory/filtered-trips.js

@@ -3,10 +3,40 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /filtered-trips (btrz-api-inventory). See get-filtered-trips getSpec().
+ * @typedef {Object} FilteredTripsListQuery
+ * @property {string} [providerIds] - Comma-separated provider IDs
+ * @property {string} [productId] - Product ID to filter by
+ * @property {string} [originId] - Origin station ID to filter by
+ * @property {string} [destinationId] - Destination station ID to filter by
+ * @property {number} [page] - Page for pagination
+ * @property {string} [orderBy] - Field to order by
+ * @property {string} [orderDir] - asc (1) or desc (-1)
+ */
+
+/**
+ * Factory for filtered-trips API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function }}
+ */
+
+
 function filteredTripsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /filtered-trips - list filtered trips.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {FilteredTripsListQuery} [opts.query] - Query params (providerIds, productId, originId, destinationId, page, orderBy, orderDir)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -20,6 +50,15 @@ function filteredTripsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /filtered-trips - create filtered trip. 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.tripSegmentsId - Trip segments id payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,

package/lib/endpoints/inventory/financing-costs.js

@@ -3,10 +3,41 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /financing-costs (btrz-api-inventory). See get-financing-costs getSpec().
+ * @typedef {Object} FinancingCostsListQuery
+ * @property {number} [page] - Page number
+ * @property {string} [providerId] - Provider to get financing costs for
+ */
+
+/**
+ * Query params for GET /financing-costs/:id (btrz-api-inventory). See get-financing-cost-by-id getSpec().
+ * @typedef {Object} FinancingCostGetQuery
+ * @property {string} [providerId] - Provider to get financing cost for
+ */
+
+/**
+ * Factory for financing-costs 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 financingCostsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /financing-costs - list financing costs.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {FinancingCostsListQuery} [opts.query] - Query params (page, providerId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -20,6 +51,16 @@ function financingCostsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /financing-costs/:id - get financing cost by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Financing cost id
+   * @param {FinancingCostGetQuery} [opts.query] - Query params (providerId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var id = _ref3.id,
         token = _ref3.token,
@@ -34,6 +75,15 @@ function financingCostsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /financing-costs - create financing cost. 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.financingCost - Financing cost payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -50,6 +100,15 @@ function financingCostsFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /financing-costs/:id - remove financing cost. 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 - Financing cost id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref5) {
     var jwtToken = _ref5.jwtToken,
         id = _ref5.id,
@@ -66,6 +125,16 @@ function financingCostsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /financing-costs/:id - update financing cost. 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 - Financing cost id
+   * @param {Object} opts.financingCost - Financing cost 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/garages.js

@@ -1,12 +1,37 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /garages (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} GaragesQuery
+ * @property {string} [location] - The garage's location
+ * @property {string} [stationId] - The id of the station associated to the garage
+ */
+
+/**
+ * Factory for garages 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 garagesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /garages - list garages.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {GaragesQuery} [opts.query] - Query params (location, stationId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -20,6 +45,15 @@ function garagesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /garages/:garageId - get garage 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.garageId - Garage id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -31,6 +65,15 @@ function garagesFactory(_ref) {
     });
   }
 
+  /**
+   * POST /garages - create garage. 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 - Garage payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -47,6 +90,16 @@ function garagesFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /garages/:garageId - update garage.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.garageId - Garage id
+   * @param {Object} opts.data - Garage payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -64,6 +117,15 @@ function garagesFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /garages/:garageId - remove garage. 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.garageId - Garage id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,

package/lib/endpoints/inventory/getnet-terminals.js

@@ -3,10 +3,36 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /getnet-terminals (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} GetnetTerminalsQuery
+ * @property {number} [page] - The page number to retrieve
+ * @property {string} [stationId] - Filter terminals by station (location) ID
+ * @property {string} [serialNumber] - Filter terminals by serial number
+ */
+
+/**
+ * Factory for getnet-terminals 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, remove: function, update: function }}
+ */
+
+
 function getnetTerminalFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /getnet-terminals - list getnet terminals.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {GetnetTerminalsQuery} [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 +46,15 @@ function getnetTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * GET /getnet-terminals/:getnetTerminalId - get a getnet terminal. 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.getnetTerminalId - Getnet terminal id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var getnetTerminalId = _ref3.getnetTerminalId,
         token = _ref3.token,
@@ -31,6 +66,15 @@ function getnetTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * POST /getnet-terminals - create getnet terminal.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.getnetTerminal - Getnet terminal payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -47,6 +91,15 @@ function getnetTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /getnet-terminals/:getnetTerminalId - remove getnet terminal. 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.getnetTerminalId - Getnet terminal id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref5) {
     var jwtToken = _ref5.jwtToken,
         getnetTerminalId = _ref5.getnetTerminalId,
@@ -60,6 +113,16 @@ function getnetTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /getnet-terminals/:getnetTerminalId - update getnet terminal. 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.getnetTerminalId - Getnet terminal id
+   * @param {Object} opts.getnetTerminal - Getnet terminal 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/gift-certificate-definitions.js

@@ -3,10 +3,35 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /gift-certificate-definitions (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} GiftCertificateDefinitionsListQuery
+ * @property {string[]} [channels] - Filter by channels
+ * @property {string[]} [currencies] - Filter by currencies
+ * @property {string} providerId - Provider id (required by API)
+ */
+
+/**
+ * Factory for gift-certificate-definitions 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 giftCertificateDefinitionsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /gift-certificate-definitions - list gift certificate definitions.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {GiftCertificateDefinitionsListQuery} [opts.query] - Query params (channels, currencies, providerId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -19,6 +44,15 @@ function giftCertificateDefinitionsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /gift-certificate-definitions/:giftcertificateId - get gift certificate definition 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.giftcertificateId - Gift certificate definition id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -35,6 +69,15 @@ function giftCertificateDefinitionsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /gift-certificate-definitions - create gift certificate definition. 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.giftcertificate - Gift certificate payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -52,6 +95,16 @@ function giftCertificateDefinitionsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /gift-certificate-definitions/:giftcertificateId - update gift certificate definition. 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.giftcertificateId - Gift certificate definition id
+   * @param {Object} opts.giftcertificate - Gift certificate payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -70,6 +123,15 @@ function giftCertificateDefinitionsFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /gift-certificate-definitions/:giftcertificateId - remove gift certificate definition. 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.giftcertificateId - Gift certificate definition id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,

package/lib/endpoints/inventory/healthcheck.js

@@ -1,12 +1,18 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
-    authorizationHeaders = _require.authorizationHeaders;
-
+/**
+ * Factory for healthcheck API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @returns {{ get: function }}
+ */
 function healthCheckFactory(_ref) {
-  var client = _ref.client,
-      internalAuthTokenProvider = _ref.internalAuthTokenProvider;
+  var client = _ref.client;
 
+  /**
+   * GET /healthcheck - health check.
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get() {
     return client({
       url: "/healthcheck",

package/lib/endpoints/inventory/insurances.js

@@ -1,12 +1,37 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /insurances (btrz-api-inventory). See get-insurances getSpec().
+ * @typedef {Object} InsurancesListQuery
+ * @property {string} [productId] - Filter by product id
+ * @property {boolean} [enabled] - Filter by enabled
+ * @property {string[]} [providerIds] - Filter by provider ids
+ */
+
+/**
+ * Factory for insurances API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function, get: function, update: function, remove: function }}
+ */
+
+
 function insurancesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /insurances - list insurances.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {InsurancesListQuery} [opts.query] - Query params (productId, enabled, providerIds)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -21,6 +46,14 @@ function insurancesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /insurances/:insuranceId - get insurance by id. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.insuranceId - Insurance id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         insuranceId = _ref3.insuranceId,
@@ -33,6 +66,15 @@ function insurancesFactory(_ref) {
     });
   }
 
+  /**
+   * POST /insurances - create insurance. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} opts.insurance - Insurance payload
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var token = _ref4.token,
         insurance = _ref4.insurance,
@@ -49,6 +91,16 @@ function insurancesFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /insurances/:insuranceId - update insurance. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} opts.insurance - Insurance payload
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.insuranceId - Insurance id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref5) {
     var token = _ref5.token,
         insurance = _ref5.insurance,
@@ -66,6 +118,15 @@ function insurancesFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /insurances/:insuranceId - remove insurance. 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.insuranceId - Insurance id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,

package/lib/endpoints/inventory/insurancesCost.js

@@ -1,12 +1,39 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /insurances/:productId/cost (btrz-api-inventory). See GetInsuranceCostsHandler getSpec().
+ * Client merges opts.declaredValue into query.
+ * @typedef {Object} InsurancesCostQuery
+ * @property {*} declaredValue - Declared value (required by API; may be passed as opts.declaredValue)
+ * @property {string} [providerId] - Provider id
+ */
+
+/**
+ * Factory for insurances cost API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
+
+
 function insurancesCostFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /insurances/:productId/cost - get insurance cost for product. Client merges opts.declaredValue into query.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.productId - Product id
+   * @param {*} opts.declaredValue - Declared value (required; merged into query)
+   * @param {InsurancesCostQuery} [opts.query] - Additional query params (e.g. providerId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref2) {
     var token = _ref2.token,
         productId = _ref2.productId,