btrz-api-client 8.29.0 → 8.31.0

package/lib/endpoints/sales/cart.js

@@ -1,12 +1,50 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /cart/:cartId (btrz-api-sales get-cart getSpec).
+ * @typedef {Object} CartGetQuery
+ * @property {string} [providerId] - Provider account id
+ * @property {string} [transactionStatus] - Filter: 'created' or 'waiting_for_payment'
+ */
+
+/**
+ * Query params for POST /carts/:cartId/financing-costs (btrz-api-sales post-financingcost-handler getSpec).
+ * @typedef {Object} CartFinancingCostsCreateQuery
+ * @property {string} [providerId] - Provider id to get financing costs for
+ */
+
+/**
+ * Query params for DELETE /carts/:cartId/financing-costs (btrz-api-sales delete-financingcost-handler getSpec).
+ * @typedef {Object} CartFinancingCostsDeleteQuery
+ * @property {string} [internalId] - Internal id or code of the financing cost to match
+ */
+
+/**
+ * Factory for cart API (btrz-api-sales).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, create: function, add: function, deleteItems: function, deletePaidInItem: function, deletePaidInItems: function, loyaltyPointsAmount: Object, patch: function, partialDepositStatus: Object, payments: Object, taxExemptPaymentMethod: Object, financingCosts: Object }}
+ */
+
+
 function cartFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /cart/:id - get cart by id. Query: providerId, transactionStatus (per get-cart getSpec).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.id - Cart id
+   * @param {string} [opts.providerId] - Provider id (sent as query)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref2) {
     var token = _ref2.token,
         id = _ref2.id,
@@ -25,6 +63,15 @@ function cartFactory(_ref) {
     });
   }
 
+  /**
+   * POST /cart - create cart.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} opts.cart - Cart payload
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref3) {
     var token = _ref3.token,
         cart = _ref3.cart,
@@ -39,6 +86,16 @@ function cartFactory(_ref) {
     });
   }
 
+  /**
+   * POST /cart/:cartId/items - add items to cart. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.cartId - Cart id
+   * @param {Object} opts.cart - Cart items payload
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function add(_ref4) {
     var token = _ref4.token,
         cartId = _ref4.cartId,
@@ -54,6 +111,16 @@ function cartFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /cart/:cartId/items - delete items from cart. Query forwarded via opts.params if provided.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.cartId - Cart id
+   * @param {Object} opts.params - Query params (forwarded to API)
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function deleteItems(_ref5) {
     var token = _ref5.token,
         cartId = _ref5.cartId,
@@ -69,6 +136,16 @@ function cartFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /carts/:cartId/paid-in-items/:itemId - delete paid-in item. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.cartId - Cart id
+   * @param {string} opts.itemId - Item id
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function deletePaidInItem(_ref6) {
     var token = _ref6.token,
         cartId = _ref6.cartId,
@@ -83,6 +160,16 @@ function cartFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /carts/:cartId/paid-in-items - delete paid-in items. Query forwarded via opts.params if provided.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.cartId - Cart id
+   * @param {Object} opts.params - Query params (forwarded to API)
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function deletePaidInItems(_ref7) {
     var token = _ref7.token,
         cartId = _ref7.cartId,
@@ -99,6 +186,15 @@ function cartFactory(_ref) {
   }
 
   var loyaltyPointsAmount = {
+    /**
+     * GET /carts/:cartId/loyalty-points-amount - get loyalty points amount for cart. 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.cartId - Cart id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref8) {
       var token = _ref8.token,
           jwtToken = _ref8.jwtToken,
@@ -115,6 +211,16 @@ function cartFactory(_ref) {
     }
   };
 
+  /**
+   * PATCH /cart/:cartId - patch cart. 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.cartId - Cart id
+   * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function patch(_ref9) {
     var token = _ref9.token,
         jwtToken = _ref9.jwtToken,
@@ -131,6 +237,15 @@ function cartFactory(_ref) {
   }
 
   var partialDepositStatus = {
+    /**
+     * GET /cart/:shiftId/partial-deposit-status - get partial deposit status. 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.shiftId - Shift id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref10) {
       var token = _ref10.token,
           jwtToken = _ref10.jwtToken,
@@ -144,6 +259,15 @@ function cartFactory(_ref) {
   };
 
   var payments = {
+    /**
+     * DELETE /carts/:cartId/payments - delete cart payments. API does not accept query params.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} opts.cartId - Cart id
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     delete: function _delete(_ref11) {
       var token = _ref11.token,
           cartId = _ref11.cartId,
@@ -156,6 +280,17 @@ function cartFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * PUT /carts/:cartId/payments - put cart payments. API does not accept query params.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} opts.cartId - Cart id
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} [opts.headers] - Optional headers
+     * @param {Object} opts.payment - Payment payload
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     put: function put(_ref12) {
       var token = _ref12.token,
           cartId = _ref12.cartId,
@@ -173,6 +308,16 @@ function cartFactory(_ref) {
   };
 
   var taxExemptPaymentMethod = {
+    /**
+     * POST /carts/:cartId/tax-exempt-payment-method - set tax exempt payment method. API does not accept query params.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} opts.cartId - Cart id
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} [opts.headers] - Optional headers
+     * @param {Object} [opts.data] - Request body
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     post: function post(_ref13) {
       var token = _ref13.token,
           cartId = _ref13.cartId,
@@ -191,6 +336,17 @@ function cartFactory(_ref) {
   };
 
   var financingCosts = {
+    /**
+     * POST /carts/:cartId/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.headers] - Optional headers
+     * @param {string} opts.cartId - Cart id
+     * @param {Object} opts.financingCost - Financing cost payload
+     * @param {CartFinancingCostsCreateQuery} [opts.query] - Query params (providerId)
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref14) {
       var token = _ref14.token,
           jwtToken = _ref14.jwtToken,
@@ -210,6 +366,17 @@ function cartFactory(_ref) {
         }
       });
     },
+
+    /**
+     * DELETE /carts/:cartId/financing-costs - delete financing cost.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} [opts.headers] - Optional headers
+     * @param {string} opts.cartId - Cart id
+     * @param {CartFinancingCostsDeleteQuery} [opts.query] - Query params (internalId)
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     delete: function _delete(_ref15) {
       var token = _ref15.token,
           jwtToken = _ref15.jwtToken,

package/lib/endpoints/sales/check-in-info.js

@@ -1,12 +1,31 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+/* eslint-disable max-len */
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for check-in API (btrz-api-sales).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
+
+
 function checkInInfoFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /check-in/:id - get check-in info. API does not accept query params (btrz-api-sales).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Check-in 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/sales/custom-fields.js

@@ -1,13 +1,36 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+/* eslint-disable max-len */
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /custom-fields (btrz-api-sales get-custom-fields getSpec).
+ * @typedef {Object} CustomFieldsListQuery
+ * @property {string} [providerIds] - One or more provider account ids (comma-separated)
+ */
+
+/**
+ * Factory for custom-fields API (btrz-api-sales).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
+
+
 function customFieldsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /custom-fields - list custom fields.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {CustomFieldsListQuery} [opts.query] - Query params (providerIds)
+   * @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/sales/docs.js

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

package/lib/endpoints/sales/flexpasses.js

@@ -1,12 +1,31 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+/* eslint-disable max-len */
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for flexpasses API (btrz-api-sales).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
+
+
 function flexpassesEndpointsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /flexpasses/:flexpassId - get flexpass by id. API does not accept query params (btrz-api-sales).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.flexpassId - Flexpass 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/sales/gift-certificates.js

@@ -1,12 +1,38 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+/* eslint-disable max-len */
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /gift-certificates/:GCNumber (btrz-api-sales get-gift-certificate getSpec).
+ * @typedef {Object} GiftCertificateGetQuery
+ * @property {string} [providerId] - Provider account id
+ * @property {string} [cartId] - Calculate available balance for the voucher applied to the cart
+ */
+
+/**
+ * Factory for gift-certificates API (btrz-api-sales).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
+
+
 function giftCertificatesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /gift-certificates/:GCNumber - get gift certificate by number.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.GCNumber - Gift certificate number
+   * @param {GiftCertificateGetQuery} [opts.query] - Query params (providerId, cartId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref2) {
     var token = _ref2.token,
         GCNumber = _ref2.GCNumber,

package/lib/endpoints/sales/order.js

@@ -1,12 +1,44 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for POST /orders/:orderId/payments (btrz-api-sales post-payments-handler getSpec).
+ * @typedef {Object} OrderPaymentsQuery
+ * @property {string} [channel] - Channel where cart is being purchased (defaults to 'none' when not provided)
+ * @property {string} [providerId] - Account id the transaction belongs to
+ */
+
+/**
+ * Query params for GET /order/:orderId (btrz-api-sales get-order getSpec).
+ * @typedef {Object} OrderGetQuery
+ * @property {string} [providerId] - Provider account id
+ */
+
+/**
+ * Factory for order API (btrz-api-sales).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function, get: function, overwrite: function }}
+ */
+
+
 function orderFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * POST /order - create order.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} opts.order - Order payload
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref2) {
     var token = _ref2.token,
         order = _ref2.order,
@@ -21,6 +53,15 @@ function orderFactory(_ref) {
     });
   }
 
+  /**
+   * GET /order/:orderId - get order by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.orderId - Order id
+   * @param {OrderGetQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         orderId = _ref3.orderId,
@@ -35,6 +76,17 @@ function orderFactory(_ref) {
     });
   }
 
+  /**
+   * POST /orders/:orderId/payments - overwrite order payments.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.orderId - Order id
+   * @param {Object} opts.payments - Payments payload
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @param {OrderPaymentsQuery} [opts.query] - Query params (channel, providerId)
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function overwrite(_ref4) {
     var token = _ref4.token,
         orderId = _ref4.orderId,

package/lib/endpoints/sales/parcel-quotes.js

@@ -1,12 +1,31 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for parcel-quotes API (btrz-api-sales).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
+
+
 function parcelQuotesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * POST /parcel-quotes - get parcel quote. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} opts.parcelQuoteData - Parcel quote request payload
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref2) {
     var token = _ref2.token,
         parcelQuoteData = _ref2.parcelQuoteData,

package/lib/endpoints/sales/payment-providers.js

@@ -1,13 +1,39 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+/* eslint-disable max-len */
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /payment-providers (btrz-api-sales get-payment-providers getSpec).
+ * @typedef {Object} PaymentProvidersListQuery
+ * @property {string} [providerId] - Provider id to get payment providers for
+ * @property {string} [channel] - Channel to get payment providers for
+ * @property {string} [enabled] - Filter by enabled [true, false]
+ */
+
+/**
+ * Factory for payment-providers API (btrz-api-sales).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
+
+
 function paymentProvidersFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /payment-providers - list payment providers.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {PaymentProvidersListQuery} [opts.query] - Query params (providerId, channel, enabled)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

package/lib/endpoints/sales/redeemable-items.js

@@ -1,13 +1,47 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+/* eslint-disable max-len */
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /redeemable-items/:redeemableItemId (btrz-api-sales get-redeemable-item getSpec).
+ * @typedef {Object} RedeemableItemsGetQuery
+ * @property {string} [providerId] - Provider account id
+ * @property {string} [providerIds] - One or more provider account ids (comma-separated)
+ * @property {string} [cartId] - Current cart id (item can be redeemed once per cart)
+ */
+
+/**
+ * Query params for GET /redeemable-items list (btrz-api-sales get-redeemable-items getSpec).
+ * @typedef {Object} RedeemableItemsListQuery
+ * @property {string} [ids] - Redeemable item display ID or _id, comma-separated
+ * @property {string} [providerId] - Provider account id
+ * @property {string} [cartId] - Current cart id
+ */
+
+/**
+ * Factory for redeemable-items API (btrz-api-sales).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, getValid: function }}
+ */
+
+
 function redeemableItemsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /redeemable-items/:redeemableItemId - get redeemable item by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.redeemableItemId - Redeemable item display ID or _id
+   * @param {RedeemableItemsGetQuery} [opts.query] - Query params (providerId, providerIds, cartId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref2) {
     var token = _ref2.token,
         redeemableItemId = _ref2.redeemableItemId,
@@ -22,6 +56,15 @@ function redeemableItemsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /redeemable-items - get valid redeemable items.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {RedeemableItemsListQuery} [opts.query] - Query params (ids, providerId, cartId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getValid(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,

package/lib/endpoints/sales/sync-entry.js

@@ -1,13 +1,31 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+/* eslint-disable max-len */
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for sync-entry API (btrz-api-sales).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ patch: function }}
+ */
+
+
 function syncEntryFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * PATCH /sync-entry - patch sync entry. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} opts.data - Request body
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function patch(_ref2) {
     var token = _ref2.token,
         data = _ref2.data,