skyeye-svc-common-utils 1.0.80 → 1.0.82

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import SendGridClient, { ISgMessage, ISgCategoryStatistics, SgCategoryStatisticsItem, SgCategoryStatisticsMetricsItem } from './lib/sendGridClient';
 export * from './utils/appConfig';
 export * from './utils/appConst';
 export * from './utils/commonUtils';
@@ -23,7 +24,7 @@ export * from './utils/monitoring/apm';
 export * from './models/baseControllerParameter';
 export * from './models';
 export * from './lib/redisClient';
-export * from './lib/sendGridClient';
 export * from './interfaces/grpcServiceResponse';
 export * from './interfaces/grpcListRequest';
 export * from './utils/commonUtils/appConfigKeyRetriever';
+export { SendGridClient, ISgMessage, ISgCategoryStatistics, SgCategoryStatisticsItem, SgCategoryStatisticsMetricsItem };

package/dist/index.js

@@ -13,7 +13,13 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SendGridClient = void 0;
+const sendGridClient_1 = __importDefault(require("./lib/sendGridClient"));
+exports.SendGridClient = sendGridClient_1.default;
 __exportStar(require("./utils/appConfig"), exports);
 __exportStar(require("./utils/appConst"), exports);
 __exportStar(require("./utils/commonUtils"), exports);
@@ -39,7 +45,6 @@ __exportStar(require("./utils/monitoring/apm"), exports);
 __exportStar(require("./models/baseControllerParameter"), exports);
 __exportStar(require("./models"), exports);
 __exportStar(require("./lib/redisClient"), exports);
-__exportStar(require("./lib/sendGridClient"), exports);
 __exportStar(require("./interfaces/grpcServiceResponse"), exports);
 __exportStar(require("./interfaces/grpcListRequest"), exports);
 __exportStar(require("./utils/commonUtils/appConfigKeyRetriever"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,mDAAiC;AACjC,sDAAoC;AACpC,8DAA4C;AAC5C,wDAAsC;AACtC,8DAA4C;AAC5C,iEAA+C;AAC/C,kEAAgD;AAChD,oEAAkD;AAClD,uEAAqD;AACrD,mEAAiD;AACjD,gEAA8C;AAC9C,qDAAmC;AACnC,4DAA0C;AAC1C,oEAAkD;AAClD,gEAA8C;AAC9C,mEAAiD;AACjD,gEAA8C;AAC9C,+DAA6C;AAC7C,gEAA8C;AAC9C,mDAAiC;AACjC,yDAAuC;AACvC,mEAAiD;AACjD,2CAAyB;AACzB,oDAAkC;AAClC,uDAAqC;AACrC,mEAAiD;AACjD,+DAA6C;AAC7C,4EAA0D"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,0EAAoJ;AA8B3I,yBA9BF,wBAAc,CA8BE;AA5BvB,oDAAkC;AAClC,mDAAiC;AACjC,sDAAoC;AACpC,8DAA4C;AAC5C,wDAAsC;AACtC,8DAA4C;AAC5C,iEAA+C;AAC/C,kEAAgD;AAChD,oEAAkD;AAClD,uEAAqD;AACrD,mEAAiD;AACjD,gEAA8C;AAC9C,qDAAmC;AACnC,4DAA0C;AAC1C,oEAAkD;AAClD,gEAA8C;AAC9C,mEAAiD;AACjD,gEAA8C;AAC9C,+DAA6C;AAC7C,gEAA8C;AAC9C,mDAAiC;AACjC,yDAAuC;AACvC,mEAAiD;AACjD,2CAAyB;AACzB,oDAAkC;AAClC,mEAAiD;AACjD,+DAA6C;AAC7C,4EAA0D"}

package/dist/lib/sendGridClient.d.ts

@@ -1,18 +1,54 @@
-import { MailDataRequired } from '@sendgrid/mail';
+import { MailDataRequired, ClientResponse } from '@sendgrid/mail';
+import { SendGridEmailFeedStatus } from '../utils/appConst';
+export interface ISgMessage {
+    from_email: string;
+    to_email: string;
+    msg_id: string;
+    subject: string;
+    status: string;
+    opens_count: number;
+    clicks_count: number;
+    last_event_time: string;
+}
+export interface ISgCategoryStatistics {
+    date: string;
+    stats: SgCategoryStatisticsItem[];
+}
+export type SgCategoryStatisticsItem = {
+    type: string;
+    name: string;
+    metrics: SgCategoryStatisticsMetricsItem;
+};
+export type SgCategoryStatisticsMetricsItem = {
+    blocks: number;
+    bounce_drops: number;
+    bounces: number;
+    clicks: number;
+    deferred: number;
+    delivered: number;
+    invalid_emails: number;
+    opens: number;
+    processed: number;
+    requests: number;
+    spam_report_drops: number;
+    spam_reports: number;
+    unique_clicks: number;
+    unique_opens: number;
+    unsubscribe_drops: number;
+    unsubscribes: number;
+};
 /**
  * A SendGrid client class
  */
-declare class SendGridClient {
+export default class SendGridClient {
     private mailService;
+    private officialClient;
+    private static BASE_URL;
     /**
      * @constructor
      * @param {string} [apiKey] - SendGrid API key (optional)
      */
-    constructor();
-    /**
-     * Initializes the SendGrid client with the API key retrieved from Azure Key Vault.
-     */
-    private initialize;
+    constructor(sendGridClientSecret: string);
     /**
      * It sends an email.
      * @param {string} from - The email address of the sender.
@@ -21,7 +57,29 @@ declare class SendGridClient {
      * @param {string} htmlBodyText - The HTML body of the email.
      * @param {any} [options] - Extra settings for the email
      */
-    send(from: string, to: string[], subject: string, htmlBodyText: string, options?: Partial<MailDataRequired>): Promise<void> | never;
+    sendEmail(from: string, to: string[], subject: string, htmlBodyText: string, options?: Partial<MailDataRequired>): Promise<ClientResponse> | never;
+    getEmailActivity(lastEventStartDate?: Date, lastEventEndDate?: Date, category?: string, status?: SendGridEmailFeedStatus): Promise<ISgMessage[]>;
+    getQueryParams(batchSize?: number, lastEventStartDate?: Date, lastEventEndDate?: Date, category?: string, status?: SendGridEmailFeedStatus): {
+        limit: number;
+        query: string;
+    } | {
+        limit: number;
+        query?: undefined;
+    };
+    /**
+     * The function getCategoryStats retrieves category statistics with optional parameters such as
+     * limit, skip, startDate, category, aggregatedBy, and endDate.
+     * @param {string} startDate - The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.
+     * @param {string} category - The `category` parameter is a parameter that allows you
+     * to specify a category for which you want to retrieve statistics. It is a string type parameter.
+     * If provided, the function will return statistics specific to the specified category. If not
+     * provided, the function will return statistics for all categories.
+     * @param {string} aggregatedBy - How to group the statistics. Must be either "day", "week", or "month".
+     * @param {number} [limit=1000] - The number of results to return.
+     * @param {number} [skip=0] - The point in the list to begin retrieving results.
+     * @param {string} [endDate] - The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.
+     *
+     * https://www.twilio.com/docs/sendgrid/api-reference/stats/retrieve-global-email-statistics#operation-details
+     */
+    getCategoryStats(startDate: string, category: string, aggregatedBy: "day" | "week" | "month", limit?: number, offset?: number, endDate?: string): Promise<ISgCategoryStatistics[]>;
 }
-export declare const sendGridClient: SendGridClient;
-export {};

package/dist/lib/sendGridClient.js

@@ -9,11 +9,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sendGridClient = void 0;
 const mail_1 = require("@sendgrid/mail");
+const client_1 = require("@sendgrid/client");
 const logger_1 = require("./../utils/logger/logger");
-const appConfigKeyRetriever_1 = require("./../utils/commonUtils/appConfigKeyRetriever");
-const appConfig_1 = require("./../utils/appConfig");
+const lodash_1 = require("lodash");
 /**
  * A SendGrid client class
  */
@@ -22,18 +21,12 @@ class SendGridClient {
      * @constructor
      * @param {string} [apiKey] - SendGrid API key (optional)
      */
-    constructor() {
+    constructor(sendGridClientSecret) {
         this.mailService = new mail_1.MailService();
-        this.initialize();
-    }
-    /**
-     * Initializes the SendGrid client with the API key retrieved from Azure Key Vault.
-     */
-    initialize() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const sendGridClientSecret = yield appConfigKeyRetriever_1.AppConfigKeyRetriever.getSendgridClientSecret();
-            this.mailService.setApiKey(sendGridClientSecret);
-        });
+        this.officialClient = new client_1.Client();
+        // set API key
+        this.mailService.setApiKey(sendGridClientSecret);
+        this.officialClient.setApiKey(sendGridClientSecret);
     }
     /**
      * It sends an email.
@@ -43,13 +36,14 @@ class SendGridClient {
      * @param {string} htmlBodyText - The HTML body of the email.
      * @param {any} [options] - Extra settings for the email
      */
-    send(from, to, subject, htmlBodyText, options) {
+    sendEmail(from, to, subject, htmlBodyText, options) {
         return __awaiter(this, void 0, void 0, function* () {
             const msg = Object.assign({ from,
                 to,
                 subject, html: htmlBodyText }, options);
             try {
-                yield this.mailService.send(msg);
+                const response = yield this.mailService.send(msg);
+                return response[0];
             }
             catch (err) {
                 logger_1.logger.error(`SendGridClient/send with error, ${err}`);
@@ -57,6 +51,122 @@ class SendGridClient {
             }
         });
     }
+    /*
+        SendGrid v3 API has a pagination limitation on GET /messages
+        it only accepts limit as query param, not offset
+        https://www.twilio.com/docs/sendgrid/api-reference/how-to-use-the-sendgrid-v3-api/requests#pagination
+    */
+    getEmailActivity(lastEventStartDate, lastEventEndDate, category, status) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const method = 'GET';
+            const url = '/v3/messages';
+            const baseUrl = SendGridClient.BASE_URL;
+            const request = this.officialClient.createRequest({
+                baseUrl,
+                url,
+                method
+            });
+            const batchSize = 1000;
+            // store all unique records 
+            const map = new Map();
+            // as the records are returned in DESC order of lastEventDate, keep update nextLastEventEndDate within the loop
+            let nextLastEventEndDate = lastEventEndDate;
+            let count = 0;
+            do {
+                request.qs = this.getQueryParams(batchSize, lastEventStartDate, nextLastEventEndDate, category, status);
+                logger_1.logger.info(`Sending ${method} request to ${baseUrl + url} with body: ${JSON.stringify(request)}`);
+                const [response, body] = yield this.officialClient.request(request);
+                const statusCode = response.statusCode;
+                if (statusCode == 200) {
+                    const messages = body.messages;
+                    count = messages.length;
+                    if (count > 0) {
+                        for (const msg of messages) {
+                            if (!map.has(msg.msg_id)) {
+                                map.set(msg.msg_id, msg);
+                            }
+                        }
+                        const lastItem = messages[messages.length - 1];
+                        nextLastEventEndDate = new Date(lastItem.last_event_time);
+                    }
+                }
+                else {
+                    break;
+                }
+            } while (count >= batchSize);
+            return Array.from(map.values());
+        });
+    }
+    /*
+        https://www.twilio.com/docs/sendgrid/for-developers/sending-email/getting-started-email-activity-api
+        can add more query params
+    */
+    getQueryParams(batchSize, lastEventStartDate, lastEventEndDate, category, status) {
+        let query = '';
+        if (!((0, lodash_1.isNil)(lastEventStartDate) && (0, lodash_1.isNil)(lastEventEndDate))) {
+            query = `(last_event_time BETWEEN TIMESTAMP "${lastEventStartDate.toISOString()}" AND TIMESTAMP "${lastEventEndDate.toISOString()}")`;
+        }
+        if (!(0, lodash_1.isNil)(category)) {
+            query += ` AND (Contains(categories,"${category}"))`;
+        }
+        if (!(0, lodash_1.isNil)(status)) {
+            query += ` AND (status IN ("${status}"))`;
+        }
+        return query.length > 0 ? {
+            'limit': (0, lodash_1.isNil)(batchSize) ? 1000 : batchSize,
+            'query': query
+        } : {
+            'limit': (0, lodash_1.isNil)(batchSize) ? 1000 : batchSize
+        };
+    }
+    /**
+     * The function getCategoryStats retrieves category statistics with optional parameters such as
+     * limit, skip, startDate, category, aggregatedBy, and endDate.
+     * @param {string} startDate - The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.
+     * @param {string} category - The `category` parameter is a parameter that allows you
+     * to specify a category for which you want to retrieve statistics. It is a string type parameter.
+     * If provided, the function will return statistics specific to the specified category. If not
+     * provided, the function will return statistics for all categories.
+     * @param {string} aggregatedBy - How to group the statistics. Must be either "day", "week", or "month".
+     * @param {number} [limit=1000] - The number of results to return.
+     * @param {number} [skip=0] - The point in the list to begin retrieving results.
+     * @param {string} [endDate] - The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.
+     *
+     * https://www.twilio.com/docs/sendgrid/api-reference/stats/retrieve-global-email-statistics#operation-details
+     */
+    getCategoryStats(startDate, category, aggregatedBy, limit = 1000, offset = 0, endDate) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const method = 'GET';
+            const url = '/v3/categories/stats';
+            const baseUrl = SendGridClient.BASE_URL;
+            const request = this.officialClient.createRequest({
+                baseUrl,
+                url,
+                method
+            });
+            const queryParams = {
+                'limit': limit,
+                'offset': offset,
+                'start_date': startDate,
+                'categories': category,
+                'aggregated_by': aggregatedBy
+            };
+            if (!(0, lodash_1.isNil)(endDate)) {
+                queryParams.end_date = endDate;
+            }
+            request.qs = queryParams;
+            logger_1.logger.info(`Sending ${method} request to ${baseUrl + url} with body: ${JSON.stringify(request)}`);
+            const [response, body] = yield this.officialClient.request(request);
+            const statusCode = response.statusCode;
+            if (statusCode == 200) {
+                return response.body;
+            }
+            else {
+                return [];
+            }
+        });
+    }
 }
-exports.sendGridClient = appConfig_1.commonAppConfig.SendgridClientSecretKey ? new SendGridClient() : null;
+exports.default = SendGridClient;
+SendGridClient.BASE_URL = 'https://api.sendgrid.com';
 //# sourceMappingURL=sendGridClient.js.map

package/dist/lib/sendGridClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"sendGridClient.js","sourceRoot":"","sources":["../../src/lib/sendGridClient.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yCAA+D;AAC/D,qDAAkD;AAClD,wFAAqF;AACrF,oDAAuD;AAEvD;;GAEG;AACH,MAAM,cAAc;IAIhB;;;OAGG;IACH;QACI,IAAI,CAAC,WAAW,GAAG,IAAI,kBAAW,EAAE,CAAC;QACrC,IAAI,CAAC,UAAU,EAAE,CAAC;IACtB,CAAC;IAED;;OAEG;IACW,UAAU;;YACpB,MAAM,oBAAoB,GAAG,MAAM,6CAAqB,CAAC,uBAAuB,EAAE,CAAC;YACnF,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;QACrD,CAAC;KAAA;IAGD;;;;;;;OAOG;IACG,IAAI,CAAC,IAAY,EAAE,EAAY,EAAE,OAAe,EAAE,YAAoB,EAAE,OAAmC;;YAC7G,MAAM,GAAG,mBACL,IAAI;gBACJ,EAAE;gBACF,OAAO,EACP,IAAI,EAAE,YAAY,IACf,OAAO,CACb,CAAC;YAEF,IAAI;gBACA,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACpC;YAAC,OAAO,GAAG,EAAE;gBACV,eAAM,CAAC,KAAK,CAAC,mCAAmC,GAAG,EAAE,CAAC,CAAC;gBACvD,MAAM,GAAG,CAAC;aACb;QACL,CAAC;KAAA;CACJ;AAEY,QAAA,cAAc,GAAG,2BAAe,CAAC,uBAAuB,CAAC,CAAC,CAAC,IAAI,cAAc,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC"}
+{"version":3,"file":"sendGridClient.js","sourceRoot":"","sources":["../../src/lib/sendGridClient.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,yCAA+E;AAC/E,6CAA4D;AAE5D,qDAAkD;AAClD,mCAAwC;AA4CxC;;GAEG;AACH,MAAqB,cAAc;IAM/B;;;OAGG;IACH,YAAY,oBAA4B;QACpC,IAAI,CAAC,WAAW,GAAG,IAAI,kBAAW,EAAE,CAAC;QACrC,IAAI,CAAC,cAAc,GAAG,IAAI,eAAc,EAAE,CAAC;QAC3C,cAAc;QACd,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;QACjD,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;OAOG;IACU,SAAS,CAAC,IAAY,EAAE,EAAY,EAAE,OAAe,EAAE,YAAoB,EAAE,OAAmC;;YACzH,MAAM,GAAG,mBACL,IAAI;gBACJ,EAAE;gBACF,OAAO,EACP,IAAI,EAAE,YAAY,IACf,OAAO,CACb,CAAC;YAEF,IAAI;gBACA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAClD,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC;aACtB;YAAC,OAAO,GAAG,EAAE;gBACV,eAAM,CAAC,KAAK,CAAC,mCAAmC,GAAG,EAAE,CAAC,CAAC;gBACvD,MAAM,GAAG,CAAC;aACb;QACL,CAAC;KAAA;IAED;;;;MAIE;IACW,gBAAgB,CACzB,kBAAyB,EACzB,gBAAuB,EACvB,QAAiB,EACjB,MAAgC;;YAGhC,MAAM,MAAM,GAAG,KAAK,CAAC;YACrB,MAAM,GAAG,GAAG,cAAc,CAAC;YAC3B,MAAM,OAAO,GAAG,cAAc,CAAC,QAAQ,CAAC;YACxC,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC;gBAC9C,OAAO;gBACP,GAAG;gBACH,MAAM;aACT,CAAC,CAAC;YAEH,MAAM,SAAS,GAAG,IAAI,CAAC;YACvB,4BAA4B;YAC5B,MAAM,GAAG,GAA4B,IAAI,GAAG,EAAG,CAAC;YAChD,+GAA+G;YAC/G,IAAI,oBAAoB,GAAG,gBAAgB,CAAC;YAC5C,IAAI,KAAK,GAAG,CAAC,CAAC;YACd,GAAG;gBACC,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;gBACxG,eAAM,CAAC,IAAI,CAAC,WAAW,MAAM,eAAe,OAAO,GAAG,GAAG,eAAe,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;gBACnG,MAAM,CAAE,QAAQ,EAAE,IAAI,CAAE,GAAqC,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBACxG,MAAM,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC;gBACvC,IAAI,UAAU,IAAI,GAAG,EAAE;oBACnB,MAAM,QAAQ,GAAiB,IAAI,CAAC,QAAQ,CAAC;oBAC7C,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC;oBACxB,IAAI,KAAK,GAAG,CAAC,EAAE;wBACX,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE;4BACxB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;gCACtB,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;6BAC3B;yBACJ;wBACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;wBAC/C,oBAAoB,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;qBAC7D;iBACJ;qBACI;oBACD,MAAM;iBACT;aACJ,QACM,KAAK,IAAI,SAAS,EAAE;YAE3B,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;QACpC,CAAC;KAAA;IAED;;;MAGE;IACK,cAAc,CACjB,SAAkB,EAClB,kBAAyB,EACzB,gBAAuB,EACvB,QAAiB,EACjB,MAAgC;QAEhC,IAAI,KAAK,GAAG,EAAE,CAAC;QACf,IAAI,CAAC,CAAC,IAAA,cAAK,EAAC,kBAAkB,CAAC,IAAI,IAAA,cAAK,EAAC,gBAAgB,CAAC,CAAC,EAAE;YACzD,KAAK,GAAG,uCAAuC,kBAAkB,CAAC,WAAW,EAAE,oBAAoB,gBAAgB,CAAC,WAAW,EAAE,IAAI,CAAC;SACzI;QACD,IAAI,CAAC,IAAA,cAAK,EAAC,QAAQ,CAAC,EAAE;YAClB,KAAK,IAAI,8BAA8B,QAAQ,KAAK,CAAC;SACxD;QACD,IAAI,CAAC,IAAA,cAAK,EAAC,MAAM,CAAC,EAAE;YAChB,KAAK,IAAI,qBAAqB,MAAM,KAAK,CAAC;SAC7C;QAED,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;YACtB,OAAO,EAAE,IAAA,cAAK,EAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;YAC5C,OAAO,EAAE,KAAK;SACjB,CAAC,CAAC,CAAC;YACA,OAAO,EAAE,IAAA,cAAK,EAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;SAC/C,CAAA;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACU,gBAAgB,CACzB,SAAiB,EACjB,QAAgB,EAChB,YAAsC,EACtC,QAAgB,IAAI,EACpB,SAAiB,CAAC,EAClB,OAAgB;;YAEhB,MAAM,MAAM,GAAG,KAAK,CAAC;YACrB,MAAM,GAAG,GAAG,sBAAsB,CAAC;YACnC,MAAM,OAAO,GAAG,cAAc,CAAC,QAAQ,CAAC;YACxC,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC;gBAC9C,OAAO;gBACP,GAAG;gBACH,MAAM;aACT,CAAC,CAAC;YAEH,MAAM,WAAW,GAAQ;gBACrB,OAAO,EAAE,KAAK;gBACd,QAAQ,EAAE,MAAM;gBAChB,YAAY,EAAE,SAAS;gBACvB,YAAY,EAAE,QAAQ;gBACtB,eAAe,EAAE,YAAY;aAChC,CAAC;YACF,IAAI,CAAC,IAAA,cAAK,EAAC,OAAO,CAAC,EAAE;gBACjB,WAAW,CAAC,QAAQ,GAAG,OAAO,CAAC;aAClC;YACD,OAAO,CAAC,EAAE,GAAG,WAAW,CAAC;YAEzB,eAAM,CAAC,IAAI,CAAC,WAAW,MAAM,eAAe,OAAO,GAAG,GAAG,eAAe,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YACnG,MAAM,CAAE,QAAQ,EAAE,IAAI,CAAE,GAAqC,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACxG,MAAM,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC;YACvC,IAAI,UAAU,IAAI,GAAG,EAAE;gBACnB,OAAO,QAAQ,CAAC,IAA+B,CAAC;aACnD;iBACI;gBACD,OAAO,EAAE,CAAC;aACb;QACL,CAAC;KAAA;;AArLL,iCAsLC;AAlLkB,uBAAQ,GAAW,0BAA0B,CAAC"}

package/dist/utils/appConst.d.ts

@@ -140,3 +140,8 @@ export declare enum CAMPAIGN_USER_STATUS {
     REJECTED = 3
 }
 export declare const exitErrorMessage: Record<string, string>;
+export declare enum SendGridEmailFeedStatus {
+    Delivered = "delivered",
+    NotDelivered = "not_delivered",
+    Processing = "processing"
+}

package/dist/utils/appConst.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.exitErrorMessage = exports.CAMPAIGN_USER_STATUS = exports.CAMPAIGN_EVENT_USER_STATUS = exports.entityType = exports.jsonContentTypeHeaders = exports.ScoutAITrainingMethod = exports.ScoutAIType = exports.AllDeletedStatus = exports.DeletedStatus = exports.FeatureType = exports.commonAppConst = void 0;
+exports.SendGridEmailFeedStatus = exports.exitErrorMessage = exports.CAMPAIGN_USER_STATUS = exports.CAMPAIGN_EVENT_USER_STATUS = exports.entityType = exports.jsonContentTypeHeaders = exports.ScoutAITrainingMethod = exports.ScoutAIType = exports.AllDeletedStatus = exports.DeletedStatus = exports.FeatureType = exports.commonAppConst = void 0;
 exports.commonAppConst = {
     emptyGuid: '00000000-0000-0000-0000-000000000000',
     sampleStatus: {
@@ -160,4 +160,10 @@ exports.exitErrorMessage = {
     UnknownTimeout: `operation timed out for an unknown reason`,
     AuthenticationError: `Authentication error`
 };
+var SendGridEmailFeedStatus;
+(function (SendGridEmailFeedStatus) {
+    SendGridEmailFeedStatus["Delivered"] = "delivered";
+    SendGridEmailFeedStatus["NotDelivered"] = "not_delivered";
+    SendGridEmailFeedStatus["Processing"] = "processing";
+})(SendGridEmailFeedStatus = exports.SendGridEmailFeedStatus || (exports.SendGridEmailFeedStatus = {}));
 //# sourceMappingURL=appConst.js.map

package/dist/utils/appConst.js.map

@@ -1 +1 @@
-{"version":3,"file":"appConst.js","sourceRoot":"","sources":["../../src/utils/appConst.ts"],"names":[],"mappings":";;;AAAa,QAAA,cAAc,GAAG;IAC7B,SAAS,EAAE,sCAAsC;IACjD,YAAY,EAAE;QACb,GAAG,EAAE,KAAK;QACV,OAAO,EAAE,SAAS;QAClB,OAAO,EAAE,SAAS;KAClB;IACD,YAAY,EAAE;QACb,IAAI,EAAE,MAAM;QACZ,GAAG,EAAE,KAAK;QACV,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE,OAAO;KACd;IACD,UAAU,EAAE;QACX,GAAG,EAAE,KAAK;QACV,IAAI,EAAE,MAAM;QACZ,GAAG,EAAE,KAAK;QACV,MAAM,EAAE,QAAQ;KAChB;IACD,UAAU,EAAE;QACX,SAAS,EAAE,WAAW;QACtB,aAAa,EAAE,eAAe;QAC9B,MAAM,EAAE,QAAQ;QAChB,OAAO,EAAE,SAAS;QAChB,mBAAmB,EAAE,SAAS;QAChC,eAAe,EAAE,kBAAkB;KACnC;IACD,KAAK,EAAE;QACN,GAAG,EAAE,KAAK;QACV,IAAI,EAAE,MAAM;KACZ;IACD,cAAc,EAAE;QACf,EAAE,EAAE,IAAI;QACR,WAAW,EAAE,aAAa;QAC1B,gBAAgB,EAAE,kBAAkB;KACpC;IACD,KAAK,EAAE;QACN,UAAU,EAAE;YACX,SAAS,EAAE,IAAI;SACf;QACD,UAAU,EAAE,GAAG;QACf,OAAO,EAAE;YACR,aAAa,EAAE,IAAI;SACnB;KACD;IACD,WAAW,EAAE;QACZ,8BAA8B,EAAE,IAAI;KACpC;IACD,UAAU,EAAE;QACX,eAAe,EAAE;YAChB,WAAW,EAAE,kBAAkB;YAC/B;;eAEG;YACH,eAAe,EAAE,IAAI;YACrB,eAAe,EAAE,GAAG;SACpB;QACD,aAAa,EAAE;YACd,WAAW,EAAE,kBAAkB;SAC/B;KACD;IACD,IAAI,EAAE;QACL,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,UAAU;QACpB,eAAe,EAAE;YAChB,0BAA0B;YAC1B,4BAA4B;SAC5B;QACD,IAAI,EAAE;YACL,iCAAiC,EAAE,mCAAmC;YACtE,OAAO,EAAE,SAAS;SAClB;QACD,IAAI,EAAE;YACL,GAAG,EAAE,KAAK;YACV,GAAG,EAAE,KAAK;SACV;KACD;IACD,MAAM,EAAE;QACP,IAAI,EAAE,MAAM;QACZ,YAAY,EAAE,cAAc;QAC5B,IAAI,EAAE,MAAM;QACZ,YAAY,EAAE,cAAc;QAC5B,QAAQ,EAAE,UAAU;QACpB,OAAO,EAAE,SAAS;QAClB,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE,QAAQ;QAChB,WAAW,EAAE,aAAa;QAC1B,YAAY,EAAE,cAAc;QAC5B,IAAI,EAAE,MAAM;KACZ;IACD,OAAO,EAAE;QACR,IAAI,EAAE,wBAAwB;QAC9B,YAAY,EAAE,wBAAwB;QACtC,IAAI,EAAE,wBAAwB;QAC9B,YAAY,EAAE,wBAAwB;QACtC,QAAQ,EAAE,wBAAwB;QAClC,OAAO,EAAE,wBAAwB;QACjC,MAAM,EAAE,wBAAwB;QAChC,MAAM,EAAE,wBAAwB;QAChC,WAAW,EAAE,wBAAwB;QACrC,YAAY,EAAE,wBAAwB;QACtC,IAAI,EAAE,wBAAwB;KAC9B;CACD,CAAA;AAED,IAAY,WAGX;AAHD,WAAY,WAAW;IACtB,kCAAmB,CAAA;IACnB,gCAAiB,CAAA;AAClB,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB;AAED,IAAY,aAIX;AAJD,WAAY,aAAa;IACxB,qDAAM,CAAA;IACN,uDAAO,CAAA;IACP,iEAAY,CAAA;AACb,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB;AACY,QAAA,gBAAgB,GAAa,CAAC,aAAa,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;AAEpH,IAAY,WAIX;AAJD,WAAY,WAAW;IACtB,oCAAqB,CAAA;IACrB,gCAAiB,CAAA;IACjB,sCAAuB,CAAA;AACxB,CAAC,EAJW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAItB;AAED,IAAY,qBAEX;AAFD,WAAY,qBAAqB;IAChC,sCAAa,CAAA;AACd,CAAC,EAFW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAEhC;AAGD,SAAgB,sBAAsB;IACrC,OAAO;QACN,cAAc,EAAE,kBAAkB;KAClC,CAAC;AACH,CAAC;AAJD,wDAIC;AAED,IAAY,UAKX;AALD,WAAY,UAAU;IACrB,+BAAiB,CAAA;IACjB,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;IACnB,kCAAoB,CAAA;AACrB,CAAC,EALW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAKrB;AAED,IAAY,0BAMX;AAND,WAAY,0BAA0B;IACrC,qFAAS,CAAA;IACT,mFAAQ,CAAA;IACR,mFAAQ,CAAA;IACR,mFAAQ,CAAA;IACR,yFAAW,CAAA;AACZ,CAAC,EANW,0BAA0B,GAA1B,kCAA0B,KAA1B,kCAA0B,QAMrC;AAED,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC/B,qEAAO,CAAA;IACP,yEAAS,CAAA;IACT,uEAAQ,CAAA;IACR,uEAAQ,CAAA;AACT,CAAC,EALW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAK/B;AAEY,QAAA,gBAAgB,GAA0B;IACtD,cAAc,EAAE,kFAAkF;IAClG,cAAc,EAAE,2CAA2C;IAC3D,mBAAmB,EAAE,sBAAsB;CAC3C,CAAA"}
+{"version":3,"file":"appConst.js","sourceRoot":"","sources":["../../src/utils/appConst.ts"],"names":[],"mappings":";;;AAAa,QAAA,cAAc,GAAG;IAC7B,SAAS,EAAE,sCAAsC;IACjD,YAAY,EAAE;QACb,GAAG,EAAE,KAAK;QACV,OAAO,EAAE,SAAS;QAClB,OAAO,EAAE,SAAS;KAClB;IACD,YAAY,EAAE;QACb,IAAI,EAAE,MAAM;QACZ,GAAG,EAAE,KAAK;QACV,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE,OAAO;KACd;IACD,UAAU,EAAE;QACX,GAAG,EAAE,KAAK;QACV,IAAI,EAAE,MAAM;QACZ,GAAG,EAAE,KAAK;QACV,MAAM,EAAE,QAAQ;KAChB;IACD,UAAU,EAAE;QACX,SAAS,EAAE,WAAW;QACtB,aAAa,EAAE,eAAe;QAC9B,MAAM,EAAE,QAAQ;QAChB,OAAO,EAAE,SAAS;QAChB,mBAAmB,EAAE,SAAS;QAChC,eAAe,EAAE,kBAAkB;KACnC;IACD,KAAK,EAAE;QACN,GAAG,EAAE,KAAK;QACV,IAAI,EAAE,MAAM;KACZ;IACD,cAAc,EAAE;QACf,EAAE,EAAE,IAAI;QACR,WAAW,EAAE,aAAa;QAC1B,gBAAgB,EAAE,kBAAkB;KACpC;IACD,KAAK,EAAE;QACN,UAAU,EAAE;YACX,SAAS,EAAE,IAAI;SACf;QACD,UAAU,EAAE,GAAG;QACf,OAAO,EAAE;YACR,aAAa,EAAE,IAAI;SACnB;KACD;IACD,WAAW,EAAE;QACZ,8BAA8B,EAAE,IAAI;KACpC;IACD,UAAU,EAAE;QACX,eAAe,EAAE;YAChB,WAAW,EAAE,kBAAkB;YAC/B;;eAEG;YACH,eAAe,EAAE,IAAI;YACrB,eAAe,EAAE,GAAG;SACpB;QACD,aAAa,EAAE;YACd,WAAW,EAAE,kBAAkB;SAC/B;KACD;IACD,IAAI,EAAE;QACL,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,UAAU;QACpB,eAAe,EAAE;YAChB,0BAA0B;YAC1B,4BAA4B;SAC5B;QACD,IAAI,EAAE;YACL,iCAAiC,EAAE,mCAAmC;YACtE,OAAO,EAAE,SAAS;SAClB;QACD,IAAI,EAAE;YACL,GAAG,EAAE,KAAK;YACV,GAAG,EAAE,KAAK;SACV;KACD;IACD,MAAM,EAAE;QACP,IAAI,EAAE,MAAM;QACZ,YAAY,EAAE,cAAc;QAC5B,IAAI,EAAE,MAAM;QACZ,YAAY,EAAE,cAAc;QAC5B,QAAQ,EAAE,UAAU;QACpB,OAAO,EAAE,SAAS;QAClB,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE,QAAQ;QAChB,WAAW,EAAE,aAAa;QAC1B,YAAY,EAAE,cAAc;QAC5B,IAAI,EAAE,MAAM;KACZ;IACD,OAAO,EAAE;QACR,IAAI,EAAE,wBAAwB;QAC9B,YAAY,EAAE,wBAAwB;QACtC,IAAI,EAAE,wBAAwB;QAC9B,YAAY,EAAE,wBAAwB;QACtC,QAAQ,EAAE,wBAAwB;QAClC,OAAO,EAAE,wBAAwB;QACjC,MAAM,EAAE,wBAAwB;QAChC,MAAM,EAAE,wBAAwB;QAChC,WAAW,EAAE,wBAAwB;QACrC,YAAY,EAAE,wBAAwB;QACtC,IAAI,EAAE,wBAAwB;KAC9B;CACD,CAAA;AAED,IAAY,WAGX;AAHD,WAAY,WAAW;IACtB,kCAAmB,CAAA;IACnB,gCAAiB,CAAA;AAClB,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB;AAED,IAAY,aAIX;AAJD,WAAY,aAAa;IACxB,qDAAM,CAAA;IACN,uDAAO,CAAA;IACP,iEAAY,CAAA;AACb,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB;AACY,QAAA,gBAAgB,GAAa,CAAC,aAAa,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;AAEpH,IAAY,WAIX;AAJD,WAAY,WAAW;IACtB,oCAAqB,CAAA;IACrB,gCAAiB,CAAA;IACjB,sCAAuB,CAAA;AACxB,CAAC,EAJW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAItB;AAED,IAAY,qBAEX;AAFD,WAAY,qBAAqB;IAChC,sCAAa,CAAA;AACd,CAAC,EAFW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAEhC;AAGD,SAAgB,sBAAsB;IACrC,OAAO;QACN,cAAc,EAAE,kBAAkB;KAClC,CAAC;AACH,CAAC;AAJD,wDAIC;AAED,IAAY,UAKX;AALD,WAAY,UAAU;IACrB,+BAAiB,CAAA;IACjB,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;IACnB,kCAAoB,CAAA;AACrB,CAAC,EALW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAKrB;AAED,IAAY,0BAMX;AAND,WAAY,0BAA0B;IACrC,qFAAS,CAAA;IACT,mFAAQ,CAAA;IACR,mFAAQ,CAAA;IACR,mFAAQ,CAAA;IACR,yFAAW,CAAA;AACZ,CAAC,EANW,0BAA0B,GAA1B,kCAA0B,KAA1B,kCAA0B,QAMrC;AAED,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC/B,qEAAO,CAAA;IACP,yEAAS,CAAA;IACT,uEAAQ,CAAA;IACR,uEAAQ,CAAA;AACT,CAAC,EALW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAK/B;AAEY,QAAA,gBAAgB,GAA0B;IACtD,cAAc,EAAE,kFAAkF;IAClG,cAAc,EAAE,2CAA2C;IAC3D,mBAAmB,EAAE,sBAAsB;CAC3C,CAAA;AAED,IAAY,uBAIX;AAJD,WAAY,uBAAuB;IAClC,kDAAuB,CAAA;IACvB,yDAA8B,CAAA;IAC9B,oDAAyB,CAAA;AAC1B,CAAC,EAJW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAIlC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skyeye-svc-common-utils",
-  "version": "1.0.80",
+  "version": "1.0.82",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -29,6 +29,8 @@
     "@azure/core-rest-pipeline": "1.12.2",
     "@azure/core-lro": "2.6.0",
     "@azure/logger": "1.0.4",
+    "@sendgrid/client": "^8.1.3",
+    "@sendgrid/helpers": "^8.0.0",
     "@sendgrid/mail": "^7.7.0",
     "@types/chai": "^4.2.11",
     "@types/express": "4.17.14",

package/src/index.ts

@@ -1,3 +1,5 @@
+import SendGridClient, { ISgMessage, ISgCategoryStatistics, SgCategoryStatisticsItem, SgCategoryStatisticsMetricsItem } from './lib/sendGridClient';
+
 export * from './utils/appConfig';
 export * from './utils/appConst';
 export * from './utils/commonUtils';
@@ -23,7 +25,7 @@ export * from './utils/monitoring/apm';
 export * from './models/baseControllerParameter';
 export * from './models';
 export * from './lib/redisClient';
-export * from './lib/sendGridClient';
 export * from './interfaces/grpcServiceResponse';
 export * from './interfaces/grpcListRequest';
 export * from './utils/commonUtils/appConfigKeyRetriever';
+export { SendGridClient, ISgMessage, ISgCategoryStatistics, SgCategoryStatisticsItem, SgCategoryStatisticsMetricsItem };

package/src/lib/sendGridClient.ts

@@ -1,33 +1,72 @@
-import { MailService, MailDataRequired } from '@sendgrid/mail';
+import { MailService, MailDataRequired, ClientResponse } from '@sendgrid/mail';
+import { Client as OfficialClient } from '@sendgrid/client';
+import helpers from '@sendgrid/helpers';
 import { logger } from './../utils/logger/logger';
-import { AppConfigKeyRetriever } from './../utils/commonUtils/appConfigKeyRetriever';
-import { commonAppConfig } from './../utils/appConfig';
+import { isEmpty, isNil } from 'lodash';
+import { SendGridEmailFeedStatus, commonAppConst } from '../utils/appConst';
+
+export interface ISgMessage {
+    from_email: string;
+    to_email: string;
+    msg_id: string;
+    subject: string;
+    status: string; // Possible values: processed, delivered, not_delivered
+    opens_count: number;
+    clicks_count: number;
+    last_event_time: string; //ISO 8601 format
+}
+
+export interface ISgCategoryStatistics {
+    date: string;
+    stats: SgCategoryStatisticsItem[]
+}
+
+export type SgCategoryStatisticsItem = {
+    type: string;
+    name: string;
+    metrics: SgCategoryStatisticsMetricsItem;
+}
+
+export type SgCategoryStatisticsMetricsItem = {
+    blocks: number;
+    bounce_drops: number;
+    bounces: number;
+    clicks: number;
+    deferred: number;
+    delivered: number;
+    invalid_emails: number;
+    opens: number;
+    processed: number;
+    requests: number;
+    spam_report_drops: number;
+    spam_reports: number;
+    unique_clicks: number;
+    unique_opens: number;
+    unsubscribe_drops: number;
+    unsubscribes: number;
+}
 
 /**
  * A SendGrid client class
  */
-class SendGridClient {
+export default class SendGridClient {
 
     private mailService: MailService;
+    private officialClient: OfficialClient;
+    private static BASE_URL: string = 'https://api.sendgrid.com';
 
     /**
      * @constructor
      * @param {string} [apiKey] - SendGrid API key (optional)
      */
-    constructor() {
+    constructor(sendGridClientSecret: string) {
         this.mailService = new MailService();
-        this.initialize();
-    }
-
-    /**
-     * Initializes the SendGrid client with the API key retrieved from Azure Key Vault.
-     */
-    private async initialize(): Promise<void> {
-        const sendGridClientSecret = await AppConfigKeyRetriever.getSendgridClientSecret();
+        this.officialClient = new OfficialClient();
+        // set API key
         this.mailService.setApiKey(sendGridClientSecret);
+        this.officialClient.setApiKey(sendGridClientSecret);
     }
 
-
     /**
      * It sends an email.
      * @param {string} from - The email address of the sender.
@@ -36,7 +75,7 @@ class SendGridClient {
      * @param {string} htmlBodyText - The HTML body of the email.
      * @param {any} [options] - Extra settings for the email
      */
-    async send(from: string, to: string[], subject: string, htmlBodyText: string, options?: Partial<MailDataRequired>): Promise<void> | never {
+    public async sendEmail(from: string, to: string[], subject: string, htmlBodyText: string, options?: Partial<MailDataRequired>): Promise<ClientResponse> | never {
         const msg: MailDataRequired = {
             from,
             to,
@@ -46,12 +85,150 @@ class SendGridClient {
         };
 
         try {
-            await this.mailService.send(msg);
+            const response = await this.mailService.send(msg);
+            return response[0];
         } catch (err) {
             logger.error(`SendGridClient/send with error, ${err}`);
             throw err;
         }
     }
-}
 
-export const sendGridClient = commonAppConfig.SendgridClientSecretKey ? new SendGridClient() : null;
+    /*
+        SendGrid v3 API has a pagination limitation on GET /messages
+        it only accepts limit as query param, not offset
+        https://www.twilio.com/docs/sendgrid/api-reference/how-to-use-the-sendgrid-v3-api/requests#pagination
+    */
+    public async getEmailActivity(
+        lastEventStartDate?: Date,
+        lastEventEndDate?: Date,
+        category?: string,
+        status?: SendGridEmailFeedStatus
+    ): Promise<ISgMessage[]> {
+        
+        const method = 'GET';
+        const url = '/v3/messages';
+        const baseUrl = SendGridClient.BASE_URL;
+        const request = this.officialClient.createRequest({
+            baseUrl,
+            url,
+            method
+        });
+        
+        const batchSize = 1000;
+        // store all unique records 
+        const map: Map<string, ISgMessage> = new Map ();
+        // as the records are returned in DESC order of lastEventDate, keep update nextLastEventEndDate within the loop
+        let nextLastEventEndDate = lastEventEndDate;
+        let count = 0;
+        do {
+            request.qs = this.getQueryParams(batchSize, lastEventStartDate, nextLastEventEndDate, category, status);
+            logger.info(`Sending ${method} request to ${baseUrl + url} with body: ${JSON.stringify(request)}`);
+            const [ response, body ]: [helpers.classes.Response, any]  = await this.officialClient.request(request);
+            const statusCode = response.statusCode;
+            if (statusCode == 200) {
+                const messages: ISgMessage[] = body.messages;
+                count = messages.length;
+                if (count > 0) {
+                    for (const msg of messages) {
+                        if (!map.has(msg.msg_id)) {
+                            map.set(msg.msg_id, msg)
+                        }
+                    }
+                    const lastItem = messages[messages.length - 1];
+                    nextLastEventEndDate = new Date(lastItem.last_event_time);
+                }
+            }
+            else {
+                break;
+            }
+        }
+        while (count >= batchSize);
+
+        return Array.from(map.values());
+    }
+
+    /*
+        https://www.twilio.com/docs/sendgrid/for-developers/sending-email/getting-started-email-activity-api
+        can add more query params
+    */
+    public getQueryParams(
+        batchSize?: number,
+        lastEventStartDate?: Date,
+        lastEventEndDate?: Date,
+        category?: string,
+        status?: SendGridEmailFeedStatus
+    ) {
+        let query = '';
+        if (!(isNil(lastEventStartDate) && isNil(lastEventEndDate))) {
+            query = `(last_event_time BETWEEN TIMESTAMP "${lastEventStartDate.toISOString()}" AND TIMESTAMP "${lastEventEndDate.toISOString()}")`;
+        }
+        if (!isNil(category)) {
+            query += ` AND (Contains(categories,"${category}"))`;
+        }
+        if (!isNil(status)) {
+            query += ` AND (status IN ("${status}"))`;
+        }
+
+        return query.length > 0 ? {
+            'limit': isNil(batchSize) ? 1000 : batchSize,
+            'query': query
+        } : {
+            'limit': isNil(batchSize) ? 1000 : batchSize
+        }
+    }
+
+    /**
+     * The function getCategoryStats retrieves category statistics with optional parameters such as
+     * limit, skip, startDate, category, aggregatedBy, and endDate.
+     * @param {string} startDate - The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.
+     * @param {string} category - The `category` parameter is a parameter that allows you
+     * to specify a category for which you want to retrieve statistics. It is a string type parameter.
+     * If provided, the function will return statistics specific to the specified category. If not
+     * provided, the function will return statistics for all categories.
+     * @param {string} aggregatedBy - How to group the statistics. Must be either "day", "week", or "month".
+     * @param {number} [limit=1000] - The number of results to return.
+     * @param {number} [skip=0] - The point in the list to begin retrieving results.
+     * @param {string} [endDate] - The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.
+     * 
+     * https://www.twilio.com/docs/sendgrid/api-reference/stats/retrieve-global-email-statistics#operation-details
+     */
+    public async getCategoryStats(
+        startDate: string, 
+        category: string,
+        aggregatedBy: "day" | "week" | "month",
+        limit: number = 1000,
+        offset: number = 0, 
+        endDate?: string
+    ): Promise<ISgCategoryStatistics[]> {
+        const method = 'GET';
+        const url = '/v3/categories/stats';
+        const baseUrl = SendGridClient.BASE_URL;
+        const request = this.officialClient.createRequest({
+            baseUrl,
+            url,
+            method
+        });
+
+        const queryParams: any = {
+            'limit': limit,
+            'offset': offset,
+            'start_date': startDate,
+            'categories': category,
+            'aggregated_by': aggregatedBy
+        };
+        if (!isNil(endDate)) {
+            queryParams.end_date = endDate;
+        }
+        request.qs = queryParams;
+
+        logger.info(`Sending ${method} request to ${baseUrl + url} with body: ${JSON.stringify(request)}`);
+        const [ response, body ]: [helpers.classes.Response, any]  = await this.officialClient.request(request);
+        const statusCode = response.statusCode;
+        if (statusCode == 200) {
+            return response.body as ISgCategoryStatistics[];
+        }
+        else {
+            return [];
+        }
+    }
+}

package/src/utils/appConst.ts

@@ -159,3 +159,9 @@ export const exitErrorMessage:Record<string, string> = {
 	UnknownTimeout: `operation timed out for an unknown reason`,
 	AuthenticationError: `Authentication error`
 }
+
+export enum SendGridEmailFeedStatus {
+	Delivered = "delivered",
+	NotDelivered = "not_delivered",
+	Processing = "processing"
+}