feat(Platform Notifications): include acknowledge endpoints

Author: AkosSz

examples/platform-notifications.v1.test.js

@@ -352,6 +352,63 @@ describe('PlatformNotificationsV1', () => {
     // end-list_notifications
   });
 
+  test('getAcknowledgement 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('getAcknowledgement() result:');
+    // begin-get_acknowledgement
+
+    const params = {
+      accountId: '1369339417d906e5620b8d861d40cfd7',
+    };
+
+    let res;
+    try {
+      res = await platformNotificationsService.getAcknowledgement(params);
+      console.log(JSON.stringify(res.result, null, 2));
+    } catch (err) {
+      console.warn(err);
+    }
+
+    // end-get_acknowledgement
+  });
+
+  test('replaceNotificationAcknowledgement 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('replaceNotificationAcknowledgement() result:');
+    // begin-replace_notification_acknowledgement
+
+    const params = {
+      lastAcknowledgedId: '1772804159452',
+      accountId: '1369339417d906e5620b8d861d40cfd7',
+    };
+
+    let res;
+    try {
+      res = await platformNotificationsService.replaceNotificationAcknowledgement(params);
+      console.log(JSON.stringify(res.result, null, 2));
+    } catch (err) {
+      console.warn(err);
+    }
+
+    // end-replace_notification_acknowledgement
+  });
+
   test('deleteDistributionListDestination request example', async () => {
     consoleLogMock.mockImplementation((output) => {
       originalLog(output);

platform-notifications/v1.ts

@@ -926,6 +926,125 @@ class PlatformNotificationsV1 extends BaseService {
 
     return this.createRequest(parameters);
   }
+
+  /**
+   * Get user's last acknowledged notification Id.
+   *
+   * Retrieve the ID of the last notification acknowledged by the user for a specific account.
+   *
+   * @param {Object} [params] - The parameters to send to the service.
+   * @param {string} [params.accountId] - The account ID to retrieve acknowledgement for.
+   * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
+   * @returns {Promise<PlatformNotificationsV1.Response<PlatformNotificationsV1.Acknowledgement>>}
+   */
+  public getAcknowledgement(
+    params?: PlatformNotificationsV1.GetAcknowledgementParams
+  ): Promise<PlatformNotificationsV1.Response<PlatformNotificationsV1.Acknowledgement>> {
+    const _params = { ...params };
+    const _requiredParams = [];
+    const _validParams = ['accountId', 'signal', 'headers'];
+    const _validationErrors = validateParams(_params, _requiredParams, _validParams);
+    if (_validationErrors) {
+      return Promise.reject(_validationErrors);
+    }
+
+    const query = {
+      'account_id': _params.accountId,
+    };
+
+    const sdkHeaders = getSdkHeaders(
+      PlatformNotificationsV1.DEFAULT_SERVICE_NAME,
+      'v1',
+      'getAcknowledgement'
+    );
+
+    const parameters = {
+      options: {
+        url: '/v1/notifications/acknowledgement',
+        method: 'GET',
+        qs: query,
+      },
+      defaultOptions: extend(true, {}, this.baseOptions, {
+        headers: extend(
+          true,
+          sdkHeaders,
+          this.baseOptions.headers,
+          {
+            'Accept': 'application/json',
+          },
+          _params.headers
+        ),
+        axiosOptions: {
+          signal: _params.signal,
+        },
+      }),
+    };
+
+    return this.createRequest(parameters);
+  }
+
+  /**
+   * Update user's last acknowledged notification.
+   *
+   * Update the ID of the last notification acknowledged by the user for a specific account.
+   *
+   * @param {Object} params - The parameters to send to the service.
+   * @param {string} params.lastAcknowledgedId - The ID of a notification.
+   * @param {string} [params.accountId] - The account ID to update acknowledgement for.
+   * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
+   * @returns {Promise<PlatformNotificationsV1.Response<PlatformNotificationsV1.Acknowledgement>>}
+   */
+  public replaceNotificationAcknowledgement(
+    params: PlatformNotificationsV1.ReplaceNotificationAcknowledgementParams
+  ): Promise<PlatformNotificationsV1.Response<PlatformNotificationsV1.Acknowledgement>> {
+    const _params = { ...params };
+    const _requiredParams = ['lastAcknowledgedId'];
+    const _validParams = ['lastAcknowledgedId', 'accountId', 'signal', 'headers'];
+    const _validationErrors = validateParams(_params, _requiredParams, _validParams);
+    if (_validationErrors) {
+      return Promise.reject(_validationErrors);
+    }
+
+    const body = {
+      'last_acknowledged_id': _params.lastAcknowledgedId,
+    };
+
+    const query = {
+      'account_id': _params.accountId,
+    };
+
+    const sdkHeaders = getSdkHeaders(
+      PlatformNotificationsV1.DEFAULT_SERVICE_NAME,
+      'v1',
+      'replaceNotificationAcknowledgement'
+    );
+
+    const parameters = {
+      options: {
+        url: '/v1/notifications/acknowledgement',
+        method: 'PUT',
+        body,
+        qs: query,
+      },
+      defaultOptions: extend(true, {}, this.baseOptions, {
+        headers: extend(
+          true,
+          sdkHeaders,
+          this.baseOptions.headers,
+          {
+            'Accept': 'application/json',
+            'Content-Type': 'application/json',
+          },
+          _params.headers
+        ),
+        axiosOptions: {
+          signal: _params.signal,
+        },
+      }),
+    };
+
+    return this.createRequest(parameters);
+  }
 }
 
 /*************************
@@ -1139,6 +1258,20 @@ namespace PlatformNotificationsV1 {
     limit?: number;
   }
 
+  /** Parameters for the `getAcknowledgement` operation. */
+  export interface GetAcknowledgementParams extends DefaultParams {
+    /** The account ID to retrieve acknowledgement for. */
+    accountId?: string;
+  }
+
+  /** Parameters for the `replaceNotificationAcknowledgement` operation. */
+  export interface ReplaceNotificationAcknowledgementParams extends DefaultParams {
+    /** The ID of a notification. */
+    lastAcknowledgedId: string;
+    /** The account ID to update acknowledgement for. */
+    accountId?: string;
+  }
+
   /*************************
    * model interfaces
    ************************/
@@ -1393,6 +1526,18 @@ namespace PlatformNotificationsV1 {
     message: string;
   }
 
+  /**
+   * Status indicating whether the user has unread notifications.
+   */
+  export interface Acknowledgement {
+    /** Indicates whether the user has unread notifications. */
+    has_unread: boolean;
+    /** The ID of the most recent notification available to the user. */
+    latest_notification_id: string;
+    /** The ID of the last notification acknowledged by the user. */
+    last_acknowledged_id: string;
+  }
+
   /**
    * Prototype for creating an Event Notifications destination entry.
    */

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

@@ -288,6 +288,25 @@ describe('PlatformNotificationsV1_integration', () => {
     console.log(`Retrieved a total of ${allResults.length} items(s) with pagination.`);
   });
 
+  test('getAcknowledgement()', async () => {
+    const res = await platformNotificationsService.getAcknowledgement();
+    expect(res).toBeDefined();
+    expect(res.status).toBe(200);
+    expect(res.result).toBeDefined();
+  });
+
+  test('replaceNotificationAcknowledgement()', async () => {
+    const params = {
+      lastAcknowledgedId: '1772804159452',
+      accountId,
+    };
+
+    const res = await platformNotificationsService.replaceNotificationAcknowledgement(params);
+    expect(res).toBeDefined();
+    expect(res.status).toBe(200);
+    expect(res.result).toBeDefined();
+  });
+
   test('deleteNotificationPreferences()', async () => {
     const params = {
       iamId,