btrz-api-client 8.31.0 → 8.33.0

package/lib/endpoints/accounts/exchange-receipts.js

@@ -6,6 +6,7 @@ var _require = require("../endpoints_helpers"),
 
 /**
  * Factory for exchange-receipt-settings API (btrz-api-accounts).
+ * Get or update account exchange receipt settings (CNBV-related fields). Requires BETTEREZ_APP audience.
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
@@ -18,13 +19,15 @@ function exchangeReceiptsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * PUT /exchange-receipt-settings - update exchange receipt settings. API does not accept query params.
+   * PUT /exchange-receipt-settings – Update exchange receipt settings. Requires BETTEREZ_APP JWT.
+   * Body: { exchangeReceipt } or ExchangeReceipt fields at root. All fields must be strings.
+   * Emits exchangeReceipt.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 {string} [opts.jwtToken] - JWT (BETTEREZ_APP audience)
+   * @param {Object} opts.data - Body: { exchangeReceipt } or required ExchangeReceipt fields
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ exchangeReceipt: object }>>}
    */
   function update(_ref2) {
     var data = _ref2.data,
@@ -41,12 +44,13 @@ function exchangeReceiptsFactory(_ref) {
   }
 
   /**
-   * GET /exchange-receipt-settings - get exchange receipt settings. API does not accept query params.
+   * GET /exchange-receipt-settings – Get exchange receipt settings. Requires BETTEREZ_APP JWT.
+   * Returns empty object if not set.
    * @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<{ exchangeReceipt: object }>>}
    */
   function get(_ref3) {
     var token = _ref3.token,

package/lib/endpoints/accounts/external-customers.js

@@ -0,0 +1,50 @@
+"use strict";
+
+/* eslint-disable import/extensions */
+var _require = require("../endpoints_helpers"),
+    authorizationHeaders = _require.authorizationHeaders;
+
+/**
+ * Factory for external-customers API (btrz-api-accounts). Saldo Max (ADO) registration proxy.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ registerSaldoMax: function }}
+ */
+
+
+function externalCustomersFactory(_ref) {
+  var client = _ref.client,
+      internalAuthTokenProvider = _ref.internalAuthTokenProvider;
+
+  /**
+   * POST /external-customers/ado – Register a user with Saldo Max (ADO). Requires BETTEREZ_APP JWT.
+   * Body: SaldoMaxRegistrationRequest at root or { body: SaldoMaxRegistrationRequest }.
+   * Required: firstName, lastName, email, password (Base64), verificationCode, isoCode (2-letter).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT (BETTEREZ_APP audience)
+   * @param {Object} opts.data - Request body (or { body: SaldoMaxRegistrationRequest })
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ code: string }>>}
+   */
+  function registerSaldoMax(_ref2) {
+    var data = _ref2.data,
+        token = _ref2.token,
+        jwtToken = _ref2.jwtToken,
+        headers = _ref2.headers;
+
+    return client({
+      url: "/external-customers/ado",
+      method: "post",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      data: data
+    });
+  }
+
+  return {
+    registerSaldoMax: registerSaldoMax
+  };
+}
+
+module.exports = externalCustomersFactory;

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

@@ -4,7 +4,7 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Factory for goal-settings API (btrz-api-accounts).
+ * Factory for goal-settings API (btrz-api-accounts). Goal API integration settings.
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
@@ -17,12 +17,13 @@ function goalSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /goal-settings - get goal settings. API does not accept query params.
+   * GET /goal-settings – Get goal settings for the account. Requires BETTEREZ_APP JWT.
+   * If user lacks read permission for /admin/integrations/goal, returns 200 with empty goalSettings.
    * @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<{ goalSettings: object }>>}
    */
   function get(_ref2) {
     var token = _ref2.token,
@@ -38,13 +39,14 @@ function goalSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /goal-settings - update goal settings. API does not accept query params.
+   * PUT /goal-settings – Update goal settings. Requires BETTEREZ_APP and update permission for
+   * /admin/integrations/goal. Emits goalsettings.updated. Body: { goalSettings }.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.goalSettings - Settings payload
+   * @param {Object} opts.goalSettings - Required: baseUrl, clientId, clientSecret, pushOnManifestStatus
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ goalSettings: object }>>}
    */
   function update(_ref3) {
     var jwtToken = _ref3.jwtToken,

package/lib/endpoints/accounts/images.js

@@ -5,7 +5,7 @@ var _require = require("./../endpoints_helpers"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Factory for images API (btrz-api-accounts).
+ * Factory for images API (btrz-api-accounts). Account images (url-based). POST/DELETE require BETTEREZ_APP.
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
@@ -18,12 +18,13 @@ function ImagesFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /images - list images. API getSpec() does not define query params.
+   * GET /images – List images for the account (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 for pagination)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ images: object[], totalRecords: number, ... }>>}
    */
   function all(_ref2) {
     var token = _ref2.token,
@@ -40,13 +41,13 @@ function ImagesFactory(_ref) {
   }
 
   /**
-   * GET /images/:imageId - get an image. API does not accept query params.
+   * GET /images/:imageId – Get a single image by id (24 hex ObjectId).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.imageId - Image id (ObjectId)
+   * @param {string} opts.imageId - Image id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ image: object }>>}
    */
   function get(_ref3) {
     var token = _ref3.token,
@@ -64,13 +65,13 @@ function ImagesFactory(_ref) {
   }
 
   /**
-   * POST /images - create an image.
+   * POST /images – Create an image. Requires BETTEREZ_APP JWT. Body: { image } with url required. Emits images.created.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.image - Image payload
+   * @param {string} [opts.jwtToken] - JWT (BETTEREZ_APP audience)
+   * @param {Object} opts.image - { url } (required)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ image: object }>>}
    */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
@@ -91,13 +92,13 @@ function ImagesFactory(_ref) {
   }
 
   /**
-   * DELETE /images/:imageId - remove an image.
+   * DELETE /images/:imageId – Delete an image. Requires BETTEREZ_APP JWT. Emits images.deleted (data: { imageId }).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.imageId - Image id (ObjectId)
+   * @param {string} opts.imageId - Image id (24 hex ObjectId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ imageId: string }>>}
    */
   function remove(_ref5) {
     var imageId = _ref5.imageId,

package/lib/endpoints/accounts/interline.js

@@ -4,7 +4,8 @@ var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * 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]
@@ -18,12 +19,13 @@ function interlineFactory(_ref) {
 
   var 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: function all(_ref2) {
       var token = _ref2.token,
@@ -40,12 +42,12 @@ function interlineFactory(_ref) {
     },
 
     /**
-     * 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: function get(_ref3) {
       var token = _ref3.token,
@@ -58,13 +60,14 @@ function interlineFactory(_ref) {
     },
 
     /**
-     * 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: function create(_ref4) {
       var data = _ref4.data,
@@ -81,14 +84,15 @@ function interlineFactory(_ref) {
     },
 
     /**
-     * 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: function update(_ref5) {
       var invitationId = _ref5.invitationId,
@@ -108,12 +112,13 @@ function interlineFactory(_ref) {
 
   var 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: function all(_ref6) {
       var token = _ref6.token,
@@ -132,12 +137,13 @@ function interlineFactory(_ref) {
 
   var 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: function all(_ref7) {
       var token = _ref7.token,
@@ -156,32 +162,34 @@ function interlineFactory(_ref) {
 
   var 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: function get(_ref8) {
       var token = _ref8.token,
+          jwtToken = _ref8.jwtToken,
           interlineId = _ref8.interlineId,
           headers = _ref8.headers;
 
       return client.get("/interline/" + interlineId + "/network", {
-        headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+        headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: 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: function update(_ref9) {
       var interlineId = _ref9.interlineId,
@@ -205,11 +213,11 @@ function interlineFactory(_ref) {
     providers: providers,
     network: 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/lib/endpoints/accounts/journey-prices-settings.js

@@ -4,7 +4,8 @@ var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * 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]
@@ -17,12 +18,12 @@ function journeyPricesSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
@@ -36,13 +37,14 @@ function journeyPricesSettingsFactory(_ref) {
   }
 
   /**
-   * 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(_ref3) {
     var token = _ref3.token,

package/lib/endpoints/accounts/lexicons.js

@@ -47,13 +47,13 @@ function lexiconsFactory(_ref) {
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
@@ -72,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,
@@ -97,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,
@@ -124,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,
@@ -149,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,

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. 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(_ref2) {
     var token = _ref2.token,
@@ -36,13 +37,13 @@ function marketPricingSettingsFactory(_ref) {
   }
 
   /**
-   * 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(_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. 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(_ref2) {
     var token = _ref2.token,
@@ -36,13 +37,13 @@ function multiproductSalesSettingsFactory(_ref) {
   }
 
   /**
-   * 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(_ref3) {
     var token = _ref3.token,