btrz-api-client 8.29.0 → 8.31.0

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

@@ -1,13 +1,30 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var jwtToken = _ref2.jwtToken,
         token = _ref2.token,

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

@@ -3,10 +3,27 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -18,6 +35,15 @@ function ticketMovementSettingsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,

package/lib/endpoints/accounts/tokens.js

@@ -1,12 +1,37 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -19,6 +44,15 @@ function applicationsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var data = _ref3.data,
         token = _ref3.token,

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

@@ -3,10 +3,27 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -18,6 +35,15 @@ function transportRegulationSettingsForCNRT(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,

package/lib/endpoints/accounts/travellers.js

@@ -1,12 +1,44 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /travellers (btrz-api-accounts). See get-handler getSpec().
+ * @typedef {Object} TravellersListQuery
+ * @property {string} [customerId] - Filter by customer (ObjectId)
+ * @property {number} [page] - Page number (1-based); if omitted results are not paginated
+ * @property {string} [providerIds] - Provider ids for traveller card types
+ */
+
+/**
+ * Query for PUT/DELETE/POST travellers (btrz-api-accounts). See put/delete/post handlers getSpec().
+ * @typedef {Object} TravellerProviderIdsQuery
+ * @property {string} [providerIds] - Provider ids to seek for customer, cards and fares
+ */
+
+/**
+ * Factory for travellers API (btrz-api-accounts).
+ * @param {Object} deps
+ * @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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -20,6 +52,15 @@ function travellersFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -36,6 +77,17 @@ function travellersFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -54,6 +106,16 @@ function travellersFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -70,6 +132,16 @@ function travellersFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,

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

@@ -1,12 +1,38 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /trusted-machines (btrz-api-accounts). See get-handler getSpec().
+ * @typedef {Object} TrustedMachinesListQuery
+ * @property {string} [userId] - Filter by user id (ObjectId)
+ * @property {number} [page] - Page to return
+ * @property {number} [recordsPerPage] - Records per page (max 100)
+ */
+
+/**
+ * Factory for trusted-machines API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function, get: function, all: function }}
+ */
+
+
 function trustedMachinesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -22,6 +48,15 @@ function trustedMachinesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -35,6 +70,15 @@ function trustedMachinesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,

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

@@ -3,10 +3,27 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var jwtToken = _ref2.jwtToken,
         token = _ref2.token,
@@ -20,6 +37,15 @@ function twilioSettingsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var jwtToken = _ref3.jwtToken,
         token = _ref3.token,

package/lib/endpoints/accounts/users.js

@@ -1,12 +1,38 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /users/:userId/sequences (btrz-api-accounts). See get-user-sequences-handler getSpec().
+ * @typedef {Object} UserSequencesListQuery
+ * @property {string} [status] - inUse | notAvailable
+ * @property {boolean} [nextSequenceNumber] - Include next sequence number
+ */
+
+/**
+ * Factory for users API (btrz-api-accounts).
+ * @param {Object} deps
+ * @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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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() {
     var _ref2 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
         token = _ref2.token,
@@ -20,6 +46,15 @@ function usersFactory(_ref) {
     });
   }
 
+  /**
+   * 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() {
     var _ref3 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
         token = _ref3.token,
@@ -33,6 +68,14 @@ function usersFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -47,6 +90,15 @@ function usersFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -64,7 +116,15 @@ function usersFactory(_ref) {
     });
   }
 
-  // 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(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,
@@ -76,6 +136,16 @@ function usersFactory(_ref) {
     return login({ token: token, jwtToken: jwtToken, query: query, data: data, headers: 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(_ref7) {
     var token = _ref7.token,
         jwtToken = _ref7.jwtToken,
@@ -91,6 +161,15 @@ function usersFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref8) {
     var token = _ref8.token,
         jwtToken = _ref8.jwtToken,
@@ -105,6 +184,15 @@ function usersFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref9) {
     var token = _ref9.token,
         jwtToken = _ref9.jwtToken,
@@ -119,6 +207,15 @@ function usersFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref10) {
     var token = _ref10.token,
         jwtToken = _ref10.jwtToken,
@@ -132,6 +229,16 @@ function usersFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref11) {
     var token = _ref11.token,
         jwtToken = _ref11.jwtToken,
@@ -147,6 +254,15 @@ function usersFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref12) {
     var token = _ref12.token,
         jwtToken = _ref12.jwtToken,
@@ -161,6 +277,16 @@ function usersFactory(_ref) {
   }
 
   var 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: function get(_ref13) {
       var token = _ref13.token,
           jwtToken = _ref13.jwtToken,
@@ -173,6 +299,17 @@ function usersFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: 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: function all(_ref14) {
       var token = _ref14.token,
           jwtToken = _ref14.jwtToken,
@@ -187,6 +324,17 @@ function usersFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: 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: function create(_ref15) {
       var jwtToken = _ref15.jwtToken,
           token = _ref15.token,
@@ -201,6 +349,18 @@ function usersFactory(_ref) {
         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: function update(_ref16) {
       var jwtToken = _ref16.jwtToken,
           token = _ref16.token,
@@ -216,6 +376,18 @@ function usersFactory(_ref) {
         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: function transfer(_ref17) {
       var jwtToken = _ref17.jwtToken,
           token = _ref17.token,