btrz-api-client 8.30.0 → 8.31.0

package/src/endpoints/accounts/sms-templates.js

@@ -3,6 +3,35 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * Query params for GET /sms-templates (btrz-api-accounts). See get-handler getSpec().
+ * @typedef {Object} SmsTemplatesListQuery
+ * @property {string} [providerId] - Filter by provider account (ObjectId)
+ * @property {string} [type] - Filter by template type
+ * @property {string} [channel] - backoffice | agency-backoffice | websales | agency-websales | any
+ * @property {string} [sort] - relevance | natural | createdAsc | createdDesc | updatedAsc | updatedDesc
+ * @property {string} [templateCollectionId] - default | custom
+ * @property {string} [status] - draft | published
+ * @property {string} [mainTemplateAccountId] - Filter by source provider (ObjectId)
+ * @property {string} [lang] - ISO language code (e.g. en-us)
+ * @property {number} [page] - 1-based page for pagination
+ */
+
+/**
+ * Query params for GET /sms-templates/:smsTemplateId (btrz-api-accounts). See get-by-id-handler getSpec().
+ * @typedef {Object} SmsTemplateGetByIdQuery
+ * @property {string} [providerId] - Filter by provider; template must belong to this account, current, or global (ObjectId)
+ * @property {string} [superUserId] - Super user ID for authentication (ObjectId)
+ * @property {string} [superUserHash] - Super user hash for authentication
+ */
+
+/**
+ * Query params for PUT /sms-templates/:smsTemplateId/versions/:versionId (btrz-api-accounts). See put-version-handler getSpec().
+ * @typedef {Object} SmsTemplateVersionUpdateQuery
+ * @property {string} [superUserId] - Super user ID (ObjectId)
+ * @property {string} [superUserHash] - Super user hash for authentication
+ */
+
 /**
  * Factory for sms-templates API (btrz-api-accounts).
  * @param {Object} deps
@@ -12,7 +41,7 @@ const {
  */
 function smsTemplatesFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /sms-templates/types - returns available template types.
+   * GET /sms-templates/types - returns available template types. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -31,7 +60,7 @@ function smsTemplatesFactory({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 {SmsTemplatesListQuery} [opts.query] - Query params (providerId, type, channel, sort, etc.)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -49,7 +78,7 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.smsTemplateId - Template id (ObjectId)
-   * @param {Object} [opts.query] - Optional query params
+   * @param {SmsTemplateGetByIdQuery} [opts.query] - Query params (providerId, superUserId, superUserHash)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -62,7 +91,7 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /sms-templates - create an SMS template.
+   * POST /sms-templates - create an SMS template. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -80,7 +109,7 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /sms-templates/:smsTemplateId - update an SMS template.
+   * PUT /sms-templates/:smsTemplateId - update an SMS template. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -99,7 +128,7 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /sms-templates/:smsTemplateId - delete an SMS template.
+   * DELETE /sms-templates/:smsTemplateId - delete an SMS template. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -116,7 +145,7 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /sub-sms-templates - create a sub SMS template from a main template.
+   * POST /sub-sms-templates - create a sub SMS template from a main template. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -136,13 +165,13 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
 
   const versions = {
     /**
-     * PUT /sms-templates/:smsTemplateId/versions/:versionId - update a template version.
+     * PUT /sms-templates/:smsTemplateId/versions/:versionId - roll back sms template to a version.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.smsTemplateId - Template id (ObjectId)
-     * @param {string} opts.versionId - Version id (ObjectId)
-     * @param {Object} [opts.query] - Optional query params
+     * @param {string} opts.versionId - Zero-based version index (e.g. "0", "1")
+     * @param {SmsTemplateVersionUpdateQuery} [opts.query] - Query params (superUserId, superUserHash)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */

package/src/endpoints/accounts/sub-print-templates.js

@@ -11,7 +11,7 @@ const {
  */
 function subPrintTemplatesFactory({client, internalAuthTokenProvider}) {
   /**
-   * POST /sub-print-templates - create a sub print template.
+   * POST /sub-print-templates - create a sub print template. 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/accounts/ticket-movement-settings.js

@@ -11,7 +11,7 @@ const {
  */
 function ticketMovementSettingsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /ticket-movement-settings - get ticket movement settings.
+   * GET /ticket-movement-settings - get ticket movement 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
@@ -26,7 +26,7 @@ function ticketMovementSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /ticket-movement-settings - update ticket movement settings.
+   * PUT /ticket-movement-settings - update ticket movement 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/src/endpoints/accounts/tokens.js

@@ -1,5 +1,12 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /tokens (btrz-api-accounts). See get-tokens handler getSpec().
+ * @typedef {Object} TokensGetQuery
+ * @property {string} token - Token ID (required)
+ * @property {string} type - Token type (required; see API Token.getTypes())
+ */
+
 /**
  * Factory for tokens (applications) API (btrz-api-accounts).
  * @param {Object} deps
@@ -9,11 +16,11 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function applicationsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /tokens - get tokens (applications).
+   * GET /tokens - get a token by ID and type.
    * @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 {TokensGetQuery} [opts.query] - Query params: token (id), type (required)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -25,7 +32,7 @@ function applicationsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /tokens - create a token (application).
+   * POST /tokens - create a token (application). 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/accounts/transport-regulation-settings.js

@@ -11,7 +11,7 @@ const {
  */
 function transportRegulationSettingsForCNRT({client, internalAuthTokenProvider}) {
   /**
-   * GET /transport-regulation-settings/cnrt - get CNRT transport regulation settings.
+   * GET /transport-regulation-settings/cnrt - get CNRT transport regulation 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
@@ -26,7 +26,7 @@ function transportRegulationSettingsForCNRT({client, internalAuthTokenProvider})
   }
 
   /**
-   * PUT /transport-regulation-settings/cnrt - update CNRT transport regulation settings.
+   * PUT /transport-regulation-settings/cnrt - update CNRT transport regulation 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/src/endpoints/accounts/travellers.js

@@ -1,5 +1,19 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * 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
@@ -13,7 +27,7 @@ function travellersFactory({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 {TravellersListQuery} [opts.query] - Query params (customerId, page, providerIds)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -26,12 +40,11 @@ function travellersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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>}
    */
@@ -51,7 +64,7 @@ function travellersFactory({client, internalAuthTokenProvider}) {
    * @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>}
    */
@@ -71,7 +84,7 @@ function travellersFactory({client, internalAuthTokenProvider}) {
    * @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>}
    */
@@ -89,8 +102,8 @@ function travellersFactory({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 - Traveller payload
+   * @param {TravellerProviderIdsQuery} [opts.query] - Query params (providerIds)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

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

@@ -1,5 +1,13 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * 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
@@ -9,7 +17,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function trustedMachinesFactory({client, 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
@@ -28,7 +36,7 @@ function trustedMachinesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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
@@ -49,7 +57,7 @@ function trustedMachinesFactory({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 {TrustedMachinesListQuery} [opts.query] - Query params (userId, page, recordsPerPage)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

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

@@ -11,11 +11,10 @@ const {
  */
 function twilioSettingsFactory({client, 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>}
    */
@@ -28,7 +27,7 @@ function twilioSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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/src/endpoints/accounts/users.js

@@ -1,6 +1,13 @@
 /* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * 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
@@ -10,7 +17,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 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 +33,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 +49,10 @@ function usersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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>}
    */
@@ -63,7 +69,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 +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 - User data
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
@@ -202,7 +206,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 +227,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>}
      */

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,11 +17,11 @@ 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).
    * @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>}
    */
@@ -27,7 +34,7 @@ function websalesConfigFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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/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