btrz-api-client 9.19.0 → 9.20.0

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.20.0",
   "description": "Api client for Betterez endpoints",
   "main": "index.js",
   "scripts": {

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/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/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;