btrz-api-client 8.28.0 → 8.30.0

package/lib/endpoints/btrzpay/docs.js

@@ -1,8 +1,19 @@
 "use strict";
 
+/**
+ * Factory for API docs (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @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/btrzpay/oxxo.js

@@ -1,13 +1,42 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /oxxo/:token/payments (btrz-api-payments getSpec).
+ * @typedef {Object} OxxoPaymentsListQuery
+ * @property {string} [referenceNumber] - Payment reference number
+ */
+
+/**
+ * POST /oxxo/:token/payments/:referenceNumber and POST /oxxo/:token/reverse/:referenceNumber do not define
+ * query params in backend getSpec (path + body only). Use for optional query keys forwarded as-is.
+ * @typedef {Object} OxxoPostQuery
+ */
+
+/**
+ * Factory for OXXO API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ token: Object, payments: Object }}
+ */
+
+
 function oxxoFactory(_ref) {
   var client = _ref.client,
-      internalAuthTokenProvider = _ref.internalAuthTokenProvider;
+      _internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   var token = {
+    /**
+     * GET /oxxo/token - get OXXO token.
+     * @param {Object} opts
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {{ getToken: function(): string }} [opts.internalAuthTokenProvider]
+     * @param {Object} [opts.headers] - Optional request headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref2) {
       var jwtToken = _ref2.jwtToken,
           headers = _ref2.headers,
@@ -21,6 +50,16 @@ function oxxoFactory(_ref) {
   };
 
   var payments = {
+    /**
+     * GET /oxxo/:oxxoToken/payments - list OXXO payments.
+     * @param {Object} opts
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.oxxoToken - OXXO token
+     * @param {OxxoPaymentsListQuery} [opts.query] - referenceNumber (optional)
+     * @param {{ getToken: function(): string }} [opts.internalAuthTokenProvider]
+     * @param {Object} [opts.headers] - Optional request headers
+     * @returns {Promise<import("axios").AxiosResponse>} GetOxxoPaymentsResponse; 400 ERROR_GETTING_PAYMENT_METHODS
+     */
     all: function all(_ref3) {
       var jwtToken = _ref3.jwtToken,
           headers = _ref3.headers,
@@ -34,6 +73,19 @@ function oxxoFactory(_ref) {
         headers: authorizationHeaders({ jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * POST /oxxo/:oxxoToken/payments/:referenceNumber - update OXXO payment.
+     * @param {Object} opts
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.oxxoToken - OXXO token
+     * @param {string} opts.referenceNumber - Payment reference number
+     * @param {OxxoPostQuery} [opts.query] - Optional query params (backend getSpec has none; forwarded as-is)
+     * @param {Object} opts.data - Request body (PostOxxoPaymentsPayload)
+     * @param {{ getToken: function(): string }} [opts.internalAuthTokenProvider]
+     * @param {Object} [opts.headers] - Optional request headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref4) {
       var jwtToken = _ref4.jwtToken,
           headers = _ref4.headers,
@@ -51,8 +103,22 @@ function oxxoFactory(_ref) {
         headers: authorizationHeaders({ jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * POST /oxxo/:oxxoToken/reverse/:referenceNumber - reverse OXXO payment.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.oxxoToken - OXXO token
+     * @param {string} opts.referenceNumber - Payment reference number
+     * @param {OxxoPostQuery} [opts.query] - Optional query params (backend getSpec has none; forwarded as-is)
+     * @param {Object} [opts.data] - Request body (PostOxxoReversePayload)
+     * @param {{ getToken: function(): string }} [opts.internalAuthTokenProvider]
+     * @param {Object} [opts.headers] - Optional request headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     reverse: function reverse(_ref5) {
-      var token = _ref5.token,
+      var authToken = _ref5.token,
           jwtToken = _ref5.jwtToken,
           headers = _ref5.headers,
           query = _ref5.query,
@@ -66,7 +132,7 @@ function oxxoFactory(_ref) {
         method: "post",
         params: query,
         data: data,
-        headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+        headers: authorizationHeaders({ token: authToken, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     }
   };

package/lib/endpoints/btrzpay/payment-methods.js

@@ -1,13 +1,38 @@
 "use strict";
 
 /* eslint-disable import/extensions */
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /payment-methods (btrz-api-payments). Passed through as-is when no backend spec found.
+ * @typedef {Object} PaymentMethodsListQuery
+ * @property {string} [providerName] - Filter by provider name (deprecated; use getByProviderName for single provider)
+ */
+
+/**
+ * Factory for payment methods API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} methods all, getByProviderName, create, get, update, setToAgency,
+ *   createDefaultPaymentMethods, deleteCustomersCreditCardInfo, deletePaymentMethodsDomain
+ */
+
+
 function paymentMethodsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /payment-methods - list payment methods.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {PaymentMethodsListQuery} [opts.query] - Optional query params (e.g. providerName)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -21,18 +46,37 @@ function paymentMethodsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /payment-methods?providerName= - get by provider name (deprecated).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.providerName - Provider name
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   * @deprecated
+   */
   function getByProviderName(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
         providerName = _ref3.providerName,
         headers = _ref3.headers;
-    //deprecated
+
     return client({
       url: "/payment-methods?providerName=" + providerName,
       headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
     });
   }
 
+  /**
+   * POST /payment-methods - create payment method.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.paymentMethod - Payment method payload
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -47,6 +91,16 @@ function paymentMethodsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /payment-methods/:paymentMethodId - get payment method.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.paymentMethodId - Payment method id
+   * @param {PaymentMethodsListQuery} [opts.query] - Optional query params (e.g. providerName); forwarded to API
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -61,6 +115,16 @@ function paymentMethodsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /payment-methods/:paymentMethodId - update payment method.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.paymentMethodId - Payment method id
+   * @param {Object} opts.paymentMethod - Payment method payload
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,
@@ -76,6 +140,17 @@ function paymentMethodsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /payment-methods-to-agencies - set payment methods to agency.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.agencyId - Agency id
+   * @param {string} opts.providerId - Provider id
+   * @param {string[]} opts.paymentMethodNames - Payment method names
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function setToAgency(_ref7) {
     var token = _ref7.token,
         jwtToken = _ref7.jwtToken,
@@ -92,6 +167,14 @@ function paymentMethodsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /default-payment-methods - create default payment methods.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.accountId - Account id
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function createDefaultPaymentMethods(_ref8) {
     var token = _ref8.token,
         jwtToken = _ref8.jwtToken,
@@ -105,6 +188,14 @@ function paymentMethodsFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /payment-methods/:paymentMethodId/customers - delete customers credit card info.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.paymentMethodId - Payment method id
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function deleteCustomersCreditCardInfo(_ref9) {
     var token = _ref9.token,
         jwtToken = _ref9.jwtToken,
@@ -117,6 +208,14 @@ function paymentMethodsFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /payment-methods/domains/:domain - delete payment methods domain.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.domain - Domain
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function deletePaymentMethodsDomain(_ref10) {
     var token = _ref10.token,
         jwtToken = _ref10.jwtToken,

package/lib/endpoints/btrzpay/payments.js

@@ -1,13 +1,30 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for payments API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function, get: function }}
+ */
+
+
 function paymentsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * POST /payments - create payments.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.payments - Payments payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -22,6 +39,15 @@ function paymentsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /transactions/:transactionId - get transaction.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.transactionId - Transaction id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,

package/lib/endpoints/btrzpay/prismaTerminals.js

@@ -3,11 +3,36 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} PrismaTerminalsQuery
+ * @property {string} [providerId] - Account provider/operator ID for agencies/sellers
+ * @property {boolean} [validateRefund] - (PUT refunds only) If true, fetch current state from Prisma before applying
+ */
+
+/**
+ * Factory for Prisma terminals API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ payments: Object, settlements: Object }}
+ */
+
+
 function prismaTerminalsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   var reversals = {
+    /**
+     * GET /prisma-terminals/reversals/:id - get reversal by id.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.id - Reversal id
+     * @param {PrismaTerminalsQuery} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref2) {
       var token = _ref2.token,
           jwtToken = _ref2.jwtToken,
@@ -21,6 +46,18 @@ function prismaTerminalsFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * POST /prisma-terminals/payments/:id/reversals - create reversal.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.id - Payment id
+     * @param {Object} opts.prismaReversal - Prisma reversal payload
+     * @param {PrismaTerminalsQuery} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref3) {
       var token = _ref3.token,
           jwtToken = _ref3.jwtToken,
@@ -38,6 +75,17 @@ function prismaTerminalsFactory(_ref) {
         data: { prismaReversal: prismaReversal }
       });
     },
+
+    /**
+     * DELETE /prisma-terminals/reversals/:id - delete reversal.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.id - Reversal id
+     * @param {PrismaTerminalsQuery} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     delete: function _delete(_ref4) {
       var token = _ref4.token,
           jwtToken = _ref4.jwtToken,
@@ -56,6 +104,16 @@ function prismaTerminalsFactory(_ref) {
   };
 
   var refunds = {
+    /**
+     * GET /prisma-terminals/refunds/:id - get refund by id.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.id - Refund id
+     * @param {PrismaTerminalsQuery} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref5) {
       var token = _ref5.token,
           jwtToken = _ref5.jwtToken,
@@ -69,6 +127,18 @@ function prismaTerminalsFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * POST /prisma-terminals/payments/:id/refunds - create refund.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.id - Payment id
+     * @param {Object} opts.prismaRefund - Prisma refund payload
+     * @param {PrismaTerminalsQuery} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref6) {
       var token = _ref6.token,
           jwtToken = _ref6.jwtToken,
@@ -86,6 +156,17 @@ function prismaTerminalsFactory(_ref) {
         data: { prismaRefund: prismaRefund }
       });
     },
+
+    /**
+     * DELETE /prisma-terminals/refunds/:id - delete refund.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.id - Refund id
+     * @param {PrismaTerminalsQuery} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     delete: function _delete(_ref7) {
       var token = _ref7.token,
           jwtToken = _ref7.jwtToken,
@@ -101,6 +182,18 @@ function prismaTerminalsFactory(_ref) {
         params: query
       });
     },
+
+    /**
+     * PUT /prisma-terminals/refunds/:id - update refund.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.id - Refund id
+     * @param {Object} opts.prismaRefund - Prisma refund payload
+     * @param {PrismaTerminalsQuery} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref8) {
       var token = _ref8.token,
           jwtToken = _ref8.jwtToken,
@@ -121,6 +214,16 @@ function prismaTerminalsFactory(_ref) {
   };
 
   var payments = {
+    /**
+     * GET /prisma-terminals/payments/:id - get payment by id.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.id - Payment id
+     * @param {PrismaTerminalsQuery} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref9) {
       var token = _ref9.token,
           jwtToken = _ref9.jwtToken,
@@ -134,6 +237,17 @@ function prismaTerminalsFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * POST /prisma-terminals/payments - create payment.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} opts.prismaPayment - Prisma payment payload
+     * @param {PrismaTerminalsQuery} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref10) {
       var token = _ref10.token,
           jwtToken = _ref10.jwtToken,
@@ -150,6 +264,17 @@ function prismaTerminalsFactory(_ref) {
         data: { prismaPayment: prismaPayment }
       });
     },
+
+    /**
+     * DELETE /prisma-terminals/payments/:id - delete payment.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.id - Payment id
+     * @param {PrismaTerminalsQuery} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     delete: function _delete(_ref11) {
       var token = _ref11.token,
           jwtToken = _ref11.jwtToken,
@@ -165,6 +290,18 @@ function prismaTerminalsFactory(_ref) {
         params: query
       });
     },
+
+    /**
+     * PUT /prisma-terminals/payments/:id - update payment.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.id - Payment id
+     * @param {Object} opts.prismaPayment - Prisma payment payload
+     * @param {PrismaTerminalsQuery} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref12) {
       var token = _ref12.token,
           jwtToken = _ref12.jwtToken,
@@ -188,6 +325,16 @@ function prismaTerminalsFactory(_ref) {
   };
 
   var settlements = {
+    /**
+     * POST /prisma-terminals/settlements - create settlement.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} opts.settlement - Settlement payload
+     * @param {PrismaTerminalsQuery} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref13) {
       var token = _ref13.token,
           jwtToken = _ref13.jwtToken,

package/lib/endpoints/btrzpay/reference-numbers.js

@@ -1,13 +1,30 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for reference numbers API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function }}
+ */
+
+
 function referenceNumbersFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * POST /reference-numbers - create reference number.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.referenceNumberRequest - Reference number request payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

package/lib/endpoints/btrzpay/referenced-payments.js

@@ -1,12 +1,31 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for referenced payments API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ getStatus: function, update: function }}
+ */
+
+
 function referencedPaymentsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /referenced-payments/:transactionId/:referenceNumber/status - get status.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.transactionId - Transaction id
+   * @param {string} opts.referenceNumber - Reference number
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getStatus(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -20,6 +39,17 @@ function referencedPaymentsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /referenced-payments/:externalType/:referenceNumber/results - update payment result.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.externalType - External type
+   * @param {string} opts.referenceNumber - Reference number
+   * @param {Object} opts.paymentResult - Payment result payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,