function's name

Author: mbasadi

src/__tests__/notificationapi.test.ts

@@ -8,7 +8,7 @@ import {
   CreateSubNotificationRequest,
   DeleteSubNotificationRequest,
   InAppNotificationPatchRequest,
-  LogQueryPostBody,
+  queryLogsPostBody,
   PushProviders,
   SendRequest,
   SetUserPreferencesRequest,
@@ -318,13 +318,13 @@ describe('send', () => {
     );
   });
 });
-describe('logQuery', () => {
-  const logQueryEndPointRegex = /.*\/logs\/query/;
+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: LogQueryPostBody = {
+    const nonCostumeQuery: queryLogsPostBody = {
       dateRangeFilter: { startTime: 1715904000000, endTime: 1718668799999 },
       notificationFilter: ['test'],
       channelFilter: [Channels.CALL],
@@ -333,24 +333,24 @@ describe('logQuery', () => {
       trackingIds: ['e2d6987f-52c'],
       envIdFilter: [clientId]
     };
-    axiosMock.onPost(logQueryEndPointRegex).reply(200);
+    axiosMock.onPost(queryLogsEndPointRegex).reply(200);
     notificationapi.init(clientId, clientSecret);
-    await notificationapi.logQuery(nonCostumeQuery);
+    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: LogQueryPostBody = {
+    const nonCostumeQuery: queryLogsPostBody = {
       dateRangeFilter: { startTime: 1715904000000, endTime: 1718668799999 },
       customFilter:
         'fields @message| filter @logStream like /NotificationsSummary/| sort @timestamp desc'
     };
-    axiosMock.onPost(logQueryEndPointRegex).reply(200);
+    axiosMock.onPost(queryLogsEndPointRegex).reply(200);
     notificationapi.init(clientId, clientSecret);
-    await notificationapi.logQuery(nonCostumeQuery);
+    await notificationapi.queryLogs(nonCostumeQuery);
     expect(axiosMock.history.post).toHaveLength(1);
     expect(axiosMock.history.post[0].url).toEqual(
       `https://api.notificationapi.com/${clientId}/logs/query`

src/interfaces.ts

@@ -167,7 +167,7 @@ export interface InAppNotificationPatchRequest {
     message: string;
   };
 }
-export interface LogQueryPostBody {
+export interface queryLogsPostBody {
   dateRangeFilter?: {
     startTime?: number;
     endTime?: number;

src/notificationapi.ts

@@ -3,7 +3,7 @@ import {
   DeleteSubNotificationRequest,
   InAppNotificationPatchRequest,
   InitConfiguration,
-  LogQueryPostBody,
+  queryLogsPostBody,
   RetractRequest,
   SendRequest,
   SetUserPreferencesRequest,
@@ -71,7 +71,7 @@ class NotificationAPIService {
     return this.request('POST', 'sender/retract', retractRequest);
   };
   /** create a query on logs */
-  logQuery = async (params: LogQueryPostBody): Promise<AxiosResponse> => {
+  queryLogs = async (params: queryLogsPostBody): Promise<AxiosResponse> => {
     return this.request('POST', 'logs/query', params);
   };
   /** Used to create a subNotification of a specified notification. */