btrz-api-client 8.29.0 → 8.31.0

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

@@ -1,13 +1,52 @@
 "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). See get-payment-methods getSpec().
+ * @typedef {Object} PaymentMethodsListQuery
+ * @property {string} [providerName] - The provider name to filter the payment methods (deprecated; use getByProviderName)
+ * @property {string} [channel] - The channel to get payment methods for
+ * @property {boolean} [enabled] - Filter by enabled [true, false]; if omitted returns both
+ * @property {boolean} [excludePredefined] - Exclude predefined methods; default included
+ * @property {string} [providerId] - Account provider (operator) ID; used by agencies/sellers
+ * @property {string} [domain] - Filter by domain
+ * @property {string} [externalType] - Reference external type
+ * @property {boolean} [allowToRefundTo] - Filter by ability to accept refunds [true, false]
+ * @property {string} [flows] - Flows in which the method is available (comma-separated); channel required
+ */
+
+/**
+ * Query params for GET /payment-methods/:paymentMethodId (btrz-api-payments). See get-payment-method getSpec().
+ * @typedef {Object} PaymentMethodGetQuery
+ * @property {string} [providerId] - Account provider ID; used by agencies
+ */
+
+/**
+ * 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] - Query params (providerName, channel, enabled, etc.)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -21,18 +60,37 @@ function paymentMethodsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /payment-methods?providerName= - get by provider name (deprecated). API accepts providerName only.
+   * @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. 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 {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 +105,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 {PaymentMethodGetQuery} [opts.query] - Query params (providerId for agencies)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -61,6 +129,16 @@ function paymentMethodsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /payment-methods/:paymentMethodId - update payment method. 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.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 +154,17 @@ function paymentMethodsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /payment-methods-to-agencies - set payment methods to agency. 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.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 +181,14 @@ function paymentMethodsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /default-payment-methods - create default payment methods. 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.accountId - Account id
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function createDefaultPaymentMethods(_ref8) {
     var token = _ref8.token,
         jwtToken = _ref8.jwtToken,
@@ -105,6 +202,14 @@ function paymentMethodsFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /payment-methods/:paymentMethodId/customers - delete customers credit card info. 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.paymentMethodId - Payment method id
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function deleteCustomersCreditCardInfo(_ref9) {
     var token = _ref9.token,
         jwtToken = _ref9.jwtToken,
@@ -117,6 +222,14 @@ function paymentMethodsFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /payment-methods/domains/:domain - delete payment methods domain. 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.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. 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 {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. 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.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,37 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET payment/reversal/refund and PUT refund (btrz-api-payments). See get-by-id-* and put-refunds getSpec().
+ * @typedef {Object} PrismaTerminalsQuery
+ * @property {string} [providerId] - Account provider (operator) ID; used by 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 (providerId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref2) {
       var token = _ref2.token,
           jwtToken = _ref2.jwtToken,
@@ -21,6 +47,17 @@ function prismaTerminalsFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * POST /prisma-terminals/payments/:id/reversals - create reversal. 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.id - Payment id
+     * @param {Object} opts.prismaReversal - Prisma reversal payload
+     * @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,16 @@ function prismaTerminalsFactory(_ref) {
         data: { prismaReversal: prismaReversal }
       });
     },
+
+    /**
+     * DELETE /prisma-terminals/reversals/:id - delete reversal. 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.id - Reversal id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     delete: function _delete(_ref4) {
       var token = _ref4.token,
           jwtToken = _ref4.jwtToken,
@@ -56,6 +103,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 (providerId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref5) {
       var token = _ref5.token,
           jwtToken = _ref5.jwtToken,
@@ -69,6 +126,17 @@ function prismaTerminalsFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * POST /prisma-terminals/payments/:id/refunds - create refund. 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.id - Payment id
+     * @param {Object} opts.prismaRefund - Prisma refund payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref6) {
       var token = _ref6.token,
           jwtToken = _ref6.jwtToken,
@@ -86,6 +154,16 @@ function prismaTerminalsFactory(_ref) {
         data: { prismaRefund: prismaRefund }
       });
     },
+
+    /**
+     * DELETE /prisma-terminals/refunds/:id - delete refund. 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.id - Refund id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     delete: function _delete(_ref7) {
       var token = _ref7.token,
           jwtToken = _ref7.jwtToken,
@@ -101,6 +179,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 (providerId, validateRefund)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref8) {
       var token = _ref8.token,
           jwtToken = _ref8.jwtToken,
@@ -121,6 +211,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 (providerId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref9) {
       var token = _ref9.token,
           jwtToken = _ref9.jwtToken,
@@ -134,6 +234,16 @@ function prismaTerminalsFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * POST /prisma-terminals/payments - create payment. 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 {Object} opts.prismaPayment - Prisma payment payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref10) {
       var token = _ref10.token,
           jwtToken = _ref10.jwtToken,
@@ -150,6 +260,16 @@ function prismaTerminalsFactory(_ref) {
         data: { prismaPayment: prismaPayment }
       });
     },
+
+    /**
+     * DELETE /prisma-terminals/payments/:id - delete payment. 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.id - Payment id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     delete: function _delete(_ref11) {
       var token = _ref11.token,
           jwtToken = _ref11.jwtToken,
@@ -165,6 +285,17 @@ function prismaTerminalsFactory(_ref) {
         params: query
       });
     },
+
+    /**
+     * PUT /prisma-terminals/payments/:id - update payment. 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.id - Payment id
+     * @param {Object} opts.prismaPayment - Prisma payment payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref12) {
       var token = _ref12.token,
           jwtToken = _ref12.jwtToken,
@@ -188,6 +319,15 @@ function prismaTerminalsFactory(_ref) {
   };
 
   var settlements = {
+    /**
+     * POST /prisma-terminals/settlements - create settlement. 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 {Object} opts.settlement - Settlement payload
+     * @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. 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 {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,37 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query for POST .../referenced-payments/:type/:referenceNumber/results (btrz-api-payments). See post-referenced-payments getSpec().
+ * @typedef {Object} ReferencedPaymentsUpdateQuery
+ * @property {string} [includePaidOrExpired] - Update beyond paid/expired for completion [true, false]
+ */
+
+/**
+ * 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. 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.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,17 +45,32 @@ 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 {ReferencedPaymentsUpdateQuery} [opts.query] - Query params (includePaidOrExpired)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
         externalType = _ref3.externalType,
         referenceNumber = _ref3.referenceNumber,
         paymentResult = _ref3.paymentResult,
+        _ref3$query = _ref3.query,
+        query = _ref3$query === undefined ? {} : _ref3$query,
         headers = _ref3.headers;
 
     return client({
       url: "/referenced-payments/" + externalType + "/" + referenceNumber + "/results",
       method: "post",
+      params: query,
       headers: authorizationHeaders({ token: token, jwtToken: jwtToken, headers: headers }),
       data: { paymentResult: paymentResult }
     });

package/lib/endpoints/btrzpay/square.js

@@ -1,12 +1,31 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for Square webhooks API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function }}
+ */
+
+
 function squareWebhooksFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * POST /square-webhooks/:providerId - create Square webhook. 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.providerId - Provider id
+   * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -27,10 +46,25 @@ function squareWebhooksFactory(_ref) {
   };
 }
 
+/**
+ * Factory for Square terminals API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
 function squareTerminalsFactory(_ref3) {
   var client = _ref3.client,
       internalAuthTokenProvider = _ref3.internalAuthTokenProvider;
 
+  /**
+   * GET /square-terminals - get Square terminals. 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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,

package/lib/endpoints/btrzpay/stripe-terminals.js

@@ -3,10 +3,34 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /stripe-terminals (btrz-api-payments). See get-handler getSpec().
+ * @typedef {Object} StripeTerminalsListQuery
+ * @property {string} [providerId] - Account provider (operator) ID; used by agencies/sellers
+ */
+
+/**
+ * Factory for Stripe terminals API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, simulate: function }}
+ */
+
+
 function stripeTerminalsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /stripe-terminals - list Stripe terminals.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {StripeTerminalsListQuery} [opts.query] - Query params (providerId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -22,6 +46,16 @@ function stripeTerminalsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /stripe-terminals/:id/simulate - simulate Stripe payment. 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.id - Terminal id
+   * @param {Object} opts.stripePayment - Stripe payment payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function simulate(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,