Merge pull request #32 from notificationapi-com/tqLKwvhB/2053-query-log

add query log

package.json

@@ -1,6 +1,6 @@
 {
   "name": "notificationapi-node-server-sdk",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "NotificationAPI server-side library for Node.js",
   "keywords": [
     "notificationapi",

src/__tests__/notificationapi.test.ts

@@ -8,6 +8,7 @@ import {
   CreateSubNotificationRequest,
   DeleteSubNotificationRequest,
   InAppNotificationPatchRequest,
+  queryLogsPostBody,
   PushProviders,
   SendRequest,
   SetUserPreferencesRequest,
@@ -317,6 +318,46 @@ describe('send', () => {
     );
   });
 });
+describe('queryLogs', () => {
+  const queryLogsEndPointRegex = /.*\/logs\/query/;
+  const clientId = 'testClientId';
+  const clientSecret = 'testClientSecret';
+
+  test('makes API calls to the correct end-point, non custom', async () => {
+    const nonCostumeQuery: queryLogsPostBody = {
+      dateRangeFilter: { startTime: 1715904000000, endTime: 1718668799999 },
+      notificationFilter: ['test'],
+      channelFilter: [Channels.CALL],
+      userFilter: ['[email protected]'],
+      statusFilter: ['FAILURE'],
+      trackingIds: ['e2d6987f-52c'],
+      envIdFilter: [clientId]
+    };
+    axiosMock.onPost(queryLogsEndPointRegex).reply(200);
+    notificationapi.init(clientId, clientSecret);
+    await notificationapi.queryLogs(nonCostumeQuery);
+    expect(axiosMock.history.post).toHaveLength(1);
+    expect(axiosMock.history.post[0].url).toEqual(
+      `https://api.notificationapi.com/${clientId}/logs/query`
+    );
+    expect(JSON.parse(axiosMock.history.post[0].data)).toEqual(nonCostumeQuery);
+  });
+  test('makes API calls to the correct end-point, custom', async () => {
+    const nonCostumeQuery: queryLogsPostBody = {
+      dateRangeFilter: { startTime: 1715904000000, endTime: 1718668799999 },
+      customFilter:
+        'fields @message| filter @logStream like /NotificationsSummary/| sort @timestamp desc'
+    };
+    axiosMock.onPost(queryLogsEndPointRegex).reply(200);
+    notificationapi.init(clientId, clientSecret);
+    await notificationapi.queryLogs(nonCostumeQuery);
+    expect(axiosMock.history.post).toHaveLength(1);
+    expect(axiosMock.history.post[0].url).toEqual(
+      `https://api.notificationapi.com/${clientId}/logs/query`
+    );
+    expect(JSON.parse(axiosMock.history.post[0].data)).toEqual(nonCostumeQuery);
+  });
+});
 
 describe('retract by secondaryId', () => {
   const retractEndPointRegex = /.*\/sender\/retract/;

src/interfaces.ts

@@ -167,3 +167,17 @@ export interface InAppNotificationPatchRequest {
     message: string;
   };
 }
+export interface queryLogsPostBody {
+  dateRangeFilter?: {
+    startTime?: number;
+    endTime?: number;
+  };
+  notificationFilter?: string[];
+  channelFilter?: Channels[];
+  userFilter?: string[];
+  statusFilter?: string[];
+  trackingIds?: string[];
+  requestFilter?: string[];
+  envIdFilter?: string[];
+  customFilter?: string;
+}

src/notificationapi.ts

@@ -3,6 +3,7 @@ import {
   DeleteSubNotificationRequest,
   InAppNotificationPatchRequest,
   InitConfiguration,
+  queryLogsPostBody,
   RetractRequest,
   SendRequest,
   SetUserPreferencesRequest,
@@ -15,7 +16,7 @@ const DEFAULT_BASE_URL = 'https://api.notificationapi.com';
 
 class NotificationAPIService {
   private USER_AGENT = 'notificationapi-node-server-sdk';
-  private VERSION = '2.1.0';
+  private VERSION = '2.2.0';
 
   clientId: null | string = null;
   clientSecret: null | string = null;
@@ -69,6 +70,10 @@ class NotificationAPIService {
   retract = async (retractRequest: RetractRequest): Promise<AxiosResponse> => {
     return this.request('POST', 'sender/retract', retractRequest);
   };
+  /** create a query on logs */
+  queryLogs = async (params: queryLogsPostBody): Promise<AxiosResponse> => {
+    return this.request('POST', 'logs/query', params);
+  };
   /** Used to create a subNotification of a specified notification. */
   createSubNotification = async (
     params: CreateSubNotificationRequest