btrz-api-client 8.31.0 → 8.32.0

package/src/endpoints/accounts/interline.js

@@ -3,7 +3,8 @@ const {
 } = require("../endpoints_helpers.js");
 
 /**
- * Factory for interline API (btrz-api-accounts).
+ * Factory for interline API (btrz-api-accounts). Interline invitations, consumers, providers, network.
+ * POST/PUT/DELETE require BETTEREZ_APP.
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
@@ -12,12 +13,13 @@ const {
 function interlineFactory({client, internalAuthTokenProvider}) {
   const invitations = {
     /**
-     * GET /interline/invitations - list interline invitations. API does not accept query params.
+     * GET /interline/invitations – List interline invitations (paginated). Query: page.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} [opts.query] - Optional query (e.g. page)
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ invitations: object[], totalRecords: number, ... }>>}
      */
     all({token, jwtToken, query = {}, headers}) {
       return client({
@@ -27,12 +29,12 @@ function interlineFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * GET /interline/invitations/:invitationId - get an invitation. API does not accept query params.
+     * GET /interline/invitations/:invitationId – Get a single invitation by id (24 hex ObjectId).
      * @param {Object} opts
      * @param {string} [opts.token] - API key
-     * @param {string} opts.invitationId - Invitation id (ObjectId)
+     * @param {string} opts.invitationId - Invitation id (24 hex characters)
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ invitation: object }>>}
      */
     get({token, invitationId, headers}) {
       return client.get(`/interline/invitations/${invitationId}`, {
@@ -40,13 +42,14 @@ function interlineFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * POST /interline/invitations - create an invitation.
+     * POST /interline/invitations – Create an invitation. Requires BETTEREZ_APP JWT. Emits interlineinvitation.created.
+     * Body: { interline } or InterlineInvitationPost at root.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
-     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} [opts.jwtToken] - JWT (BETTEREZ_APP audience)
      * @param {Object} opts.data - Invitation payload
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ invitation: object }>>}
      */
     create({data, token, jwtToken, headers}) {
       return client({
@@ -57,14 +60,15 @@ function interlineFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /interline/invitations/:invitationId - update an invitation.
+     * PUT /interline/invitations/:invitationId – Update invitation (e.g. accept/reject). Requires BETTEREZ_APP.
+     * Emits interlineinvitation.updated.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {string} opts.invitationId - Invitation id (ObjectId)
-     * @param {Object} opts.data - Invitation payload
+     * @param {string} opts.invitationId - Invitation id (24 hex ObjectId)
+     * @param {Object} opts.data - Body (InterlineInvitePutData)
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ invitation: object }>>}
      */
     update({invitationId, data, token, jwtToken, headers}) {
       return client({
@@ -78,12 +82,13 @@ function interlineFactory({client, internalAuthTokenProvider}) {
 
   const consumers = {
     /**
-     * GET /interline/consumers - list interline consumers. API does not accept query params.
+     * GET /interline/consumers – List interline consumers (paginated). Query: page.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} [opts.query] - Optional query (e.g. page)
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ consumers: object[], totalRecords: number, ... }>>}
      */
     all({token, jwtToken, query = {}, headers}) {
       return client({
@@ -96,12 +101,13 @@ function interlineFactory({client, internalAuthTokenProvider}) {
 
   const providers = {
     /**
-     * GET /interline/providers - list interline providers. API does not accept query params.
+     * GET /interline/providers – List interline providers (paginated). Query: page.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} [opts.query] - Optional query (e.g. page)
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ providers: object[], totalRecords: number, ... }>>}
      */
     all({token, jwtToken, query = {}, headers}) {
       return client({
@@ -114,27 +120,28 @@ function interlineFactory({client, internalAuthTokenProvider}) {
 
   const network = {
     /**
-     * GET /interline/:interlineId/network - get interline network. API does not accept query params.
+     * GET /interline/:interlineId/network – Get interline network by interline id (24 hex ObjectId).
      * @param {Object} opts
      * @param {string} [opts.token] - API key
-     * @param {string} opts.interlineId - Interline id (ObjectId)
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.interlineId - Interline id (24 hex ObjectId)
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ network: object }>>}
      */
-    get({token, interlineId, headers}) {
+    get({token, jwtToken, interlineId, headers}) {
       return client.get(`/interline/${interlineId}/network`, {
-        headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
+        headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
       });
     },
     /**
-     * PUT /interline/:interlineId/network - update interline network.
+     * PUT /interline/:interlineId/network – Update interline network. Requires BETTEREZ_APP. Emits interlinenetwork.updated.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {string} opts.interlineId - Interline id (ObjectId)
-     * @param {Object} opts.data - Network payload
+     * @param {string} opts.interlineId - Interline id (24 hex ObjectId)
+     * @param {Object} opts.data - Network payload (InterlinePutData)
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ network: object }>>}
      */
     update({interlineId, data, token, jwtToken, headers}) {
       return client({
@@ -152,11 +159,11 @@ function interlineFactory({client, internalAuthTokenProvider}) {
     providers,
     network,
     /**
-     * DELETE /interline/:interlineId - remove an interline.
+     * DELETE /interline/:interlineId – Remove an interline. Requires BETTEREZ_APP. Emits interlinenetwork.deleted.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {string} opts.interlineId - Interline id (ObjectId)
+     * @param {string} opts.interlineId - Interline id (24 hex ObjectId)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */

package/src/endpoints/accounts/journey-prices-settings.js

@@ -3,7 +3,8 @@ const {
 } = require("../endpoints_helpers.js");
 
 /**
- * Factory for journey-prices-settings API (btrz-api-accounts).
+ * Factory for journey-prices-settings API (btrz-api-accounts). Journey pricing settings (record protection rules, pricing parameters).
+ * Requires user logged in to backoffice app.
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
@@ -11,12 +12,12 @@ const {
  */
 function journeyPricesSettingsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /journey-prices-settings - get journey prices settings. API does not accept query params.
+   * GET /journey-prices-settings – Get journey prices 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<{ journeyPricesSettings: object }>>}
    */
   function get({token, jwtToken, headers}) {
     return client({
@@ -26,13 +27,14 @@ function journeyPricesSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /journey-prices-settings - update journey prices settings. API does not accept query params.
+   * PUT /journey-prices-settings – Update journey prices settings. Body: JourneyPricesSettings at root.
+   * Required: recordProtectionRules. Optional: pricingParameters, allowEachTripSegmentToBePricedIndividually.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.journeyPricesSettings - Settings payload
+   * @param {Object} opts.journeyPricesSettings - { recordProtectionRules, pricingParameters?, allowEachTripSegmentToBePricedIndividually? }
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ journeyPricesSettings: object }>>}
    */
   function update({token, jwtToken, journeyPricesSettings, headers}) {
     return client({

package/src/endpoints/accounts/lexicons.js

@@ -43,13 +43,13 @@ function lexiconsFactory({
   client, internalAuthTokenProvider
 }) {
   /**
-   * GET /lexicons/buscompany - list lexicons (collection buscompany). Query params from get-lexicons getSpec().
+   * 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 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({
     token,
@@ -67,13 +67,13 @@ function lexiconsFactory({
   }
 
   /**
-   * 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({
     token,
@@ -92,13 +92,13 @@ function lexiconsFactory({
   }
 
   /**
-   * 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({
     token,
@@ -119,13 +119,13 @@ function lexiconsFactory({
   }
 
   /**
-   * 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({
     token,
@@ -144,14 +144,14 @@ function lexiconsFactory({
   }
 
   /**
-   * 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({token, jwtToken, headers, lang, txt}) {
     return client({

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

@@ -3,7 +3,8 @@ const {
 } = require("../endpoints_helpers.js");
 
 /**
- * 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]
@@ -11,12 +12,12 @@ const {
  */
 function marketPricingSettingsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /market-pricing-settings - get market pricing settings. API does not accept query params.
+   * 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({token, jwtToken, headers}) {
     return client({
@@ -26,13 +27,13 @@ function marketPricingSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /market-pricing-settings - update market pricing settings. API does not accept query params.
+   * 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({token, jwtToken, marketPricingSettings, headers}) {
     return client({

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

@@ -3,7 +3,8 @@ const {
 } = require("../endpoints_helpers.js");
 
 /**
- * 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]
@@ -11,12 +12,12 @@ const {
  */
 function multiproductSalesSettingsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /multiproduct-sales-settings - get multiproduct sales settings. API does not accept query params.
+   * 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({token, jwtToken, headers}) {
     return client({
@@ -26,13 +27,13 @@ function multiproductSalesSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /multiproduct-sales-settings - update multiproduct sales settings. API does not accept query params.
+   * 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({token, jwtToken, data, headers}) {
     return client({

package/src/endpoints/accounts/network.js

@@ -3,6 +3,13 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * 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
@@ -13,12 +20,14 @@ const {
 function networkFactory({client, internalAuthTokenProvider}) {
   const agencies = {
     /**
-     * GET /network/agencies - list agencies. API getSpec() does not define query params.
+     * 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 {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({token, jwtToken, query = {}, headers}) {
       return client({
@@ -28,18 +37,21 @@ function networkFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * GET /network/agencies/:agencyId - get an agency by id. API does not accept query params.
+     * 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), maps to path agencyId
+     * @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({token, query, headers, sellerId}) {
+    get({token, jwtToken, query, headers, sellerId}) {
       return client({
         url: `/network/agencies/${sellerId}`,
-        params: query,
-        headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
+        params: query || {},
+        headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
       });
     },
     /**
@@ -87,13 +99,14 @@ function networkFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /network/agencies/remove-product - remove product from agency. API does not accept query params.
+     * 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({token, jwtToken, productId, headers}) {
       return client({
@@ -108,13 +121,14 @@ function networkFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /network/agencies/remove-fare - remove fare from agency. API does not accept query params.
+     * 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({token, jwtToken, fareId, headers}) {
       return client({

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

@@ -3,7 +3,8 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
- * 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]
@@ -11,12 +12,13 @@ const {
  */
 function operationSettingsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /operation-settings - get operation settings. API does not accept query params.
+   * 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] - 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({token, jwtToken, query, headers}) {
     return client({
@@ -27,13 +29,13 @@ function operationSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /operation-settings - update operation settings. API does not accept query params.
+   * 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({jwtToken, token, operationSettings, headers}) {
     return client({

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

@@ -4,11 +4,11 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
- * Query params for GET /people-lookups (btrz-api-accounts). See get-handler getSpec().
+ * 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 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
@@ -29,14 +29,14 @@ const {
  */
 function peopleLookupsFactory({client, 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 {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({token, jwtToken, query, headers, providerId}) {
     const query_ = providerId ? {...query, providerId} : query;
@@ -48,15 +48,15 @@ function peopleLookupsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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 {string} opts.personId - Person 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({token, jwtToken, query, headers, personId, providerId}) {
     const query_ = providerId ? {...query, providerId} : query;
@@ -69,15 +69,15 @@ function peopleLookupsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /people-lookups/:personId - update a person lookup. API getSpec() does not define query params.
+   * 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.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({jwtToken, token, personId, person, headers, providerId}) {
     const query = providerId ? {providerId} : {};
@@ -96,14 +96,14 @@ function peopleLookupsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /people-lookups - create a person lookup. API getSpec() does not define query params.
+   * 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 {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({jwtToken, token, person, headers, providerId}) {
     const query = providerId ? {providerId} : {};
@@ -122,13 +122,13 @@ function peopleLookupsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /people-lookups/:personId - remove a person lookup. API does not accept query params.
+   * 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({personId, token, jwtToken, headers}) {
     return client({