btrz-api-client 8.30.0 → 8.32.0

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

@@ -3,7 +3,8 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
- * Factory for operation-settings API (btrz-api-accounts).
+ * Factory for operation-settings API (btrz-api-accounts). Operation settings (manifest, schedule, preferences.operations).
+ * Requires BETTEREZ_APP audience. PUT emits webhook operationsettings.updated.
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
@@ -11,13 +12,13 @@ const {
  */
 function operationSettingsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /operation-settings - get operation settings.
+   * GET /operation-settings – Get operation settings for the account.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.query] - Optional query params (passed to request)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ operationSettings: object }>>}
    */
   function get({token, jwtToken, query, headers}) {
     return client({
@@ -28,13 +29,13 @@ function operationSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /operation-settings - update operation settings.
+   * PUT /operation-settings – Update operation settings. Body: { operationSettings } (OperationSettingsPutData). Emits operationsettings.updated.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.operationSettings - Settings payload
+   * @param {Object} opts.operationSettings - Operation settings payload (partial or full OperationSettingsPutData)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ operationSettings: object }>>}
    */
   function update({jwtToken, token, operationSettings, headers}) {
     return client({

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

@@ -1,7 +1,25 @@
+/* eslint-disable max-len */
 const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /people-lookups (btrz-api-accounts). Optional filters; when provided only matching people are returned.
+ * @typedef {Object} PeopleLookupsListQuery
+ * @property {string} [dynamicFormId] - If provided, only include this dynamic form's data in response
+ * @property {string} [documentNumber] - Document number to search for
+ * @property {string} [documentTypeId] - Document type id (ObjectId) to search for
+ * @property {string} [email] - Email to search for
+ * @property {string} [customerNumber] - Customer number to search for
+ * @property {string} [phone] - Phone to search for
+ */
+
+/**
+ * Query params for GET /people-lookups/:personId (btrz-api-accounts). See get-by-id-handler getSpec().
+ * @typedef {Object} PeopleLookupGetByIdQuery
+ * @property {string} [dynamicFormId] - If provided, only include this dynamic form's data in response
+ */
+
 /**
  * Factory for people-lookups API (btrz-api-accounts).
  * @param {Object} deps
@@ -11,14 +29,14 @@ const {
  */
 function peopleLookupsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /people-lookups - list people lookups.
+   * GET /people-lookups – list people lookups (paginated). Requires BETTEREZ_APP audience.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} [opts.query] - Query params
-   * @param {string} [opts.providerId] - Provider id (ObjectId)
+   * @param {PeopleLookupsListQuery} [opts.query] - Query params (dynamicFormId, documentNumber, documentTypeId, email, customerNumber, phone)
+   * @param {string} [opts.providerId] - Provider id (ObjectId); merged into query for provider context
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ people: object[], totalRecords: number, page?: number, pageSize?: number }>>}
    */
   function all({token, jwtToken, query, headers, providerId}) {
     const query_ = providerId ? {...query, providerId} : query;
@@ -30,15 +48,15 @@ function peopleLookupsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /people-lookups/:personId - get a person lookup.
+   * GET /people-lookups/:personId – get a single person lookup by id. Returns 404 if not found. Requires BETTEREZ_APP audience.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} [opts.query] - Query params
-   * @param {string} opts.personId - Person id (ObjectId)
-   * @param {string} [opts.providerId] - Provider id (ObjectId)
+   * @param {string} opts.personId - Person id (24 hex ObjectId)
+   * @param {PeopleLookupGetByIdQuery} [opts.query] - Query params: dynamicFormId
+   * @param {string} [opts.providerId] - Provider id (ObjectId); merged into query for provider context
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ person: object }>>}
    */
   function getById({token, jwtToken, query, headers, personId, providerId}) {
     const query_ = providerId ? {...query, providerId} : query;
@@ -51,15 +69,15 @@ function peopleLookupsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /people-lookups/:personId - update a person lookup.
+   * PUT /people-lookups/:personId – update a person lookup. Emits peopleLookups.updated webhook. Requires BETTEREZ_APP audience.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.personId - Person id (ObjectId)
-   * @param {Object} opts.person - Person payload
-   * @param {string} [opts.providerId] - Provider id (ObjectId)
+   * @param {string} opts.personId - Person id (24 hex ObjectId)
+   * @param {Object} opts.person - Person payload (PeopleLookupPutData: documentTypeId, documentNumber, firstName, lastName, email, phone, dynamicForms, etc.)
+   * @param {string} [opts.providerId] - Provider id (ObjectId); sent as query for provider context
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ person: object }>>}
    */
   function update({jwtToken, token, personId, person, headers, providerId}) {
     const query = providerId ? {providerId} : {};
@@ -78,14 +96,14 @@ function peopleLookupsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /people-lookups - create a person lookup.
+   * POST /people-lookups – create a person lookup. Emits peopleLookups.created webhook. Requires BETTEREZ_APP audience. Body requires documentTypeId and documentNumber.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.person - Person payload
-   * @param {string} [opts.providerId] - Provider id (ObjectId)
+   * @param {Object} opts.person - Person payload (PeopleLookupPostData: documentTypeId, documentNumber required; firstName, lastName, email, phone, dynamicForms, etc.)
+   * @param {string} [opts.providerId] - Provider id (ObjectId); sent as query for provider context
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ person: object }>>}
    */
   function create({jwtToken, token, person, headers, providerId}) {
     const query = providerId ? {providerId} : {};
@@ -104,13 +122,13 @@ function peopleLookupsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /people-lookups/:personId - remove a person lookup.
+   * DELETE /people-lookups/:personId – remove a person lookup. Emits peoplelookups.deleted webhook. Returns 404 if person not found. Requires BETTEREZ_APP audience.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.personId - Person id (ObjectId)
+   * @param {string} opts.personId - Person id (24 hex ObjectId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ personId: string }>>}
    */
   function remove({personId, token, jwtToken, headers}) {
     return client({

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

@@ -3,7 +3,7 @@ const {
 } = require("../endpoints_helpers.js");
 
 /**
- * Factory for point-to-point-settings API (btrz-api-accounts).
+ * Factory for point-to-point-settings API (btrz-api-accounts). Requires user logged in to backoffice app.
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
@@ -11,12 +11,12 @@ const {
  */
 function pointToPointSettingsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /point-to-point-settings - get point-to-point settings.
+   * GET /point-to-point-settings – get point-to-point settings for the current account. No query params.
    * @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<{ pointToPointSettings: object }>>}
    */
   function get({token, jwtToken, headers}) {
     return client({
@@ -26,13 +26,13 @@ function pointToPointSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /point-to-point-settings - update point-to-point settings.
+   * PUT /point-to-point-settings – update settings. Body: useOnlySpecificFareTable (boolean) required.
    * @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 {{ useOnlySpecificFareTable: boolean }} opts.pointToPointSettings - Settings payload (useOnlySpecificFareTable required)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ pointToPointSettings: object }>>}
    */
   function update({token, jwtToken, pointToPointSettings, headers}) {
     return client({

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

@@ -11,29 +11,30 @@ const {
  */
 function printSettingsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /print-settings - list/get print settings.
+   * GET /print-settings – get print settings for the current account. No query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {Object} [opts.query] - Query params
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.query] - Optional query params
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ printSettings: object }>>}
    */
-  function all({token, query, headers}) {
+  function all({token, jwtToken, query, headers}) {
     return client({
       url: "/print-settings",
       params: query,
-      headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
   /**
-   * PUT /print-settings - update print settings.
+   * PUT /print-settings – update print settings. Emits printsettings.updated webhook. Requires BETTEREZ_APP.
    * @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.printSettings - Print settings payload (PrintSettingsPutData)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ printSettings: object }>>}
    */
   function update({jwtToken, token, printSettings, headers}) {
     return client({

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

@@ -1,7 +1,41 @@
+/* eslint-disable max-len */
 const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /print-templates (btrz-api-accounts). See get-handler getSpec().
+ * @typedef {Object} PrintTemplatesListQuery
+ * @property {string} [providerId] - Filter by provider account (ObjectId)
+ * @property {string} [type] - Filter by type (product, ssr, transaction, invoice, shift, manifest, order, voucher, etc.)
+ * @property {string} [channel] - backoffice | agency-backoffice | websales | agency-websales
+ * @property {string} [consumer] - printer | attachment
+ * @property {string} [format] - default | esc
+ * @property {string} [productFamily] - Only when type is product or invoice
+ * @property {string} [productId] - Only when type is product or invoice (ObjectId)
+ * @property {string} [sort] - relevance | natural | createdAsc | createdDesc | updatedAsc | updatedDesc
+ * @property {string} [templateCollectionId] - default | epsontmt88v | zebralp2844 | zebragx420t
+ * @property {string} [status] - draft | published
+ * @property {string} [agencyId] - Filter sub-templates for this agency (ObjectId)
+ * @property {string} [mainTemplateAccountId] - Filter by source provider (ObjectId)
+ * @property {number} [page] - 1-based page for pagination
+ */
+
+/**
+ * Query params for GET /print-templates/:printTemplateId (btrz-api-accounts). See get-by-id-handler getSpec().
+ * @typedef {Object} PrintTemplateGetByIdQuery
+ * @property {string} [providerId] - Filter by provider; template must belong to this account, current, or global (ObjectId)
+ * @property {string} [superUserId] - Super user ID for authentication (ObjectId)
+ * @property {string} [superUserHash] - Super user hash for authentication
+ */
+
+/**
+ * Query params for PUT /print-templates/:printTemplateId/versions/:versionId (btrz-api-accounts). See put-version-handler getSpec().
+ * @typedef {Object} PrintTemplateVersionUpdateQuery
+ * @property {string} [superUserId] - Super user ID (ObjectId)
+ * @property {string} [superUserHash] - Super user hash for authentication
+ */
+
 /**
  * Factory for print-templates API (btrz-api-accounts).
  * @param {Object} deps
@@ -11,35 +45,40 @@ const {
  */
 function printSettingsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /print-templates - list print templates.
+   * GET /print-templates - list print templates (paginated when page is provided).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {Object} [opts.query] - Query params
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {PrintTemplatesListQuery} [opts.query] - Query params (providerId, type, channel, agencyId, etc.)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ printTemplates: object[], next?: string, previous?: string, totalRecords?: number, page?: number }>>}
+   *   When page is used, response includes next, previous, totalRecords, page.
+   * @throws {import("axios").AxiosError} 400 WRONG_DATA, INVALID_PRODUCT_ID; 401; 500
    */
-  function all({token, query, headers}) {
+  function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/print-templates",
       params: query,
-      headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
   /**
-   * GET /print-templates/:printTemplateId - get a print template.
+   * GET /print-templates/:printTemplateId - get a single print template.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {Object} [opts.query] - Query params
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.printTemplateId - Print template id (ObjectId)
+   * @param {PrintTemplateGetByIdQuery} [opts.query] - Query params (providerId, superUserId, superUserHash)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ printTemplate: object }>>}
+   * @throws {import("axios").AxiosError} 400 INVALID_PRINT_TEMPLATE_ID / INVALID_PROVIDER_ID, 401, 404 PRINT_TEMPLATE_NOT_FOUND, 500
    */
-  function get({token, query, headers, printTemplateId}) {
+  function get({token, jwtToken, printTemplateId, query = {}, headers}) {
     return client({
       url: `/print-templates/${printTemplateId}`,
       params: query,
-      headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
@@ -49,10 +88,11 @@ function printSettingsFactory({client, internalAuthTokenProvider}) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.printTemplateId - Print template id (ObjectId)
-   * @param {Object} opts.printTemplate - Print template payload
-   * @param {Object} [opts.query] - Query params
+   * @param {Object} opts.printTemplate - Print template payload (name, type; type-specific fields)
+   * @param {Object} [opts.query] - Optional (superUserId, superUserHash)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ printTemplate: object }>>}
+   * @throws {import("axios").AxiosError} 400 WRONG_DATA, type-specific; 401 NOT_SUPER_USER; 404; 500
    */
   function update({jwtToken, token, printTemplateId, printTemplate, headers, query}) {
     return client({
@@ -69,13 +109,14 @@ function printSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /print-templates - create a print template.
+   * POST /print-templates - create a print template. Body: printTemplate (name, type required; type-specific fields).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.printTemplate - Print template payload
+   * @param {Object} opts.printTemplate - Print template payload (see PrintTemplatePostData)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ printTemplate: object }>>}
+   * @throws {import("axios").AxiosError} 400 WRONG_DATA / PRODUCT_* / INVOICE_* / META_* / TEMPLATE_*, 401 NOT_SUPER_USER, 500
    */
   function create({jwtToken, token, printTemplate, headers}) {
     return client({
@@ -91,13 +132,14 @@ function printSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /print-templates/:printTemplateId - remove a print template.
+   * DELETE /print-templates/:printTemplateId - delete a print template.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.printTemplateId - Print template id (ObjectId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ printTemplateId: string }>>}
+   * @throws {import("axios").AxiosError} 400 PRINT_TEMPLATE_ID, 401, 404 PRINT_TEMPLATE_NOT_FOUND, 500
    */
   function remove({printTemplateId, token, jwtToken, headers}) {
     return client({
@@ -111,15 +153,16 @@ function printSettingsFactory({client, internalAuthTokenProvider}) {
 
   const versions = {
     /**
-     * PUT /print-templates/:printTemplateId/versions/:versionId - update a print template version.
+     * PUT /print-templates/:printTemplateId/versions/:versionId - roll back to a saved version (versionId = zero-based index).
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.printTemplateId - Print template id (ObjectId)
-     * @param {string} opts.versionId - Version id (ObjectId)
-     * @param {Object} [opts.query] - Query params
+     * @param {string} opts.versionId - Zero-based version index (e.g. "0", "1")
+     * @param {PrintTemplateVersionUpdateQuery} [opts.query] - Query params (superUserId, superUserHash)
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ printTemplate: object }>>}
+     * @throws {import("axios").AxiosError} 400 WRONG_DATA; 401 NOT_SUPER_USER; 404; 500
      */
     update({printTemplateId, token, jwtToken, headers, query, versionId}) {
       return client({

package/src/endpoints/accounts/printers.js

@@ -1,3 +1,4 @@
+/* eslint-disable max-len */
 const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
@@ -11,18 +12,21 @@ const {
  */
 function printersFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /printers - list printers.
+   * GET /printers - list supported printers and their print templates. No query parameters accepted.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {Object} [opts.query] - Query params
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.query] - Unused; API accepts no query params
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ printers: Array<object> }>>}
+   *   Response printers array: each has id, name, itemTypes, templates (see GET /printers).
+   * @throws {import("axios").AxiosError} 401 Unauthorized, 500 Internal server error
    */
-  function all({token, query, headers}) {
+  function all({token, jwtToken, query, headers}) {
     return client({
       url: "/printers",
-      params: query,
-      headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
+      params: query || {},
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 

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

@@ -1,3 +1,4 @@
+/* eslint-disable max-len */
 const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
@@ -11,12 +12,14 @@ const {
  */
 function revenueManagementSettingsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /rms-settings - get revenue management settings.
+   * GET /rms-settings — get revenue management settings for the account. No query parameters.
    * @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>}
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth token
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse<{ data: { revenueManagementSettings: { enabled: boolean, applicationId?: string, subscriptionId?: string, ratalityClientId?: string, userId?: string } } }>>}
+   * @throws {import("axios").AxiosError} 401 Unauthorized (missing or invalid API key/Authorization)
+   * @throws {import("axios").AxiosError} 500 Internal server error
    */
   function get({token, jwtToken, headers}) {
     return client({
@@ -26,13 +29,18 @@ function revenueManagementSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /rms-settings - update revenue management settings.
+   * PUT /rms-settings — update revenue management settings. Body is the settings object (e.g. { enabled: true }).
+   * When enabling, Ratality credentials must already exist on the account. Emits rms.enabled / rms.disabled webhooks.
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.revenueManagementSettings - Settings payload
-   * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth token
+   * @param {{ enabled: boolean, ratalityUsername?: string, ratalityPassword?: string }} opts.revenueManagementSettings - Settings payload (at least enabled; credentials required when enabling)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse<{ data: { revenueManagementSettings: { enabled: boolean, applicationId?: string, subscriptionId?: string, ratalityClientId?: string, userId?: string } } }>>}
+   * @throws {import("axios").AxiosError} 400 ACCOUNT_ALREADY_HAS_RMS_SETTINGS_ENABLED, RATALITY_CREDENTIALS_REQUIRED, CREATE_CLIENT_*
+   * @throws {import("axios").AxiosError} 401 Unauthorized
+   * @throws {import("axios").AxiosError} 404 ACCOUNT_NOT_FOUND
+   * @throws {import("axios").AxiosError} 500 CREATE_USER_ERROR or internal server error
    */
   function update({token, jwtToken, revenueManagementSettings, headers}) {
     return client({

package/src/endpoints/accounts/s3buckets.js

@@ -9,7 +9,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function s3BucketsFactory({client, internalAuthTokenProvider}) {
   /**
-   * PUT /account/s3Buckets/:bucketId - update an S3 bucket.
+   * PUT /account/s3Buckets/:bucketId - update an S3 bucket. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -28,7 +28,7 @@ function s3BucketsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /account/s3Buckets/:bucketId - remove an S3 bucket.
+   * DELETE /account/s3Buckets/:bucketId - remove an S3 bucket. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -45,7 +45,7 @@ function s3BucketsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /account/s3Buckets - create an S3 bucket.
+   * POST /account/s3Buckets - create an S3 bucket. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

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

@@ -3,7 +3,7 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
- * Factory for salesforce-settings API (btrz-api-accounts).
+ * Factory for salesforce-settings API (btrz-api-accounts). Requires BETTEREZ_APP audience.
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
@@ -11,13 +11,13 @@ const {
  */
 function salesforceSettingsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /salesforce-settings - get Salesforce settings.
+   * GET /salesforce-settings – get Salesforce settings for the current account. No query params.
    * @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 params
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ salesforceSettings: object }>>}
    */
   function get({jwtToken, token, query, headers}) {
     return client({
@@ -28,13 +28,14 @@ function salesforceSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /salesforce-settings - update Salesforce settings.
+   * PUT /salesforce-settings – update Salesforce settings. When enabled is true, mcInstanceId,
+   * messageId, clientId, clientSecret are required. Emits salesforcesettings.updated webhook.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.salesforceSettings - Settings payload
+   * @param {Object} opts.salesforceSettings - Settings payload (SalesforceSettingsPayload; enabled required)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ salesforceSettings: object }>>}
    */
   function update({jwtToken, token, salesforceSettings, headers}) {
     return client({

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

@@ -3,7 +3,7 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
- * Factory for shift-settings API (btrz-api-accounts).
+ * Factory for shift-settings API (btrz-api-accounts). Requires BETTEREZ_APP audience.
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
@@ -11,13 +11,13 @@ const {
  */
 function shiftSettingsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /shift-settings - get shift settings.
+   * GET /shift-settings – get shift settings for the current account. No query params.
    * @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 params
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ shiftSettings: object }>>}
    */
   function get({token, jwtToken, query, headers}) {
     return client({
@@ -28,13 +28,13 @@ function shiftSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /shift-settings - update shift settings.
+   * PUT /shift-settings – update shift settings. Emits shiftsettings.updated webhook.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.shiftSettings - Settings payload
+   * @param {Object} opts.shiftSettings - Settings payload (ShiftSetting)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ shiftSettings: object }>>}
    */
   function update({jwtToken, token, shiftSettings, headers}) {
     return client({