btrz-api-client 9.19.0 → 9.21.0

package/lib/client.js

@@ -501,6 +501,10 @@ function createAccounts({
       client,
       internalAuthTokenProvider
     }),
+    auditRecords: require("./endpoints/accounts/audit-records.js")({
+      client,
+      internalAuthTokenProvider
+    }),
     application: require("./endpoints/accounts/application.js")({
       client,
       internalAuthTokenProvider

package/lib/endpoints/accounts/audit-records.js

@@ -0,0 +1,60 @@
+const {
+  authorizationHeaders
+} = require("./../endpoints_helpers.js");
+
+/**
+ * Factory for audit-records API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
+function auditRecordsFactory({
+  client,
+  internalAuthTokenProvider
+}) {
+  /**
+   * GET /audit-records/:providerId/:folder/:itemId – get audit events for one object.
+   * Requires BETTEREZ_APP JWT. No query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.providerId - Account (provider) ID
+   * @param {string} opts.folder - Audit folder / entity name
+   * @param {string} opts.itemId - Audited object ID
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{
+   *   accountId: string,
+   *   folder: string,
+   *   objectId: string,
+   *   events: Array<{
+   *     ts: string,
+   *     userId: string,
+   *     operation: string,
+   *     changes: Array<{path: string, from: *, to: *}>
+   *   }>
+   * }>>}
+   */
+  function get({
+    token,
+    jwtToken,
+    providerId,
+    folder,
+    itemId,
+    headers
+  }) {
+    return client({
+      url: `/audit-records/${providerId}/${folder}/${itemId}`,
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      })
+    });
+  }
+  return {
+    get
+  };
+}
+module.exports = auditRecordsFactory;

package/lib/endpoints/accounts/users.js

@@ -28,12 +28,18 @@ const {
  * @property {boolean} [nextSequenceNumber] - Include next sequence number
  */
 
+/**
+ * Query params for GET /users/sequences (btrz-api-accounts).
+ * @typedef {Object} UsersSequencesBulkQuery
+ * @property {string} [userIds] - Comma-separated user ids whose sequences to return
+ */
+
 /**
  * Factory for users API (btrz-api-accounts).
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ get: function, getV2: function, all: function, create: function, login: function, update: function, delete: function, createOrUpdateMany: function, impersonate: function, startMfa: function, confirmMfa: function, disableMfa: function, sequences: { get: function, all: function, create: function, update: function, transfer: function } }}
+ * @returns {{ get: function, getV2: function, all: function, create: function, login: function, update: function, delete: function, createOrUpdateMany: function, impersonate: function, startMfa: function, confirmMfa: function, disableMfa: function, sequences: { get: function, all: function, allByUserIds: function, create: function, update: function, transfer: function } }}
  */
 function usersFactory({
   client,
@@ -526,6 +532,32 @@ function usersFactory({
           newUserId
         }
       });
+    },
+    /**
+     * GET /users/sequences - list sequences for multiple users.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {UsersSequencesBulkQuery} [opts.query] - Query params (userIds)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
+    allByUserIds({
+      token,
+      jwtToken,
+      query = {},
+      headers
+    }) {
+      return client({
+        url: "/users/sequences",
+        params: query,
+        headers: authorizationHeaders({
+          token,
+          jwtToken,
+          internalAuthTokenProvider,
+          headers
+        })
+      });
     }
   };
   return {

package/package.json

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

package/src/client.js

@@ -189,6 +189,7 @@ function createAccounts({baseURL, headers, timeout, overrideFn, internalAuthToke
     agencies: require("./endpoints/accounts/agencies.js")({client, internalAuthTokenProvider}),
     agencyTypes: require("./endpoints/accounts/agency-types.js")({client, internalAuthTokenProvider}),
     authorizedExternalMessaging: require("./endpoints/accounts/authorized-external-messaging.js")({client, internalAuthTokenProvider}),
+    auditRecords: require("./endpoints/accounts/audit-records.js")({client, internalAuthTokenProvider}),
     application: require("./endpoints/accounts/application.js")({client, internalAuthTokenProvider}),
     applications: require("./endpoints/accounts/applications.js")({client, internalAuthTokenProvider}),
     applicationSettings: require("./endpoints/accounts/application-settings.js")({client, internalAuthTokenProvider}),

package/src/endpoints/accounts/audit-records.js

@@ -0,0 +1,45 @@
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
+
+/**
+ * Factory for audit-records API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
+function auditRecordsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /audit-records/:providerId/:folder/:itemId – get audit events for one object.
+   * Requires BETTEREZ_APP JWT. No query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.providerId - Account (provider) ID
+   * @param {string} opts.folder - Audit folder / entity name
+   * @param {string} opts.itemId - Audited object ID
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{
+   *   accountId: string,
+   *   folder: string,
+   *   objectId: string,
+   *   events: Array<{
+   *     ts: string,
+   *     userId: string,
+   *     operation: string,
+   *     changes: Array<{path: string, from: *, to: *}>
+   *   }>
+   * }>>}
+   */
+  function get({token, jwtToken, providerId, folder, itemId, headers}) {
+    return client({
+      url: `/audit-records/${providerId}/${folder}/${itemId}`,
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  return {
+    get
+  };
+}
+
+module.exports = auditRecordsFactory;

package/src/endpoints/accounts/users.js

@@ -26,12 +26,18 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  * @property {boolean} [nextSequenceNumber] - Include next sequence number
  */
 
+/**
+ * Query params for GET /users/sequences (btrz-api-accounts).
+ * @typedef {Object} UsersSequencesBulkQuery
+ * @property {string} [userIds] - Comma-separated user ids whose sequences to return
+ */
+
 /**
  * Factory for users API (btrz-api-accounts).
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ get: function, getV2: function, all: function, create: function, login: function, update: function, delete: function, createOrUpdateMany: function, impersonate: function, startMfa: function, confirmMfa: function, disableMfa: function, sequences: { get: function, all: function, create: function, update: function, transfer: function } }}
+ * @returns {{ get: function, getV2: function, all: function, create: function, login: function, update: function, delete: function, createOrUpdateMany: function, impersonate: function, startMfa: function, confirmMfa: function, disableMfa: function, sequences: { get: function, all: function, allByUserIds: function, create: function, update: function, transfer: function } }}
  */
 function usersFactory({client, internalAuthTokenProvider}) {
   /**
@@ -332,6 +338,22 @@ function usersFactory({client, internalAuthTokenProvider}) {
           newUserId
         }
       });
+    },
+    /**
+     * GET /users/sequences - list sequences for multiple users.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {UsersSequencesBulkQuery} [opts.query] - Query params (userIds)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
+    allByUserIds({token, jwtToken, query = {}, headers}) {
+      return client({
+        url: "/users/sequences",
+        params: query,
+        headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+      });
     }
   };
 

package/test/all.test.js

@@ -5,6 +5,7 @@ require("./endpoints/accounts/accounts.js");
 require("./endpoints/accounts/agencies.test.js");
 require("./endpoints/accounts/agency-types.test.js");
 require("./endpoints/accounts/application-settings.test.js");
+require("./endpoints/accounts/audit-records.test.js");
 require("./endpoints/accounts/applications.test.js");
 require("./endpoints/accounts/current-shifts.test.js");
 require("./endpoints/accounts/customers.js");

package/test/endpoints/accounts/audit-records.test.js

@@ -0,0 +1,54 @@
+const assert = require("node:assert/strict");
+const {axiosMock, expectRequest} = require("./../../test-helpers.js");
+const api = require("./../../../src/client.js").createApiClient({baseURL: "http://test.com"});
+
+describe("accounts/audit-records", () => {
+  const token = "I owe you a token";
+  const jwtToken = "secret";
+
+  afterEach(() => {
+    axiosMock.reset();
+  });
+
+  it("should GET audit records by providerId, folder, and itemId", () => {
+    const providerId = "507f1f77bcf86cd799439011";
+    const folder = "fares";
+    const itemId = "64f1aaaaaaaaaaaaaaaaaaaa";
+    const auditRecord = {
+      accountId: providerId,
+      folder,
+      objectId: itemId,
+      events: [{
+        ts: "2026-08-14T08:03:12.123Z",
+        userId: "user-1",
+        operation: "update",
+        changes: [{path: "name", from: "A", to: "B"}]
+      }]
+    };
+
+    axiosMock.onGet(`/audit-records/${providerId}/${folder}/${itemId}`)
+      .reply((config) => {
+        const result = expectRequest({
+          statusCode: 200,
+          token,
+          jwtToken,
+          requireJwtTokenOnGet: true
+        })(config);
+        if (result[0] !== 200) {
+          return result;
+        }
+        return [200, auditRecord];
+      });
+
+    return api.accounts.auditRecords.get({
+      token,
+      jwtToken,
+      providerId,
+      folder,
+      itemId
+    }).then((res) => {
+      assert.deepStrictEqual(res.status, 200);
+      assert.deepStrictEqual(res.data, auditRecord);
+    });
+  });
+});

package/test/endpoints/accounts/users.js

@@ -205,4 +205,28 @@ describe("accounts/user/{id}", () => {
       newUserId
     });
   });
+
+  it("should GET /users/sequences with query.userIds", () => {
+    const query = {userIds: "1234321,9876543"};
+    axiosMock.onGet("/users/sequences", {params: query}).reply(
+      expectRequest({statusCode: 200, token, jwtToken, query})
+    );
+    return api.accounts.users.sequences.allByUserIds({
+      jwtToken,
+      token,
+      query
+    });
+  });
+
+  it("should GET /users/sequences without inventing extra query params", () => {
+    const query = {userIds: "1234321"};
+    axiosMock.onGet("/users/sequences").reply(
+      expectRequest({statusCode: 200, token, jwtToken, query})
+    );
+    return api.accounts.users.sequences.allByUserIds({
+      jwtToken,
+      token,
+      query
+    });
+  });
 });

package/types/endpoints/accounts/audit-records.d.ts

@@ -0,0 +1,16 @@
+export = auditRecordsFactory;
+/**
+ * Factory for audit-records API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
+declare function auditRecordsFactory({ client, internalAuthTokenProvider }: {
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
+}): {
+    get: Function;
+};

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

@@ -4,7 +4,7 @@ export = usersFactory;
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ get: function, getV2: function, all: function, create: function, login: function, update: function, delete: function, createOrUpdateMany: function, impersonate: function, startMfa: function, confirmMfa: function, disableMfa: function, sequences: { get: function, all: function, create: function, update: function, transfer: function } }}
+ * @returns {{ get: function, getV2: function, all: function, create: function, login: function, update: function, delete: function, createOrUpdateMany: function, impersonate: function, startMfa: function, confirmMfa: function, disableMfa: function, sequences: { get: function, all: function, allByUserIds: function, create: function, update: function, transfer: function } }}
  */
 declare function usersFactory({ client, internalAuthTokenProvider }: {
     client: import("axios").AxiosInstance;
@@ -27,6 +27,7 @@ declare function usersFactory({ client, internalAuthTokenProvider }: {
     sequences: {
         get: Function;
         all: Function;
+        allByUserIds: Function;
         create: Function;
         update: Function;
         transfer: Function;