btrz-api-client 8.30.0 → 8.31.0

package/lib/endpoints/accounts/travellers.js

@@ -3,6 +3,20 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /travellers (btrz-api-accounts). See get-handler getSpec().
+ * @typedef {Object} TravellersListQuery
+ * @property {string} [customerId] - Filter by customer (ObjectId)
+ * @property {number} [page] - Page number (1-based); if omitted results are not paginated
+ * @property {string} [providerIds] - Provider ids for traveller card types
+ */
+
+/**
+ * Query for PUT/DELETE/POST travellers (btrz-api-accounts). See put/delete/post handlers getSpec().
+ * @typedef {Object} TravellerProviderIdsQuery
+ * @property {string} [providerIds] - Provider ids to seek for customer, cards and fares
+ */
+
 /**
  * Factory for travellers API (btrz-api-accounts).
  * @param {Object} deps
@@ -21,7 +35,7 @@ function travellersFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} [opts.query] - Query params
+   * @param {TravellersListQuery} [opts.query] - Query params (customerId, page, providerIds)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -39,12 +53,11 @@ function travellersFactory(_ref) {
   }
 
   /**
-   * GET /travellers/:id - get a traveller.
+   * GET /travellers/:id - get a traveller. 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 - Traveller id (ObjectId)
-   * @param {Object} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -71,7 +84,7 @@ function travellersFactory(_ref) {
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.id - Traveller id (ObjectId)
    * @param {Object} opts.data - Traveller payload
-   * @param {Object} [opts.query] - Query params
+   * @param {TravellerProviderIdsQuery} [opts.query] - Query params (providerIds)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -99,7 +112,7 @@ function travellersFactory(_ref) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.id - Traveller id (ObjectId)
-   * @param {Object} [opts.query] - Query params
+   * @param {TravellerProviderIdsQuery} [opts.query] - Query params (providerIds)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -124,8 +137,8 @@ function travellersFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} [opts.query] - Query params
    * @param {Object} opts.data - Traveller payload
+   * @param {TravellerProviderIdsQuery} [opts.query] - Query params (providerIds)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/lib/endpoints/accounts/trusted-machines.js

@@ -3,6 +3,14 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /trusted-machines (btrz-api-accounts). See get-handler getSpec().
+ * @typedef {Object} TrustedMachinesListQuery
+ * @property {string} [userId] - Filter by user id (ObjectId)
+ * @property {number} [page] - Page to return
+ * @property {number} [recordsPerPage] - Records per page (max 100)
+ */
+
 /**
  * Factory for trusted-machines API (btrz-api-accounts).
  * @param {Object} deps
@@ -17,7 +25,7 @@ function trustedMachinesFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * POST /trusted-machines - create (register) a trusted machine.
+   * POST /trusted-machines - create (register) a trusted machine. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -41,7 +49,7 @@ function trustedMachinesFactory(_ref) {
   }
 
   /**
-   * GET /trusted-machines/:id - get a trusted machine.
+   * GET /trusted-machines/:id - get a trusted machine. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -67,7 +75,7 @@ function trustedMachinesFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} [opts.query] - Query params
+   * @param {TrustedMachinesListQuery} [opts.query] - Query params (userId, page, recordsPerPage)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/lib/endpoints/accounts/twilio-settings.js

@@ -17,11 +17,10 @@ function twilioSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /twilio-settings - get Twilio settings.
+   * GET /twilio-settings - get Twilio settings. 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.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -39,7 +38,7 @@ function twilioSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /twilio-settings - update Twilio settings.
+   * PUT /twilio-settings - update Twilio settings. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/lib/endpoints/accounts/users.js

@@ -4,6 +4,13 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /users/:userId/sequences (btrz-api-accounts). See get-user-sequences-handler getSpec().
+ * @typedef {Object} UserSequencesListQuery
+ * @property {string} [status] - inUse | notAvailable
+ * @property {boolean} [nextSequenceNumber] - Include next sequence number
+ */
+
 /**
  * Factory for users API (btrz-api-accounts).
  * @param {Object} deps
@@ -18,7 +25,7 @@ function usersFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /user/:id - get a user by id (legacy).
+   * GET /user/:id - get a user by id (legacy). API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -40,7 +47,7 @@ function usersFactory(_ref) {
   }
 
   /**
-   * GET /users/:id - get a user by id (v2).
+   * GET /users/:id - get a user by id (v2). API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -62,11 +69,10 @@ function usersFactory(_ref) {
   }
 
   /**
-   * GET /users - list users.
+   * GET /users - list users. API getSpec() does not define query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -89,7 +95,6 @@ function usersFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} [opts.query] - Query params
    * @param {Object} opts.data - Login payload
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
@@ -116,7 +121,6 @@ function usersFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} [opts.query] - Query params
    * @param {Object} opts.data - User data
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
@@ -274,7 +278,7 @@ function usersFactory(_ref) {
 
   var sequences = {
     /**
-     * GET /users/:userId/sequences/:sequenceId - get a sequence.
+     * GET /users/:userId/sequences/:sequenceId - get a sequence. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -302,7 +306,7 @@ function usersFactory(_ref) {
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.userId - User id (ObjectId)
-     * @param {Object} [opts.query] - Query params
+     * @param {UserSequencesListQuery} [opts.query] - Query params (status, nextSequenceNumber)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */

package/lib/endpoints/accounts/websales-config.js

@@ -4,6 +4,13 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /websales-config (btrz-api-accounts). See get-handler getSpec().
+ * @typedef {Object} WebsalesConfigListQuery
+ * @property {string} [domain] - Filter by domain
+ * @property {string} [providerId] - Provider id for websales-config (ObjectId)
+ */
+
 /**
  * Factory for websales-config API (btrz-api-accounts).
  * @param {Object} deps
@@ -18,11 +25,11 @@ function websalesConfigFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /websales-config - get websales config (list when no id).
+   * GET /websales-config - get websales config (list).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} [opts.query] - Query params
+   * @param {WebsalesConfigListQuery} [opts.query] - Query params (domain, providerId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -41,7 +48,7 @@ function websalesConfigFactory(_ref) {
   }
 
   /**
-   * PUT /websales-config/:websalesConfigId - update websales config.
+   * PUT /websales-config/:websalesConfigId - update websales config. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/lib/endpoints/btrzpay/cardpointe.js

@@ -17,7 +17,7 @@ function cardpointeTerminalsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /cardpointe-terminals - list Cardpointe terminals.
+   * GET /cardpointe-terminals - list Cardpointe 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
@@ -38,7 +38,7 @@ function cardpointeTerminalsFactory(_ref) {
   }
 
   /**
-   * DELETE /cardpointe-terminals/:merchantId/:terminalId - remove terminal.
+   * DELETE /cardpointe-terminals/:merchantId/:terminalId - remove terminal. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -63,7 +63,7 @@ function cardpointeTerminalsFactory(_ref) {
 
   var readCard = {
     /**
-     * GET /cardpointe-terminals/read-card/:readCardResultId - get read card result.
+     * GET /cardpointe-terminals/read-card/:readCardResultId - get read card result. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -84,7 +84,7 @@ function cardpointeTerminalsFactory(_ref) {
     },
 
     /**
-     * POST /cardpointe-terminals/read-card - create read card.
+     * POST /cardpointe-terminals/read-card - create read card. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -110,7 +110,7 @@ function cardpointeTerminalsFactory(_ref) {
 
   var ping = {
     /**
-     * POST /cardpointe-terminals/ping - create ping.
+     * POST /cardpointe-terminals/ping - create ping. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/lib/endpoints/btrzpay/customerCards.js

@@ -17,7 +17,7 @@ function customerCardsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /payment-methods/:paymentMethodId/customers/:customerId/cards/:customerCardId - get card.
+   * GET /payment-methods/:paymentMethodId/customers/:customerId/cards/:customerCardId - get card. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -42,7 +42,7 @@ function customerCardsFactory(_ref) {
   }
 
   /**
-   * GET /payment-methods/:paymentMethodId/customers/:customerId/cards - list cards.
+   * GET /payment-methods/:paymentMethodId/customers/:customerId/cards - list cards. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -65,7 +65,7 @@ function customerCardsFactory(_ref) {
   }
 
   /**
-   * POST /payment-methods/:paymentMethodId/customers/:customerId/cards - create card.
+   * POST /payment-methods/:paymentMethodId/customers/:customerId/cards - create card. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -92,7 +92,7 @@ function customerCardsFactory(_ref) {
   }
 
   /**
-   * DELETE /payment-methods/:paymentMethodId/customers/:customerId/cards/:customerCardId - remove card.
+   * DELETE /payment-methods/:paymentMethodId/customers/:customerId/cards/:customerCardId - remove card. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/lib/endpoints/btrzpay/customers.js

@@ -17,7 +17,7 @@ function customersFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /payment-methods/:paymentMethodId/customers/:customerId - get customer.
+   * GET /payment-methods/:paymentMethodId/customers/:customerId - get customer. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -40,7 +40,7 @@ function customersFactory(_ref) {
   }
 
   /**
-   * POST /payment-methods/:paymentMethodId/customers - create customer.
+   * POST /payment-methods/:paymentMethodId/customers - create customer. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -65,7 +65,7 @@ function customersFactory(_ref) {
   }
 
   /**
-   * DELETE /payment-methods/:paymentMethodId/customers/:customerId - remove customer.
+   * DELETE /payment-methods/:paymentMethodId/customers/:customerId - remove customer. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/lib/endpoints/btrzpay/datalogic.js

@@ -4,8 +4,9 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * @typedef {Object} DatalogicQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /datalogic/payments (btrz-api-payments). See get-payments-handler getSpec().
+ * @typedef {Object} DatalogicPaymentsListQuery
+ * @property {string} [referenceNumber] - The payment reference number
  */
 
 /**
@@ -26,7 +27,7 @@ function datalogicFactory(_ref) {
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {DatalogicQuery} [opts.query] - Query params
+     * @param {DatalogicPaymentsListQuery} [opts.query] - Query params (referenceNumber)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -45,13 +46,12 @@ function datalogicFactory(_ref) {
     },
 
     /**
-     * POST /datalogic/payments/:referenceNumber - update Datalogic payment.
+     * POST /datalogic/payments/:referenceNumber - update Datalogic 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.referenceNumber - Reference number
      * @param {Object} [opts.data] - Request body
-     * @param {DatalogicQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -74,13 +74,12 @@ function datalogicFactory(_ref) {
     },
 
     /**
-     * POST /datalogic/reverse/:referenceNumber - reverse Datalogic payment.
+     * POST /datalogic/reverse/:referenceNumber - reverse Datalogic 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.referenceNumber - Reference number
      * @param {Object} [opts.data] - Request body
-     * @param {DatalogicQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -105,7 +104,7 @@ function datalogicFactory(_ref) {
 
   var referenceNumber = {
     /**
-     * GET /datalogic/reference-number - get reference number.
+     * GET /datalogic/reference-number - get 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
@@ -127,7 +126,7 @@ function datalogicFactory(_ref) {
 
   var authCode = {
     /**
-     * GET /datalogic/auth-code - get auth code.
+     * GET /datalogic/auth-code - get auth code. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/lib/endpoints/btrzpay/oxxo.js

@@ -4,17 +4,11 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Query params for GET /oxxo/:token/payments (btrz-api-payments getSpec).
+ * Query params for GET /oxxo/:token/payments (btrz-api-payments). See get-payments-handler 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
@@ -30,7 +24,7 @@ function oxxoFactory(_ref) {
 
   var token = {
     /**
-     * GET /oxxo/token - get OXXO token.
+     * GET /oxxo/token - get OXXO token. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {{ getToken: function(): string }} [opts.internalAuthTokenProvider]
@@ -55,7 +49,7 @@ function oxxoFactory(_ref) {
      * @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 {OxxoPaymentsListQuery} [opts.query] - Query params (referenceNumber)
      * @param {{ getToken: function(): string }} [opts.internalAuthTokenProvider]
      * @param {Object} [opts.headers] - Optional request headers
      * @returns {Promise<import("axios").AxiosResponse>} GetOxxoPaymentsResponse; 400 ERROR_GETTING_PAYMENT_METHODS
@@ -75,12 +69,11 @@ function oxxoFactory(_ref) {
     },
 
     /**
-     * POST /oxxo/:oxxoToken/payments/:referenceNumber - update OXXO payment.
+     * POST /oxxo/:oxxoToken/payments/:referenceNumber - update OXXO payment. API does not accept query params.
      * @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
@@ -105,13 +98,12 @@ function oxxoFactory(_ref) {
     },
 
     /**
-     * POST /oxxo/:oxxoToken/reverse/:referenceNumber - reverse OXXO payment.
+     * POST /oxxo/:oxxoToken/reverse/:referenceNumber - reverse OXXO 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.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

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

@@ -5,9 +5,23 @@ 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.
+ * Query params for GET /payment-methods (btrz-api-payments). See get-payment-methods getSpec().
  * @typedef {Object} PaymentMethodsListQuery
- * @property {string} [providerName] - Filter by provider name (deprecated; use getByProviderName for single provider)
+ * @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
  */
 
 /**
@@ -29,7 +43,7 @@ function paymentMethodsFactory(_ref) {
    * @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 {PaymentMethodsListQuery} [opts.query] - Query params (providerName, channel, enabled, etc.)
    * @param {Object} [opts.headers] - Optional request headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -47,7 +61,7 @@ function paymentMethodsFactory(_ref) {
   }
 
   /**
-   * GET /payment-methods?providerName= - get by provider name (deprecated).
+   * 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
@@ -69,7 +83,7 @@ function paymentMethodsFactory(_ref) {
   }
 
   /**
-   * POST /payment-methods - create payment method.
+   * 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
@@ -97,7 +111,7 @@ function paymentMethodsFactory(_ref) {
    * @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 {PaymentMethodGetQuery} [opts.query] - Query params (providerId for agencies)
    * @param {Object} [opts.headers] - Optional request headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -116,7 +130,7 @@ function paymentMethodsFactory(_ref) {
   }
 
   /**
-   * PUT /payment-methods/:paymentMethodId - update payment method.
+   * 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
@@ -141,7 +155,7 @@ function paymentMethodsFactory(_ref) {
   }
 
   /**
-   * POST /payment-methods-to-agencies - set payment methods to agency.
+   * 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
@@ -168,7 +182,7 @@ function paymentMethodsFactory(_ref) {
   }
 
   /**
-   * POST /default-payment-methods - create default payment methods.
+   * 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
@@ -189,7 +203,7 @@ function paymentMethodsFactory(_ref) {
   }
 
   /**
-   * DELETE /payment-methods/:paymentMethodId/customers - delete customers credit card info.
+   * 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
@@ -209,7 +223,7 @@ function paymentMethodsFactory(_ref) {
   }
 
   /**
-   * DELETE /payment-methods/domains/:domain - delete payment methods domain.
+   * 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

package/lib/endpoints/btrzpay/payments.js

@@ -17,7 +17,7 @@ function paymentsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * POST /payments - create payments.
+   * 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
@@ -40,7 +40,7 @@ function paymentsFactory(_ref) {
   }
 
   /**
-   * GET /transactions/:transactionId - get transaction.
+   * 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