@W-20893693: Updating AM users client naming convention

amit-kumar8-sf · amit-kumar8-sf · commit a6128f41ba7d · 2026-01-30T10:05:35.000+05:30
diff --git a/docs/api-readme.md b/docs/api-readme.md
@@ -248,7 +248,6 @@ The SDK provides operations for managing users, roles, and organizations.
 
 ```typescript
 import {
-  createAccountManagerClient,
   listUsers,
   getUserByLogin,
   createUser,
@@ -258,6 +257,7 @@ import {
   grantRole,
   revokeRole,
 } from '@salesforce/b2c-tooling-sdk/operations/users';
+import {createAccountManagerUsersClient} from '@salesforce/b2c-tooling-sdk/clients';
 import { OAuthStrategy } from '@salesforce/b2c-tooling-sdk/auth';
 
 // Create Account Manager client
@@ -266,7 +266,7 @@ const auth = new OAuthStrategy({
   clientSecret: 'your-client-secret',
 });
 
-const client = createAccountManagerClient(
+const client = createAccountManagerUsersClient(
   { accountManagerHost: 'account.demandware.com' },
   auth,
 );
diff --git a/packages/b2c-cli/src/commands/role/grant.ts b/packages/b2c-cli/src/commands/role/grant.ts
@@ -47,7 +47,7 @@ export default class RoleGrant extends UserCommand<typeof RoleGrant> {
 
     this.log(t('commands.role.grant.fetching', 'Fetching user {{login}}...', {login}));
 
-    const user = await getUserByLogin(this.accountManagerClient, login);
+    const user = await getUserByLogin(this.accountManagerUsersClient, login);
 
     if (!user.id) {
       this.error(t('commands.role.grant.noId', 'User does not have an ID'));
@@ -60,7 +60,7 @@ export default class RoleGrant extends UserCommand<typeof RoleGrant> {
       }),
     );
 
-    const updatedUser = await grantRole(this.accountManagerClient, {
+    const updatedUser = await grantRole(this.accountManagerUsersClient, {
       userId: user.id,
       role,
       scope,
diff --git a/packages/b2c-cli/src/commands/role/revoke.ts b/packages/b2c-cli/src/commands/role/revoke.ts
@@ -47,7 +47,7 @@ export default class RoleRevoke extends UserCommand<typeof RoleRevoke> {
 
     this.log(t('commands.role.revoke.fetching', 'Fetching user {{login}}...', {login}));
 
-    const user = await getUserByLogin(this.accountManagerClient, login);
+    const user = await getUserByLogin(this.accountManagerUsersClient, login);
 
     if (!user.id) {
       this.error(t('commands.role.revoke.noId', 'User does not have an ID'));
@@ -60,7 +60,7 @@ export default class RoleRevoke extends UserCommand<typeof RoleRevoke> {
       }),
     );
 
-    const updatedUser = await revokeRole(this.accountManagerClient, {
+    const updatedUser = await revokeRole(this.accountManagerUsersClient, {
       userId: user.id,
       role,
       scope,
diff --git a/packages/b2c-cli/src/commands/user/create.ts b/packages/b2c-cli/src/commands/user/create.ts
@@ -48,7 +48,7 @@ export default class UserCreate extends UserCommand<typeof UserCreate> {
 
     this.log(t('commands.user.create.creating', 'Creating user {{mail}} in organization {{org}}...', {mail, org}));
 
-    const user = await createUser(this.accountManagerClient, {
+    const user = await createUser(this.accountManagerUsersClient, {
       user: {
         mail,
         firstName,
diff --git a/packages/b2c-cli/src/commands/user/delete.ts b/packages/b2c-cli/src/commands/user/delete.ts
@@ -41,7 +41,7 @@ export default class UserDelete extends UserCommand<typeof UserDelete> {
 
     this.log(t('commands.user.delete.fetching', 'Fetching user {{login}}...', {login}));
 
-    const user = await getUserByLogin(this.accountManagerClient, login);
+    const user = await getUserByLogin(this.accountManagerUsersClient, login);
 
     if (!user.id) {
       this.error(t('commands.user.delete.noId', 'User does not have an ID'));
@@ -53,14 +53,14 @@ export default class UserDelete extends UserCommand<typeof UserDelete> {
           login,
         }),
       );
-      await purgeUser(this.accountManagerClient, user.id);
+      await purgeUser(this.accountManagerUsersClient, user.id);
     } else {
       this.log(
         t('commands.user.delete.deleting', 'Deleting user {{login}}...', {
           login,
         }),
       );
-      await deleteUser(this.accountManagerClient, user.id);
+      await deleteUser(this.accountManagerUsersClient, user.id);
     }
 
     if (this.jsonEnabled()) {
diff --git a/packages/b2c-cli/src/commands/user/get.ts b/packages/b2c-cli/src/commands/user/get.ts
@@ -35,7 +35,7 @@ export default class UserGet extends UserCommand<typeof UserGet> {
 
     this.log(t('commands.user.get.fetching', 'Fetching user {{login}}...', {login}));
 
-    const user = await getUserByLogin(this.accountManagerClient, login);
+    const user = await getUserByLogin(this.accountManagerUsersClient, login);
 
     if (this.jsonEnabled()) {
       return user;
diff --git a/packages/b2c-cli/src/commands/user/list.ts b/packages/b2c-cli/src/commands/user/list.ts
@@ -137,7 +137,7 @@ export default class UserList extends UserCommand<typeof UserList> {
 
     this.log(t('commands.user.list.fetching', 'Fetching users...'));
 
-    const result = await listUsers(this.accountManagerClient, {
+    const result = await listUsers(this.accountManagerUsersClient, {
       size: pageSize,
       page: pageNumber,
     });
diff --git a/packages/b2c-cli/src/commands/user/reset.ts b/packages/b2c-cli/src/commands/user/reset.ts
@@ -33,15 +33,15 @@ export default class UserReset extends UserCommand<typeof UserReset> {
 
     this.log(t('commands.user.reset.fetching', 'Fetching user {{login}}...', {login}));
 
-    const user = await getUserByLogin(this.accountManagerClient, login);
+    const user = await getUserByLogin(this.accountManagerUsersClient, login);
 
     if (!user.id) {
       this.error(t('commands.user.reset.noId', 'User does not have an ID'));
     }
 
     this.log(t('commands.user.reset.resetting', 'Resetting password for user {{login}}...', {login}));
 
-    await resetUser(this.accountManagerClient, user.id);
+    await resetUser(this.accountManagerUsersClient, user.id);
 
     if (this.jsonEnabled()) {
       return;
diff --git a/packages/b2c-cli/src/commands/user/update.ts b/packages/b2c-cli/src/commands/user/update.ts
@@ -44,7 +44,7 @@ export default class UserUpdate extends UserCommand<typeof UserUpdate> {
 
     this.log(t('commands.user.update.fetching', 'Fetching user {{login}}...', {login}));
 
-    const user = await getUserByLogin(this.accountManagerClient, login);
+    const user = await getUserByLogin(this.accountManagerUsersClient, login);
 
     if (!user.id) {
       this.error(t('commands.user.update.noId', 'User does not have an ID'));
@@ -64,7 +64,7 @@ export default class UserUpdate extends UserCommand<typeof UserUpdate> {
 
     this.log(t('commands.user.update.updating', 'Updating user {{login}}...', {login}));
 
-    const updatedUser = await updateUser(this.accountManagerClient, {
+    const updatedUser = await updateUser(this.accountManagerUsersClient, {
       userId: user.id,
       changes: changes as UserUpdateType,
     });
diff --git a/packages/b2c-cli/test/helpers/test-setup.ts b/packages/b2c-cli/test/helpers/test-setup.ts
@@ -118,7 +118,7 @@ export function stubJsonEnabled(command: any, enabled: boolean): void {
 /**
  * Stubs a client property on a command.
  * @param command - The command instance to stub
- * @param propertyName - The name of the client property (e.g., 'accountManagerClient', 'accountManagerRolesClient', 'accountManagerOrgsClient')
+ * @param propertyName - The name of the client property (e.g., 'accountManagerUsersClient', 'accountManagerRolesClient', 'accountManagerOrgsClient')
  * @param client - The client instance to stub
  */
 export function stubClient(command: any, propertyName: string, client: any): void {
diff --git a/packages/b2c-tooling-sdk/README.md b/packages/b2c-tooling-sdk/README.md
@@ -138,15 +138,15 @@ import {
   grantRole,
   revokeRole,
 } from '@salesforce/b2c-tooling-sdk/operations/users';
-import {createAccountManagerClient} from '@salesforce/b2c-tooling-sdk/clients';
+import {createAccountManagerUsersClient} from '@salesforce/b2c-tooling-sdk/clients';
 import {OAuthStrategy} from '@salesforce/b2c-tooling-sdk/auth';
 
 const auth = new OAuthStrategy({
   clientId: 'your-client-id',
   clientSecret: 'your-client-secret',
 });
 
-const client = createAccountManagerClient({}, auth);
+const client = createAccountManagerUsersClient({}, auth);
 
 // List users with pagination
 const users = await listUsers(client, {size: 25, page: 0});
diff --git a/packages/b2c-tooling-sdk/src/cli/user-command.ts b/packages/b2c-tooling-sdk/src/cli/user-command.ts
@@ -5,39 +5,39 @@
  */
 import {Command} from '@oclif/core';
 import {OAuthCommand} from './oauth-command.js';
-import {createAccountManagerClient} from '../clients/am-users-api.js';
-import type {AccountManagerClient} from '../clients/am-users-api.js';
+import {createAccountManagerUsersClient} from '../clients/am-users-api.js';
+import type {AccountManagerUsersClient} from '../clients/am-users-api.js';
 
 /**
  * Base command for Account Manager user operations.
  *
- * Extends OAuthCommand with Account Manager client setup.
+ * Extends OAuthCommand with Account Manager Users client setup.
  *
  * @example
  * export default class UserList extends UserCommand<typeof UserList> {
  *   async run(): Promise<void> {
- *     const users = await this.accountManagerClient.listUsers();
+ *     const users = await this.accountManagerUsersClient.listUsers();
  *     // ...
  *   }
  * }
  */
 export abstract class UserCommand<T extends typeof Command> extends OAuthCommand<T> {
-  private _accountManagerClient?: AccountManagerClient;
+  private _accountManagerUsersClient?: AccountManagerUsersClient;
 
   /**
-   * Gets the Account Manager client, creating it if necessary.
+   * Gets the Account Manager Users client, creating it if necessary.
    */
-  protected get accountManagerClient(): AccountManagerClient {
-    if (!this._accountManagerClient) {
+  protected get accountManagerUsersClient(): AccountManagerUsersClient {
+    if (!this._accountManagerUsersClient) {
       this.requireOAuthCredentials();
       const authStrategy = this.getOAuthStrategy();
-      this._accountManagerClient = createAccountManagerClient(
+      this._accountManagerUsersClient = createAccountManagerUsersClient(
         {
           hostname: this.accountManagerHost,
         },
         authStrategy,
       );
     }
-    return this._accountManagerClient;
+    return this._accountManagerUsersClient;
   }
 }
diff --git a/packages/b2c-tooling-sdk/src/clients/am-users-api.ts b/packages/b2c-tooling-sdk/src/clients/am-users-api.ts
@@ -28,9 +28,9 @@ export type {paths, components};
 /**
  * The typed Account Manager Users client - this is the openapi-fetch Client with full type safety.
  *
- * @see {@link createAccountManagerClient} for instantiation
+ * @see {@link createAccountManagerUsersClient} for instantiation
  */
-export type AccountManagerClient = Client<paths>;
+export type AccountManagerUsersClient = Client<paths>;
 
 /**
  * Helper type to extract response data from an operation.
@@ -95,7 +95,7 @@ function createPageableTransformMiddleware(): Middleware {
 /**
  * Configuration for creating an Account Manager client.
  */
-export interface AccountManagerClientConfig {
+export interface AccountManagerUsersClientConfig {
   /**
    * Account Manager hostname.
    * Defaults to: account.demandware.com
@@ -129,7 +129,7 @@ export interface AccountManagerClientConfig {
  *   clientSecret: 'your-client-secret',
  * });
  *
- * const client = createAccountManagerClient({}, oauthStrategy);
+ * const client = createAccountManagerUsersClient({}, oauthStrategy);
  *
  * // List users
  * const { data, error } = await client.GET('/dw/rest/v1/users', {
@@ -152,10 +152,10 @@ export interface AccountManagerClientConfig {
  *   }
  * });
  */
-export function createAccountManagerClient(
-  config: AccountManagerClientConfig,
+export function createAccountManagerUsersClient(
+  config: AccountManagerUsersClientConfig,
   auth: AuthStrategy,
-): AccountManagerClient {
+): AccountManagerUsersClient {
   const hostname = config.hostname ?? DEFAULT_ACCOUNT_MANAGER_HOST;
   const registry = config.middlewareRegistry ?? globalMiddlewareRegistry;
 
@@ -241,7 +241,7 @@ export interface ListUsersOptions {
  * @returns User details
  * @throws Error if user is not found or request fails
  */
-export async function getUser(client: AccountManagerClient, userId: string): Promise<AccountManagerUser> {
+export async function getUser(client: AccountManagerUsersClient, userId: string): Promise<AccountManagerUser> {
   const result = await client.GET('/dw/rest/v1/users/{userId}', {
     params: {path: {userId}},
   });
@@ -269,7 +269,10 @@ export async function getUser(client: AccountManagerClient, userId: string): Pro
  * @returns Paginated user collection
  * @throws Error if request fails
  */
-export async function listUsers(client: AccountManagerClient, options: ListUsersOptions = {}): Promise<UserCollection> {
+export async function listUsers(
+  client: AccountManagerUsersClient,
+  options: ListUsersOptions = {},
+): Promise<UserCollection> {
   const {size = 20, page = 0} = options;
 
   const result = await client.GET('/dw/rest/v1/users', {
@@ -311,7 +314,7 @@ export async function listUsers(client: AccountManagerClient, options: ListUsers
  * @returns Created user
  * @throws Error if request fails
  */
-export async function createUser(client: AccountManagerClient, user: UserCreate): Promise<AccountManagerUser> {
+export async function createUser(client: AccountManagerUsersClient, user: UserCreate): Promise<AccountManagerUser> {
   const result = await client.POST('/dw/rest/v1/users', {
     body: user,
   });
@@ -338,7 +341,7 @@ export async function createUser(client: AccountManagerClient, user: UserCreate)
  * @throws Error if request fails
  */
 export async function updateUser(
-  client: AccountManagerClient,
+  client: AccountManagerUsersClient,
   userId: string,
   changes: UserUpdate,
 ): Promise<AccountManagerUser> {
@@ -367,7 +370,7 @@ export async function updateUser(
  * @param userId - User ID
  * @throws Error if request fails
  */
-export async function deleteUser(client: AccountManagerClient, userId: string): Promise<void> {
+export async function deleteUser(client: AccountManagerUsersClient, userId: string): Promise<void> {
   const result = await client.POST('/dw/rest/v1/users/{userId}/disable', {
     params: {path: {userId}},
     body: {},
@@ -387,7 +390,7 @@ export async function deleteUser(client: AccountManagerClient, userId: string):
  * @param userId - User ID
  * @throws Error if request fails
  */
-export async function purgeUser(client: AccountManagerClient, userId: string): Promise<void> {
+export async function purgeUser(client: AccountManagerUsersClient, userId: string): Promise<void> {
   const result = await client.DELETE('/dw/rest/v1/users/{userId}', {
     params: {path: {userId}},
   });
@@ -405,7 +408,7 @@ export async function purgeUser(client: AccountManagerClient, userId: string): P
  * @param userId - User ID
  * @throws Error if request fails
  */
-export async function resetUser(client: AccountManagerClient, userId: string): Promise<void> {
+export async function resetUser(client: AccountManagerUsersClient, userId: string): Promise<void> {
   const result = await client.POST('/dw/rest/v1/users/{userId}/reset', {
     params: {path: {userId}},
     body: {},
@@ -427,7 +430,7 @@ export async function resetUser(client: AccountManagerClient, userId: string): P
  * @throws Error if request fails
  */
 export async function findUserByLogin(
-  client: AccountManagerClient,
+  client: AccountManagerUsersClient,
   login: string,
 ): Promise<AccountManagerUser | undefined> {
   // Search through paginated results
diff --git a/packages/b2c-tooling-sdk/src/clients/index.ts b/packages/b2c-tooling-sdk/src/clients/index.ts
@@ -205,7 +205,7 @@ export type {
 } from './scapi-schemas.js';
 
 export {
-  createAccountManagerClient,
+  createAccountManagerUsersClient,
   getUser,
   listUsers,
   createUser,
@@ -220,8 +220,8 @@ export {
   ROLE_NAMES_MAP_REVERSE,
 } from './am-users-api.js';
 export type {
-  AccountManagerClient,
-  AccountManagerClientConfig,
+  AccountManagerUsersClient,
+  AccountManagerUsersClientConfig,
   AccountManagerUser,
   AccountManagerResponse,
   AccountManagerError,
diff --git a/packages/b2c-tooling-sdk/src/index.ts b/packages/b2c-tooling-sdk/src/index.ts
@@ -66,7 +66,9 @@ export {
   createSlasClient,
   createOdsClient,
   createCustomApisClient,
-  createAccountManagerClient,
+  createAccountManagerUsersClient,
+  createAccountManagerRolesClient,
+  createAccountManagerOrgsClient,
   createCdnZonesClient,
   toOrganizationId,
   toTenantId,
@@ -104,8 +106,8 @@ export type {
   CustomApisResponse,
   CustomApisPaths,
   CustomApisComponents,
-  AccountManagerClient,
-  AccountManagerClientConfig,
+  AccountManagerUsersClient,
+  AccountManagerUsersClientConfig,
   AccountManagerUser,
   AccountManagerResponse,
   AccountManagerError,
diff --git a/packages/b2c-tooling-sdk/src/operations/orgs/index.ts b/packages/b2c-tooling-sdk/src/operations/orgs/index.ts
@@ -64,7 +64,6 @@ import type {
 
 // Re-export types
 export type {
-  AccountManagerOrgsClient,
   AccountManagerOrganization,
   OrganizationCollection,
   AuditLogCollection,
diff --git a/packages/b2c-tooling-sdk/src/operations/roles/index.ts b/packages/b2c-tooling-sdk/src/operations/roles/index.ts
diff --git a/packages/b2c-tooling-sdk/src/operations/users/index.ts b/packages/b2c-tooling-sdk/src/operations/users/index.ts
diff --git a/packages/b2c-tooling-sdk/test/cli/user-command.test.ts b/packages/b2c-tooling-sdk/test/cli/user-command.test.ts
diff --git a/packages/b2c-tooling-sdk/test/clients/am-users-api.test.ts b/packages/b2c-tooling-sdk/test/clients/am-users-api.test.ts
diff --git a/packages/b2c-tooling-sdk/test/operations/users/index.test.ts b/packages/b2c-tooling-sdk/test/operations/users/index.test.ts
