btrz-api-client 8.30.0 → 8.32.0

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

@@ -5,6 +5,7 @@ var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
+ * Query params for GET /email-templates (btrz-api-accounts). See get-handler getSpec().
  * @typedef {Object} EmailTemplatesListQuery
  * @property {string} [providerId] - Filter by provider account (ObjectId)
  * @property {string} [type] - Filter by template type
@@ -12,11 +13,20 @@ var _require = require("../endpoints_helpers.js"),
  * @property {string} [sort] - relevance | natural | createdAsc | createdDesc | updatedAsc | updatedDesc
  * @property {string} [templateCollectionId] - default | custom
  * @property {string} [status] - draft | published
+ * @property {string} [agencyId] - Filter sub-templates for this agency (ObjectId)
  * @property {string} [mainTemplateAccountId] - Filter by source provider (ObjectId)
  * @property {string} [lang] - ISO language code (e.g. en-us)
  * @property {number} [page] - 1-based page for pagination
  */
 
+/**
+ * Query params for GET /email-templates/:emailTemplateId (btrz-api-accounts). See get-by-id-handler getSpec().
+ * @typedef {Object} EmailTemplateGetByIdQuery
+ * @property {string} [providerId] - Filter by provider; template must belong to this account, current account, or be global (ObjectId)
+ * @property {string} [superUserId] - Super user ID for authentication (ObjectId)
+ * @property {string} [superUserHash] - Super user hash for authentication
+ */
+
 /**
  * @typedef {Object} EmailTemplatePostData
  * @property {string} name - Template name
@@ -92,7 +102,7 @@ function emailTemplatesFactory(_ref) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.emailTemplateId - Template id (ObjectId)
-   * @param {Object} [opts.query] - Optional query params
+   * @param {EmailTemplateGetByIdQuery} [opts.query] - Query params (providerId, superUserId, superUserHash)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse<{ emailTemplate: object }>>}
    */
@@ -189,7 +199,8 @@ function emailTemplatesFactory(_ref) {
    * @param {string} opts.mainTemplateId - Main template id (ObjectId)
    * @param {string} opts.agencyId - Agency id (ObjectId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ emailTemplate: object }>>}
+   * @throws {import("axios").AxiosError} 400 validation (WRONG_DATA, MAIN_TEMPLATE_IS_NOT_CUSTOM), 401 (MAIN_TEMPLATE_ACCOUNT_MISMATCH, MAIN_TEMPLATE_NOT_FROM_PROVIDER), 404 MAIN_TEMPLATE_NOT_FOUND, 500
    */
   function createSub(_ref8) {
     var token = _ref8.token,
@@ -208,15 +219,16 @@ function emailTemplatesFactory(_ref) {
 
   var versions = {
     /**
-     * PUT /email-templates/:emailTemplateId/versions/:versionId - update a template version.
+     * PUT /email-templates/:emailTemplateId/versions/:versionId - roll back template to a saved version (versionId is zero-based index in versions array).
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.emailTemplateId - Template id (ObjectId)
-     * @param {string} opts.versionId - Version id (ObjectId)
-     * @param {Object} [opts.query] - Optional query params
+     * @param {string} opts.versionId - Zero-based version index (e.g. "0", "1")
+     * @param {Object} [opts.query] - Optional query (superUserId, superUserHash for default templates)
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ emailTemplate: object }>>}
+     * @throws {import("axios").AxiosError} 400 WRONG_DATA, 401 NOT_SUPER_USER, 404 EMAIL_TEMPLATE_NOT_FOUND / EMAIL_TEMPLATE_VERSION_NOT_FOUND, 500
      */
     update: function update(_ref9) {
       var token = _ref9.token,

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

@@ -1,11 +1,13 @@
 "use strict";
 
+/* eslint-disable max-len */
 /* eslint-disable import/extensions */
 var _require = require("./../endpoints_helpers"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
  * Factory for exchange-rates API (btrz-api-accounts).
+ * Manage account exchange rates by currency ISO code. GET returns paginated list; POST creates a rate and updates account preferences.
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
@@ -18,14 +20,15 @@ function exchangeRatesFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /exchange-rates/:isoCode - get exchange rates by ISO code.
+   * GET /exchange-rates/:isoCode – List exchange rates for the account filtered by currency ISO code (3 letters).
+   * Response is paginated (exchangeRates array + totalRecords, page, etc.).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.isoCode - Currency ISO code
-   * @param {Object} [opts.query] - Query params
+   * @param {string} opts.isoCode - Currency ISO code (3 uppercase letters, e.g. USD, MXN)
+   * @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<{ exchangeRates: object[], totalRecords: number, ... }>>}
    */
   function allByIsoCode(_ref2) {
     var token = _ref2.token,
@@ -43,13 +46,15 @@ function exchangeRatesFactory(_ref) {
   }
 
   /**
-   * POST /exchange-rates - create an exchange rate.
+   * POST /exchange-rates – Create an exchange rate. Requires BETTEREZ_APP JWT. Currency must be in account preferences and enabled.
+   * Updates account preferences.supportedCurrencies for that currency. Emits exchangeRates.created.
+   * Body: { exchangeRate } or { isoCode, buy, sell }. buy and sell must be > 0.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.data - Exchange rate payload
+   * @param {string} [opts.jwtToken] - JWT (required for BETTEREZ_APP audience)
+   * @param {Object} opts.data - Body: { isoCode, buy, sell } or { exchangeRate: { isoCode, buy, sell } }
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ exchangeRate: object }>>}
    */
   function create(_ref3) {
     var data = _ref3.data,

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.
+   * 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.
+   * 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,13 +17,13 @@ function goalSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /goal-settings - get goal settings.
+   * 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.query] - Query params
    * @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,
@@ -39,13 +39,14 @@ function goalSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /goal-settings - update goal settings.
+   * 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,13 +18,13 @@ function ImagesFactory(_ref) {
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
@@ -41,14 +41,13 @@ function ImagesFactory(_ref) {
   }
 
   /**
-   * 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(_ref3) {
     var token = _ref3.token,
@@ -66,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,
@@ -93,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,13 +19,13 @@ function interlineFactory(_ref) {
 
   var 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: function all(_ref2) {
       var token = _ref2.token,
@@ -41,12 +42,12 @@ function interlineFactory(_ref) {
     },
 
     /**
-     * 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: function get(_ref3) {
       var token = _ref3.token,
@@ -59,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,
@@ -82,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,
@@ -109,13 +112,13 @@ function interlineFactory(_ref) {
 
   var 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: function all(_ref6) {
       var token = _ref6.token,
@@ -134,13 +137,13 @@ function interlineFactory(_ref) {
 
   var 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: function all(_ref7) {
       var token = _ref7.token,
@@ -159,32 +162,34 @@ function interlineFactory(_ref) {
 
   var 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: 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,
@@ -208,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.
+   * 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.
+   * 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,