btrz-api-client 8.34.0 → 8.36.0

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

@@ -30,13 +30,14 @@ function financingCostsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /financing-costs - list financing costs.
+   * GET /financing-costs - list financing costs (paginated).
    * @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>}
+   * @returns {Promise<import("axios").AxiosResponse<{ financingcosts: Array, next: string, previous: string, count: number }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_PAGE, 401, 500)
    */
   function all(_ref2) {
     var token = _ref2.token,
@@ -56,10 +57,11 @@ function financingCostsFactory(_ref) {
    * @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 {string} opts.id - Financing cost id (24 hex characters)
    * @param {FinancingCostGetQuery} [opts.query] - Query params (providerId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ financingcost: Object }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_FINANCINGCOST_ID, 401, 404 FINANCINGCOST_NOT_FOUND, 500)
    */
   function get(_ref3) {
     var id = _ref3.id,
@@ -76,13 +78,14 @@ function financingCostsFactory(_ref) {
   }
 
   /**
-   * POST /financing-costs - create financing cost. API does not accept query params.
+   * POST /financing-costs - create financing cost.
    * @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.financingCost - Financing cost (name, internalId, currencyCode, dow, creditCard, maxQuota, interest, enabled)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ financingcost: Object }>>}
+   * @throws When response is 4xx/5xx (400 WRONG_DATA, 401, 409 duplicated internalId, 500)
    */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
@@ -101,13 +104,14 @@ function financingCostsFactory(_ref) {
   }
 
   /**
-   * DELETE /financing-costs/:id - remove financing cost. API does not accept query params.
+   * DELETE /financing-costs/:id - remove financing cost.
    * @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 {string} opts.id - Financing cost id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ financingcostId: string }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_FINANCINGCOST_ID, 401, 404 FINANCINGCOST_NOT_FOUND, 500)
    */
   function remove(_ref5) {
     var jwtToken = _ref5.jwtToken,
@@ -126,14 +130,15 @@ function financingCostsFactory(_ref) {
   }
 
   /**
-   * PUT /financing-costs/:id - update financing cost. API does not accept query params.
+   * PUT /financing-costs/:id - update financing cost.
    * @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 {string} opts.id - Financing cost id (24 hex characters)
+   * @param {Object} opts.financingCost - Financing cost (name, internalId, currencyCode, dow, creditCard, maxQuota, interest, enabled)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ financingcost: Object }>>}
+   * @throws When response is 4xx/5xx (400 WRONG_DATA, 401, 404 not found, 409 duplicated internalId, 500)
    */
   function update(_ref6) {
     var jwtToken = _ref6.jwtToken,

package/lib/endpoints/inventory/garages.js

@@ -24,13 +24,14 @@ function garagesFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /garages - list garages.
+   * GET /garages - list garages (paginated).
    * @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>}
+   * @returns {Promise<import("axios").AxiosResponse<{ garages: Array, next?: string, previous?: string, count: number }>>}
+   * @throws When response is 4xx/5xx (401, 500)
    */
   function all(_ref2) {
     var token = _ref2.token,
@@ -46,13 +47,14 @@ function garagesFactory(_ref) {
   }
 
   /**
-   * GET /garages/:garageId - get garage by id. API does not accept query params.
+   * GET /garages/:garageId - get garage by id.
    * @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 {string} opts.garageId - Garage id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ garage: Object }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_GARAGE_ID, 401, 404 GARAGE_NOT_FOUND, 500)
    */
   function get(_ref3) {
     var token = _ref3.token,
@@ -66,13 +68,14 @@ function garagesFactory(_ref) {
   }
 
   /**
-   * POST /garages - create garage. API does not accept query params.
+   * POST /garages - create garage.
    * @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.data - Garage payload (name, location, stationId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ garage: Object }>>}
+   * @throws When response is 4xx/5xx (400 WRONG_DATA, 401, 500)
    */
   function create(_ref4) {
     var token = _ref4.token,
@@ -95,10 +98,11 @@ function garagesFactory(_ref) {
    * @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 {string} opts.garageId - Garage id (24 hex characters)
+   * @param {Object} opts.data - Garage payload (name, location, stationId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ garage: Object }>>}
+   * @throws When response is 4xx/5xx (400, 401, 404 GARAGE_NOT_FOUND/STATION_NOT_FOUND, 500)
    */
   function update(_ref5) {
     var token = _ref5.token,
@@ -118,13 +122,14 @@ function garagesFactory(_ref) {
   }
 
   /**
-   * DELETE /garages/:garageId - remove garage. API does not accept query params.
+   * DELETE /garages/:garageId - remove 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 {string} opts.garageId - Garage id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ success: boolean }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_GARAGE_ID or GARAGE_WITH_VEHICLES, 401, 404, 500)
    */
   function remove(_ref6) {
     var token = _ref6.token,

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

@@ -25,13 +25,14 @@ function getnetTerminalFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /getnet-terminals - list getnet terminals.
+   * GET /getnet-terminals - list getnet terminals (paginated).
    * @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 {GetnetTerminalsQuery} [opts.query] - Query params (page, stationId, serialNumber)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ getnetTerminals: Array, next?: string, previous?: string, count: number }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_PAGE, 401, 500)
    */
   function all(_ref2) {
     var token = _ref2.token,
@@ -47,13 +48,14 @@ function getnetTerminalFactory(_ref) {
   }
 
   /**
-   * GET /getnet-terminals/:getnetTerminalId - get a getnet terminal. API does not accept query params.
+   * GET /getnet-terminals/:getnetTerminalId - get a getnet terminal by id.
    * @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 {string} opts.getnetTerminalId - Getnet terminal id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ getnetTerminal: Object }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_GETNET_TERMINAL_ID, 401, 404 GETNET_TERMINAL_NOT_FOUND, 500)
    */
   function get(_ref3) {
     var getnetTerminalId = _ref3.getnetTerminalId,
@@ -71,9 +73,10 @@ function getnetTerminalFactory(_ref) {
    * @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.getnetTerminal - Getnet terminal payload (name, serialNumber, stationId optional)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ getnetTerminal: Object }>>}
+   * @throws When response is 4xx/5xx (400 WRONG_DATA/INVALID_STATION_ID/STATION_NOT_FOUND, 401, 409 duplicate serial, 500)
    */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
@@ -92,13 +95,14 @@ function getnetTerminalFactory(_ref) {
   }
 
   /**
-   * DELETE /getnet-terminals/:getnetTerminalId - remove getnet terminal. API does not accept query params.
+   * DELETE /getnet-terminals/:getnetTerminalId - remove getnet terminal.
    * @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 {string} opts.getnetTerminalId - Getnet terminal id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ getnetTerminalId: string }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_GETNET_TERMINAL_ID, 401, 404 GETNET_TERMINAL_NOT_FOUND, 500)
    */
   function remove(_ref5) {
     var jwtToken = _ref5.jwtToken,
@@ -114,14 +118,15 @@ function getnetTerminalFactory(_ref) {
   }
 
   /**
-   * PUT /getnet-terminals/:getnetTerminalId - update getnet terminal. API does not accept query params.
+   * PUT /getnet-terminals/:getnetTerminalId - update getnet terminal.
    * @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 {string} opts.getnetTerminalId - Getnet terminal id (24 hex characters)
+   * @param {Object} opts.getnetTerminal - Getnet terminal payload (name, serialNumber, stationId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ getnetTerminal: Object }>>}
+   * @throws When response is 4xx/5xx (400, 401, 404 GETNET_TERMINAL_NOT_FOUND, 409 duplicate serial, 500)
    */
   function update(_ref6) {
     var jwtToken = _ref6.jwtToken,

package/lib/endpoints/inventory/gift-certificate-definitions.js

@@ -30,7 +30,8 @@ function giftCertificateDefinitionsFactory(_ref) {
    * @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>}
+   * @returns {Promise<import("axios").AxiosResponse<{ giftCertificates: Object[], next?: string, previous?: string, count: number }>>}
+   * @throws 400 WRONG_DATA, PROVIDER_ID; 401 Unauthorized; 500.
    */
   function all(_ref2) {
     var token = _ref2.token,
@@ -51,7 +52,8 @@ function giftCertificateDefinitionsFactory(_ref) {
    * @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>}
+   * @returns {Promise<import("axios").AxiosResponse<{ giftcertificate: Object }>>}
+   * @throws When the API returns an error. 400 INVALID_GIFTCERTIFICATE_ID; 401 Unauthorized; 404 GIFTCERTIFICATE_NOT_FOUND; 500.
    */
   function get(_ref3) {
     var token = _ref3.token,
@@ -76,7 +78,8 @@ function giftCertificateDefinitionsFactory(_ref) {
    * @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>}
+   * @returns {Promise<import("axios").AxiosResponse<{ giftcertificate: Object }>>}
+   * @throws When the API returns an error. 400 WRONG_DATA; 401 Unauthorized; 500.
    */
   function create(_ref4) {
     var token = _ref4.token,
@@ -103,7 +106,8 @@ function giftCertificateDefinitionsFactory(_ref) {
    * @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>}
+   * @returns {Promise<import("axios").AxiosResponse<{ giftcertificate: Object }>>}
+   * @throws 400 WRONG_DATA, GIFTCERTIFICATE_ID; 401; 404 GIFTCERTIFICATE_NOT_FOUND; 500.
    */
   function update(_ref5) {
     var token = _ref5.token,
@@ -130,7 +134,8 @@ function giftCertificateDefinitionsFactory(_ref) {
    * @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>}
+   * @returns {Promise<import("axios").AxiosResponse<{ giftcertificateId: string }>>}
+   * @throws 400 WRONG_DATA, GIFTCERTIFICATE_ID, GIFT_CERTIFICATE_DEFINITION_ALREADY_IMPLEMENTED; 401; 404; 500.
    */
   function remove(_ref6) {
     var token = _ref6.token,

package/lib/endpoints/inventory/holidays.js

@@ -0,0 +1,158 @@
+"use strict";
+
+var _require = require("../endpoints_helpers.js"),
+    authorizationHeaders = _require.authorizationHeaders;
+
+/**
+ * Query params for GET /holidays (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} HolidaysListQuery
+ * @property {number} [page] - The page number to retrieve
+ * @property {string} [providerId] - Provider (account) id to list holidays for
+ */
+
+/**
+ * Factory for holidays 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 holidaysFactory(_ref) {
+  var client = _ref.client,
+      internalAuthTokenProvider = _ref.internalAuthTokenProvider;
+
+  /**
+   * GET /holidays - list holidays (paginated).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {HolidaysListQuery} [opts.query] - Query params (page, providerId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ holidays: Object[], next?: string, previous?: string, count: number }>>}
+   * @throws 400 INVALID_PAGE; 401; 500.
+   */
+  function all(_ref2) {
+    var token = _ref2.token,
+        jwtToken = _ref2.jwtToken,
+        _ref2$query = _ref2.query,
+        query = _ref2$query === undefined ? {} : _ref2$query,
+        headers = _ref2.headers;
+
+    return client.get("/holidays", {
+      params: query,
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  /**
+   * GET /holidays/:holidayId - get holiday by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.holidayId - Holiday id (24 hex characters)
+   * @param {{ providerId?: string }} [opts.query] - Optional providerId
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ holiday: Object }>>}
+   * @throws 400 INVALID_HOLIDAY_ID, INVALID_PROVIDER_ID; 401; 404 HOLIDAY_NOT_FOUND; 500.
+   */
+  function get(_ref3) {
+    var token = _ref3.token,
+        jwtToken = _ref3.jwtToken,
+        holidayId = _ref3.holidayId,
+        _ref3$query = _ref3.query,
+        query = _ref3$query === undefined ? {} : _ref3$query,
+        headers = _ref3.headers;
+
+    return client({
+      url: "/holidays/" + holidayId,
+      method: "get",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      params: query
+    });
+  }
+
+  /**
+   * POST /holidays - create holiday.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.holiday - Holiday payload (day, month, year required; name, blackout, recurring, externalId optional)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ holiday: Object }>>}
+   * @throws 400 WRONG_DATA; 401; 500.
+   */
+  function create(_ref4) {
+    var token = _ref4.token,
+        jwtToken = _ref4.jwtToken,
+        holiday = _ref4.holiday,
+        headers = _ref4.headers;
+
+    return client({
+      url: "/holidays",
+      method: "post",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      data: { holiday: holiday }
+    });
+  }
+
+  /**
+   * PUT /holidays/:holidayId - update holiday.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.holidayId - Holiday id
+   * @param {Object} opts.holiday - Holiday payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ holiday: Object }>>}
+   * @throws 400 WRONG_DATA, INVALID_HOLIDAY_ID; 401; 404 HOLIDAY_NOT_FOUND; 500.
+   */
+  function update(_ref5) {
+    var token = _ref5.token,
+        jwtToken = _ref5.jwtToken,
+        holidayId = _ref5.holidayId,
+        holiday = _ref5.holiday,
+        headers = _ref5.headers;
+
+    return client({
+      url: "/holidays/" + holidayId,
+      method: "put",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      data: { holiday: holiday }
+    });
+  }
+
+  /**
+   * DELETE /holidays/:holidayId - remove holiday.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.holidayId - Holiday id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ holidayId: string }>>}
+   * @throws 400 INVALID_HOLIDAY_ID; 401; 404 HOLIDAY_NOT_FOUND; 500.
+   */
+  function remove(_ref6) {
+    var token = _ref6.token,
+        jwtToken = _ref6.jwtToken,
+        holidayId = _ref6.holidayId,
+        headers = _ref6.headers;
+
+    return client({
+      url: "/holidays/" + holidayId,
+      method: "delete",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  return {
+    all: all,
+    get: get,
+    create: create,
+    update: update,
+    remove: remove
+  };
+}
+
+module.exports = holidaysFactory;

package/lib/endpoints/inventory/insurances.js

@@ -6,9 +6,9 @@ var _require = require("./../endpoints_helpers.js"),
 /**
  * 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
+ * @property {string} [productId] - The ids of the products to get insurances for
+ * @property {string} [enabled] - Filter insurances if they are enabled or not [true, false]
+ * @property {string} [providerIds] - The ids of the providers to get products for
  */
 
 /**
@@ -25,12 +25,13 @@ function insurancesFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /insurances - list insurances.
+   * GET /insurances - list insurances for the account and product provided.
    * @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>}
+   * @returns {Promise<import("axios").AxiosResponse<{ insurances: Object[] }>>}
+   * @throws 400 INVALID_PRODUCTIDS; 401; 500.
    */
   function all(_ref2) {
     var token = _ref2.token,
@@ -47,12 +48,13 @@ function insurancesFactory(_ref) {
   }
 
   /**
-   * GET /insurances/:insuranceId - get insurance by id. API does not accept query params.
+   * GET /insurances/:insuranceId - get insurance by id.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} opts.insuranceId - Insurance id
+   * @param {string} opts.insuranceId - Insurance id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ insurance: Object }>>}
+   * @throws 400 INVALID_INSURANCE_ID; 401; 404 INSURANCE_NOT_FOUND; 500.
    */
   function get(_ref3) {
     var token = _ref3.token,
@@ -92,14 +94,15 @@ function insurancesFactory(_ref) {
   }
 
   /**
-   * PUT /insurances/:insuranceId - update insurance. API does not accept query params.
+   * PUT /insurances/:insuranceId - update insurance.
    * @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>}
+   * @returns {Promise<import("axios").AxiosResponse<{ insurance: Object }>>}
+   * @throws 400 WRONG_DATA; 401; 404 INSURANCE_NOT_FOUND; 500.
    */
   function update(_ref5) {
     var token = _ref5.token,
@@ -119,13 +122,14 @@ function insurancesFactory(_ref) {
   }
 
   /**
-   * DELETE /insurances/:insuranceId - remove insurance. API does not accept query params.
+   * DELETE /insurances/:insuranceId - remove insurance.
    * @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 {string} opts.insuranceId - Insurance id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ insuranceId: string }>>}
+   * @throws 400 INVALID_INSURANCE_ID; 401; 404 INSURANCE_NOT_FOUND; 500.
    */
   function remove(_ref6) {
     var token = _ref6.token,

package/lib/endpoints/inventory/items.js

@@ -36,13 +36,14 @@ function itemsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /items - list items.
+   * GET /items - list items (paginated).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {ItemsQuery} [opts.query] - Query params (productId, disabled, type, providerIds, channels, currency, etc.)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ items: Object[], next?: string, previous?: string, count: number }>>}
+   * @throws 401; 500.
    */
   function all(_ref2) {
     var token = _ref2.token,
@@ -63,10 +64,11 @@ function itemsFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.itemId - Item id (ObjectId format)
+   * @param {string} opts.itemId - Item id (24 hex characters)
    * @param {ItemByIdQuery} [opts.query] - Query params (currency)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ item: Object }>>}
+   * @throws 400 INVALID_ITEM_ID; 401; 404 ITEM_NOT_FOUND; 500.
    */
   function get(_ref3) {
     var itemId = _ref3.itemId,
@@ -87,9 +89,10 @@ function itemsFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.item - Item payload
+   * @param {Object} opts.item - Item payload (ItemPostData: name, productId, type, amount, valueType, order, etc.)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ item: Object }>>}
+   * @throws 400 WRONG_DATA, PRODUCT_ID_INVALID, etc.; 401; 404 PRODUCT_NOT_FOUND, etc.; 500.
    */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
@@ -110,10 +113,11 @@ function itemsFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.itemId - Item id
-   * @param {Object} opts.item - Item payload
+   * @param {string} opts.itemId - Item id (24 hex characters)
+   * @param {Object} opts.item - Item payload (ItemPostData)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ item: Object }>>}
+   * @throws 400 WRONG_DATA, INVALID ids; 401; 404 ITEM_NOT_FOUND, PRODUCT_NOT_FOUND, etc.; 500.
    */
   function update(_ref5) {
     var jwtToken = _ref5.jwtToken,