btrz-api-client 8.29.0 → 8.31.0

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

@@ -1,9 +1,24 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for sub-print-templates API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function }}
+ */
 function subPrintTemplatesFactory({client, internalAuthTokenProvider}) {
-
+  /**
+   * 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
+   * @param {Object} opts.subPrintTemplate - Sub print template payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, subPrintTemplate, headers}) {
     return client({
       url: "/sub-print-templates",

package/src/endpoints/accounts/ticket-movement-settings.js

@@ -2,7 +2,22 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for ticket-movement-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 ticketMovementSettingsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * 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
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, headers}) {
     return client({
       url: "/ticket-movement-settings",
@@ -10,6 +25,15 @@ function ticketMovementSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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
+   * @param {Object} opts.ticketMovementSettings - Settings payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, ticketMovementSettings, headers}) {
     return client({
       url: "/ticket-movement-settings",

package/src/endpoints/accounts/tokens.js

@@ -1,6 +1,29 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+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
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, create: function }}
+ */
 function applicationsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * 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 {TokensGetQuery} [opts.query] - Query params: token (id), type (required)
+   * @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 +31,15 @@ function applicationsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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
+   * @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. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({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. 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.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,36 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+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
+ * @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 {TravellersListQuery} [opts.query] - Query params (customerId, page, providerIds)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query, headers}) {
     return client({
       url: "/travellers",
@@ -9,6 +39,15 @@ function travellersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, id, query = {}, headers}) {
     return client({
       url: `/travellers/${id}`,
@@ -18,6 +57,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 {TravellerProviderIdsQuery} [opts.query] - Query params (providerIds)
+   * @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 +78,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 {TravellerProviderIdsQuery} [opts.query] - Query params (providerIds)
+   * @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 +97,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.data - Traveller payload
+   * @param {TravellerProviderIdsQuery} [opts.query] - Query params (providerIds)
+   * @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,30 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+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
+ * @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. 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.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 +35,15 @@ function trustedMachinesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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
+   * @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 +52,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 {TrustedMachinesListQuery} [opts.query] - Query params (userId, page, recordsPerPage)
+   * @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,22 @@ 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. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({jwtToken, token, query, headers}) {
     return client({
       url: "/twilio-settings",
@@ -11,6 +26,15 @@ function twilioSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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
+   * @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,30 @@
+/* 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
+ * @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). 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 - 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 +32,15 @@ function usersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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
+   * @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 +48,14 @@ function usersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/users",
@@ -23,6 +64,15 @@ 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.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 +83,29 @@ 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.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 +115,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 +133,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 +151,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 +168,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 +187,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 +205,32 @@ function usersFactory({client, internalAuthTokenProvider}) {
   }
 
   const sequences = {
+    /**
+     * 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
+     * @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 {UserSequencesListQuery} [opts.query] - Query params (status, nextSequenceNumber)
+     * @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 +238,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 +256,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 +275,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,30 @@
 /* eslint-disable import/extensions */
-const {authorizationHeaders} = require("./../endpoints_helpers");
+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
+ * @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).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {WebsalesConfigListQuery} [opts.query] - Query params (domain, providerId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, query = {}, headers}) {
     return client({
       params: query,
@@ -10,6 +33,16 @@ function websalesConfigFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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
+   * @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}`,