feat: add support for getBounceMetrics (#84)

Signed-off-by: nitish <nitish.kulkarni3@ibm.com>
Co-authored-by: Nitish-Kulkarni3 <nitish.kulkarni3@ibm.com>

Author: Divya-Singh1693

.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "package-lock.json|^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2025-10-28T09:15:04Z",
+  "generated_at": "2025-12-09T16:56:26Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"

README.md

@@ -146,7 +146,8 @@ SDK Methods to consume
 	- [Delete SMTP Configuration](#delete-smtp-user)
 	- [Verify SMTP](#verify-smtp)
 - [Metrics](#Metrics) 
-  - [Get Metrics](#get-metrics)      
+  - [Get Metrics](#get-metrics)   
+  - [Get Bounce Metrics](#get-bounce-metrics)   
 - [Send Notifications](#send-notifications)
 
 ## Source 
@@ -1468,6 +1469,8 @@ const getMetricsParams = {
   gte: <gte-timestamp>,
   lte: <lte-timestamp>,
   destinationId: <destination-id>,
+  subscriptionId: <subscription-id>,
+  sourceId: <source-id>,
   emailTo: <email-to>,
   notificationId: <notification-id>,
   subject: <subject>,
@@ -1481,6 +1484,30 @@ try {
 }
 ```
 
+### Get Bounce Metrics
+
+```js
+const getBounceMetricsParams = {
+  instanceId: <instance-id>,
+  destinationType: 'smtp_custom',
+  gte: <gte-timestamp>,
+  lte: <lte-timestamp>,
+  destinationId: <destination-id>,
+  subscriptionId: <subscription-id>,
+  sourceId: <source-id>,
+  emailTo: <email-to>,
+  notificationId: <notification-id>,
+  subject: <subject>,
+};
+
+try {
+  const res = await eventNotificationsService.getBounceMetrics(getBounceMetricsParams);
+  console.log(JSON.stringify(res.result, null, 2));
+} catch (err) {
+  console.warn(err);
+}
+```
+
 ## Send Notifications
 
 ```js

event-notifications/v1.ts

@@ -112,6 +112,7 @@ class EventNotificationsV1 extends BaseService {
    * @param {string} params.gte - GTE (greater than equal), start timestamp in UTC.
    * @param {string} params.lte - LTE (less than equal), end timestamp in UTC.
    * @param {string} [params.destinationId] - Unique identifier for Destination.
+   * @param {string} [params.subscriptionId] - Unique identifier for Subscription.
    * @param {string} [params.sourceId] - Unique identifier for Source.
    * @param {string} [params.emailTo] - Receiver email id.
    * @param {string} [params.notificationId] - Notification Id.
@@ -130,6 +131,7 @@ class EventNotificationsV1 extends BaseService {
       'gte',
       'lte',
       'destinationId',
+      'subscriptionId',
       'sourceId',
       'emailTo',
       'notificationId',
@@ -146,6 +148,7 @@ class EventNotificationsV1 extends BaseService {
       'gte': _params.gte,
       'lte': _params.lte,
       'destination_id': _params.destinationId,
+      'subscription_id': _params.subscriptionId,
       'source_id': _params.sourceId,
       'email_to': _params.emailTo,
       'notification_id': _params.notificationId,
@@ -179,6 +182,98 @@ class EventNotificationsV1 extends BaseService {
 
     return this.createRequest(parameters);
   }
+
+  /**
+   * Get bounce metrics.
+   *
+   * Get bounce metrics.
+   *
+   * @param {Object} params - The parameters to send to the service.
+   * @param {string} params.instanceId - Unique identifier for IBM Cloud Event Notifications instance.
+   * @param {string} params.destinationType - Destination type. Allowed values are [smtp_custom].
+   * @param {string} params.gte - GTE (greater than equal), start timestamp in UTC.
+   * @param {string} params.lte - LTE (less than equal), end timestamp in UTC.
+   * @param {string} [params.destinationId] - Unique identifier for Destination.
+   * @param {string} [params.subscriptionId] - Unique identifier for Subscription.
+   * @param {string} [params.sourceId] - Unique identifier for Source.
+   * @param {string} [params.emailTo] - Receiver email id.
+   * @param {string} [params.notificationId] - Notification Id.
+   * @param {string} [params.subject] - Email subject.
+   * @param {number} [params.limit] - Page limit for paginated results.
+   * @param {number} [params.offset] - offset for paginated results.
+   * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
+   * @returns {Promise<EventNotificationsV1.Response<EventNotificationsV1.BounceMetrics>>}
+   */
+  public getBounceMetrics(
+    params: EventNotificationsV1.GetBounceMetricsParams
+  ): Promise<EventNotificationsV1.Response<EventNotificationsV1.BounceMetrics>> {
+    const _params = { ...params };
+    const _requiredParams = ['instanceId', 'destinationType', 'gte', 'lte'];
+    const _validParams = [
+      'instanceId',
+      'destinationType',
+      'gte',
+      'lte',
+      'destinationId',
+      'subscriptionId',
+      'sourceId',
+      'emailTo',
+      'notificationId',
+      'subject',
+      'limit',
+      'offset',
+      'headers',
+    ];
+    const _validationErrors = validateParams(_params, _requiredParams, _validParams);
+    if (_validationErrors) {
+      return Promise.reject(_validationErrors);
+    }
+
+    const query = {
+      'destination_type': _params.destinationType,
+      'gte': _params.gte,
+      'lte': _params.lte,
+      'destination_id': _params.destinationId,
+      'subscription_id': _params.subscriptionId,
+      'source_id': _params.sourceId,
+      'email_to': _params.emailTo,
+      'notification_id': _params.notificationId,
+      'subject': _params.subject,
+      'limit': _params.limit,
+      'offset': _params.offset,
+    };
+
+    const path = {
+      'instance_id': _params.instanceId,
+    };
+
+    const sdkHeaders = getSdkHeaders(
+      EventNotificationsV1.DEFAULT_SERVICE_NAME,
+      'v1',
+      'getBounceMetrics'
+    );
+
+    const parameters = {
+      options: {
+        url: '/v1/instances/{instance_id}/metrics/bounce',
+        method: 'GET',
+        qs: query,
+        path,
+      },
+      defaultOptions: extend(true, {}, this.baseOptions, {
+        headers: extend(
+          true,
+          sdkHeaders,
+          {
+            'Accept': 'application/json',
+          },
+          _params.headers
+        ),
+      }),
+    };
+
+    return this.createRequest(parameters);
+  }
   /*************************
    * sendNotifications
    ************************/
@@ -3391,6 +3486,8 @@ namespace EventNotificationsV1 {
     lte: string;
     /** Unique identifier for Destination. */
     destinationId?: string;
+    /** Unique identifier for Subscription. */
+    subscriptionId?: string;
     /** Unique identifier for Source. */
     sourceId?: string;
     /** Receiver email id. */
@@ -3410,6 +3507,43 @@ namespace EventNotificationsV1 {
     }
   }
 
+  /** Parameters for the `getBounceMetrics` operation. */
+  export interface GetBounceMetricsParams {
+    /** Unique identifier for IBM Cloud Event Notifications instance. */
+    instanceId: string;
+    /** Destination type. Allowed values are [smtp_custom]. */
+    destinationType: GetBounceMetricsConstants.DestinationType | string;
+    /** GTE (greater than equal), start timestamp in UTC. */
+    gte: string;
+    /** LTE (less than equal), end timestamp in UTC. */
+    lte: string;
+    /** Unique identifier for Destination. */
+    destinationId?: string;
+    /** Unique identifier for Subscription. */
+    subscriptionId?: string;
+    /** Unique identifier for Source. */
+    sourceId?: string;
+    /** Receiver email id. */
+    emailTo?: string;
+    /** Notification Id. */
+    notificationId?: string;
+    /** Email subject. */
+    subject?: string;
+    /** Page limit for paginated results. */
+    limit?: number;
+    /** offset for paginated results. */
+    offset?: number;
+    headers?: OutgoingHttpHeaders;
+  }
+
+  /** Constants for the `getBounceMetrics` operation. */
+  export namespace GetBounceMetricsConstants {
+    /** Destination type. Allowed values are [smtp_custom]. */
+    export enum DestinationType {
+      SMTP_CUSTOM = 'smtp_custom',
+    }
+  }
+
   /** Parameters for the `sendNotifications` operation. */
   export interface SendNotificationsParams {
     /** Unique identifier for IBM Cloud Event Notifications instance. */
@@ -4114,6 +4248,30 @@ namespace EventNotificationsV1 {
    * model interfaces
    ************************/
 
+  /** Bounce metric object. */
+  export interface BounceMetricItem {
+    /** Email address. */
+    email_address: string;
+    /** Subject. */
+    subject: string;
+    /** Error message. */
+    error_message: string;
+    /** IP address. */
+    ip_address?: string;
+    /** Subscription ID. */
+    subscription_id?: string;
+    /** Bounced at. */
+    timestamp: string;
+  }
+
+  /** Payload describing bounce metrics. */
+  export interface BounceMetrics {
+    /** array of bounce metrics. */
+    metrics: BounceMetricItem[];
+    /** total number of bounce metrics. */
+    total_count: number;
+  }
+
   /** Bucket object. */
   export interface Buckets {
     /** Total count. */

examples/event-notifications.v1.test.js

@@ -3084,6 +3084,8 @@ describe('EventNotificationsV1', () => {
       gte,
       lte,
       destinationId: destinationId16,
+      subscriptionId: subscriptionId6,
+      sourceId,
       emailTo: email_to,
       notificationId: notificationID,
       subject,
@@ -3098,6 +3100,45 @@ describe('EventNotificationsV1', () => {
     // end-metrics
   });
 
+  test('getBounceMetrics 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('getBounceMetrics() result:');
+    // begin-bounce-metrics
+    const destination_type = 'smtp_custom';
+    const gte = '2025-12-08T17:18:43Z';
+    const lte = '2025-12-09T17:18:43Z';
+    const email_to = 'testuser@in.ibm.com';
+    const subject = 'Test Metrics Subject';
+    const getBounceMetricsParams = {
+      instanceId,
+      destinationType: destination_type,
+      gte,
+      lte,
+      destinationId: destinationId16,
+      subscriptionId: subscriptionId6,
+      sourceId,
+      emailTo: email_to,
+      notificationId: notificationID,
+      subject,
+    };
+
+    try {
+      const res = await eventNotificationsService.getBounceMetrics(getBounceMetricsParams);
+      console.log(JSON.stringify(res.result, null, 2));
+    } catch (err) {
+      console.warn(err);
+    }
+    // end-bounce-metrics
+  });
+
   test('createSMTPConfiguration request example', async () => {
     consoleLogMock.mockImplementation((output) => {
       originalLog(output);

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

@@ -3434,8 +3434,8 @@ describe('EventNotificationsV1_integration', () => {
 
   test('getMetrics()', async () => {
     const destination_type = 'smtp_custom';
-    const gte = '2024-08-01T17:18:43Z';
-    const lte = '2024-08-02T11:55:22Z';
+    const gte = '2025-12-08T17:18:43Z';
+    const lte = '2025-12-09T11:55:22Z';
     const email_to = 'testuser@in.ibm.com';
     const subject = 'Test Metrics Subject';
     const getMetricsParams = {
@@ -3444,6 +3444,8 @@ describe('EventNotificationsV1_integration', () => {
       gte,
       lte,
       destinationId: destinationId16,
+      subscriptionId: subscriptionId16,
+      sourceId,
       emailTo: email_to,
       notificationId: notificationID,
       subject,
@@ -3455,6 +3457,31 @@ describe('EventNotificationsV1_integration', () => {
     expect(res.result).toBeDefined();
   });
 
+  test('getBounceMetrics()', async () => {
+    const destination_type = 'smtp_custom';
+    const gte = '2025-12-08T17:18:43Z';
+    const lte = '2025-12-09T11:55:22Z';
+    const email_to = 'testuser@in.ibm.com';
+    const subject = 'Test Metrics Subject';
+    const getBounceMetricsParams = {
+      instanceId,
+      destinationType: destination_type,
+      gte,
+      lte,
+      destinationId: destinationId16,
+      subscriptionId: subscriptionId16,
+      sourceId,
+      emailTo: email_to,
+      notificationId: notificationID,
+      subject,
+    };
+
+    const res = await eventNotificationsService.getBounceMetrics(getBounceMetricsParams);
+    expect(res).toBeDefined();
+    expect(res.status).toBe(200);
+    expect(res.result).toBeDefined();
+  });
+
   test('createSMTPConfiguration()', async () => {
     const name = 'SMTP Configuration';
     const domain = 'test.event-notifications.test.cloud.ibm.com';