btrz-api-client 8.31.0 → 8.32.0

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

@@ -13,6 +13,7 @@ var _require = require("../endpoints_helpers.js"),
  * @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
@@ -47,12 +48,13 @@ function smsTemplatesFactory(_ref) {
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
@@ -66,13 +68,14 @@ function smsTemplatesFactory(_ref) {
   }
 
   /**
-   * 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(_ref3) {
     var token = _ref3.token,
@@ -96,7 +99,8 @@ function smsTemplatesFactory(_ref) {
    * @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(_ref4) {
     var token = _ref4.token,
@@ -114,13 +118,14 @@ function smsTemplatesFactory(_ref) {
   }
 
   /**
-   * 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(_ref5) {
     var token = _ref5.token,
@@ -137,14 +142,15 @@ function smsTemplatesFactory(_ref) {
   }
 
   /**
-   * 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(_ref6) {
     var token = _ref6.token,
@@ -162,13 +168,14 @@ function smsTemplatesFactory(_ref) {
   }
 
   /**
-   * 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(_ref7) {
     var token = _ref7.token,
@@ -184,14 +191,15 @@ function smsTemplatesFactory(_ref) {
   }
 
   /**
-   * 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(_ref8) {
     var token = _ref8.token,
@@ -210,15 +218,16 @@ function smsTemplatesFactory(_ref) {
 
   var 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: function update(_ref9) {
       var token = _ref9.token,

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

@@ -1,5 +1,6 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
@@ -17,13 +18,14 @@ function subPrintTemplatesFactory(_ref) {
       internalAuthTokenProvider = _ref.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(_ref2) {
     var jwtToken = _ref2.jwtToken,

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

@@ -17,12 +17,13 @@ function ticketMovementSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
@@ -36,13 +37,15 @@ function ticketMovementSettingsFactory(_ref) {
   }
 
   /**
-   * 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(_ref3) {
     var token = _ref3.token,

package/lib/endpoints/accounts/travellers.js

@@ -31,13 +31,14 @@ function travellersFactory(_ref) {
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
@@ -53,13 +54,15 @@ function travellersFactory(_ref) {
   }
 
   /**
-   * 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(_ref3) {
     var token = _ref3.token,
@@ -78,15 +81,16 @@ function travellersFactory(_ref) {
   }
 
   /**
-   * 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(_ref4) {
     var token = _ref4.token,
@@ -107,14 +111,15 @@ function travellersFactory(_ref) {
   }
 
   /**
-   * 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(_ref5) {
     var token = _ref5.token,
@@ -133,14 +138,15 @@ function travellersFactory(_ref) {
   }
 
   /**
-   * 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(_ref6) {
     var token = _ref6.token,

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

@@ -25,13 +25,14 @@ function trustedMachinesFactory(_ref) {
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
@@ -49,13 +50,14 @@ function trustedMachinesFactory(_ref) {
   }
 
   /**
-   * 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(_ref3) {
     var token = _ref3.token,
@@ -71,13 +73,14 @@ function trustedMachinesFactory(_ref) {
   }
 
   /**
-   * 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(_ref4) {
     var token = _ref4.token,

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

@@ -17,12 +17,14 @@ function twilioSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.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(_ref2) {
     var jwtToken = _ref2.jwtToken,
@@ -38,13 +40,14 @@ function twilioSettingsFactory(_ref) {
   }
 
   /**
-   * 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(_ref3) {
     var jwtToken = _ref3.jwtToken,