btrz-api-client 8.28.0 → 8.30.0

package/src/endpoints/accounts/interline.js

@@ -2,8 +2,24 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * Factory for interline API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ invitations: object, consumers: object, providers: object, network: object, remove: function }}
+ */
 function interlineFactory({client, internalAuthTokenProvider}) {
   const invitations = {
+    /**
+     * GET /interline/invitations - list interline invitations.
+     * @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>}
+     */
     all({token, jwtToken, query = {}, headers}) {
       return client({
         url: "/interline/invitations",
@@ -11,11 +27,28 @@ function interlineFactory({client, internalAuthTokenProvider}) {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
       });
     },
+    /**
+     * GET /interline/invitations/:invitationId - get an invitation.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} opts.invitationId - Invitation id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, invitationId, headers}) {
       return client.get(`/interline/invitations/${invitationId}`, {
         headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
       });
     },
+    /**
+     * POST /interline/invitations - create an invitation.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} opts.data - Invitation payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create({data, token, jwtToken, headers}) {
       return client({
         url: "/interline/invitations",
@@ -24,6 +57,16 @@ function interlineFactory({client, internalAuthTokenProvider}) {
         data
       });
     },
+    /**
+     * PUT /interline/invitations/:invitationId - update an invitation.
+     * @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 {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update({invitationId, data, token, jwtToken, headers}) {
       return client({
         url: `/interline/invitations/${invitationId}`,
@@ -35,6 +78,15 @@ function interlineFactory({client, internalAuthTokenProvider}) {
   };
 
   const consumers = {
+    /**
+     * GET /interline/consumers - list interline consumers.
+     * @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>}
+     */
     all({token, jwtToken, query = {}, headers}) {
       return client({
         url: "/interline/consumers",
@@ -45,6 +97,15 @@ function interlineFactory({client, internalAuthTokenProvider}) {
   };
 
   const providers = {
+    /**
+     * GET /interline/providers - list interline providers.
+     * @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>}
+     */
     all({token, jwtToken, query = {}, headers}) {
       return client({
         url: "/interline/providers",
@@ -55,11 +116,29 @@ function interlineFactory({client, internalAuthTokenProvider}) {
   };
 
   const network = {
+    /**
+     * GET /interline/:interlineId/network - get interline network.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} opts.interlineId - Interline id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, interlineId, headers}) {
       return client.get(`/interline/${interlineId}/network`, {
         headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
       });
     },
+    /**
+     * PUT /interline/:interlineId/network - update interline network.
+     * @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 {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update({interlineId, data, token, jwtToken, headers}) {
       return client({
         url: `/interline/${interlineId}/network`,
@@ -75,6 +154,15 @@ function interlineFactory({client, internalAuthTokenProvider}) {
     consumers,
     providers,
     network,
+    /**
+     * DELETE /interline/:interlineId - remove an interline.
+     * @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.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     remove({interlineId, token, jwtToken, headers}) {
       return client({
         url: `/interline/${interlineId}`,

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

@@ -2,7 +2,22 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * Factory for journey-prices-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function }}
+ */
 function journeyPricesSettingsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /journey-prices-settings - get journey prices settings.
+   * @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>}
+   */
   function get({token, jwtToken, headers}) {
     return client({
       url: "/journey-prices-settings",
@@ -10,6 +25,15 @@ function journeyPricesSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /journey-prices-settings - update journey prices settings.
+   * @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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, journeyPricesSettings, headers}) {
     return client({
       url: "/journey-prices-settings",

package/src/endpoints/accounts/lexicons.js

@@ -1,10 +1,27 @@
+/* eslint-disable max-len */
 const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for lexicons API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function, createOrUpdateMany: function, updateMany: function, getByText: function, suggestions: { list: function, getById: function, update: function, delete: function, create: function } }}
+ */
 function lexiconsFactory({
   client, internalAuthTokenProvider
 }) {
+  /**
+   * GET lexicons/buscompany - list lexicons for bus company context.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.context - Context (e.g. buscompany)
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     context,
@@ -20,6 +37,15 @@ function lexiconsFactory({
     });
   }
 
+  /**
+   * POST /lexicons - create lexicon entries.
+   * @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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({
     token,
     jwtToken,
@@ -36,6 +62,15 @@ function lexiconsFactory({
     });
   }
 
+  /**
+   * PUT /lexicons - create or update many lexicon entries.
+   * @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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function createOrUpdateMany({
     token,
     jwtToken,
@@ -54,6 +89,15 @@ function lexiconsFactory({
     });
   }
 
+  /**
+   * PATCH /lexicons - update many lexicon entries.
+   * @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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function updateMany({
     token,
     jwtToken,

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

@@ -2,7 +2,22 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * Factory for market-pricing-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function }}
+ */
 function marketPricingSettingsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /market-pricing-settings - get market pricing settings.
+   * @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>}
+   */
   function get({token, jwtToken, headers}) {
     return client({
       url: "/market-pricing-settings",
@@ -10,6 +25,15 @@ function marketPricingSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /market-pricing-settings - update market pricing settings.
+   * @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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, marketPricingSettings, headers}) {
     return client({
       url: "/market-pricing-settings",

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

@@ -2,7 +2,22 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * Factory for multiproduct-sales-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function }}
+ */
 function multiproductSalesSettingsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /multiproduct-sales-settings - get multiproduct sales settings.
+   * @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>}
+   */
   function get({token, jwtToken, headers}) {
     return client({
       url: "/multiproduct-sales-settings",
@@ -10,6 +25,15 @@ function multiproductSalesSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /multiproduct-sales-settings - update multiproduct sales settings.
+   * @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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, data, headers}) {
     return client({
       url: "/multiproduct-sales-settings",

package/src/endpoints/accounts/network.js

@@ -1,9 +1,26 @@
+/* eslint-disable max-len */
 const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * Factory for network API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ agencies: { all: function, get: function, update: function, create: function, removeProduct: function, removeFare: function } }}
+ */
 function networkFactory({client, internalAuthTokenProvider}) {
   const agencies = {
+    /**
+     * GET /network/agencies - list agencies.
+     * @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>}
+     */
     all({token, jwtToken, query = {}, headers}) {
       return client({
         url: "/network/agencies",
@@ -11,6 +28,15 @@ function networkFactory({client, internalAuthTokenProvider}) {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
       });
     },
+    /**
+     * GET /network/agencies/:sellerId - get an agency by seller 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 {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, query, headers, sellerId}) {
       return client({
         url: `/network/agencies/${sellerId}`,
@@ -18,6 +44,17 @@ function networkFactory({client, internalAuthTokenProvider}) {
         headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
       });
     },
+    /**
+     * PUT /network/agencies/:sellerId - update an agency.
+     * @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>}
+     */
     update({jwtToken, token, sellerId, agency, headers, query}) {
       return client({
         url: `/network/agencies/${sellerId}`,
@@ -31,6 +68,15 @@ function networkFactory({client, internalAuthTokenProvider}) {
         params: query
       });
     },
+    /**
+     * POST /network/agencies - create an agency.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} opts.agency - Agency payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create({jwtToken, token, agency, headers}) {
       return client({
         url: "/network/agencies",
@@ -43,6 +89,15 @@ function networkFactory({client, internalAuthTokenProvider}) {
         }
       });
     },
+    /**
+     * PUT /network/agencies/remove-product - remove product from agency.
+     * @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 {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     removeProduct({token, jwtToken, productId, headers}) {
       return client({
         url: "/network/agencies/remove-product",
@@ -55,6 +110,15 @@ function networkFactory({client, internalAuthTokenProvider}) {
         }
       });
     },
+    /**
+     * PUT /network/agencies/remove-fare - remove fare from agency.
+     * @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 {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     removeFare({token, jwtToken, fareId, headers}) {
       return client({
         url: "/network/agencies/remove-fare",

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

@@ -2,7 +2,23 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for operation-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function }}
+ */
 function operationSettingsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /operation-settings - get operation settings.
+   * @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>}
+   */
   function get({token, jwtToken, query, headers}) {
     return client({
       url: "/operation-settings",
@@ -11,6 +27,15 @@ function operationSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /operation-settings - update operation settings.
+   * @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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, operationSettings, headers}) {
     return client({
       url: "/operation-settings",

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

@@ -2,7 +2,24 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for people-lookups API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, getById: function, update: function, create: function, remove: function }}
+ */
 function peopleLookupsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /people-lookups - list people lookups.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.query] - Query params
+   * @param {string} [opts.providerId] - Provider id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query, headers, providerId}) {
     const query_ = providerId ? {...query, providerId} : query;
     return client({
@@ -12,6 +29,17 @@ function peopleLookupsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /people-lookups/:personId - get a person lookup.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.query] - Query params
+   * @param {string} opts.personId - Person id (ObjectId)
+   * @param {string} [opts.providerId] - Provider id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getById({token, jwtToken, query, headers, personId, providerId}) {
     const query_ = providerId ? {...query, providerId} : query;
 
@@ -22,6 +50,17 @@ function peopleLookupsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /people-lookups/:personId - update a person lookup.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.personId - Person id (ObjectId)
+   * @param {Object} opts.person - Person payload
+   * @param {string} [opts.providerId] - Provider id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, personId, person, headers, providerId}) {
     const query = providerId ? {providerId} : {};
 
@@ -38,6 +77,16 @@ function peopleLookupsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /people-lookups - create a person lookup.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.person - Person payload
+   * @param {string} [opts.providerId] - Provider id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, person, headers, providerId}) {
     const query = providerId ? {providerId} : {};
 
@@ -54,6 +103,15 @@ function peopleLookupsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /people-lookups/:personId - remove a person lookup.
+   * @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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({personId, token, jwtToken, headers}) {
     return client({
       url: `/people-lookups/${personId}`,

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

@@ -2,7 +2,22 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * Factory for point-to-point-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function }}
+ */
 function pointToPointSettingsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /point-to-point-settings - get point-to-point settings.
+   * @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>}
+   */
   function get({token, jwtToken, headers}) {
     return client({
       url: "/point-to-point-settings",
@@ -10,6 +25,15 @@ function pointToPointSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /point-to-point-settings - update point-to-point settings.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.pointToPointSettings - Settings payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, pointToPointSettings, headers}) {
     return client({
       url: "/point-to-point-settings",

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

@@ -1,8 +1,23 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for print-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, update: function }}
+ */
 function printSettingsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /print-settings - list/get print settings.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, query, headers}) {
     return client({
       url: "/print-settings",
@@ -11,6 +26,15 @@ function printSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /print-settings - update print settings.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.printSettings - Print settings payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, printSettings, headers}) {
     return client({
       url: "/print-settings",