cheshirecat-typescript-client 1.2.3 → 1.2.4

package/dist/endpoints/users.d.ts

@@ -17,83 +17,70 @@ export declare class UsersEndpoint extends AbstractEndpoint {
     /**
      * This endpoint is used to get a list of available permissions in the system. The permissions are used to define
      * the access rights of the users in the system. The permissions are defined by the system administrator.
-     * The endpoint can be used either for the agent identified by the agentId parameter (for multi-agent installations)
-     * or for the default agent (for single-agent installations).
      *
      * @param agentId The ID of the agent.
      *
      * @returns The available permissions in the system.
      */
-    getAvailablePermissions(agentId?: string | null): Promise<Permission>;
+    getAvailablePermissions(agentId: string): Promise<Permission>;
     /**
      * This endpoint is used to create a new user in the system. The user is created with the specified username and
      * password. The user is assigned the specified permissions. The permissions are used to define the access rights
      * of the user in the system and are defined by the system administrator.
-     * The endpoint can be used either for the
-     * agent identified by the agentId parameter (for multi-agent installations) or for the default agent (for
-     * single-agent installations).
      *
+     * @param agentId The ID of the agent.
      * @param username The username of the user.
      * @param password The password of the user.
      * @param permissions The permissions of the user.
-     * @param agentId The ID of the agent.
      *
      * @returns The created user.
      */
-    postUser(username: string, password: string, permissions?: Record<string, string[]> | null, agentId?: string | null): Promise<UserOutput>;
+    postUser(agentId: string, username: string, password: string, permissions?: Record<string, string[]> | null): Promise<UserOutput>;
     /**
      * This endpoint is used to get a list of users in the system. The list includes the username and the permissions of
      * each user. The permissions are used to define the access rights of the users in the system and are defined by the
      * system administrator.
-     * The endpoint can be used either for the agent identified by the agentId parameter (for multi-agent installations)
-     * or for the default agent (for single-agent installations).
      *
      * @param agentId The ID of the agent.
      *
      * @returns The list of users in the system.
      */
-    getUsers(agentId?: string | null): Promise<UserOutput[]>;
+    getUsers(agentId: string): Promise<UserOutput[]>;
     /**
      * This endpoint is used to get a user in the system. The user is identified by the userId parameter, previously
      * provided by the CheshireCat API when the user was created. The endpoint returns the username and the permissions
      * of the user. The permissions are used to define the access rights of the user in the system and are defined by
      * the system administrator.
-     * The endpoint can be used either for the agent identified by the agentId parameter (for multi-agent installations)
-     * or for the default agent (for single-agent installations).
      *
      * @param userId The ID of the user.
      * @param agentId The ID of the agent.
      *
      * @returns The user in the system.
      */
-    getUser(userId: string, agentId?: string | null): Promise<UserOutput>;
+    getUser(userId: string, agentId: string): Promise<UserOutput>;
     /**
      * The endpoint is used to update the user in the system. The user is identified by the userId parameter, previously
      * provided by the CheshireCat API when the user was created. The endpoint updates the username, the password, and
      * the permissions of the user. The permissions are used to define the access rights of the user in the system and
      * are defined by the system administrator.
-     * The endpoint can be used either for the agent identified by the agentId parameter (for multi-agent installations)
-     * or for the default agent (for single-agent installations).
      *
      * @param userId The ID of the user.
+     * @param agentId The ID of the agent.
      * @param username The username of the user.
      * @param password The password of the user.
      * @param permissions The permissions of the user.
-     * @param agentId The ID of the agent.
      *
      * @returns The updated user.
      */
-    putUser(userId: string, username?: string | null, password?: string | null, permissions?: Record<string, string[]> | null, agentId?: string | null): Promise<UserOutput>;
+    putUser(userId: string, agentId: string, username?: string | null, password?: string | null, permissions?: Record<string, string[]> | null): Promise<UserOutput>;
     /**
      * This endpoint is used to delete the user in the system. The user is identified by the userId parameter,
      * previously provided by the CheshireCat API when the user was created.
-     * The endpoint can be used either for the agent identified by the agentId parameter (for multi-agent installations)
-     * or for the default agent (for single-agent installations).
      *
      * @param userId The ID of the user.
      * @param agentId The ID of the agent.
      *
      * @returns The deleted user.
      */
-    deleteUser(userId: string, agentId?: string | null): Promise<UserOutput>;
+    deleteUser(userId: string, agentId: string): Promise<UserOutput>;
 }

package/dist/endpoints/users.js

@@ -27,8 +27,6 @@ class UsersEndpoint extends abstract_1.AbstractEndpoint {
     /**
      * This endpoint is used to get a list of available permissions in the system. The permissions are used to define
      * the access rights of the users in the system. The permissions are defined by the system administrator.
-     * The endpoint can be used either for the agent identified by the agentId parameter (for multi-agent installations)
-     * or for the default agent (for single-agent installations).
      *
      * @param agentId The ID of the agent.
      *
@@ -42,18 +40,15 @@ class UsersEndpoint extends abstract_1.AbstractEndpoint {
      * This endpoint is used to create a new user in the system. The user is created with the specified username and
      * password. The user is assigned the specified permissions. The permissions are used to define the access rights
      * of the user in the system and are defined by the system administrator.
-     * The endpoint can be used either for the
-     * agent identified by the agentId parameter (for multi-agent installations) or for the default agent (for
-     * single-agent installations).
      *
+     * @param agentId The ID of the agent.
      * @param username The username of the user.
      * @param password The password of the user.
      * @param permissions The permissions of the user.
-     * @param agentId The ID of the agent.
      *
      * @returns The created user.
      */
-    async postUser(username, password, permissions, agentId) {
+    async postUser(agentId, username, password, permissions) {
         const payload = {
             username,
             password,
@@ -62,14 +57,12 @@ class UsersEndpoint extends abstract_1.AbstractEndpoint {
         if (permissions) {
             payload.permissions = permissions;
         }
-        return this.post(this.prefix, payload, agentId);
+        return this.post(this.prefix, agentId, payload);
     }
     /**
      * This endpoint is used to get a list of users in the system. The list includes the username and the permissions of
      * each user. The permissions are used to define the access rights of the users in the system and are defined by the
      * system administrator.
-     * The endpoint can be used either for the agent identified by the agentId parameter (for multi-agent installations)
-     * or for the default agent (for single-agent installations).
      *
      * @param agentId The ID of the agent.
      *
@@ -85,8 +78,6 @@ class UsersEndpoint extends abstract_1.AbstractEndpoint {
      * provided by the CheshireCat API when the user was created. The endpoint returns the username and the permissions
      * of the user. The permissions are used to define the access rights of the user in the system and are defined by
      * the system administrator.
-     * The endpoint can be used either for the agent identified by the agentId parameter (for multi-agent installations)
-     * or for the default agent (for single-agent installations).
      *
      * @param userId The ID of the user.
      * @param agentId The ID of the agent.
@@ -101,18 +92,16 @@ class UsersEndpoint extends abstract_1.AbstractEndpoint {
      * provided by the CheshireCat API when the user was created. The endpoint updates the username, the password, and
      * the permissions of the user. The permissions are used to define the access rights of the user in the system and
      * are defined by the system administrator.
-     * The endpoint can be used either for the agent identified by the agentId parameter (for multi-agent installations)
-     * or for the default agent (for single-agent installations).
      *
      * @param userId The ID of the user.
+     * @param agentId The ID of the agent.
      * @param username The username of the user.
      * @param password The password of the user.
      * @param permissions The permissions of the user.
-     * @param agentId The ID of the agent.
      *
      * @returns The updated user.
      */
-    async putUser(userId, username, password, permissions, agentId) {
+    async putUser(userId, agentId, username, password, permissions) {
         const payload = {};
         if (username) {
             payload.username = username;
@@ -123,13 +112,11 @@ class UsersEndpoint extends abstract_1.AbstractEndpoint {
         if (permissions) {
             payload.permissions = permissions;
         }
-        return this.put(this.formatUrl(userId), payload, agentId);
+        return this.put(this.formatUrl(userId), agentId, payload);
     }
     /**
      * This endpoint is used to delete the user in the system. The user is identified by the userId parameter,
      * previously provided by the CheshireCat API when the user was created.
-     * The endpoint can be used either for the agent identified by the agentId parameter (for multi-agent installations)
-     * or for the default agent (for single-agent installations).
      *
      * @param userId The ID of the user.
      * @param agentId The ID of the agent.

package/dist/endpoints/users.js.map

@@ -1 +1 @@
-{"version":3,"file":"users.js","sourceRoot":"","sources":["../../src/endpoints/users.ts"],"names":[],"mappings":";;;AAAA,yCAA4C;AAK5C,MAAa,aAAc,SAAQ,2BAAgB;IACrC,MAAM,GAAG,QAAQ,CAAC;IAE5B;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAK,CAAC,QAAgB,EAAE,QAAgB;QAC1C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC,gBAAgB,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE;YACtF,IAAI,EAAE;gBACF,QAAQ;gBACR,QAAQ;aACX;SACJ,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAc,QAAQ,CAAC,IAAI,CAAC,CAAC;QAE5D,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAEzC,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,uBAAuB,CAAC,OAAuB;QACjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;QAEtF,OAAO,IAAI,CAAC,WAAW,CAAa,QAAQ,CAAC,IAAI,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,QAAQ,CACV,QAAgB,EAChB,QAAgB,EAChB,WAA6C,EAC7C,OAAuB;QAEvB,MAAM,OAAO,GAAG;YACZ,QAAQ;YACR,QAAQ;YACR,WAAW,EAAE,WAAW;SAC3B,CAAC;QACF,IAAI,WAAW,EAAE,CAAC;YACd,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;QACtC,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAa,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,QAAQ,CAAC,OAAuB;QAClC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEpE,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC5B,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAS,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAa,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,OAAO,CAAC,MAAc,EAAE,OAAuB;QACjD,OAAO,IAAI,CAAC,GAAG,CAAa,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,OAAO,CACT,MAAc,EACd,QAAwB,EACxB,QAAwB,EACxB,WAA6C,EAC7C,OAAuB;QAEvB,MAAM,OAAO,GAAQ,EAAE,CAAC;QACxB,IAAI,QAAQ,EAAE,CAAC;YACX,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAChC,CAAC;QACD,IAAI,QAAQ,EAAE,CAAC;YACX,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAChC,CAAC;QACD,IAAI,WAAW,EAAE,CAAC;YACd,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;QACtC,CAAC;QAED,OAAO,IAAI,CAAC,GAAG,CAAa,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,UAAU,CAAC,MAAc,EAAE,OAAuB;QACpD,OAAO,IAAI,CAAC,MAAM,CAAa,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;CACJ;AAlKD,sCAkKC"}
+{"version":3,"file":"users.js","sourceRoot":"","sources":["../../src/endpoints/users.ts"],"names":[],"mappings":";;;AAAA,yCAA4C;AAK5C,MAAa,aAAc,SAAQ,2BAAgB;IACrC,MAAM,GAAG,QAAQ,CAAC;IAE5B;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAK,CAAC,QAAgB,EAAE,QAAgB;QAC1C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC,gBAAgB,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE;YACtF,IAAI,EAAE;gBACF,QAAQ;gBACR,QAAQ;aACX;SACJ,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAc,QAAQ,CAAC,IAAI,CAAC,CAAC;QAE5D,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAEzC,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,uBAAuB,CAAC,OAAe;QACzC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;QAEtF,OAAO,IAAI,CAAC,WAAW,CAAa,QAAQ,CAAC,IAAI,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,QAAQ,CACV,OAAe,EACf,QAAgB,EAChB,QAAgB,EAChB,WAA6C;QAE7C,MAAM,OAAO,GAAG;YACZ,QAAQ;YACR,QAAQ;YACR,WAAW,EAAE,WAAW;SAC3B,CAAC;QACF,IAAI,WAAW,EAAE,CAAC;YACd,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;QACtC,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAa,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,QAAQ,CAAC,OAAe;QAC1B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEpE,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC5B,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAS,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAa,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,OAAO,CAAC,MAAc,EAAE,OAAe;QACzC,OAAO,IAAI,CAAC,GAAG,CAAa,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,OAAO,CACT,MAAc,EACd,OAAe,EACf,QAAwB,EACxB,QAAwB,EACxB,WAA6C;QAE7C,MAAM,OAAO,GAAQ,EAAE,CAAC;QACxB,IAAI,QAAQ,EAAE,CAAC;YACX,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAChC,CAAC;QACD,IAAI,QAAQ,EAAE,CAAC;YACX,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAChC,CAAC;QACD,IAAI,WAAW,EAAE,CAAC;YACd,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;QACtC,CAAC;QAED,OAAO,IAAI,CAAC,GAAG,CAAa,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,UAAU,CAAC,MAAc,EAAE,OAAe;QAC5C,OAAO,IAAI,CAAC,MAAM,CAAa,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;CACJ;AArJD,sCAqJC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cheshirecat-typescript-client",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "engines": {
     "node": "22.x"
   },