btrz-api-client 8.28.0 → 8.30.0

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

@@ -3,10 +3,28 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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 {Object} [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 +38,15 @@ function filteredTripsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /filtered-trips - create filtered trip.
+   * @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,33 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} FinancingCostsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * 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 {FinancingCostsQuery} [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 +43,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 {FinancingCostsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var id = _ref3.id,
         token = _ref3.token,
@@ -34,6 +67,15 @@ function financingCostsFactory(_ref) {
     });
   }
 
+  /**
+   * 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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -50,6 +92,16 @@ function financingCostsFactory(_ref) {
     });
   }
 
+  /**
+   * 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 {FinancingCostsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref5) {
     var jwtToken = _ref5.jwtToken,
         id = _ref5.id,
@@ -66,6 +118,16 @@ function financingCostsFactory(_ref) {
     });
   }
 
+  /**
+   * 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 {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,35 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} GaragesQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * 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
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -20,6 +43,15 @@ function garagesFactory(_ref) {
     });
   }
 
+  /**
+   * 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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -31,6 +63,15 @@ function garagesFactory(_ref) {
     });
   }
 
+  /**
+   * 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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -47,6 +88,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 +115,15 @@ function garagesFactory(_ref) {
     });
   }
 
+  /**
+   * 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 {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,28 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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 {Object} [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 +38,15 @@ function getnetTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * GET /getnet-terminals/:getnetTerminalId - get a 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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var getnetTerminalId = _ref3.getnetTerminalId,
         token = _ref3.token,
@@ -31,6 +58,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 +83,15 @@ function getnetTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * 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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref5) {
     var jwtToken = _ref5.jwtToken,
         getnetTerminalId = _ref5.getnetTerminalId,
@@ -60,6 +105,16 @@ function getnetTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * 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 {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,32 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for gift-certificate-definitions endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryGiftCertificateDefinitionsQuery
+ */
+
+/**
+ * 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 {InventoryGiftCertificateDefinitionsQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -19,6 +41,16 @@ function giftCertificateDefinitionsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /gift-certificate-definitions/:giftcertificateId - get gift certificate definition by id.
+   * @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 {InventoryGiftCertificateDefinitionsQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -35,6 +67,16 @@ function giftCertificateDefinitionsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /gift-certificate-definitions - create gift certificate definition.
+   * @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 {InventoryGiftCertificateDefinitionsQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -52,6 +94,17 @@ function giftCertificateDefinitionsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /gift-certificate-definitions/:giftcertificateId - update gift certificate definition.
+   * @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 {InventoryGiftCertificateDefinitionsQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -70,6 +123,16 @@ function giftCertificateDefinitionsFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /gift-certificate-definitions/:giftcertificateId - remove gift certificate definition.
+   * @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 {InventoryGiftCertificateDefinitionsQuery} [opts.query] - Optional query params (forwarded to API)
+   * @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,34 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for insurances endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryInsurancesQuery
+ */
+
+/**
+ * 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 {InventoryInsurancesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -21,6 +43,14 @@ function insurancesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /insurances/:insuranceId - get insurance by id.
+   * @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 +63,15 @@ function insurancesFactory(_ref) {
     });
   }
 
+  /**
+   * POST /insurances - create 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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var token = _ref4.token,
         insurance = _ref4.insurance,
@@ -49,6 +88,16 @@ function insurancesFactory(_ref) {
     });
   }
 
+  /**
+   * 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>}
+   */
   function update(_ref5) {
     var token = _ref5.token,
         insurance = _ref5.insurance,
@@ -66,6 +115,15 @@ function insurancesFactory(_ref) {
     });
   }
 
+  /**
+   * 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 {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,36 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for insurances cost endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryInsurancesCostQuery
+ */
+
+/**
+ * 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.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.productId - Product id
+   * @param {*} opts.declaredValue - Declared value (merged into query)
+   * @param {InventoryInsurancesCostQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref2) {
     var token = _ref2.token,
         productId = _ref2.productId,

package/lib/endpoints/inventory/items.js

@@ -3,10 +3,28 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for items 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, tickets: object }}
+ */
+
+
 function itemsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /items - list items.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -21,6 +39,16 @@ function itemsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /items/:itemId - get item by id.
+   * @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.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var itemId = _ref3.itemId,
         token = _ref3.token,
@@ -35,6 +63,15 @@ function itemsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /items - create item.
+   * @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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
         item = _ref4.item,
@@ -49,6 +86,16 @@ function itemsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /items/:itemId - update item.
+   * @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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref5) {
     var jwtToken = _ref5.jwtToken,
         token = _ref5.token,
@@ -64,7 +111,19 @@ function itemsFactory(_ref) {
     });
   }
 
+  /** @type {{ update: function }} */
   var tickets = {
+    /**
+     * PUT /items/:soldItemId/tickets/:ticketId - update ticket.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.soldItemId - Sold item id
+     * @param {string} opts.ticketId - Ticket id
+     * @param {Object} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref6) {
       var jwtToken = _ref6.jwtToken,
           token = _ref6.token,