btrz-api-client 8.30.0 → 8.32.0

package/lib/endpoints/accounts/lexicons.js

@@ -4,6 +4,35 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /lexicons/:lexiconCollectionId (btrz-api-accounts). See get-lexicons handler getSpec().
+ * @typedef {Object} LexiconsListQuery
+ * @property {string} [providerIds] - Provider ids to get lexicons for
+ * @property {string} [context] - Context of the lexicons to search
+ * @property {boolean} [accountOnly] - Filter lexicons only for the given providerIds; context ignored when true
+ * @property {string} [key] - Specific lexicon key to search for
+ * @property {string} [keys] - Comma-separated list of keys to search for
+ * @property {string} [lang] - ISO language code to filter values
+ * @property {string} [langs] - Comma-separated ISO language codes to filter values
+ */
+
+/**
+ * Query params for GET /lexicons/suggestions (btrz-api-accounts). See get-lexicons-suggestions handler getSpec().
+ * @typedef {Object} LexiconSuggestionsListQuery
+ * @property {string} [status] - Filter by status: under review | accepted | rejected
+ * @property {string} [lang] - Filter by language code (e.g. en-us, pt-br)
+ * @property {string} [key] - Filter by lexicon key
+ * @property {string} [superUserId] - Super user id; with superUserHash returns suggestions for all accounts
+ * @property {string} [superUserHash] - Super user hash; with superUserId returns suggestions for all accounts
+ */
+
+/**
+ * Query params for GET /lexicons/suggestions/:id (btrz-api-accounts). See get-lexicons-suggestion-by-id handler getSpec().
+ * @typedef {Object} LexiconSuggestionGetByIdQuery
+ * @property {string} [superUserId] - Super user id; with superUserHash any suggestion can be retrieved
+ * @property {string} [superUserHash] - Super user hash; with superUserId any suggestion can be retrieved
+ */
+
 /**
  * Factory for lexicons API (btrz-api-accounts).
  * @param {Object} deps
@@ -18,13 +47,13 @@ function lexiconsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET lexicons/buscompany - list lexicons for bus company context.
+   * GET /lexicons/buscompany – list account translations from buscompany collection. Query params from get-lexicons getSpec().
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} opts.context - Context (e.g. buscompany)
-   * @param {Object} [opts.query] - Query params
+   * @param {string} [opts.context] - Context of the lexicons to search (merged into query)
+   * @param {LexiconsListQuery} [opts.query] - Query params: providerIds, context, accountOnly, key, keys, lang, langs
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ lexicons: Array }>>}
    */
   function all(_ref2) {
     var token = _ref2.token,
@@ -43,13 +72,13 @@ function lexiconsFactory(_ref) {
   }
 
   /**
-   * POST /lexicons - create lexicon entries.
+   * POST /lexicons – create lexicon entries. Body: { entries }. Requires BETTEREZ_APP audience.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Array} opts.lexiconEntries - Entries to create
+   * @param {Array} opts.lexiconEntries - Entries to create (accountId, name, values, context per item)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ successes: Array, failures: Array }>>}
    */
   function create(_ref3) {
     var token = _ref3.token,
@@ -68,13 +97,13 @@ function lexiconsFactory(_ref) {
   }
 
   /**
-   * PUT /lexicons - create or update many lexicon entries.
+   * PUT /lexicons – create or update many lexicon entries. Body: { entries }. Emits webhook lexicons.updated. Requires BETTEREZ_APP audience.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Array} opts.entries - Entries to create or update
+   * @param {Array} opts.entries - Entries to create or update (key, values per item)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ status: string, entries: Array }>>}
    */
   function createOrUpdateMany(_ref4) {
     var token = _ref4.token,
@@ -95,13 +124,13 @@ function lexiconsFactory(_ref) {
   }
 
   /**
-   * PATCH /lexicons - update many lexicon entries.
+   * PATCH /lexicons – update many lexicon entries. Body: { updates } (key, accountId, values and/or context). Requires BETTEREZ_APP audience.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Array} opts.updates - Updates to apply
+   * @param {Array} opts.updates - Updates to apply (key, accountId, values?, context?)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ entries: Array }>>}
    */
   function updateMany(_ref5) {
     var token = _ref5.token,
@@ -120,14 +149,14 @@ function lexiconsFactory(_ref) {
   }
 
   /**
-   * Search global lexicons (no account) by partial match on the translation value for the given language.
+   * GET /lexicons/:lang/content – search global lexicons (no account) by partial match on translation value. Requires BETTEREZ_APP audience.
    * @param {Object} opts
    * @param {string} opts.lang - Language code (e.g. en-us, pt-br). Must be a supported language.
    * @param {string} opts.txt - Text to search for (partial, case-insensitive). Required.
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT
    * @param {Object} [opts.headers] - Optional request headers
-   * @returns {Promise<{data: { lexiconTextContentItems: Array }}>}
+   * @returns {Promise<import("axios").AxiosResponse<{ lexiconTextContentItems: Array }>>}
    */
   function getByText(_ref6) {
     var token = _ref6.token,
@@ -145,12 +174,12 @@ function lexiconsFactory(_ref) {
 
   var suggestions = {
     /**
-     * List lexicon suggestions for the account (or all accounts when super user params are provided).
+     * GET /lexicons/suggestions - list lexicon suggestions (or all accounts when super user params provided).
      * @param {Object} opts
      * @param {string} [opts.token] - API key (x-api-key)
      * @param {string} [opts.jwtToken] - JWT or constants.INTERNAL_AUTH_TOKEN_SYMBOL for internal auth
      * @param {Object} [opts.headers] - Optional request headers
-     * @param {Object} [opts.params] - Query params: status, lang, key, superUserId, superUserHash
+     * @param {LexiconSuggestionsListQuery} [opts.params] - Query params: status, lang, key, superUserId, superUserHash
      * @returns {Promise<{data: { suggestions: Array }}>}
      */
     list: function list(_ref7) {
@@ -169,13 +198,13 @@ function lexiconsFactory(_ref) {
 
 
     /**
-     * Get a single lexicon suggestion by id.
+     * GET /lexicons/suggestions/:id - get a single lexicon suggestion by id.
      * @param {Object} opts
      * @param {string} opts.suggestionId - MongoDB ObjectId of the suggestion
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {Object} [opts.headers] - Optional request headers
-     * @param {Object} [opts.params] - Query params: superUserId, superUserHash (to access any account's suggestion)
+     * @param {LexiconSuggestionGetByIdQuery} [opts.params] - Query params: superUserId, superUserHash (to access any account's suggestion)
      * @returns {Promise<{data: Object}>}
      */
     getById: function getById(_ref8) {

package/lib/endpoints/accounts/market-pricing-settings.js

@@ -4,7 +4,8 @@ var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Factory for market-pricing-settings API (btrz-api-accounts).
+ * Factory for market-pricing-settings API (btrz-api-accounts). Market pricing configuration (e.g. useOnlySpecificFareTable).
+ * Requires user logged in to backoffice app.
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
@@ -17,12 +18,12 @@ function marketPricingSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /market-pricing-settings - get market pricing settings.
+   * GET /market-pricing-settings – Get market pricing settings for the account.
    * @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<{ marketPricingSettings: { useOnlySpecificFareTable: boolean } }>>}
    */
   function get(_ref2) {
     var token = _ref2.token,
@@ -36,13 +37,13 @@ function marketPricingSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /market-pricing-settings - update market pricing settings.
+   * PUT /market-pricing-settings – Update market pricing settings. Body: MarketPricingSettings at root (useOnlySpecificFareTable required).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.marketPricingSettings - Settings payload
+   * @param {Object} opts.marketPricingSettings - { useOnlySpecificFareTable: boolean }
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ marketPricingSettings: object }>>}
    */
   function update(_ref3) {
     var token = _ref3.token,

package/lib/endpoints/accounts/multiproduct-sales-settings.js

@@ -4,7 +4,8 @@ var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Factory for multiproduct-sales-settings API (btrz-api-accounts).
+ * Factory for multiproduct-sales-settings API (btrz-api-accounts). Multi-product sales settings (product/station/fare/fareClass mappings).
+ * Requires BETTEREZ_APP audience. PUT emits webhooks networks.created or networks.updated.
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
@@ -17,12 +18,12 @@ function multiproductSalesSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /multiproduct-sales-settings - get multiproduct sales settings.
+   * GET /multiproduct-sales-settings – Get multi-product sales settings for the account.
    * @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<{ multiProductSettings: object }>>}
    */
   function get(_ref2) {
     var token = _ref2.token,
@@ -36,13 +37,13 @@ function multiproductSalesSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /multiproduct-sales-settings - update multiproduct sales settings.
+   * PUT /multiproduct-sales-settings – Create or update multi-product sales settings (upsert). Body: MultiProductSettingsPayload (productsMapping, stationsMapping, faresMapping, fareClassesMapping). Emits networks.created or networks.updated.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.data - Settings payload
+   * @param {Object} opts.data - multiProductSettings payload (productsMapping, stationsMapping, faresMapping, fareClassesMapping; each key ObjectId, each value array of ObjectIds)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ multiProductSettings: object }>>}
    */
   function update(_ref3) {
     var token = _ref3.token,

package/lib/endpoints/accounts/network.js

@@ -4,6 +4,13 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /network/agencies (btrz-api-accounts). See get-agencies-handler getSpec().
+ * @typedef {Object} NetworkAgenciesListQuery
+ * @property {string} [name] - Filter by agency/seller name (prefix, case-insensitive)
+ * @property {number} [page] - Page number (1-based)
+ */
+
 /**
  * Factory for network API (btrz-api-accounts).
  * @param {Object} deps
@@ -19,13 +26,14 @@ function networkFactory(_ref) {
 
   var agencies = {
     /**
-     * GET /network/agencies - list agencies.
+     * GET /network/agencies - list agencies (paginated). Query: name, page.
      * @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 {NetworkAgenciesListQuery} [opts.query] - Query params (name, page)
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ agencies: Array, next?: string, previous?: string, count?: number }>>}
+     *   Errors: 401, 500
      */
     all: function all(_ref2) {
       var token = _ref2.token,
@@ -42,35 +50,37 @@ function networkFactory(_ref) {
     },
 
     /**
-     * GET /network/agencies/:sellerId - get an agency by seller id.
+     * GET /network/agencies/:agencyId - get an agency by id.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
-     * @param {string} opts.sellerId - Seller/agency id (ObjectId)
-     * @param {Object} [opts.query] - Query params
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.sellerId - Seller/agency id (ObjectId), path param agencyId
+     * @param {Object} [opts.query] - Optional query params
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ agency: Object }>>}
+     *   Errors: 400 (INVALID_AGENCY_ID), 401, 404 (AGENCY_NOT_FOUND), 500
      */
     get: function get(_ref3) {
       var token = _ref3.token,
+          jwtToken = _ref3.jwtToken,
           query = _ref3.query,
           headers = _ref3.headers,
           sellerId = _ref3.sellerId;
 
       return client({
         url: "/network/agencies/" + sellerId,
-        params: query,
-        headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+        params: query || {},
+        headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
 
     /**
-     * PUT /network/agencies/:sellerId - update an agency.
+     * PUT /network/agencies/:sellerId - update an agency. 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.sellerId - Seller/agency id (ObjectId)
      * @param {Object} opts.agency - Agency payload
-     * @param {Object} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -123,13 +133,14 @@ function networkFactory(_ref) {
     },
 
     /**
-     * PUT /network/agencies/remove-product - remove product from agency.
+     * PUT /network/agencies/remove-product - remove productId from all agencies for the account.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {string} opts.productId - Product id (ObjectId)
+     * @param {string} opts.productId - Product id (non-empty string)
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{}>>}
+     *   Errors: 400 (WRONG_DATA), 401, 500
      */
     removeProduct: function removeProduct(_ref6) {
       var token = _ref6.token,
@@ -150,13 +161,14 @@ function networkFactory(_ref) {
     },
 
     /**
-     * PUT /network/agencies/remove-fare - remove fare from agency.
+     * PUT /network/agencies/remove-fare - remove fareId from all agencies for the account.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {string} opts.fareId - Fare id (ObjectId)
+     * @param {string} opts.fareId - Fare id (non-empty string)
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{}>>}
+     *   Errors: 400 (WRONG_DATA), 401, 500
      */
     removeFare: function removeFare(_ref7) {
       var token = _ref7.token,

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

@@ -4,7 +4,8 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Factory for operation-settings API (btrz-api-accounts).
+ * Factory for operation-settings API (btrz-api-accounts). Operation settings (manifest, schedule, preferences.operations).
+ * Requires BETTEREZ_APP audience. PUT emits webhook operationsettings.updated.
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
@@ -17,13 +18,13 @@ function operationSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /operation-settings - get operation settings.
+   * GET /operation-settings – Get operation settings for the account.
    * @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 (passed to request)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ operationSettings: object }>>}
    */
   function get(_ref2) {
     var token = _ref2.token,
@@ -39,13 +40,13 @@ function operationSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /operation-settings - update operation settings.
+   * PUT /operation-settings – Update operation settings. Body: { operationSettings } (OperationSettingsPutData). Emits operationsettings.updated.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.operationSettings - Settings payload
+   * @param {Object} opts.operationSettings - Operation settings payload (partial or full OperationSettingsPutData)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ operationSettings: object }>>}
    */
   function update(_ref3) {
     var jwtToken = _ref3.jwtToken,

package/lib/endpoints/accounts/people-lookups.js

@@ -2,9 +2,27 @@
 
 var _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; };
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /people-lookups (btrz-api-accounts). Optional filters; when provided only matching people are returned.
+ * @typedef {Object} PeopleLookupsListQuery
+ * @property {string} [dynamicFormId] - If provided, only include this dynamic form's data in response
+ * @property {string} [documentNumber] - Document number to search for
+ * @property {string} [documentTypeId] - Document type id (ObjectId) to search for
+ * @property {string} [email] - Email to search for
+ * @property {string} [customerNumber] - Customer number to search for
+ * @property {string} [phone] - Phone to search for
+ */
+
+/**
+ * Query params for GET /people-lookups/:personId (btrz-api-accounts). See get-by-id-handler getSpec().
+ * @typedef {Object} PeopleLookupGetByIdQuery
+ * @property {string} [dynamicFormId] - If provided, only include this dynamic form's data in response
+ */
+
 /**
  * Factory for people-lookups API (btrz-api-accounts).
  * @param {Object} deps
@@ -19,14 +37,14 @@ function peopleLookupsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /people-lookups - list people lookups.
+   * GET /people-lookups – list people lookups (paginated). Requires BETTEREZ_APP audience.
    * @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 {string} [opts.providerId] - Provider id (ObjectId)
+   * @param {PeopleLookupsListQuery} [opts.query] - Query params (dynamicFormId, documentNumber, documentTypeId, email, customerNumber, phone)
+   * @param {string} [opts.providerId] - Provider id (ObjectId); merged into query for provider context
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ people: object[], totalRecords: number, page?: number, pageSize?: number }>>}
    */
   function all(_ref2) {
     var token = _ref2.token,
@@ -44,15 +62,15 @@ function peopleLookupsFactory(_ref) {
   }
 
   /**
-   * GET /people-lookups/:personId - get a person lookup.
+   * GET /people-lookups/:personId – get a single person lookup by id. Returns 404 if not found. Requires BETTEREZ_APP audience.
    * @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 {string} opts.personId - Person id (ObjectId)
-   * @param {string} [opts.providerId] - Provider id (ObjectId)
+   * @param {string} opts.personId - Person id (24 hex ObjectId)
+   * @param {PeopleLookupGetByIdQuery} [opts.query] - Query params: dynamicFormId
+   * @param {string} [opts.providerId] - Provider id (ObjectId); merged into query for provider context
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ person: object }>>}
    */
   function getById(_ref3) {
     var token = _ref3.token,
@@ -72,15 +90,15 @@ function peopleLookupsFactory(_ref) {
   }
 
   /**
-   * PUT /people-lookups/:personId - update a person lookup.
+   * PUT /people-lookups/:personId – update a person lookup. Emits peopleLookups.updated webhook. Requires BETTEREZ_APP audience.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.personId - Person id (ObjectId)
-   * @param {Object} opts.person - Person payload
-   * @param {string} [opts.providerId] - Provider id (ObjectId)
+   * @param {string} opts.personId - Person id (24 hex ObjectId)
+   * @param {Object} opts.person - Person payload (PeopleLookupPutData: documentTypeId, documentNumber, firstName, lastName, email, phone, dynamicForms, etc.)
+   * @param {string} [opts.providerId] - Provider id (ObjectId); sent as query for provider context
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ person: object }>>}
    */
   function update(_ref4) {
     var jwtToken = _ref4.jwtToken,
@@ -106,14 +124,14 @@ function peopleLookupsFactory(_ref) {
   }
 
   /**
-   * POST /people-lookups - create a person lookup.
+   * POST /people-lookups – create a person lookup. Emits peopleLookups.created webhook. Requires BETTEREZ_APP audience. Body requires documentTypeId and documentNumber.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.person - Person payload
-   * @param {string} [opts.providerId] - Provider id (ObjectId)
+   * @param {Object} opts.person - Person payload (PeopleLookupPostData: documentTypeId, documentNumber required; firstName, lastName, email, phone, dynamicForms, etc.)
+   * @param {string} [opts.providerId] - Provider id (ObjectId); sent as query for provider context
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ person: object }>>}
    */
   function create(_ref5) {
     var jwtToken = _ref5.jwtToken,
@@ -138,13 +156,13 @@ function peopleLookupsFactory(_ref) {
   }
 
   /**
-   * DELETE /people-lookups/:personId - remove a person lookup.
+   * DELETE /people-lookups/:personId – remove a person lookup. Emits peoplelookups.deleted webhook. Returns 404 if person not found. Requires BETTEREZ_APP audience.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.personId - Person id (ObjectId)
+   * @param {string} opts.personId - Person id (24 hex ObjectId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ personId: string }>>}
    */
   function remove(_ref6) {
     var personId = _ref6.personId,

package/lib/endpoints/accounts/point-to-point-settings.js

@@ -4,7 +4,7 @@ var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Factory for point-to-point-settings API (btrz-api-accounts).
+ * Factory for point-to-point-settings API (btrz-api-accounts). Requires user logged in to backoffice app.
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
@@ -17,12 +17,12 @@ function pointToPointSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /point-to-point-settings - get point-to-point settings.
+   * GET /point-to-point-settings – get point-to-point settings for the current account. No 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>}
+   * @returns {Promise<import("axios").AxiosResponse<{ pointToPointSettings: object }>>}
    */
   function get(_ref2) {
     var token = _ref2.token,
@@ -36,13 +36,13 @@ function pointToPointSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /point-to-point-settings - update point-to-point settings.
+   * PUT /point-to-point-settings – update settings. Body: useOnlySpecificFareTable (boolean) required.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.pointToPointSettings - Settings payload
+   * @param {{ useOnlySpecificFareTable: boolean }} opts.pointToPointSettings - Settings payload (useOnlySpecificFareTable required)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ pointToPointSettings: object }>>}
    */
   function update(_ref3) {
     var token = _ref3.token,

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

@@ -17,33 +17,35 @@ function printSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /print-settings - list/get print settings.
+   * GET /print-settings – get print settings for the current account. No query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {Object} [opts.query] - Query params
+   * @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<{ printSettings: object }>>}
    */
   function all(_ref2) {
     var token = _ref2.token,
+        jwtToken = _ref2.jwtToken,
         query = _ref2.query,
         headers = _ref2.headers;
 
     return client({
       url: "/print-settings",
       params: query,
-      headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
     });
   }
 
   /**
-   * PUT /print-settings - update print settings.
+   * PUT /print-settings – update print settings. Emits printsettings.updated webhook. Requires BETTEREZ_APP.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.printSettings - Print settings payload
+   * @param {Object} opts.printSettings - Print settings payload (PrintSettingsPutData)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ printSettings: object }>>}
    */
   function update(_ref3) {
     var jwtToken = _ref3.jwtToken,