btrz-api-client 8.30.0 → 8.32.0

package/src/endpoints/accounts/users.js

@@ -1,16 +1,41 @@
 /* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /users (btrz-api-accounts). See get-users getSpec().
+ * @typedef {Object} GetUsersListQuery
+ * @property {number} [page] - Page number (1-based). When provided, response is limited to pageSize items.
+ * @property {string} [deleted] - "true" | "false" to filter by deleted flag
+ * @property {string} [firstName] - Filter by first name (prefix, case-insensitive)
+ * @property {string} [lastName] - Filter by last name (prefix, case-insensitive)
+ * @property {string} [display] - Filter by display name (prefix, case-insensitive)
+ * @property {string} [externalId] - Filter by external ID (exact)
+ * @property {string} [employeeNumber] - Filter by employee number (exact)
+ * @property {string} [email] - Filter by email (prefix, case-insensitive)
+ * @property {string} [assignableToManifest] - "true" | "false"
+ * @property {string} [role] - Filter users that have this role (role key)
+ * @property {string} [excludedRoles] - Comma-separated role keys to exclude
+ * @property {string} [preferredLocationId] - Filter by preferred location ID
+ * @property {string} [preferredLocationIds] - Filter by preferred location IDs
+ */
+
+/**
+ * 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
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ get: function, getV2: function, all: function, create: function, login: function, update: function, createOrUpdateMany: function, impersonate: function, startMfa: function, confirmMfa: function, disableMfa: function, sequences: { get: function, all: function, create: function, update: function, transfer: function } }}
+ * @returns {{ get: function, getV2: function, all: function, create: function, login: function, update: function, delete: function, createOrUpdateMany: function, impersonate: function, startMfa: function, confirmMfa: function, disableMfa: function, sequences: { get: function, all: function, create: function, update: function, transfer: function } }}
  */
 function usersFactory({client, 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
@@ -26,7 +51,7 @@ function usersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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
@@ -42,11 +67,11 @@ function usersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /users - list users.
+   * GET /users - list users with optional pagination and filters.
    * @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 {GetUsersListQuery} [opts.query] - Query params (page, deleted, firstName, lastName, display, externalId, employeeNumber, email, assignableToManifest, role, excludedRoles, preferredLocationId, preferredLocationIds)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -63,7 +88,6 @@ function usersFactory({client, internalAuthTokenProvider}) {
    * @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>}
@@ -83,7 +107,6 @@ function usersFactory({client, internalAuthTokenProvider}) {
    * @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>}
@@ -93,14 +116,14 @@ function usersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /users/:userId - update a user.
+   * PUT /users/:userId - update a user. Emits webhook user.updated.
    * @param {Object} opts
    * @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.user - User payload
+   * @param {Object} opts.user - User payload (allowed fields per PUT /users/:userId spec)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ user: Object }>>}
    */
   function update({token, jwtToken, userId, user, headers}) {
     return client({
@@ -111,6 +134,23 @@ function usersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /users/:id - delete a user. Emits webhook user.deleted. Returns 204 on success.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - User id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function deleteUser({token, jwtToken, id, headers}) {
+    return client({
+      url: `/users/${id}`,
+      method: "delete",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
   /**
    * POST /users/import - create or update many users.
    * @param {Object} opts
@@ -202,7 +242,7 @@ function usersFactory({client, internalAuthTokenProvider}) {
 
   const 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
@@ -223,7 +263,7 @@ function usersFactory({client, internalAuthTokenProvider}) {
      * @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>}
      */
@@ -302,6 +342,7 @@ function usersFactory({client, internalAuthTokenProvider}) {
     create,
     login,
     update,
+    delete: deleteUser,
     createOrUpdateMany,
     impersonate,
     startMfa,

package/src/endpoints/accounts/verified-emails.js

@@ -0,0 +1,100 @@
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
+
+/**
+ * Query params for GET /verified-emails (btrz-api-accounts). See get-handler getSpec().
+ * @typedef {Object} VerifiedEmailsListQuery
+ * @property {number} [page] - Page number (1-based). Default 1.
+ * @property {number} [pageSize] - Page size. Default 20.
+ */
+
+/**
+ * Factory for verified-emails API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function }}
+ */
+function verifiedEmailsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /verified-emails - list verified emails for the account (paginated).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {VerifiedEmailsListQuery} [opts.query] - Query params (page, pageSize)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ verifiedEmails: Array }>>}
+   *   Errors: 401, 500
+   */
+  function all({token, jwtToken, query = {}, headers}) {
+    return client({
+      url: "/verified-emails",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      params: query
+    });
+  }
+
+  /**
+   * GET /verified-emails/:email - get a verified email by email address.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.email - Email address (path parameter)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ verifiedEmail: Object }>>}
+   *   Errors: 400 (WRONG_DATA), 401, 404 (VERIFIED_EMAIL_NOT_FOUND), 500
+   */
+  function get({token, jwtToken, email, headers}) {
+    return client({
+      url: `/verified-emails/${encodeURIComponent(email)}`,
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * POST /verified-emails - create a verified email. Emits webhook verifiedEmails.created.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - Body: email (required), status (BLACKLISTED | BLOCKED | WHITELISTED), optional QEVResponse
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ verifiedEmail: Object }>>}
+   *   Errors: 400 (WRONG_DATA, INVALID_STATUS), 401, 500
+   */
+  function create({token, jwtToken, data, headers}) {
+    return client({
+      url: "/verified-emails",
+      method: "post",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data
+    });
+  }
+
+  /**
+   * PUT /verified-emails/:email - update a verified email. Emits webhook verifiedEmails.updated.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.email - Email address (path parameter)
+   * @param {Object} opts.data - Body: status (BLACKLISTED | BLOCKED | WHITELISTED), optional QEVResponse
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ verifiedEmail: Object }>>}
+   *   Errors: 400 (INVALID_STATUS, VERIFIED_EMAIL_BLOCKED), 401, 404 (VERIFIED_EMAIL_NOT_FOUND), 500
+   */
+  function update({token, jwtToken, email, data, headers}) {
+    return client({
+      url: `/verified-emails/${encodeURIComponent(email)}`,
+      method: "put",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data
+    });
+  }
+
+  return {
+    all,
+    get,
+    create,
+    update
+  };
+}
+
+module.exports = verifiedEmailsFactory;

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

@@ -1,6 +1,13 @@
 /* eslint-disable import/extensions */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * 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
@@ -10,13 +17,14 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function websalesConfigFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /websales-config - get websales config (list when no id).
+   * GET /websales-config - get websales config list (paginated). Query: domain, providerId.
    * @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>}
+   * @returns {Promise<import("axios").AxiosResponse<{ websalesConfig: Array, next?: string, previous?: string, count?: number }>>}
+   *   Errors: 401, 500
    */
   function get({token, jwtToken, query = {}, headers}) {
     return client({
@@ -27,14 +35,15 @@ function websalesConfigFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /websales-config/:websalesConfigId - update websales config.
+   * PUT /websales-config/:websalesConfigId - update websales config. Emits webhook websalesConfig.updated.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.websalesConfigId - Websales config id (ObjectId)
-   * @param {Object} opts.websalesConfig - Config payload
+   * @param {Object} opts.websalesConfig - Config payload (WebsalesConfigPutData; SSO cannot be updated)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ websalesConfig: Object }>>}
+   *   Errors: 400, 401, 404 (WEBSALESCONFIG_NOT_FOUND), 409, 500
    */
   function update({token, jwtToken, websalesConfigId, websalesConfig, headers}) {
     return client({

package/src/endpoints/btrzpay/cardpointe.js

@@ -11,7 +11,7 @@ const {
  */
 function cardpointeTerminalsFactory({client, 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
@@ -28,7 +28,7 @@ function cardpointeTerminalsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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
@@ -47,7 +47,7 @@ function cardpointeTerminalsFactory({client, internalAuthTokenProvider}) {
 
   const 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
@@ -62,7 +62,7 @@ function cardpointeTerminalsFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * 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
@@ -83,7 +83,7 @@ function cardpointeTerminalsFactory({client, internalAuthTokenProvider}) {
 
   const 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/src/endpoints/btrzpay/customerCards.js

@@ -9,7 +9,7 @@ const {authorizationHeaders} = require("../endpoints_helpers.js");
  */
 function customerCardsFactory({client, 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
@@ -27,7 +27,7 @@ function customerCardsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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
@@ -44,7 +44,7 @@ function customerCardsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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
@@ -64,7 +64,7 @@ function customerCardsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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/src/endpoints/btrzpay/customers.js

@@ -9,7 +9,7 @@ const {authorizationHeaders} = require("../endpoints_helpers.js");
  */
 function customersFactory({client, 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
@@ -26,7 +26,7 @@ function customersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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
@@ -45,7 +45,7 @@ function customersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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/src/endpoints/btrzpay/datalogic.js

@@ -3,8 +3,9 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
- * @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
  */
 
 /**
@@ -21,7 +22,7 @@ function datalogicFactory({client}) {
      * @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>}
      */
@@ -33,13 +34,12 @@ function datalogicFactory({client}) {
       });
     },
     /**
-     * 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>}
      */
@@ -53,13 +53,12 @@ function datalogicFactory({client}) {
       });
     },
     /**
-     * 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>}
      */
@@ -76,7 +75,7 @@ function datalogicFactory({client}) {
 
   const 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
@@ -93,7 +92,7 @@ function datalogicFactory({client}) {
 
   const 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/src/endpoints/btrzpay/oxxo.js

@@ -3,17 +3,11 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
- * 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
@@ -24,7 +18,7 @@ const {
 function oxxoFactory({client, internalAuthTokenProvider: _internalAuthTokenProvider}) {
   const 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]
@@ -45,7 +39,7 @@ function oxxoFactory({client, internalAuthTokenProvider: _internalAuthTokenProvi
      * @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
@@ -58,12 +52,11 @@ function oxxoFactory({client, internalAuthTokenProvider: _internalAuthTokenProvi
       });
     },
     /**
-     * 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
@@ -79,13 +72,12 @@ function oxxoFactory({client, internalAuthTokenProvider: _internalAuthTokenProvi
       });
     },
     /**
-     * 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/src/endpoints/btrzpay/payment-methods.js

@@ -2,9 +2,23 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * 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
  */
 
 /**
@@ -21,7 +35,7 @@ function paymentMethodsFactory({client, internalAuthTokenProvider}) {
    * @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>}
    */
@@ -33,7 +47,7 @@ function paymentMethodsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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
@@ -50,7 +64,7 @@ function paymentMethodsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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
@@ -73,7 +87,7 @@ function paymentMethodsFactory({client, internalAuthTokenProvider}) {
    * @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>}
    */
@@ -85,7 +99,7 @@ function paymentMethodsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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
@@ -104,7 +118,7 @@ function paymentMethodsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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
@@ -124,7 +138,7 @@ function paymentMethodsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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
@@ -141,7 +155,7 @@ function paymentMethodsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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
@@ -157,7 +171,7 @@ function paymentMethodsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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/src/endpoints/btrzpay/payments.js

@@ -9,7 +9,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function paymentsFactory({client, 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
@@ -27,7 +27,7 @@ function paymentsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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