btrz-api-client 8.31.0 → 8.32.0

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

@@ -4,7 +4,8 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * 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]
@@ -17,12 +18,13 @@ function operationSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /operation-settings - get operation settings. API does not accept query params.
+   * 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] - 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(_ref2) {
     var token = _ref2.token,
@@ -38,13 +40,13 @@ function operationSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /operation-settings - update operation settings. API does not accept query params.
+   * 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(_ref3) {
     var jwtToken = _ref3.jwtToken,

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

@@ -7,11 +7,11 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Query params for GET /people-lookups (btrz-api-accounts). See get-handler getSpec().
+ * 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 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
@@ -37,14 +37,14 @@ function peopleLookupsFactory(_ref) {
       internalAuthTokenProvider = _ref.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 {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(_ref2) {
     var token = _ref2.token,
@@ -62,15 +62,15 @@ function peopleLookupsFactory(_ref) {
   }
 
   /**
-   * 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 {string} opts.personId - Person 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(_ref3) {
     var token = _ref3.token,
@@ -90,15 +90,15 @@ function peopleLookupsFactory(_ref) {
   }
 
   /**
-   * PUT /people-lookups/:personId - update a person lookup. API getSpec() does not define query params.
+   * 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.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(_ref4) {
     var jwtToken = _ref4.jwtToken,
@@ -124,14 +124,14 @@ function peopleLookupsFactory(_ref) {
   }
 
   /**
-   * POST /people-lookups - create a person lookup. API getSpec() does not define query params.
+   * 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 {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(_ref5) {
     var jwtToken = _ref5.jwtToken,
@@ -156,13 +156,13 @@ function peopleLookupsFactory(_ref) {
   }
 
   /**
-   * DELETE /people-lookups/:personId - remove a person lookup. API does not accept query params.
+   * 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(_ref6) {
     var personId = _ref6.personId,

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

@@ -4,7 +4,7 @@ var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * 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]
@@ -17,12 +17,12 @@ function pointToPointSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /point-to-point-settings - get point-to-point settings. API does not accept query params.
+   * 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(_ref2) {
     var token = _ref2.token,
@@ -36,13 +36,13 @@ function pointToPointSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /point-to-point-settings - update point-to-point settings. API does not accept query params.
+   * 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(_ref3) {
     var token = _ref3.token,

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

@@ -17,32 +17,35 @@ function printSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /print-settings - list/get print settings. API does not accept query params.
+   * GET /print-settings – get print 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] - Optional query params
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ printSettings: object }>>}
    */
   function all(_ref2) {
     var token = _ref2.token,
+        jwtToken = _ref2.jwtToken,
         query = _ref2.query,
         headers = _ref2.headers;
 
     return client({
       url: "/print-settings",
       params: query,
-      headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
     });
   }
 
   /**
-   * PUT /print-settings - update print settings. API does not accept query params.
+   * 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(_ref3) {
     var jwtToken = _ref3.jwtToken,

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

@@ -1,5 +1,6 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
@@ -16,6 +17,7 @@ var _require = require("./../endpoints_helpers.js"),
  * @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
  */
@@ -49,56 +51,67 @@ function printSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.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 {PrintTemplatesListQuery} [opts.query] - Query params (providerId, type, channel, consumer, format, etc.)
+   * @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(_ref2) {
     var token = _ref2.token,
-        query = _ref2.query,
+        jwtToken = _ref2.jwtToken,
+        _ref2$query = _ref2.query,
+        query = _ref2$query === undefined ? {} : _ref2$query,
         headers = _ref2.headers;
 
     return client({
       url: "/print-templates",
       params: query,
-      headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: 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 {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(_ref3) {
     var token = _ref3.token,
-        query = _ref3.query,
-        headers = _ref3.headers,
-        printTemplateId = _ref3.printTemplateId;
+        jwtToken = _ref3.jwtToken,
+        printTemplateId = _ref3.printTemplateId,
+        _ref3$query = _ref3.query,
+        query = _ref3$query === undefined ? {} : _ref3$query,
+        headers = _ref3.headers;
 
     return client({
       url: "/print-templates/" + printTemplateId,
       params: query,
-      headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
     });
   }
 
   /**
-   * PUT /print-templates/:printTemplateId - update a print template. API getSpec() does not define query params.
+   * PUT /print-templates/:printTemplateId - update 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.printTemplate - Print template payload
+   * @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(_ref4) {
     var jwtToken = _ref4.jwtToken,
@@ -122,13 +135,14 @@ function printSettingsFactory(_ref) {
   }
 
   /**
-   * POST /print-templates - create a print template. API does not accept query params.
+   * 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(_ref5) {
     var jwtToken = _ref5.jwtToken,
@@ -149,13 +163,14 @@ function printSettingsFactory(_ref) {
   }
 
   /**
-   * DELETE /print-templates/:printTemplateId - remove a print template. API does not accept query params.
+   * 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(_ref6) {
     var printTemplateId = _ref6.printTemplateId,
@@ -174,7 +189,7 @@ function printSettingsFactory(_ref) {
 
   var versions = {
     /**
-     * PUT /print-templates/:printTemplateId/versions/:versionId - roll back print template to a 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
@@ -182,7 +197,8 @@ function printSettingsFactory(_ref) {
      * @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: function update(_ref7) {
       var printTemplateId = _ref7.printTemplateId,

package/lib/endpoints/accounts/printers.js

@@ -1,5 +1,6 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
@@ -17,21 +18,26 @@ function printersFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /printers - list printers. API does not accept query params.
+   * GET /printers - list supported printers and their print templates. No query parameters accepted.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
+   * @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(_ref2) {
     var token = _ref2.token,
+        jwtToken = _ref2.jwtToken,
         query = _ref2.query,
         headers = _ref2.headers;
 
     return client({
       url: "/printers",
-      params: query,
-      headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+      params: query || {},
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
     });
   }
 

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

@@ -1,5 +1,6 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
@@ -17,12 +18,14 @@ function revenueManagementSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /rms-settings - get revenue management settings. API does not accept query params.
+   * 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(_ref2) {
     var token = _ref2.token,
@@ -36,13 +39,18 @@ function revenueManagementSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /rms-settings - update revenue management settings. API does not accept query params.
+   * 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(_ref3) {
     var token = _ref3.token,

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

@@ -4,7 +4,7 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * 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]
@@ -17,12 +17,13 @@ function salesforceSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /salesforce-settings - get Salesforce settings. API does not accept query params.
+   * 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] - Optional query params
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ salesforceSettings: object }>>}
    */
   function get(_ref2) {
     var jwtToken = _ref2.jwtToken,
@@ -38,13 +39,14 @@ function salesforceSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /salesforce-settings - update Salesforce settings. API does not accept query params.
+   * 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(_ref3) {
     var jwtToken = _ref3.jwtToken,

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

@@ -4,7 +4,7 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * 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]
@@ -17,12 +17,13 @@ function shiftSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /shift-settings - get shift settings. API does not accept query params.
+   * 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] - Optional query params
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ shiftSettings: object }>>}
    */
   function get(_ref2) {
     var token = _ref2.token,
@@ -38,13 +39,13 @@ function shiftSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /shift-settings - update shift settings. API does not accept query params.
+   * 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(_ref3) {
     var jwtToken = _ref3.jwtToken,

package/lib/endpoints/accounts/shifts.js

@@ -54,13 +54,14 @@ function shiftsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /shifts - list shifts.
+   * GET /shifts - list shifts for the account. Returns shifts filtered by query params.
+   * See get-shifts handler getSpec() in btrz-api-accounts for full API details.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {ShiftsListQuery} [opts.query] - Query params
+   * @param {ShiftsListQuery} [opts.query] - Query params (includeActivity, status, pendingShiftClosure, locationId, providerId, sort, fromDate, toDate)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ shifts: Array }>>} Response body: { shifts }. Errors: 400 (validation), 401, 500
    */
   function all(_ref2) {
     var jwtToken = _ref2.jwtToken,
@@ -95,13 +96,14 @@ function shiftsFactory(_ref) {
   }
 
   /**
-   * POST /shifts - create a shift.
+   * POST /shifts - open a shift for a user. Body: PostShiftRequest (stationId, userId, counterNumber).
+   * See post-shift handler getSpec() in btrz-api-accounts for full API details.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.shiftData - Shift payload
+   * @param {Object} opts.shiftData - Shift payload (stationId, userId, counterNumber)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ shift: Object }>>} Response body: { shift }. Errors: 400, 401, 404 (USER_NOT_FOUND, STATION_NOT_FOUND), 409 (SHIFT_ALREADY_OPEN_FOR_USER, USER_WITHOUT_SHIFT_ENABLED), 500
    */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
@@ -120,14 +122,16 @@ function shiftsFactory(_ref) {
   }
 
   /**
-   * PATCH /shifts/:shiftId - update a shift (operations). API getSpec() does not define query params.
+   * PATCH /shifts/:shiftId - close a shift. Body: PatchShiftRequest (operations array with comment).
+   * See patch-shift handler getSpec() in btrz-api-accounts for full API details.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.shiftId - Shift id (ObjectId)
-   * @param {Object} opts.operations - Operations payload
+   * @param {Object} opts.operations - Operations payload (e.g. [{ comment }] for close)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @param {Object} [opts.query] - Optional query params
+   * @returns {Promise<import("axios").AxiosResponse<{ shift: Object }>>} Response body: { shift }. Errors: 401, 404 (SHIFT_NOT_FOUND, USER_NOT_FOUND), 409 (SHIFT_ALREADY_CLOSED, COMMENT_IS_MANDATORY_WHEN_VARIANCE_EXISTS, TOTAL_CHANGED), 500
    */
   function update(_ref5) {
     var jwtToken = _ref5.jwtToken,