@optimiser/common 1.0.365 → 1.0.367

package/dist/lib/helper.d.ts

@@ -1,93 +1,94 @@
-import { Db, ObjectId } from "mongodb";
-import { AnyObjectInterface } from "../modals/utility.modal";
-declare function GetCompanyDetails(Master_DB: Db, companyId: string): Promise<any>;
-declare function GetListSchema(db: Db, listName: string): Promise<Error | AnyObjectInterface[] | []>;
-declare function GetEmailwiseUnsubscribeData(db: Db, mailID: string, domainID?: string): Promise<Error | AnyObjectInterface[] | []>;
-declare function GenerateAutoIncrementFieldValue(db: Db, autoIncrementID: string): Promise<null | string>;
-declare function GetAccountDetailByName(db: Db, accountName: string): Promise<AnyObjectInterface | null>;
-declare function GetContactDetailByEmail(db: Db, contactEmail: string): Promise<null | AnyObjectInterface>;
-declare function GetSystemEmailTemplate(db: Db, TemplateIDArray: ObjectId[]): Promise<null | AnyObjectInterface>;
-declare function UpdateContactDetails(db: Db, contactData: AnyObjectInterface): void;
-declare function CreateContact(db: Db, contactData: AnyObjectInterface): Promise<null | AnyObjectInterface>;
-declare function MapAccountContact(db: Db, dataObj: AnyObjectInterface): void;
-declare function UpdatePipelineMailStatus(db: Db, pipelineID: string, mailStatus: any): void;
-declare function AddLog(db: Db, data: any): void;
-/**
- * Returns object - To and From date from given operator value
- *
- * @param {string} operator  today/yesterday/tomorrow
- * @return { dates } object container start and end date
- */
-declare const GetDateRangeFromOperatorValue: (operator: any, fiscalMonth: any, fiscalFrom: any) => {
-    startDate: any;
-    endDate: any;
-};
-/**
- * Returns boolean - Check date exist in Given Date Range(Quarter)
- *
- * @param {string} date  date to compare
- * @param {string} startDate format DD-MMM-YYYY
- * @param {string} endDate  format DD-MMM-YYYY
- * @return { boolean } true/false
- */
-declare const CheckDateExistInRange: (date: any, startDate: any, endDate: any) => boolean;
-/**
- * To get the email subscribe status. By default it take email as subscribed
- * and check if email is unsusbscribed for all categories of all domains then it give it as unsubscribe.
- * @param {db} database object
- * @param {email} string
- *
- * @param retunrs true|false|error for subscribe or unsubscribe.
- */
-declare const GetEmailSubscribeStatus: (db: Db, email: string) => Promise<Error | boolean>;
-/**
- * To subscribe or unsubscribe email id for all domains
- * @param {db} database object
- * @param {email} string
- * @param {isSubscribe} boolean
- * @param {companyID} mongodb object id, comany id of email
- * @param {comment} string , to add comment
- * @param {mongodbQueryOptions} object, params to pass on db queries
- * @returns resolve success | error object
- */
-declare const SubscribeEmailForAllDomains: (db: Db, email: string, isSubscribe: boolean, companyID: ObjectId, comment?: string, mongodbQueryOptions?: any) => Promise<unknown>;
-/**
- * checking phone number is valid and has dialing code
- * if it has dialing code then get country code, get its optimiser country phone code
- * if it doesn't has dialing code then try to pasrse it with countryCode
- * if phone is valid then use it other wise ignore that no.
- * @param {phoneNumber} string, phone no with or without dialing code
- * @param {countryCode} string, ISO country code
- * @returns {
-        IsValid: boolean,       //phone is valid or not
-        CountryCode?: string,   //phone country code
-        PhoneCallingCode?: CountryCallingCode,  //phone country calling code
-        PhoneNumberParsed?: NationalNumber,  //phone no local to the country, without country calling code and only digits
-        Error: Error
-    }
- */
-declare const IsValidPhoneNumber: (phoneNumber: string, countryCode: string) => AnyObjectInterface;
-/**
- *
- * Server side field validatinon
- * @param {db} object database connection
- * @param {dataObj} object contains field data
- * @param {objectType} string object name
- * @param {countryCode} string, ISO country code
- * @returns {
-        IsValid: boolean,       //phone is valid or not
-        CountryCode?: string,   //phone country code
-        PhoneCallingCode?: CountryCallingCode,  //phone country calling code
-        PhoneNumberParsed?: NationalNumber,  //phone no local to the country, without country calling code and only digits
-        Error: Error
-    }
- */
-declare function ValidateData(db: Db, dataObj: AnyObjectInterface, objectType: string): Promise<unknown>;
-/**
- * Returns boolean - Whether given date is future or not
- *
- * @param {string} date  date
- * @return { boolean } true/false
- */
-declare const IsFutureDate: (date: any) => boolean;
-export { GetCompanyDetails, GetListSchema, GetEmailwiseUnsubscribeData, GenerateAutoIncrementFieldValue, GetAccountDetailByName, GetContactDetailByEmail, GetSystemEmailTemplate, UpdateContactDetails, CreateContact, MapAccountContact, UpdatePipelineMailStatus, AddLog, CheckDateExistInRange, GetDateRangeFromOperatorValue, GetEmailSubscribeStatus, SubscribeEmailForAllDomains, IsValidPhoneNumber, ValidateData, IsFutureDate };
+import { Db, ObjectId } from "mongodb";
+import { AnyObjectInterface } from "../modals/utility.modal";
+declare function GetCompanyDetails(Master_DB: Db, companyId: string): Promise<any>;
+declare function GetListSchema(db: Db, listName: string): Promise<Error | AnyObjectInterface[] | []>;
+declare function GetEmailwiseUnsubscribeData(db: Db, mailID: string, domainID?: string): Promise<Error | AnyObjectInterface[] | []>;
+declare function GenerateAutoIncrementFieldValue(db: Db, autoIncrementID: string): Promise<null | string>;
+declare function GetAccountDetailByName(db: Db, accountName: string): Promise<AnyObjectInterface | null>;
+declare function GetContactDetailByEmail(db: Db, contactEmail: string): Promise<null | AnyObjectInterface>;
+declare function GetSystemEmailTemplate(db: Db, TemplateIDArray: ObjectId[]): Promise<null | AnyObjectInterface>;
+declare function UpdateContactDetails(db: Db, contactData: AnyObjectInterface): void;
+declare function CreateContact(db: Db, contactData: AnyObjectInterface): Promise<null | AnyObjectInterface>;
+declare function MapAccountContact(db: Db, dataObj: AnyObjectInterface): void;
+declare function UpdatePipelineMailStatus(db: Db, pipelineID: string, mailStatus: any): void;
+declare function AddLog(db: Db, data: any): void;
+/**
+ * Returns object - To and From date from given operator value
+ *
+ * @param {string} operator  today/yesterday/tomorrow
+ * @return { dates } object container start and end date
+ */
+declare const GetDateRangeFromOperatorValue: (operator: any, fiscalMonth: any, fiscalFrom: any) => {
+    startDate: any;
+    endDate: any;
+};
+/**
+ * Returns boolean - Check date exist in Given Date Range(Quarter)
+ *
+ * @param {string} date  date to compare
+ * @param {string} startDate format DD-MMM-YYYY
+ * @param {string} endDate  format DD-MMM-YYYY
+ * @return { boolean } true/false
+ */
+declare const CheckDateExistInRange: (date: any, startDate: any, endDate: any) => boolean;
+/**
+ * To get the email subscribe status. By default it take email as subscribed
+ * and check if email is unsusbscribed for all categories of all domains then it give it as unsubscribe.
+ * @param {db} database object
+ * @param {email} string
+ *
+ * @param retunrs true|false|error for subscribe or unsubscribe.
+ */
+declare const GetEmailSubscribeStatus: (db: Db, email: string) => Promise<Error | boolean>;
+/**
+ * To subscribe or unsubscribe email id for all domains
+ * @param {db} database object
+ * @param {email} string
+ * @param {isSubscribe} boolean
+ * @param {companyID} mongodb object id, comany id of email
+ * @param {comment} string , to add comment
+ * @param {mongodbQueryOptions} object, params to pass on db queries
+ * @returns resolve success | error object
+ */
+declare const SubscribeEmailForAllDomains: (db: Db, email: string, isSubscribe: boolean, companyID: ObjectId, comment?: string, mongodbQueryOptions?: any) => Promise<unknown>;
+/**
+ * checking phone number is valid and has dialing code
+ * if it has dialing code then get country code, get its optimiser country phone code
+ * if it doesn't has dialing code then try to pasrse it with countryCode
+ * if phone is valid then use it other wise ignore that no.
+ * @param {phoneNumber} string, phone no with or without dialing code
+ * @param {countryCode} string, ISO country code
+ * @returns {
+        IsValid: boolean,       //phone is valid or not
+        CountryCode?: string,   //phone country code
+        PhoneCallingCode?: CountryCallingCode,  //phone country calling code
+        PhoneNumberParsed?: NationalNumber,  //phone no local to the country, without country calling code and only digits
+        ValidatedBy? : string,      //Possible Values are SELF | COUNTRY_CODE, this field tells Phone No is valid by self or found valid with Country code
+        Error: Error
+    }
+ */
+declare const IsValidPhoneNumber: (phoneNumber: string, countryCode: string) => AnyObjectInterface;
+/**
+ *
+ * Server side field validatinon
+ * @param {db} object database connection
+ * @param {dataObj} object contains field data
+ * @param {objectType} string object name
+ * @param {countryCode} string, ISO country code
+ * @returns {
+        IsValid: boolean,       //phone is valid or not
+        CountryCode?: string,   //phone country code
+        PhoneCallingCode?: CountryCallingCode,  //phone country calling code
+        PhoneNumberParsed?: NationalNumber,  //phone no local to the country, without country calling code and only digits
+        Error: Error
+    }
+ */
+declare function ValidateData(db: Db, dataObj: AnyObjectInterface, objectType: string): Promise<unknown>;
+/**
+ * Returns boolean - Whether given date is future or not
+ *
+ * @param {string} date  date
+ * @return { boolean } true/false
+ */
+declare const IsFutureDate: (date: any) => boolean;
+export { GetCompanyDetails, GetListSchema, GetEmailwiseUnsubscribeData, GenerateAutoIncrementFieldValue, GetAccountDetailByName, GetContactDetailByEmail, GetSystemEmailTemplate, UpdateContactDetails, CreateContact, MapAccountContact, UpdatePipelineMailStatus, AddLog, CheckDateExistInRange, GetDateRangeFromOperatorValue, GetEmailSubscribeStatus, SubscribeEmailForAllDomains, IsValidPhoneNumber, ValidateData, IsFutureDate };