btrz-api-client 8.28.0 → 8.30.0

package/src/endpoints/sales/cart.js

@@ -1,6 +1,28 @@
+/* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} CartQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * 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({client, internalAuthTokenProvider}) {
+  /**
+   * GET /cart/:id - get cart by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.id - Cart id
+   * @param {string} [opts.providerId] - Provider id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, id, providerId, headers}) {
     let url = `/cart/${id}`;
 
@@ -14,6 +36,15 @@ function cartFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, cart, jwtToken, headers}) {
     return client({
       url: "/cart",
@@ -23,6 +54,16 @@ function cartFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /cart/:cartId/items - add items to cart.
+   * @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({token, cartId, cart, jwtToken, headers}) {
     return client({
       url: `/cart/${cartId}/items`,
@@ -32,6 +73,16 @@ function cartFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /cart/:cartId/items - delete items from cart.
+   * @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({token, cartId, params, jwtToken, headers}) {
     return client({
       url: `/cart/${cartId}/items`,
@@ -41,6 +92,16 @@ function cartFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /carts/:cartId/paid-in-items/:itemId - delete paid-in item.
+   * @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({token, cartId, itemId, jwtToken, headers}) {
     return client({
       url: `/carts/${cartId}/paid-in-items/${itemId}`,
@@ -49,6 +110,16 @@ function cartFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /carts/:cartId/paid-in-items - delete paid-in items.
+   * @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({token, cartId, params, jwtToken, headers}) {
     return client({
       url: `/carts/${cartId}/paid-in-items`,
@@ -59,6 +130,16 @@ function cartFactory({client, internalAuthTokenProvider}) {
   }
 
   const loyaltyPointsAmount = {
+    /**
+     * GET /carts/:cartId/loyalty-points-amount - get loyalty points amount for cart.
+     * @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 {CartQuery} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, cartId, query = {}, headers}) {
       return client({
         url: `/carts/${cartId}/loyalty-points-amount`,
@@ -69,6 +150,16 @@ function cartFactory({client, internalAuthTokenProvider}) {
   };
 
 
+  /**
+   * PATCH /cart/:cartId - patch cart.
+   * @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({token, jwtToken, cartId, data, headers}) {
     return client({
       url: `/cart/${cartId}`,
@@ -79,6 +170,15 @@ function cartFactory({client, internalAuthTokenProvider}) {
   }
 
   const partialDepositStatus = {
+    /**
+     * GET /cart/:shiftId/partial-deposit-status - get partial deposit status.
+     * @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({token, jwtToken, shiftId, headers}) {
       return client.get(`/cart/${shiftId}/partial-deposit-status`, {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
@@ -87,6 +187,15 @@ function cartFactory({client, internalAuthTokenProvider}) {
   };
 
   const payments = {
+    /**
+     * DELETE /carts/:cartId/payments - delete cart payments.
+     * @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({token, cartId, jwtToken, headers}) {
       return client({
         url: `/carts/${cartId}/payments`,
@@ -94,6 +203,16 @@ function cartFactory({client, internalAuthTokenProvider}) {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
       });
     },
+    /**
+     * PUT /carts/:cartId/payments - put cart payments.
+     * @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({token, cartId, jwtToken, headers, payment}) {
       return client({
         url: `/carts/${cartId}/payments`,
@@ -105,6 +224,16 @@ function cartFactory({client, internalAuthTokenProvider}) {
   };
 
   const taxExemptPaymentMethod = {
+    /**
+     * POST /carts/:cartId/tax-exempt-payment-method - set tax exempt payment method.
+     * @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({token, cartId, jwtToken, headers, data = {}}) {
       return client({
         url: `/carts/${cartId}/tax-exempt-payment-method`,
@@ -116,6 +245,17 @@ function cartFactory({client, internalAuthTokenProvider}) {
   };
 
   const 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 {CartQuery} [opts.query] - Query params
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create({token, jwtToken, headers, cartId, financingCost, query = {}}) {
       return client({
         url: `/carts/${cartId}/financing-costs`,
@@ -127,6 +267,16 @@ function cartFactory({client, internalAuthTokenProvider}) {
         }
       });
     },
+    /**
+     * 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 {CartQuery} [opts.query] - Query params
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     delete({token, jwtToken, headers, cartId, query = {}}) {
       return client({
         url: `/carts/${cartId}/financing-costs`,

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

@@ -1,7 +1,30 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function checkInInfoFactory({ client, internalAuthTokenProvider }) {
-  function get({ token, jwtToken, id, headers, query = {} }) {
+/**
+ * @typedef {Object} CheckInInfoQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * 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({client, internalAuthTokenProvider}) {
+  /**
+   * GET /check-in/:id - get check-in info.
+   * @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
+   * @param {CheckInInfoQuery} [opts.query] - Query params
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function get({token, jwtToken, id, headers, query = {}}) {
     return client({
       url: `/check-in/${id}`,
       params: query,
@@ -9,9 +32,9 @@ function checkInInfoFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
-  return { 
+  return {
     get
   };
 }
 
-module.exports = checkInInfoFactory;
+module.exports = checkInInfoFactory;

package/src/endpoints/sales/custom-fields.js

@@ -1,15 +1,35 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function customFieldsFactory({ client, internalAuthTokenProvider }) {
+/**
+ * @typedef {Object} CustomFieldsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
 
-  function all({ token, query = {}, headers }) {
+/**
+ * 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({client, internalAuthTokenProvider}) {
+  /**
+   * GET /custom-fields - list custom fields.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {CustomFieldsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, query = {}, headers}) {
     return client.get("/custom-fields", {
       params: query,
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
-  return { 
+  return {
     all
   };
 }

package/src/endpoints/sales/docs.js

@@ -1,4 +1,14 @@
+/**
+ * Factory for API docs (btrz-api-sales).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @returns {{ get: function }}
+ */
 function docsFactory({client}) {
+  /**
+   * GET /api-docs-v2 - get API docs.
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get() {
     return client.get("/api-docs-v2", {});
   }

package/src/endpoints/sales/flexpasses.js

@@ -1,6 +1,29 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} FlexpassGetQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * 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({client, internalAuthTokenProvider}) {
+  /**
+   * GET /flexpasses/:flexpassId - get flexpass by id.
+   * @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 {FlexpassGetQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, flexpassId, query = {}, headers}) {
     return client({
       url: `/flexpasses/${flexpassId}`,

package/src/endpoints/sales/gift-certificates.js

@@ -1,10 +1,32 @@
+/* eslint-disable max-len */
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} GiftCertificateGetQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * 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({
   client, 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
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, GCNumber, query = {}, headers}) {
     return client({
       url: `/gift-certificates/${GCNumber}`,

package/src/endpoints/sales/order.js

@@ -1,6 +1,34 @@
+/* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} OrderPaymentsQuery
+ * @property {string} channel - Channel where cart is being purchased (see API for allowed values)
+ * @property {string} [providerId] - Account ID the transaction belongs to
+ */
+
+/**
+ * @typedef {Object} OrderGetQuery
+ * @property {string} [providerId] - Account ID for the order
+ */
+
+/**
+ * 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({client, 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({token, order, jwtToken, headers}) {
     return client({
       url: "/order",
@@ -10,6 +38,15 @@ function orderFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, orderId, query = {}, headers}) {
     return client({
       url: `/order/${orderId}`,
@@ -18,6 +55,17 @@ function orderFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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 required, providerId optional)
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function overwrite({token, orderId, payments, jwtToken, headers, query = {}}) {
     return client({
       url: `/orders/${orderId}/payments`,

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

@@ -1,8 +1,25 @@
+/* eslint-disable max-len */
 const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * 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({client, internalAuthTokenProvider}) {
+  /**
+   * POST /parcel-quotes - get parcel quote.
+   * @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({token, parcelQuoteData, jwtToken, headers}) {
     return client({
       url: "/parcel-quotes",
@@ -12,7 +29,7 @@ function parcelQuotesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
-  return { 
+  return {
     get
   };
 }

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

@@ -1,18 +1,38 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function paymentProvidersFactory({client, internalAuthTokenProvider}) {
+/**
+ * @typedef {Object} PaymentProvidersQuery
+ * @property {string} [providerId] - Provider account ID
+ */
 
-  function all({ token, jwtToken, query = {}, headers }) {
+/**
+ * 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({client, 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 {PaymentProvidersQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, jwtToken, query = {}, headers}) {
     return client.get("/payment-providers", {
-      params: query,   
+      params: query,
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
-  return { 
+  return {
     all
   };
-
 }
 
 module.exports = paymentProvidersFactory;

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

@@ -1,8 +1,29 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function redeemableItemsFactory({ client, internalAuthTokenProvider }) {
+/**
+ * @typedef {Object} RedeemableItemsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
 
-  function get({ token, redeemableItemId, query = {}, headers }) {
+/**
+ * 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({client, 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 id
+   * @param {RedeemableItemsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function get({token, redeemableItemId, query = {}, headers}) {
     return client({
       url: `/redeemable-items/${redeemableItemId}`,
       params: query,
@@ -10,6 +31,15 @@ function redeemableItemsFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
+  /**
+   * 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 {RedeemableItemsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getValid({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/redeemable-items",

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

@@ -1,8 +1,24 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function syncEntryFactory({ client, internalAuthTokenProvider }) {
-
-  function patch({ token, data, jwtToken, headers }) {
+/**
+ * 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({client, internalAuthTokenProvider}) {
+  /**
+   * PATCH /sync-entry - patch sync entry.
+   * @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({token, data, jwtToken, headers}) {
     return client({
       url: "/sync-entry",
       method: "patch",
@@ -14,7 +30,6 @@ function syncEntryFactory({ client, internalAuthTokenProvider }) {
   return {
     patch
   };
-
 }
 
 module.exports = syncEntryFactory;