btrz-api-client 8.30.0 → 8.32.0

package/src/endpoints/accounts/shifts.js

@@ -1,6 +1,42 @@
 /* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /shifts (btrz-api-accounts). See get-shifts handler getSpec().
+ * @typedef {Object} ShiftsListQuery
+ * @property {string} [includeActivity] - 'true'|'false'; default 'true' (include sales activity)
+ * @property {string} [status] - open | closed (ignored if pendingShiftClosure is true)
+ * @property {string} [pendingShiftClosure] - 'true'|'false'; return shifts that need shift closure
+ * @property {string} [locationId] - Filter by location (ObjectId)
+ * @property {string} [providerId] - Provider for payments (ObjectId)
+ * @property {string} [sort] - closedAsc | closedDesc | openedAsc
+ * @property {string} [fromDate] - Start date (YYYY-MM-DD); requires toDate
+ * @property {string} [toDate] - End date (YYYY-MM-DD); requires fromDate
+ */
+
+/**
+ * Query params for GET /shifts/location-closures (btrz-api-accounts). See get-location-closures handler getSpec().
+ * @typedef {Object} LocationClosuresListQuery
+ * @property {string} [sort] - createdAsc | createdDesc | updatedAsc | updatedDesc
+ * @property {number} [page] - Page number
+ * @property {string} [fromDate] - Start date (YYYY-MM-DD); requires toDate
+ * @property {string} [toDate] - End date (YYYY-MM-DD); requires fromDate
+ */
+
+/**
+ * Query params for GET /shifts/:locationId/purchase-limit-payments (btrz-api-accounts). See getSpec().
+ * @typedef {Object} PurchaseLimitPaymentsQuery
+ * @property {string} day - Date of payments (YYYY-MM-DD). Required.
+ */
+
+/**
+ * Query params for GET /shifts/:shiftId/sales-summary (btrz-api-accounts). See get-shift-sales-summary getSpec().
+ * @typedef {Object} ShiftSalesSummaryQuery
+ * @property {string} [type] - 'revenueOperatingCompany' to aggregate by revenue operating company
+ * @property {boolean} [depositable] - Get only depositable payment types
+ * @property {boolean} [paymentsAndRefundsDetails] - Include payments and refunds details per payment type and currency
+ */
+
 /**
  * Factory for shifts API (btrz-api-accounts).
  * @param {Object} deps
@@ -10,13 +46,14 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function shiftsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /shifts - list shifts.
+   * GET /shifts - list shifts for the account. Returns shifts filtered by query params.
+   * See get-shifts handler getSpec() in btrz-api-accounts for full API details.
    * @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 {ShiftsListQuery} [opts.query] - Query params (includeActivity, status, pendingShiftClosure, locationId, providerId, sort, fromDate, toDate)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ shifts: Array }>>} Response body: { shifts }. Errors: 400 (validation), 401, 500
    */
   function all({jwtToken, token, query, headers}) {
     return client.get("/shifts", {
@@ -28,7 +65,7 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /shift/user/:userId - get shift for user.
+   * GET /shift/user/:userId - get shift for user. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.userId - User id (ObjectId)
@@ -42,13 +79,14 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /shifts - create a shift.
+   * POST /shifts - open a shift for a user. Body: PostShiftRequest (stationId, userId, counterNumber).
+   * See post-shift handler getSpec() in btrz-api-accounts for full API details.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.shiftData - Shift payload
+   * @param {Object} opts.shiftData - Shift payload (stationId, userId, counterNumber)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ shift: Object }>>} Response body: { shift }. Errors: 400, 401, 404 (USER_NOT_FOUND, STATION_NOT_FOUND), 409 (SHIFT_ALREADY_OPEN_FOR_USER, USER_WITHOUT_SHIFT_ENABLED), 500
    */
   function create({jwtToken, token, shiftData, headers}) {
     return client({
@@ -62,15 +100,16 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PATCH /shifts/:shiftId - update a shift (operations).
+   * PATCH /shifts/:shiftId - close a shift. Body: PatchShiftRequest (operations array with comment).
+   * See patch-shift handler getSpec() in btrz-api-accounts for full API details.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.shiftId - Shift id (ObjectId)
-   * @param {Object} opts.operations - Operations payload
-   * @param {Object} [opts.query] - Query params
+   * @param {Object} opts.operations - Operations payload (e.g. [{ comment }] for close)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @param {Object} [opts.query] - Optional query params
+   * @returns {Promise<import("axios").AxiosResponse<{ shift: Object }>>} Response body: { shift }. Errors: 401, 404 (SHIFT_NOT_FOUND, USER_NOT_FOUND), 409 (SHIFT_ALREADY_CLOSED, COMMENT_IS_MANDATORY_WHEN_VARIANCE_EXISTS, TOTAL_CHANGED), 500
    */
   function update({jwtToken, token, shiftId, operations, headers, query}) {
     return client({
@@ -157,7 +196,7 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {Object} [opts.query] - Query params
+     * @param {ShiftsListQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -170,7 +209,7 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * GET /shifts/location-closures/:locationClosureId - get a location closure.
+     * GET /shifts/location-closures/:locationClosureId - get a location closure. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -458,7 +497,7 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.locationId - Location id (ObjectId)
-     * @param {Object} [opts.query] - Query params
+     * @param {PurchaseLimitPaymentsQuery} [opts.query] - Query params; day (YYYY-MM-DD) is required
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -478,7 +517,7 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.shiftId - Shift id (ObjectId)
-     * @param {Object} [opts.query] - Query params
+     * @param {ShiftSalesSummaryQuery} [opts.query] - Query params (type, depositable, paymentsAndRefundsDetails)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */

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

@@ -3,6 +3,36 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * Query params for GET /sms-templates (btrz-api-accounts). See get-handler getSpec().
+ * @typedef {Object} SmsTemplatesListQuery
+ * @property {string} [providerId] - Filter by provider account (ObjectId)
+ * @property {string} [type] - Filter by template type
+ * @property {string} [channel] - backoffice | agency-backoffice | websales | agency-websales | any
+ * @property {string} [sort] - relevance | natural | createdAsc | createdDesc | updatedAsc | updatedDesc
+ * @property {string} [templateCollectionId] - default | custom
+ * @property {string} [status] - draft | published
+ * @property {string} [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
+ */
+
+/**
+ * Query params for GET /sms-templates/:smsTemplateId (btrz-api-accounts). See get-by-id-handler getSpec().
+ * @typedef {Object} SmsTemplateGetByIdQuery
+ * @property {string} [providerId] - Filter by provider; template must belong to this account, current, or global (ObjectId)
+ * @property {string} [superUserId] - Super user ID for authentication (ObjectId)
+ * @property {string} [superUserHash] - Super user hash for authentication
+ */
+
+/**
+ * Query params for PUT /sms-templates/:smsTemplateId/versions/:versionId (btrz-api-accounts). See put-version-handler getSpec().
+ * @typedef {Object} SmsTemplateVersionUpdateQuery
+ * @property {string} [superUserId] - Super user ID (ObjectId)
+ * @property {string} [superUserHash] - Super user hash for authentication
+ */
+
 /**
  * Factory for sms-templates API (btrz-api-accounts).
  * @param {Object} deps
@@ -17,7 +47,8 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
    * @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({
@@ -27,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 {Object} [opts.query] - Query params
+   * @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({
@@ -49,9 +81,10 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.smsTemplateId - Template id (ObjectId)
-   * @param {Object} [opts.query] - Optional query params
+   * @param {SmsTemplateGetByIdQuery} [opts.query] - Query params (providerId, superUserId, superUserHash)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @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({
@@ -62,13 +95,14 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /sms-templates - create an SMS template.
+   * 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({
@@ -80,14 +114,15 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /sms-templates/:smsTemplateId - update an SMS template.
+   * 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({
@@ -105,7 +140,8 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
    * @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({
@@ -123,7 +159,8 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
    * @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({
@@ -136,15 +173,16 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
 
   const versions = {
     /**
-     * PUT /sms-templates/:smsTemplateId/versions/:versionId - update a template version.
+     * PUT /sms-templates/:smsTemplateId/versions/:versionId - roll back SMS template to a 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 - Version id (ObjectId)
-     * @param {Object} [opts.query] - Optional query params
+     * @param {string} opts.versionId - Zero-based version index (e.g. "0", "1")
+     * @param {SmsTemplateVersionUpdateQuery} [opts.query] - Query params (superUserId, superUserHash 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.
+   * 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.
+   * 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.
+   * 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/tokens.js

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

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

@@ -11,7 +11,7 @@ const {
  */
 function transportRegulationSettingsForCNRT({client, internalAuthTokenProvider}) {
   /**
-   * GET /transport-regulation-settings/cnrt - get CNRT transport regulation settings.
+   * GET /transport-regulation-settings/cnrt - get CNRT transport regulation settings. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -26,7 +26,7 @@ function transportRegulationSettingsForCNRT({client, internalAuthTokenProvider})
   }
 
   /**
-   * PUT /transport-regulation-settings/cnrt - update CNRT transport regulation settings.
+   * PUT /transport-regulation-settings/cnrt - update CNRT transport regulation settings. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/src/endpoints/accounts/travellers.js

@@ -1,5 +1,19 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /travellers (btrz-api-accounts). See get-handler getSpec().
+ * @typedef {Object} TravellersListQuery
+ * @property {string} [customerId] - Filter by customer (ObjectId)
+ * @property {number} [page] - Page number (1-based); if omitted results are not paginated
+ * @property {string} [providerIds] - Provider ids for traveller card types
+ */
+
+/**
+ * Query for PUT/DELETE/POST travellers (btrz-api-accounts). See put/delete/post handlers getSpec().
+ * @typedef {Object} TravellerProviderIdsQuery
+ * @property {string} [providerIds] - Provider ids to seek for customer, cards and fares
+ */
+
 /**
  * Factory for travellers API (btrz-api-accounts).
  * @param {Object} deps
@@ -9,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 {Object} [opts.query] - Query params
+   * @param {TravellersListQuery} [opts.query] - Query params (customerId, page, providerIds)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @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({
@@ -26,14 +41,15 @@ function travellersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /travellers/:id - get a traveller.
+   * 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] - Query params
+   * @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({
@@ -45,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.query] - Query params
+   * @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({
@@ -66,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 {Object} [opts.query] - Query params
+   * @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({
@@ -85,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.query] - Query params
-   * @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

@@ -1,5 +1,13 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /trusted-machines (btrz-api-accounts). See get-handler getSpec().
+ * @typedef {Object} TrustedMachinesListQuery
+ * @property {string} [userId] - Filter by user id (ObjectId)
+ * @property {number} [page] - Page to return
+ * @property {number} [recordsPerPage] - Records per page (max 100)
+ */
+
 /**
  * Factory for trusted-machines API (btrz-api-accounts).
  * @param {Object} deps
@@ -9,13 +17,14 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function trustedMachinesFactory({client, internalAuthTokenProvider}) {
   /**
-   * POST /trusted-machines - create (register) a trusted machine.
+   * 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({
@@ -28,13 +37,14 @@ function trustedMachinesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /trusted-machines/:id - get a trusted machine.
+   * 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({
@@ -45,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 {Object} [opts.query] - Query params
+   * @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,13 +11,14 @@ const {
  */
 function twilioSettingsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /twilio-settings - get Twilio settings.
+   * 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] - Query params
+   * @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({
@@ -28,13 +29,14 @@ function twilioSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /twilio-settings - update Twilio settings.
+   * 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({