btrz-api-client 8.31.0 → 8.33.0

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

@@ -12,6 +12,7 @@ const {
  * @property {string} [sort] - relevance | natural | createdAsc | createdDesc | updatedAsc | updatedDesc
  * @property {string} [templateCollectionId] - default | custom
  * @property {string} [status] - draft | published
+ * @property {string} [agencyId] - Filter sub-templates for this agency (ObjectId)
  * @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
@@ -41,12 +42,13 @@ const {
  */
 function smsTemplatesFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /sms-templates/types - returns available template types. API does not accept query params.
+   * GET /sms-templates/types - returns available template types.
    * @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>}
+   * @returns {Promise<import("axios").AxiosResponse<{ types: string[] }>>}
+   * @throws {import("axios").AxiosError} 401, 500
    */
   function getTypes({token, jwtToken, headers}) {
     return client({
@@ -56,13 +58,14 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /sms-templates - list SMS templates.
+   * GET /sms-templates - list SMS templates (paginated when page is provided).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {SmsTemplatesListQuery} [opts.query] - Query params (providerId, type, channel, sort, etc.)
+   * @param {SmsTemplatesListQuery} [opts.query] - Query params (providerId, type, channel, sort, agencyId, etc.)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ smsTemplates: object[], next?: string, previous?: string, totalRecords?: number, page?: number }>>}
+   * @throws {import("axios").AxiosError} 400 WRONG_DATA, 401, 500
    */
   function all({token, jwtToken, query = {}, headers}) {
     return client({
@@ -80,7 +83,8 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
    * @param {string} opts.smsTemplateId - Template id (ObjectId)
    * @param {SmsTemplateGetByIdQuery} [opts.query] - Query params (providerId, superUserId, superUserHash)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ smsTemplate: object }>>}
+   * @throws {import("axios").AxiosError} 400 INVALID_SMS_TEMPLATE_ID / INVALID_PROVIDER_ID, 401, 404 SMS_TEMPLATE_NOT_FOUND, 500
    */
   function get({token, jwtToken, smsTemplateId, query = {}, headers}) {
     return client({
@@ -91,13 +95,14 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /sms-templates - create an SMS template. API does not accept query params.
+   * POST /sms-templates - create an SMS template. Body: smsTemplate (name, type, lang, txtTemplate required).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.data - Request body
+   * @param {Object} opts.data - Request body (smsTemplate or root with name, type, lang, txtTemplate)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ smsTemplate: object }>>}
+   * @throws {import("axios").AxiosError} 400 WRONG_DATA / TEMPLATE_* / LANG_* / TXT_TEMPLATE_REQUIRED, 401 NOT_SUPER_USER, 500
    */
   function create({token, jwtToken, data, headers}) {
     return client({
@@ -109,14 +114,15 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /sms-templates/:smsTemplateId - update an SMS template. API does not accept query params.
+   * PUT /sms-templates/:smsTemplateId - update an SMS template. Body: smsTemplate (name, type, txtTemplate required; lang read-only).
    * @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 {Object} opts.data - Request body
+   * @param {Object} opts.data - Request body (smsTemplate or root)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ smsTemplate: object }>>}
+   * @throws {import("axios").AxiosError} 400 WRONG_DATA / TEMPLATE_* / TXT_TEMPLATE_REQUIRED, 401 NOT_SUPER_USER, 404 SMS_TEMPLATE_NOT_FOUND, 500
    */
   function update({token, jwtToken, smsTemplateId, data, headers}) {
     return client({
@@ -128,13 +134,14 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /sms-templates/:smsTemplateId - delete an SMS template. API does not accept query params.
+   * DELETE /sms-templates/:smsTemplateId - delete an SMS template.
    * @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 {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ smsTemplateId: string }>>}
+   * @throws {import("axios").AxiosError} 400 SMS_TEMPLATE_ID, 401, 404 SMS_TEMPLATE_NOT_FOUND, 500
    */
   function remove({token, jwtToken, smsTemplateId, headers}) {
     return client({
@@ -145,14 +152,15 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /sub-sms-templates - create a sub SMS template from a main template. API does not accept query params.
+   * POST /sub-sms-templates - create a sub SMS template from a main template.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.mainTemplateId - Main template id (ObjectId)
    * @param {string} opts.agencyId - Agency id (ObjectId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ smsTemplate: object }>>}
+   * @throws {import("axios").AxiosError} 400 WRONG_DATA / MAIN_TEMPLATE_IS_NOT_CUSTOM, 401 MAIN_TEMPLATE_ACCOUNT_MISMATCH / MAIN_TEMPLATE_NOT_FROM_PROVIDER, 404 MAIN_TEMPLATE_NOT_FOUND, 500
    */
   function createSub({token, jwtToken, mainTemplateId, agencyId, headers}) {
     return client({
@@ -165,15 +173,16 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
 
   const versions = {
     /**
-     * PUT /sms-templates/:smsTemplateId/versions/:versionId - roll back sms template to a version.
+     * PUT /sms-templates/:smsTemplateId/versions/:versionId - roll back SMS template to a saved version (versionId = zero-based index).
      * @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 - Zero-based version index (e.g. "0", "1")
-     * @param {SmsTemplateVersionUpdateQuery} [opts.query] - Query params (superUserId, superUserHash)
+     * @param {SmsTemplateVersionUpdateQuery} [opts.query] - Query params (superUserId, superUserHash for default templates)
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ smsTemplate: object }>>}
+     * @throws {import("axios").AxiosError} 400 WRONG_DATA, 401 NOT_SUPER_USER, 404 SMS_TEMPLATE_NOT_FOUND / SMS_TEMPLATE_VERSION_NOT_FOUND, 500
      */
     update({token, jwtToken, smsTemplateId, versionId, query = {}, headers}) {
       return client({

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

@@ -1,3 +1,4 @@
+/* eslint-disable max-len */
 const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
@@ -11,13 +12,14 @@ const {
  */
 function subPrintTemplatesFactory({client, internalAuthTokenProvider}) {
   /**
-   * POST /sub-print-templates - create a sub print template. API does not accept query params.
+   * POST /sub-print-templates - create a sub print template from a main template (body: agencyId, mainTemplateId).
    * @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.subPrintTemplate - Payload with agencyId and mainTemplateId (both ObjectIds)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ printTemplate: object }>>}
+   * @throws {import("axios").AxiosError} 400 WRONG_DATA / MAIN_TEMPLATE_IS_NOT_CUSTOM, 401 MAIN_TEMPLATE_ACCOUNT_MISMATCH / MAIN_TEMPLATE_NOT_FROM_PROVIDER, 404 MAIN_TEMPLATE_NOT_FOUND, 500
    */
   function create({jwtToken, token, subPrintTemplate, headers}) {
     return client({

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

@@ -11,12 +11,13 @@ const {
  */
 function ticketMovementSettingsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /ticket-movement-settings - get ticket movement settings. API does not accept query params.
+   * GET /ticket-movement-settings - get ticket movement settings for the account.
+   * No query or path parameters. See get-handler getSpec() in btrz-api-accounts for response schema.
    * @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>}
+   * @returns {Promise<import("axios").AxiosResponse<Object>>} Response body: ticket movement settings object. Errors: 401, 500
    */
   function get({token, jwtToken, headers}) {
     return client({
@@ -26,13 +27,15 @@ function ticketMovementSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /ticket-movement-settings - update ticket movement settings. API does not accept query params.
+   * PUT /ticket-movement-settings - update ticket movement settings for the account.
+   * Body must include all required fields (see put-handler getSpec() in btrz-api-accounts).
+   * Side effect: persists to account.preferences.ticketMovements.
    * @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.ticketMovementSettings - Full settings payload (see put-handler getSpec())
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<Object>>} Updated settings. Errors: 400, 401, 500
    */
   function update({token, jwtToken, ticketMovementSettings, headers}) {
     return client({

package/src/endpoints/accounts/travellers.js

@@ -23,13 +23,14 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function travellersFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /travellers - list travellers.
+   * GET /travellers - list travellers for the account. See get-handler getSpec() in btrz-api-accounts.
    * @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>}
+   * @returns {Promise<import("axios").AxiosResponse<{ travellers: Array, page?: number, count?: number }>>}
+   *   Errors: 401, 404 (CUSTOMER_NOT_FOUND), 500
    */
   function all({token, jwtToken, query, headers}) {
     return client({
@@ -40,13 +41,15 @@ function travellersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /travellers/:id - get a traveller. API does not accept query params.
+   * GET /travellers/:id - get a traveller by id. See get-by-id-handler getSpec() in btrz-api-accounts.
    * @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] - Optional query params
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ traveller: Object }>>}
+   *   Errors: 400, 401, 404 (TRAVELLER_NOT_FOUND), 500
    */
   function get({token, jwtToken, id, query = {}, headers}) {
     return client({
@@ -58,15 +61,16 @@ function travellersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /travellers/:id - update a traveller.
+   * PUT /travellers/:id - update a traveller. See put-handler getSpec() in btrz-api-accounts.
    * @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.data - Traveller payload (TravellerPutData)
    * @param {TravellerProviderIdsQuery} [opts.query] - Query params (providerIds)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ traveller: Object }>>}
+   *   Errors: 400, 401, 404, 409, 500
    */
   function update({token, jwtToken, id, data, query = {}, headers}) {
     return client({
@@ -79,14 +83,15 @@ function travellersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /travellers/:id - remove a traveller.
+   * DELETE /travellers/:id - remove a traveller. Returns 204 No Content. See delete-handler getSpec().
    * @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>}
+   * @returns {Promise<import("axios").AxiosResponse<void>>}
+   *   Errors: 400, 401, 404 (TRAVELLER_NOT_FOUND), 500
    */
   function remove({token, jwtToken, id, query = {}, headers}) {
     return client({
@@ -98,14 +103,15 @@ function travellersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /travellers - create a traveller.
+   * POST /travellers - create a traveller. Returns 201. See post-handler getSpec() in btrz-api-accounts.
    * @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 {Object} opts.data - Traveller payload (TravellerPostData: customerId, fareId, cards, etc.)
    * @param {TravellerProviderIdsQuery} [opts.query] - Query params (providerIds)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ traveller: Object }>>}
+   *   Errors: 400, 401, 404, 409, 500
    */
   function create({token, jwtToken, query = {}, data, headers}) {
     return client({

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

@@ -17,13 +17,14 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function trustedMachinesFactory({client, internalAuthTokenProvider}) {
   /**
-   * POST /trusted-machines - create (register) a trusted machine. API does not accept query params.
+   * POST /trusted-machines - trust the machine (hideInDocumentation: true in API). Sets cookie via Set-Cookie.
    * @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.data - Body (NewTrustedMachine: expirationDays, browserFingerprint, etc.)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ result: string, trustedMachine: Object }>>}
+   *   Errors: 400, 401, 409, 500
    */
   function create({token, jwtToken, data, headers}) {
     return client({
@@ -36,13 +37,14 @@ function trustedMachinesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /trusted-machines/:id - get a trusted machine. API does not accept query params.
+   * GET /trusted-machines/:id - get a trusted machine by id. See get-by-id-handler getSpec() in btrz-api-accounts.
    * @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>}
+   * @returns {Promise<import("axios").AxiosResponse<{ trustedmachine: Object }>>}
+   *   Errors: 400, 401, 404 (TRUSTED_MACHINE_NOT_FOUND), 500
    */
   function get({token, jwtToken, id, headers}) {
     return client({
@@ -53,13 +55,14 @@ function trustedMachinesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /trusted-machines - list trusted machines.
+   * GET /trusted-machines - list enabled trusted machines for the account. See get-handler getSpec().
    * @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 {TrustedMachinesListQuery} [opts.query] - Query params (userId, page, recordsPerPage max 100)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ trustedmachines: Array }>>}
+   *   Paginated. Errors: 401, 500
    */
   function all({token, jwtToken, query = {}, headers}) {
     return client({

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

@@ -11,12 +11,14 @@ const {
  */
 function twilioSettingsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /twilio-settings - get Twilio settings. API does not accept query params.
+   * GET /twilio-settings - get Twilio settings for the account. See get-handler getSpec() in btrz-api-accounts.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.query] - Optional query params
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ twilioSettings: Object }>>}
+   *   Errors: 401, 404 (TWILIO_SETTINGS_NOT_FOUND), 500
    */
   function get({jwtToken, token, query, headers}) {
     return client({
@@ -27,13 +29,14 @@ function twilioSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /twilio-settings - update Twilio settings. API does not accept query params.
+   * PUT /twilio-settings - update Twilio settings. See put-handler getSpec() in btrz-api-accounts.
    * @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.twilioSettings - Settings payload (TwilioSettingsPayload: enabled, sendingNumber, etc.)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ twilioSettings: Object }>>}
+   *   Errors: 401, 404, 409, 500
    */
   function update({jwtToken, token, twilioSettings, headers}) {
     return client({

package/src/endpoints/accounts/users.js

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

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

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

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

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

package/src/endpoints/coltrane/healthcheck.js

@@ -0,0 +1,28 @@
+/**
+ * Factory for Coltrane healthcheck API (btrz-api-coltrane) — liveness probe.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @returns {{ get: function }}
+ */
+function healthcheckFactory({client}) {
+  /**
+   * GET /healthcheck — liveness probe. Returns 200 with empty body when the service is running. No authentication required.
+   * @param {Object} [opts]
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse<{ data: {} }>>}
+   * @throws {import("axios").AxiosError} 500 Service unhealthy or shutting down
+   */
+  function get({headers} = {}) {
+    return client({
+      url: "/healthcheck",
+      method: "get",
+      headers: headers || {}
+    });
+  }
+
+  return {
+    get
+  };
+}
+
+module.exports = healthcheckFactory;