btrz-api-client 8.29.0 → 8.30.0

package/src/endpoints/accounts/tokens.js

@@ -1,6 +1,22 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for tokens (applications) API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, create: function }}
+ */
 function applicationsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /tokens - get tokens (applications).
+   * @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>}
+   */
   function get({token, jwtToken, headers, query}) {
     return client.get("/tokens", {
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
@@ -8,6 +24,15 @@ function applicationsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /tokens - create a token (application).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - Token payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({data, token, jwtToken, headers}) {
     return client({
       url: "/tokens",

package/src/endpoints/accounts/transport-regulation-settings.js

@@ -2,7 +2,22 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * Factory for transport-regulation-settings (CNRT) API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function }}
+ */
 function transportRegulationSettingsForCNRT({client, internalAuthTokenProvider}) {
+  /**
+   * GET /transport-regulation-settings/cnrt - get CNRT transport regulation settings.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, headers}) {
     return client({
       url: "/transport-regulation-settings/cnrt",
@@ -10,6 +25,15 @@ function transportRegulationSettingsForCNRT({client, internalAuthTokenProvider})
     });
   }
 
+  /**
+   * PUT /transport-regulation-settings/cnrt - update CNRT transport regulation settings.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.transportRegulationSettings - Settings payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, transportRegulationSettings, headers}) {
     return client({
       url: "/transport-regulation-settings/cnrt",

package/src/endpoints/accounts/travellers.js

@@ -1,6 +1,22 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for travellers API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, update: function, remove: function, create: function }}
+ */
 function travellersFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /travellers - list travellers.
+   * @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>}
+   */
   function all({token, jwtToken, query, headers}) {
     return client({
       url: "/travellers",
@@ -9,6 +25,16 @@ function travellersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /travellers/:id - get a traveller.
+   * @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>}
+   */
   function get({token, jwtToken, id, query = {}, headers}) {
     return client({
       url: `/travellers/${id}`,
@@ -18,6 +44,17 @@ function travellersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /travellers/:id - update a traveller.
+   * @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.data - Traveller payload
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, id, data, query = {}, headers}) {
     return client({
       url: `/travellers/${id}`,
@@ -28,6 +65,16 @@ function travellersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /travellers/:id - remove a traveller.
+   * @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>}
+   */
   function remove({token, jwtToken, id, query = {}, headers}) {
     return client({
       url: `/travellers/${id}`,
@@ -37,6 +84,16 @@ function travellersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /travellers - create a traveller.
+   * @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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, query = {}, data, headers}) {
     return client({
       url: "/travellers",

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

@@ -1,6 +1,22 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for trusted-machines API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function, get: function, all: function }}
+ */
 function trustedMachinesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /trusted-machines - create (register) a trusted machine.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - Trusted machine payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, data, headers}) {
     return client({
       url: "/trusted-machines",
@@ -11,6 +27,15 @@ function trustedMachinesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /trusted-machines/:id - get a trusted machine.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Trusted machine id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, id, headers}) {
     return client({
       url: `/trusted-machines/${id}`,
@@ -19,6 +44,15 @@ function trustedMachinesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /trusted-machines - list trusted machines.
+   * @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>}
+   */
   function all({token, jwtToken, query = {}, headers}) {
     return client({
       params: query,

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

@@ -2,7 +2,23 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for twilio-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function }}
+ */
 function twilioSettingsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /twilio-settings - get Twilio settings.
+   * @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>}
+   */
   function get({jwtToken, token, query, headers}) {
     return client({
       url: "/twilio-settings",
@@ -11,6 +27,15 @@ function twilioSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /twilio-settings - update Twilio settings.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.twilioSettings - Settings payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, twilioSettings, headers}) {
     return client({
       url: "/twilio-settings",

package/src/endpoints/accounts/users.js

@@ -1,6 +1,23 @@
+/* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * 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 } }}
+ */
 function usersFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /user/:id - get a user by id (legacy).
+   * @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 get({token, jwtToken, id, headers} = {}) {
     return client({
       url: `/user/${id}`,
@@ -8,6 +25,15 @@ function usersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /users/:id - get a user by id (v2).
+   * @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 getV2({token, jwtToken, id, headers} = {}) {
     return client({
       url: `/users/${id}`,
@@ -15,6 +41,15 @@ function usersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /users - list users.
+   * @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>}
+   */
   function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/users",
@@ -23,6 +58,16 @@ function usersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /users - login (create session).
+   * @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>}
+   */
   function login({token, jwtToken, query = {}, data, headers}) {
     return client({
       url: "/users",
@@ -33,11 +78,30 @@ function usersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
-  // Deprecated. Use login instead.
+  /**
+   * @deprecated Use login instead. POST /users - create user (alias for login).
+   * @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>}
+   */
   function create({token, jwtToken, query = {}, data, headers}) {
     return login({token, jwtToken, query, data, headers});
   }
 
+  /**
+   * PUT /users/:userId - update a user.
+   * @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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, userId, user, headers}) {
     return client({
       url: `/users/${userId}`,
@@ -47,6 +111,15 @@ function usersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /users/import - create or update many users.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Array} opts.users - Array of user objects
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function createOrUpdateMany({token, jwtToken, users, headers}) {
     return client({
       url: "/users/import",
@@ -56,6 +129,15 @@ function usersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /users/impersonate - start impersonation session.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.offlineUserId - Offline user id to impersonate
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function impersonate({token, jwtToken, offlineUserId, headers}) {
     return client({
       url: "/users/impersonate",
@@ -65,6 +147,15 @@ function usersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /users/:userId/mfa - start MFA setup.
+   * @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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function startMfa({token, jwtToken, userId, headers}) {
     return client({
       url: `/users/${userId}/mfa`,
@@ -73,6 +164,16 @@ function usersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /users/:userId/mfa - confirm MFA with TOTP token.
+   * @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 {string} opts.totpToken - TOTP token from authenticator app
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function confirmMfa({token, jwtToken, userId, totpToken, headers}) {
     return client({
       url: `/users/${userId}/mfa`,
@@ -82,6 +183,15 @@ function usersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /users/:userId/mfa - disable MFA for user.
+   * @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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function disableMfa({token, jwtToken, userId, headers}) {
     return client({
       url: `/users/${userId}/mfa`,
@@ -91,12 +201,32 @@ function usersFactory({client, internalAuthTokenProvider}) {
   }
 
   const sequences = {
+    /**
+     * GET /users/:userId/sequences/:sequenceId - get a sequence.
+     * @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 {string} opts.sequenceId - Sequence id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, userId, sequenceId, headers}) {
       return client({
         url: `/users/${userId}/sequences/${sequenceId}`,
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
       });
     },
+    /**
+     * GET /users/:userId/sequences - list sequences for user.
+     * @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.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     all({token, jwtToken, userId, query = {}, headers}) {
       return client({
         url: `/users/${userId}/sequences`,
@@ -104,6 +234,16 @@ function usersFactory({client, internalAuthTokenProvider}) {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
       });
     },
+    /**
+     * POST /users/:userId/sequences - create a sequence.
+     * @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.sequence - Sequence payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create({jwtToken, token, userId, sequence, headers}) {
       return client({
         url: `/users/${userId}/sequences`,
@@ -112,6 +252,17 @@ function usersFactory({client, internalAuthTokenProvider}) {
         data: sequence
       });
     },
+    /**
+     * PUT /users/:userId/sequences/:sequenceId - update a sequence.
+     * @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 {string} opts.sequenceId - Sequence id (ObjectId)
+     * @param {Object} opts.sequence - Sequence payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update({jwtToken, token, userId, sequenceId, sequence, headers}) {
       return client({
         url: `/users/${userId}/sequences/${sequenceId}`,
@@ -120,6 +271,17 @@ function usersFactory({client, internalAuthTokenProvider}) {
         data: sequence
       });
     },
+    /**
+     * PATCH /users/:userId/sequences/:sequenceId - transfer sequence to another user.
+     * @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 {string} opts.sequenceId - Sequence id (ObjectId)
+     * @param {string} opts.newUserId - Target user id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     transfer({jwtToken, token, userId, sequenceId, newUserId, headers}) {
       return client({
         url: `/users/${userId}/sequences/${sequenceId}`,

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

@@ -1,7 +1,23 @@
 /* eslint-disable import/extensions */
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for websales-config API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function }}
+ */
 function websalesConfigFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /websales-config - get websales config (list when no id).
+   * @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>}
+   */
   function get({token, jwtToken, query = {}, headers}) {
     return client({
       params: query,
@@ -10,6 +26,16 @@ function websalesConfigFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /websales-config/:websalesConfigId - update websales config.
+   * @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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, websalesConfigId, websalesConfig, headers}) {
     return client({
       url: `/websales-config/${websalesConfigId}`,

package/src/endpoints/btrzpay/cardpointe.js

@@ -2,7 +2,22 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * Factory for Cardpointe terminals API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, remove: function, readCard: Object, ping: Object }}
+ */
 function cardpointeTerminalsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /cardpointe-terminals - list Cardpointe terminals.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, headers}) {
     return client.get("/cardpointe-terminals", {
       params: {},
@@ -12,6 +27,16 @@ function cardpointeTerminalsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /cardpointe-terminals/:merchantId/:terminalId - remove terminal.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.merchantId - Merchant id
+   * @param {string} opts.terminalId - Terminal id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({token, jwtToken, merchantId, terminalId, headers}) {
     return client({
       url: `/cardpointe-terminals/${merchantId}/${terminalId}`,
@@ -21,12 +46,31 @@ function cardpointeTerminalsFactory({client, internalAuthTokenProvider}) {
   }
 
   const readCard = {
+    /**
+     * GET /cardpointe-terminals/read-card/:readCardResultId - get read card result.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.readCardResultId - Read card result id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, readCardResultId, headers}) {
       return client.get(`/cardpointe-terminals/read-card/${readCardResultId}`, {
         params: {},
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
       });
     },
+    /**
+     * POST /cardpointe-terminals/read-card - create read card.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} opts.readCard - Read card payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
+    // eslint-disable-next-line no-shadow
     create({token, jwtToken, readCard, headers}) {
       return client({
         url: "/cardpointe-terminals/read-card",
@@ -38,6 +82,16 @@ function cardpointeTerminalsFactory({client, internalAuthTokenProvider}) {
   };
 
   const ping = {
+    /**
+     * POST /cardpointe-terminals/ping - create ping.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} opts.ping - Ping payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
+    // eslint-disable-next-line no-shadow
     create({token, jwtToken, ping, headers}) {
       return client({
         url: "/cardpointe-terminals/ping",
@@ -46,8 +100,8 @@ function cardpointeTerminalsFactory({client, internalAuthTokenProvider}) {
         data: {ping}
       });
     }
-  }
-  
+  };
+
 
   return {
     all,