feat: support for clone smtp user credentials (#83)

Signed-off-by: nitish <[email protected]>

Author: nitish-sudo

.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "package-lock.json|^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2025-09-25T01:54:39Z",
+  "generated_at": "2025-10-28T09:15:04Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
@@ -126,15 +126,15 @@
         "hashed_secret": "d4c3d66fd0c38547a3c7a4c6bdc29c36911bc030",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 1658,
+        "line_number": 1661,
         "type": "Secret Keyword",
         "verified_result": null
       },
       {
         "hashed_secret": "3235b7f8d626cde63611d2e9ec43473f4e844c67",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 2967,
+        "line_number": 2970,
         "type": "Base64 High Entropy String",
         "verified_result": null
       }
@@ -144,21 +144,21 @@
         "hashed_secret": "0cc20f91828bed53ddb6294968b7f9abd631a3ba",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 1598,
+        "line_number": 1601,
         "type": "Secret Keyword",
         "verified_result": null
       },
       {
         "hashed_secret": "3235b7f8d626cde63611d2e9ec43473f4e844c67",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 3332,
+        "line_number": 3335,
         "type": "Base64 High Entropy String",
         "verified_result": null
       }
     ]
   },
-  "version": "0.13.1+ibm.62.dss",
+  "version": "0.13.1+ibm.64.dss",
   "word_list": {
     "file": null,
     "hash": null

README.md

@@ -1314,6 +1314,19 @@ const res = await eventNotificationsService.createSmtpUser(createSmtpUserParams)
 
 ```
 
+### Clone SMTP User
+
+```js
+const cloneSmtpUserParams = {
+  instanceId : <instance-id>,
+  id: <smtp-Config-id>,
+  usernameToClone: <smtp-user-to-clone>,
+};
+
+const res = await eventNotificationsService.createSmtpUser(cloneSmtpUserParams);
+
+```
+
 ### Get SMTP Configuration
 
 ```js
@@ -1675,6 +1688,7 @@ Find [event_notifications_v1.env.hide](https://github.com/IBM/event-notification
 - `EVENT_NOTIFICATIONS_CODE_ENGINE_JOB_TEMPLATE_BODY` - base 64 encoded json body for Code Engine Job
 - `EVENT_NOTIFICATIONS_APP_CONFIG_CRN` - CRN of App Configuration instance
 - `EVENT_NOTIFICATIONS_APP_CONFIG_TEMPLATE_BODY` -  base 64 encoded json body for App Configuration
+- `EVENT_NOTIFICATIONS_SMTP_USER_TO_CLONE` - SMTP username to be cloned
 
 ## Questions
 

event-notifications/v1.ts

@@ -2725,6 +2725,7 @@ class EventNotificationsV1 extends BaseService {
    * @param {string} params.instanceId - Unique identifier for IBM Cloud Event Notifications instance.
    * @param {string} params.id - Unique identifier for SMTP.
    * @param {string} [params.description] - The description of SMTP configuration.
+   * @param {string} [params.usernameToClone] - provide name of the user to clone.
    * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
    * @returns {Promise<EventNotificationsV1.Response<EventNotificationsV1.SMTPUserResponse>>}
    */
@@ -2733,7 +2734,7 @@ class EventNotificationsV1 extends BaseService {
   ): Promise<EventNotificationsV1.Response<EventNotificationsV1.SMTPUserResponse>> {
     const _params = { ...params };
     const _requiredParams = ['instanceId', 'id'];
-    const _validParams = ['instanceId', 'id', 'description', 'headers'];
+    const _validParams = ['instanceId', 'id', 'description', 'usernameToClone', 'headers'];
     const _validationErrors = validateParams(_params, _requiredParams, _validParams);
     if (_validationErrors) {
       return Promise.reject(_validationErrors);
@@ -2743,6 +2744,10 @@ class EventNotificationsV1 extends BaseService {
       'description': _params.description,
     };
 
+    const query = {
+      'username_to_clone': _params.usernameToClone,
+    };
+
     const path = {
       'instance_id': _params.instanceId,
       'id': _params.id,
@@ -2759,6 +2764,7 @@ class EventNotificationsV1 extends BaseService {
         url: '/v1/instances/{instance_id}/smtp/config/{id}/users',
         method: 'POST',
         body,
+        qs: query,
         path,
       },
       defaultOptions: extend(true, {}, this.baseOptions, {
@@ -3989,6 +3995,8 @@ namespace EventNotificationsV1 {
     id: string;
     /** The description of SMTP configuration. */
     description?: string;
+    /** provide name of the user to clone. */
+    usernameToClone?: string;
     headers?: OutgoingHttpHeaders;
   }
 
@@ -4702,8 +4710,8 @@ namespace EventNotificationsV1 {
     smtp_config_id: string;
     /** SMTP user name. */
     username: string;
-    /** password. */
-    password: string;
+    /** Password for SMTP user; Cloned SMTP user response do not include a password. */
+    password?: string;
     /** Created time. */
     created_at: string;
   }

examples/event-notifications.v1.test.js

@@ -124,6 +124,8 @@ let eventStreamsEndPoint = '';
 let appConfigTemplateBody = '';
 let appConfigCRN = '';
 let appConfigTemplateID = '';
+let smtpUserToClone = '';
+let smtpUserID2 = '';
 
 // Save original console.log
 const originalLog = console.log;
@@ -170,6 +172,7 @@ describe('EventNotificationsV1', () => {
   eventStreamsEndPoint = config.eventStreamsEndpoint;
   appConfigTemplateBody = config.appConfigTemplateBody;
   appConfigCRN = config.appConfigCrn;
+  smtpUserToClone = config.smtpUserToClone;
 
   let eventNotificationsService = EventNotificationsV1.newInstance({});
 
@@ -3186,6 +3189,34 @@ describe('EventNotificationsV1', () => {
     // end-create_smtp_user
   });
 
+  test('cloneSMTPUser request example', async () => {
+    consoleLogMock.mockImplementation((output) => {
+      originalLog(output);
+    });
+    consoleWarnMock.mockImplementation((output) => {
+      // if an error occurs, display the message and then fail the test
+      originalWarn(output);
+      expect(true).toBeFalsy();
+    });
+
+    originalLog('cloneSMTPUser() result:');
+    // begin-clone_smtp_user
+    const cloneSMTPUserParams = {
+      instanceId,
+      id: smtpConfigID,
+      usernameToClone: smtpUserToClone,
+    };
+
+    try {
+      const res = await eventNotificationsService.createSmtpUser(cloneSMTPUserParams);
+      smtpUserID2 = res.result.id;
+      console.log(JSON.stringify(res.result, null, 2));
+    } catch (err) {
+      console.warn(err);
+    }
+    // end-clone_smtp_user
+  });
+
   test('listSMTPConfigurations request example', async () => {
     consoleLogMock.mockImplementation((output) => {
       originalLog(output);
@@ -3472,6 +3503,19 @@ describe('EventNotificationsV1', () => {
       console.warn(err);
     }
     // end-delete_smtp_user
+
+    const deleteSmtpClonedUserParams = {
+      instanceId,
+      id: smtpConfigID,
+      userId: smtpUserID2,
+    };
+
+    try {
+      const res = await eventNotificationsService.deleteSmtpUser(deleteSmtpClonedUserParams);
+      console.log(JSON.stringify(res.result, null, 2));
+    } catch (err) {
+      console.warn(err);
+    }
   });
 
   test('deleteSMTPConfiguration  request example', async () => {

test/integration/event-notifications.v1.test.js

@@ -107,7 +107,9 @@ let slackTemplateBody = '';
 let cosInstanceCRN = '';
 let cosIntegrationId = '';
 let smtpConfigID = '';
+let smtpUserToClone = '';
 let smtpUserID = '';
+let smtpUserID2 = '';
 let notificationID = '';
 let slackDmToken = '';
 let slackChannelID = '';
@@ -178,6 +180,7 @@ describe('EventNotificationsV1_integration', () => {
     codeEngineJobTemplateBody = config.codeEngineJobTemplateBody;
     appConfigTemplateBody = config.appConfigTemplateBody;
     appConfigCRN = config.appConfigCrn;
+    smtpUserToClone = config.smtpUserToClone;
     eventNotificationsService.enableRetries();
   });
 
@@ -3509,6 +3512,24 @@ describe('EventNotificationsV1_integration', () => {
     smtpUserID = res.result.id;
   });
 
+  test('cloneSMTPUser()', async () => {
+    const description = 'SMTP user description clone';
+    const createSmtpUserParams = {
+      instanceId,
+      id: smtpConfigID,
+      usernameToClone: smtpUserToClone,
+      description,
+    };
+
+    const res = await eventNotificationsService.createSmtpUser(createSmtpUserParams);
+    expect(res).toBeDefined();
+    expect(res.status).toBe(201);
+    expect(res.result).toBeDefined();
+    expect(res.result.username).toBeDefined();
+    expect(res.result.domain).toBeDefined();
+    smtpUserID2 = res.result.id;
+  });
+
   test('listSMTPConfigurations()', async () => {
     const limit = 1;
     const offset = 0;
@@ -3656,7 +3677,7 @@ describe('EventNotificationsV1_integration', () => {
   });
 
   test('deleteSMTPUser()', async () => {
-    const userIDs = [smtpUserID];
+    const userIDs = [smtpUserID, smtpUserID2];
 
     for (let i = 0; i < userIDs.length; i += 1) {
       const deleteSmtpUserParams = {

test/unit/event-notifications.v1.test.js

@@ -4920,10 +4920,12 @@ describe('EventNotificationsV1', () => {
         const instanceId = 'testString';
         const id = 'testString';
         const description = 'testString';
+        const usernameToClone = 'testString';
         const createSmtpUserParams = {
           instanceId,
           id,
           description,
+          usernameToClone,
         };
 
         const createSmtpUserResult = eventNotificationsService.createSmtpUser(createSmtpUserParams);
@@ -4945,6 +4947,7 @@ describe('EventNotificationsV1', () => {
         const expectedContentType = 'application/json';
         checkMediaHeaders(createRequestMock, expectedAccept, expectedContentType);
         expect(mockRequestOptions.body.description).toEqual(description);
+        expect(mockRequestOptions.qs.username_to_clone).toEqual(usernameToClone);
         expect(mockRequestOptions.path.instance_id).toEqual(instanceId);
         expect(mockRequestOptions.path.id).toEqual(id);
       }