btrz-api-client 8.30.0 → 8.32.0

package/src/endpoints/accounts/images.js

@@ -2,7 +2,7 @@
 const {authorizationHeaders} = require("./../endpoints_helpers");
 
 /**
- * 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]
@@ -10,13 +10,13 @@ const {authorizationHeaders} = require("./../endpoints_helpers");
  */
 function ImagesFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /images - list images.
+   * 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] - Query params
+   * @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({token, jwtToken, query = {}, headers}) {
     return client({
@@ -27,14 +27,13 @@ function ImagesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /images/:imageId - get an image.
+   * 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 {Object} [opts.query] - Query params
-   * @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({token, jwtToken, query = {}, headers, imageId}) {
     return client({
@@ -45,13 +44,13 @@ function ImagesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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({jwtToken, token, image, headers}) {
     return client({
@@ -67,13 +66,13 @@ function ImagesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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({imageId, token, jwtToken, headers}) {
     return client({

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,13 +13,13 @@ const {
 function interlineFactory({client, internalAuthTokenProvider}) {
   const invitations = {
     /**
-     * GET /interline/invitations - list interline invitations.
+     * 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] - Query params
+     * @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({
@@ -28,12 +29,12 @@ function interlineFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * GET /interline/invitations/:invitationId - get an invitation.
+     * 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}`, {
@@ -41,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({
@@ -58,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({
@@ -79,13 +82,13 @@ function interlineFactory({client, internalAuthTokenProvider}) {
 
   const consumers = {
     /**
-     * GET /interline/consumers - list interline consumers.
+     * 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] - Query params
+     * @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({
@@ -98,13 +101,13 @@ function interlineFactory({client, internalAuthTokenProvider}) {
 
   const providers = {
     /**
-     * GET /interline/providers - list interline providers.
+     * 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] - Query params
+     * @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({
@@ -117,27 +120,28 @@ function interlineFactory({client, internalAuthTokenProvider}) {
 
   const network = {
     /**
-     * GET /interline/:interlineId/network - get interline network.
+     * 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({
@@ -155,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.
+   * 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.
+   * 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

@@ -3,6 +3,35 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * 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
@@ -14,13 +43,13 @@ function lexiconsFactory({
   client, 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({
     token,
@@ -38,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,
@@ -63,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,
@@ -90,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,
@@ -115,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({
@@ -134,12 +163,12 @@ function lexiconsFactory({
 
   const 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({token, jwtToken, headers, params = {}}) {
@@ -151,13 +180,13 @@ function lexiconsFactory({
     },
 
     /**
-     * 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({token, jwtToken, headers, suggestionId, params = {}}) {

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.
+   * 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.
+   * 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.
+   * 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.
+   * 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,13 +20,14 @@ const {
 function networkFactory({client, internalAuthTokenProvider}) {
   const 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({token, jwtToken, query = {}, headers}) {
       return client({
@@ -29,29 +37,30 @@ function networkFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * 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({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})
       });
     },
     /**
-     * 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>}
      */
@@ -90,13 +99,14 @@ function networkFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * 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({token, jwtToken, productId, headers}) {
       return client({
@@ -111,13 +121,14 @@ function networkFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * 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({token, jwtToken, fareId, headers}) {
       return client({