btrz-api-client 8.29.0 → 8.31.0

package/src/endpoints/ratality/auth.js

@@ -1,4 +1,18 @@
+/**
+ * Factory for Ratality auth API.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function }}
+ */
 function authFactory({client}) {
+  /**
+   * POST /authenticate - authenticate.
+   * @param {Object} opts
+   * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({
     data,
     headers

package/src/endpoints/ratality/clients.js

@@ -2,7 +2,23 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for Ratality clients API.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @param {string} deps.version - API version path
+ * @returns {{ create: function, get: function }}
+ */
 function clientsFactory({client, version}) {
+  /**
+   * POST /:version/client - create client.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({
     jwtToken,
     data,
@@ -16,6 +32,13 @@ function clientsFactory({client, version}) {
     });
   }
 
+  /**
+   * GET /:version/client - get client.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.clientId - Client id (sent as header)
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({
     jwtToken, clientId
   }) {

package/src/endpoints/ratality/integrations.js

@@ -2,7 +2,22 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for Ratality integrations API.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @param {string} deps.version - API version path
+ * @returns {{ get: function, create: function, remove: function }}
+ */
 function integrationsFactory({client, version}) {
+  /**
+   * GET /:version/client/integrations - get client integrations.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.clientId - Client id (sent as header)
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({
     jwtToken, clientId
   }) {
@@ -13,6 +28,14 @@ function integrationsFactory({client, version}) {
     });
   }
 
+  /**
+   * POST /:version/client/integrations - create integration.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.clientId - Client id (sent as header)
+   * @param {Object} opts.data - Request body
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({
     jwtToken, clientId, data
   }) {
@@ -24,6 +47,14 @@ function integrationsFactory({client, version}) {
     });
   }
 
+  /**
+   * DELETE /:version/client/integrations/:integrationType - remove integration.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.clientId - Client id (sent as header)
+   * @param {string} opts.integrationType - Integration type
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({
     jwtToken, clientId, integrationType
   }) {

package/src/endpoints/reports/custom-reports.js

@@ -1,16 +1,49 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function customReportsFactory({ client, internalAuthTokenProvider }) {
-  function create({token, customReport, jwtToken, headers }) {
+/**
+ * Query params for GET /custom-reports (btrz-api-reports). Documented from client; backend may support pagination/filters.
+ * @typedef {Object} CustomReportsListQuery
+ * @property {number} [page] - Page (if supported)
+ * @property {number} [recordsPerPage] - Records per page (if supported)
+ */
+
+/**
+ * Factory for custom reports API (btrz-api-reports).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function, all: function, remove: function }}
+ */
+function customReportsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /custom-reports - create custom report.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.customReport - Custom report payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, customReport, jwtToken, headers}) {
     return client({
       url: "/custom-reports",
       method: "post",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { customReport }
+      data: {customReport}
     });
   }
 
-  function all({token, jwtToken, query = {}, headers }) {
+  /**
+   * GET /custom-reports - list custom reports.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {CustomReportsListQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/custom-reports",
       params: query,
@@ -18,6 +51,15 @@ function customReportsFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
+  /**
+   * DELETE /custom-reports/:customReportId - remove custom report.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.customReportId - Custom report id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({token, jwtToken, customReportId, headers}) {
     return client({
       url: `/custom-reports/${customReportId}`,

package/src/endpoints/reports/email.js

@@ -1,6 +1,23 @@
+/* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for report email API (btrz-api-reports).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ post: function }}
+ */
 function reportEmailFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /email - send report email.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.report - Report payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function post({token, jwtToken, report, headers}) {
     return client({
       url: "/email",

package/src/endpoints/reports/report-types.js

@@ -1,15 +1,41 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function reportTypesFactory({ client, internalAuthTokenProvider }) {
-
-  function get({ token, jwtToken, id, headers }) {
+/**
+ * Factory for report types API (btrz-api-reports).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, getByName: function }}
+ */
+function reportTypesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /types/:id - get report type by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Report type id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function get({token, jwtToken, id, headers}) {
     return client({
       url: `/types/${id}`,
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
-  function getByName({ token, jwtToken, name, headers }) { //deprecated
+  /**
+   * GET /types?name=:name - get report type by name.
+   * @deprecated Prefer get by id
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.name - Report type name
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function getByName({token, jwtToken, name, headers}) {
     return client({
       url: `/types?name=${name}`,
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})

package/src/endpoints/reports/trip-manifests.js

@@ -1,7 +1,31 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function tripManifestsFactory({ client, internalAuthTokenProvider }) {
-  function all({token, jwtToken, query = {}, headers }) {
+/**
+ * Query params for GET /trip-manifests (btrz-api-reports). Documented from client; backend may support pagination/filters.
+ * @typedef {Object} TripManifestsListQuery
+ * @property {number} [page] - Page (if supported)
+ * @property {number} [recordsPerPage] - Records per page (if supported)
+ */
+
+/**
+ * Factory for trip manifests reports API (btrz-api-reports).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
+function tripManifestsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /trip-manifests - list trip manifests.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {TripManifestsListQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/trip-manifests",
       params: query,

package/src/endpoints/sales/bundles.js

@@ -1,9 +1,31 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function bundlesFactory({ client, internalAuthTokenProvider }) {
+/**
+ * Query params for GET /bundles (btrz-api-sales get-bundles getSpec).
+ * @typedef {Object} BundlesListQuery
+ * @property {string} [providerId] - Provider account id to get bundles for
+ * @property {string} type - Filter bundles by bundle type (required)
+ */
 
-  function all({ token, query = {}, headers }) {
-    return client.get(`/bundles`, {
+/**
+ * Factory for bundles API (btrz-api-sales).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
+function bundlesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /bundles - list bundles.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {BundlesListQuery} [opts.query] - Query params (type required)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, query = {}, headers}) {
+    return client.get("/bundles", {
       params: query,
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });

package/src/endpoints/sales/cancellations.js

@@ -32,7 +32,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 function cancellationEndpointsFactory({client, internalAuthTokenProvider}) {
   /**
-   * Creates a set of refundable items and payments to be refunded
+   * Creates a set of refundable items and payments to be refunded. API does not accept query params.
    * @param {Object} params
    * @param {string} params.token Public key
    * @param {string} params.jwtToken Auth token
@@ -70,7 +70,7 @@ function cancellationEndpointsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * Completes a pending payment for a cancellation transaction (e.g. one terminal refund).
+   * Completes a pending payment for a cancellation transaction (e.g. one terminal refund). API does not accept query params.
    * @param {Object} params
    * @param {string} params.token Public key
    * @param {string} params.jwtToken Auth token

package/src/endpoints/sales/cart-promo.js

@@ -1,9 +1,25 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function cartPromoFactory({ client, internalAuthTokenProvider }) {
-
-  function create({ token, jwtToken, cartId, query = {}, headers }) {
-    return client({ 
+/**
+ * Factory for cart promos API (btrz-api-sales).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function, remove: function }}
+ */
+function cartPromoFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /cart/:cartId/promos - add promo to 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>}
+   */
+  function create({token, jwtToken, cartId, query = {}, headers}) {
+    return client({
       url: `/cart/${cartId}/promos`,
       method: "post",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
@@ -11,7 +27,16 @@ function cartPromoFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
-  function remove({ token, jwtToken, cartId, query = {}, headers }) {
+  /**
+   * DELETE /cart/:cartId - remove cart promo. 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>}
+   */
+  function remove({token, jwtToken, cartId, query = {}, headers}) {
     return client({
       url: `/cart/${cartId}`,
       method: "delete",
@@ -20,10 +45,10 @@ function cartPromoFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
-  return { 
+  return {
     create,
     remove
   };
 }
 
-module.exports = cartPromoFactory;
+module.exports = cartPromoFactory;

package/src/endpoints/sales/cart.js

@@ -1,6 +1,42 @@
+/* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * 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({client, 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({token, id, providerId, headers}) {
     let url = `/cart/${id}`;
 
@@ -14,6 +50,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 +68,16 @@ function cartFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, cartId, cart, jwtToken, headers}) {
     return client({
       url: `/cart/${cartId}/items`,
@@ -32,6 +87,16 @@ function cartFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, cartId, params, jwtToken, headers}) {
     return client({
       url: `/cart/${cartId}/items`,
@@ -41,6 +106,16 @@ function cartFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, cartId, itemId, jwtToken, headers}) {
     return client({
       url: `/carts/${cartId}/paid-in-items/${itemId}`,
@@ -49,6 +124,16 @@ function cartFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, cartId, params, jwtToken, headers}) {
     return client({
       url: `/carts/${cartId}/paid-in-items`,
@@ -59,6 +144,15 @@ function cartFactory({client, internalAuthTokenProvider}) {
   }
 
   const 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({token, jwtToken, cartId, query = {}, headers}) {
       return client({
         url: `/carts/${cartId}/loyalty-points-amount`,
@@ -69,6 +163,16 @@ function cartFactory({client, internalAuthTokenProvider}) {
   };
 
 
+  /**
+   * 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({token, jwtToken, cartId, data, headers}) {
     return client({
       url: `/cart/${cartId}`,
@@ -79,6 +183,15 @@ function cartFactory({client, internalAuthTokenProvider}) {
   }
 
   const 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({token, jwtToken, shiftId, headers}) {
       return client.get(`/cart/${shiftId}/partial-deposit-status`, {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
@@ -87,6 +200,15 @@ function cartFactory({client, internalAuthTokenProvider}) {
   };
 
   const 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({token, cartId, jwtToken, headers}) {
       return client({
         url: `/carts/${cartId}/payments`,
@@ -94,6 +216,16 @@ function cartFactory({client, internalAuthTokenProvider}) {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, 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({token, cartId, jwtToken, headers, payment}) {
       return client({
         url: `/carts/${cartId}/payments`,
@@ -105,6 +237,16 @@ function cartFactory({client, internalAuthTokenProvider}) {
   };
 
   const 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({token, cartId, jwtToken, headers, data = {}}) {
       return client({
         url: `/carts/${cartId}/tax-exempt-payment-method`,
@@ -116,6 +258,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 {CartFinancingCostsCreateQuery} [opts.query] - Query params (providerId)
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create({token, jwtToken, headers, cartId, financingCost, query = {}}) {
       return client({
         url: `/carts/${cartId}/financing-costs`,
@@ -127,6 +280,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 {CartFinancingCostsDeleteQuery} [opts.query] - Query params (internalId)
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     delete({token, jwtToken, headers, cartId, query = {}}) {
       return client({
         url: `/carts/${cartId}/financing-costs`,