btrz-api-client 9.22.0 → 9.25.0

package/lib/endpoints/accounts/accounts.js

@@ -7,7 +7,7 @@ const {
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ get: function, defaultUsers: { create: function }, configurationReplication: { create: function } }}
+ * @returns {{ get: function, defaultUsers: { create: function }, configurationReplication: { create: function }, sessionRecordingSettings: { update: function } }}
  */
 function accountsFactory({
   client,
@@ -106,10 +106,54 @@ function accountsFactory({
       });
     }
   };
+
+  /**
+   * Query params for PUT /accounts/:accountId/session-recording-settings (btrz-api-accounts).
+   * @typedef {Object} SessionRecordingSettingsUpdateQuery
+   * @property {string} superUserId - Super user id (ObjectId)
+   * @property {string} superUserHash - Super user hash
+   */
+
+  const sessionRecordingSettings = {
+    /**
+     * PUT /accounts/:accountId/session-recording-settings — replace logRocket and rrweb preferences.
+     * Requires SuperUser query credentials.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.accountId - Account _id (ObjectId)
+     * @param {SessionRecordingSettingsUpdateQuery} [opts.query] - superUserId, superUserHash
+     * @param {Object} opts.data - { logRocket, rrweb }
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>} 200 { logRocket, rrweb }
+     */
+    update({
+      token,
+      jwtToken,
+      accountId,
+      query,
+      data,
+      headers
+    }) {
+      return client({
+        url: `/accounts/${accountId}/session-recording-settings`,
+        method: "put",
+        headers: authorizationHeaders({
+          token,
+          jwtToken,
+          internalAuthTokenProvider,
+          headers
+        }),
+        params: query,
+        data
+      });
+    }
+  };
   return {
     get,
     defaultUsers,
-    configurationReplication
+    configurationReplication,
+    sessionRecordingSettings
   };
 }
 module.exports = accountsFactory;

package/lib/endpoints/operations/manifest.js

@@ -17,7 +17,7 @@ const {
  * @property {string} [dateFrom] - Start date range (yyyy-mm-dd)
  * @property {string} [dateTo] - End date range (yyyy-mm-dd)
  * @property {string} [seatmapId] - Seatmap ID
- * @property {string} [vehicleId] - Vehicle ID
+ * @property {string} [vehicleId] - Inventory vehicle document ID (MongoDB ObjectId). Filters by manifest.vehicleId. Legacy exact display-name matching may still resolve server-side; do not rely on it for new clients
  * @property {string} [assignedUserId] - Assigned user ID
  * @property {boolean} [dispatched] - If manifest was dispatched
  * @property {boolean} [reviewed] - If manifest was reviewed
@@ -30,6 +30,19 @@ const {
  * @property {string} [status] - Comma-separated manifest statuses
  */
 
+/**
+ * Body for PUT /manifests (btrz-api-operations ManifestSaveData). See put-manifest.
+ * @typedef {Object} ManifestSaveData
+ * @property {string} routeId - Route ID
+ * @property {string} scheduleId - Schedule ID
+ * @property {string} date - Date in YYYY-MM-DD format
+ * @property {string} [busSelected] - Human-readable vehicle name to assign or clear (legacy). Resolves by exact inventory name only when inventoryVehicleId is not provided. When inventoryVehicleId is also provided, the server resolves only by that ID and persists the resolved name for display/audit. Empty string unassigns only when inventoryVehicleId is absent
+ * @property {string} [inventoryVehicleId] - Stable inventory vehicle document ID (MongoDB ObjectId as string). When provided, bus assignment resolves only by this ID; there is no fallback to busSelected name. BUS_NOT_FOUND when the target vehicle cannot be resolved (invalid, disabled, deleted, or other account). Not returned when cleaning up a previous assignment whose vehicle was renamed or removed
+ * @property {number} [capacity] - Manifest capacity
+ * @property {string} [seatMapId] - Seatmap ID
+ * @property {string} [comments] - Comments
+ */
+
 /**
  * Query params for PUT /manifests (btrz-api-operations). See put-manifest getSpec().
  * @typedef {Object} ManifestSaveQuery
@@ -49,6 +62,15 @@ const {
  * @property {string} [newdesign] - "true" when using new seatmap design
  */
 
+/**
+ * assign_bus operation item for PATCH /manifests (btrz-api-operations ManifestUpdateOperation). See patch-manifest.
+ * @typedef {Object} ManifestPatchAssignBusOperation
+ * @property {"assign_bus"} op - Operation type
+ * @property {Object} manifest - Manifest data to update (ManifestUpdateCapacityNotificationSent)
+ * @property {string} [busId] - Case-sensitive inventory vehicle display name (legacy). Used only when inventoryVehicleId is not provided
+ * @property {string} [inventoryVehicleId] - Stable inventory vehicle document ID. When provided, the vehicle is resolved only by this ID (no name fallback); busId is persisted as the resolved vehicle name for display and audit. BUS_NOT_FOUND if the ID does not resolve (missing, disabled, deleted, or other account)
+ */
+
 /**
  * Query params for GET /outlook-manifests (btrz-api-operations). See get-outlook-manifests getSpec().
  * @typedef {Object} OutlookManifestsListQuery
@@ -417,9 +439,9 @@ function manifestFactory({
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {ManifestPatchQuery} [opts.query] - Query params (providerId required)
-   * @param {Object} opts.operations - JSON Patch operations
+   * @param {Array<ManifestPatchAssignBusOperation|Object>} opts.operations - Predefined operations (e.g. assign_bus, remove_bus, add_tickets). assign_bus vehicle fields: see ManifestPatchAssignBusOperation
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse>} PatchedManifest; 400 BUS_NOT_FOUND (assign_bus target vehicle only; no name fallback when inventoryVehicleId is sent), INVALID_OPERATION, MANIFEST_ALREADY_DISPATCHED
    */
   function patch({
     token,
@@ -450,7 +472,7 @@ function manifestFactory({
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.providerId] - Provider id (required by API as query)
-   * @param {Object} opts.data - Request body
+   * @param {ManifestSaveData} opts.data - Request body
    * @param {Object} [opts.headers] - Optional headers
    * @param {ManifestSaveQuery} [opts.query] - Query params (providerId required; manifestId, bypassBusValidation optional)
    * @returns {Promise<import("axios").AxiosResponse>}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "btrz-api-client",
-  "version": "9.22.0",
+  "version": "9.25.0",
   "description": "Api client for Betterez endpoints",
   "main": "index.js",
   "scripts": {

package/src/endpoints/accounts/accounts.js

@@ -7,7 +7,7 @@ const {
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ get: function, defaultUsers: { create: function }, configurationReplication: { create: function } }}
+ * @returns {{ get: function, defaultUsers: { create: function }, configurationReplication: { create: function }, sessionRecordingSettings: { update: function } }}
  */
 function accountsFactory({client, internalAuthTokenProvider}) {
   /**
@@ -75,10 +75,42 @@ function accountsFactory({client, internalAuthTokenProvider}) {
     }
   };
 
+  /**
+   * Query params for PUT /accounts/:accountId/session-recording-settings (btrz-api-accounts).
+   * @typedef {Object} SessionRecordingSettingsUpdateQuery
+   * @property {string} superUserId - Super user id (ObjectId)
+   * @property {string} superUserHash - Super user hash
+   */
+
+  const sessionRecordingSettings = {
+    /**
+     * PUT /accounts/:accountId/session-recording-settings — replace logRocket and rrweb preferences.
+     * Requires SuperUser query credentials.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.accountId - Account _id (ObjectId)
+     * @param {SessionRecordingSettingsUpdateQuery} [opts.query] - superUserId, superUserHash
+     * @param {Object} opts.data - { logRocket, rrweb }
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>} 200 { logRocket, rrweb }
+     */
+    update({token, jwtToken, accountId, query, data, headers}) {
+      return client({
+        url: `/accounts/${accountId}/session-recording-settings`,
+        method: "put",
+        headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+        params: query,
+        data
+      });
+    }
+  };
+
   return {
     get,
     defaultUsers,
-    configurationReplication
+    configurationReplication,
+    sessionRecordingSettings
   };
 }
 

package/src/endpoints/operations/manifest.js

@@ -13,7 +13,7 @@ const {
  * @property {string} [dateFrom] - Start date range (yyyy-mm-dd)
  * @property {string} [dateTo] - End date range (yyyy-mm-dd)
  * @property {string} [seatmapId] - Seatmap ID
- * @property {string} [vehicleId] - Vehicle ID
+ * @property {string} [vehicleId] - Inventory vehicle document ID (MongoDB ObjectId). Filters by manifest.vehicleId. Legacy exact display-name matching may still resolve server-side; do not rely on it for new clients
  * @property {string} [assignedUserId] - Assigned user ID
  * @property {boolean} [dispatched] - If manifest was dispatched
  * @property {boolean} [reviewed] - If manifest was reviewed
@@ -26,6 +26,19 @@ const {
  * @property {string} [status] - Comma-separated manifest statuses
  */
 
+/**
+ * Body for PUT /manifests (btrz-api-operations ManifestSaveData). See put-manifest.
+ * @typedef {Object} ManifestSaveData
+ * @property {string} routeId - Route ID
+ * @property {string} scheduleId - Schedule ID
+ * @property {string} date - Date in YYYY-MM-DD format
+ * @property {string} [busSelected] - Human-readable vehicle name to assign or clear (legacy). Resolves by exact inventory name only when inventoryVehicleId is not provided. When inventoryVehicleId is also provided, the server resolves only by that ID and persists the resolved name for display/audit. Empty string unassigns only when inventoryVehicleId is absent
+ * @property {string} [inventoryVehicleId] - Stable inventory vehicle document ID (MongoDB ObjectId as string). When provided, bus assignment resolves only by this ID; there is no fallback to busSelected name. BUS_NOT_FOUND when the target vehicle cannot be resolved (invalid, disabled, deleted, or other account). Not returned when cleaning up a previous assignment whose vehicle was renamed or removed
+ * @property {number} [capacity] - Manifest capacity
+ * @property {string} [seatMapId] - Seatmap ID
+ * @property {string} [comments] - Comments
+ */
+
 /**
  * Query params for PUT /manifests (btrz-api-operations). See put-manifest getSpec().
  * @typedef {Object} ManifestSaveQuery
@@ -45,6 +58,15 @@ const {
  * @property {string} [newdesign] - "true" when using new seatmap design
  */
 
+/**
+ * assign_bus operation item for PATCH /manifests (btrz-api-operations ManifestUpdateOperation). See patch-manifest.
+ * @typedef {Object} ManifestPatchAssignBusOperation
+ * @property {"assign_bus"} op - Operation type
+ * @property {Object} manifest - Manifest data to update (ManifestUpdateCapacityNotificationSent)
+ * @property {string} [busId] - Case-sensitive inventory vehicle display name (legacy). Used only when inventoryVehicleId is not provided
+ * @property {string} [inventoryVehicleId] - Stable inventory vehicle document ID. When provided, the vehicle is resolved only by this ID (no name fallback); busId is persisted as the resolved vehicle name for display and audit. BUS_NOT_FOUND if the ID does not resolve (missing, disabled, deleted, or other account)
+ */
+
 /**
  * Query params for GET /outlook-manifests (btrz-api-operations). See get-outlook-manifests getSpec().
  * @typedef {Object} OutlookManifestsListQuery
@@ -313,9 +335,9 @@ function manifestFactory({
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {ManifestPatchQuery} [opts.query] - Query params (providerId required)
-   * @param {Object} opts.operations - JSON Patch operations
+   * @param {Array<ManifestPatchAssignBusOperation|Object>} opts.operations - Predefined operations (e.g. assign_bus, remove_bus, add_tickets). assign_bus vehicle fields: see ManifestPatchAssignBusOperation
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse>} PatchedManifest; 400 BUS_NOT_FOUND (assign_bus target vehicle only; no name fallback when inventoryVehicleId is sent), INVALID_OPERATION, MANIFEST_ALREADY_DISPATCHED
    */
   function patch({
     token, jwtToken, query = {}, operations, headers
@@ -337,7 +359,7 @@ function manifestFactory({
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.providerId] - Provider id (required by API as query)
-   * @param {Object} opts.data - Request body
+   * @param {ManifestSaveData} opts.data - Request body
    * @param {Object} [opts.headers] - Optional headers
    * @param {ManifestSaveQuery} [opts.query] - Query params (providerId required; manifestId, bypassBusValidation optional)
    * @returns {Promise<import("axios").AxiosResponse>}

package/test/endpoints/accounts/accounts.js

@@ -68,4 +68,31 @@ describe("accounts/accounts", () => {
       query
     });
   });
+
+  it("should PUT session recording settings for an account", () => {
+    const accountId = "5976090487a7f1e158000041";
+    const query = {
+      superUserId: "superUserId",
+      superUserHash: "superUserHash"
+    };
+    const data = {
+      logRocket: {enabled: true, pathPrefixes: ["/manifests"]},
+      rrweb: {enabled: true, pathGroups: [["/manifests"]]}
+    };
+    axiosMock.onPut(`/accounts/${accountId}/session-recording-settings`)
+      .reply(expectRequest({
+        statusCode: 200,
+        token,
+        jwtToken,
+        query,
+        body: data
+      }));
+    return api.accounts.accounts.sessionRecordingSettings.update({
+      token,
+      jwtToken,
+      accountId,
+      query,
+      data
+    });
+  });
 });

package/types/endpoints/accounts/accounts.d.ts

@@ -4,7 +4,7 @@ export = accountsFactory;
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ get: function, defaultUsers: { create: function }, configurationReplication: { create: function } }}
+ * @returns {{ get: function, defaultUsers: { create: function }, configurationReplication: { create: function }, sessionRecordingSettings: { update: function } }}
  */
 declare function accountsFactory({ client, internalAuthTokenProvider }: {
     client: import("axios").AxiosInstance;
@@ -19,4 +19,7 @@ declare function accountsFactory({ client, internalAuthTokenProvider }: {
     configurationReplication: {
         create: Function;
     };
+    sessionRecordingSettings: {
+        update: Function;
+    };
 };