@getjones/test-infra 3.0.2 → 3.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getjones/test-infra",
-  "version": "3.0.2",
+  "version": "3.1.2",
   "description": "Providing internal and openapi interface",
   "main": "src/index.js",
   "scripts": {

package/src/common/commonFlows/records/records.js

@@ -3,9 +3,11 @@ const { expect } = require('chai');
 const threadScheduler = require('../../../saas/internal-api/thread-scheduler/runner');
 const timeUtils = require('../../utils/timeUtils');
 const httpResponseStatusCodes = require('../../../common/httpResponseStatusCodes.json');
+const ocrStatuses = require('../../consts/ocrStatuses');
 const contractors = require('../../../saas/internal-api/contractors');
 const compliance = require('../../../saas/internal-api/compliance');
 const requests = require('../../../saas/internal-api/requests');
+const dbEmails = require('../../../saas/internal-api/dbEmails');
 
 const makeRecordNotResponsive = async function(recordId, context, { isTenant } = {}) {
 	const offsetInDaysList = isTenant ?
@@ -112,6 +114,25 @@ const getHistoryEvents = async function(recordId, context) {
 	return recordHistory.data.map(item => item.itemTitle).reverse();
 };
 
+const waitForOcrStatus = async function(recordId, context, { expectedStatus = ocrStatuses.SUCCESS } = {}) {
+	let { data: recordOcrStatus } = await contractors.services.getRecordOcrStatus(recordId, context);
+	let maxRetries = 25;
+	while (recordOcrStatus !== expectedStatus && recordOcrStatus !== ocrStatuses.FAILED && maxRetries > 0) {
+		await timeUtils.waitFor(5).seconds;
+		recordOcrStatus = (await contractors.services.getRecordOcrStatus(recordId, context)).data;
+		maxRetries--;
+	}
+
+	if (recordOcrStatus !== expectedStatus) {
+		throw new Error(`Record OCR status not is as expected. Expected: ${expectedStatus}, Actual: ${recordOcrStatus}`);
+	}
+};
+
+const generateSubscriptionModelFromMail = async function(recipients) {
+	const data = await dbEmails.services.getSubscriptionData(recipients);
+	return contractors.services.getSubscriptionModel(data);
+};
+
 module.exports = {
 	makeRecordNotResponsive,
 	runOverAllRenewalDatesForRecord,
@@ -119,5 +140,7 @@ module.exports = {
 	updateInviteDate,
 	updatePolicyExpiryDateForRecord,
 	getHistoryEvents,
-	updateLastInviteActionDate
+	updateLastInviteActionDate,
+	waitForOcrStatus,
+	generateSubscriptionModelFromMail
 };

package/src/common/consts/accountSettings.js

@@ -0,0 +1,10 @@
+module.exports = {
+	isOcrEnabled: {
+		on: { isOcrEnabled: true },
+		off: { isOcrEnabled: false }
+	},
+	isAccountRequirementsEnabled: {
+		on: { isAccountRequirementsEnabled: true },
+		off: { isAccountRequirementsEnabled: false }
+	}
+};

package/src/common/consts/ocrStatuses.js

@@ -0,0 +1,6 @@
+module.exports = {
+	SUCCESS: 'SUCCESS',
+	FAILED: 'FAILED',
+	IN_PROGRESS: 'IN_PROGRESS',
+	UNKNOWN: 'UNKNOWN'
+};

package/src/common/utils/complianceUtil.js

@@ -6,12 +6,17 @@ const { credentials } = getEnv();
 
 const complianceStatuses = {
 	complaint: 'complaint',
+	awaitingCoi: 'awaitingCoi',
 	notCompliant: 'notCompliant',
-	expired: 'expired',
-	aboutToExpired: 'aboutToExpired',
+	waived: 'waived',
 	awaitingNewCoi: 'awaitingNewCoi'
 };
 
+const expiryStatuses = {
+	aboutToExpired: 'aboutToExpired',
+	expired: 'expired'
+};
+
 const isReaudit = (contractorId, context) => {
 	return auditApi.isReaudit(contractorId, context);
 };
@@ -61,17 +66,34 @@ const getAuditMetadata = async (
 	return metadata;
 };
 
-const getAuditConfigByStatus = (status, { glPolicyNumber } = {}) => {
+const getAuditConfigByStatus = (status, { expiryStatus, glPolicyNumber } = {}) => {
+	let config = {};
+
 	switch (status) {
 		case complianceStatuses.notCompliant:
 		case complianceStatuses.awaitingNewCoi:
-			return auditConfigs.getNotCompliantConfig({ glPolicyNumber });
-		case complianceStatuses.expired:
-			return auditConfigs.getExpiredConfig({ glPolicyNumber });
-		case complianceStatuses.aboutToExpired:
-			return auditConfigs.getAboutExpiredConfig({ glPolicyNumber });
+		case complianceStatuses.waived:
+			config = auditConfigs.getNotCompliantConfig({ glPolicyNumber });
+			break;
+		default:
+			config = auditConfigs.getCompliantAuditConfig({ glPolicyNumber });
+	}
+
+	expiryStatus && setExpiredByStatus(expiryStatus, config);
+
+	return config;
+};
+
+const setExpiredByStatus = (expiryStatus, config) => {
+	switch (expiryStatus) {
+		case expiryStatuses.expired:
+			auditConfigs.setExpiredConfig(config);
+			break;
+		case expiryStatuses.aboutToExpired:
+			auditConfigs.setAboutExpiredConfig(config);
+			break;
 		default:
-			return auditConfigs.getCompliantAuditConfig({ glPolicyNumber });
+			throw new Error(`Unknown expiry status: ${expiryStatus}`);
 	}
 };
 
@@ -79,5 +101,6 @@ module.exports = {
 	getAuditMetadata,
 	isReaudit,
 	getAuditConfigByStatus,
-	complianceStatuses
+	complianceStatuses,
+	expiryStatuses
 };

package/src/defaults/configs/auditConfigs.js

@@ -68,22 +68,30 @@ const getNotCompliantConfig = ({ glPolicyNumber } = {}) => {
 
 const getAboutExpiredConfig = ({ glPolicyNumber } = {}) => {
 	const compliantConfig = getCompliantAuditConfig({ glPolicyNumber });
-	compliantConfig[generalLiability][policyExpired] = `${getOneWeekAheadDate()}`;
+	setAboutExpiredConfig(compliantConfig);
 	return compliantConfig;
 };
 
 const getExpiredConfig = ({ glPolicyNumber } = {}) => {
 	const compliantConfig = getCompliantAuditConfig({ glPolicyNumber });
-	compliantConfig[generalLiability][policyExpired] = `${getOneWeekAgoDate()}`;
+	setExpiredConfig(compliantConfig);
 
 	return compliantConfig;
 };
 
+const setAboutExpiredConfig = config =>
+	config[generalLiability][policyExpired] = `${getOneWeekAheadDate()}`;
+
+const setExpiredConfig = config =>
+	config[generalLiability][policyExpired] = `${getOneWeekAgoDate()}`;
+
 module.exports = {
 	getCompliantAuditConfig,
 	getNotCompliantConfig,
 	getAboutExpiredConfig,
 	getExpiredConfig,
+	setExpiredConfig,
+	setAboutExpiredConfig,
 	policySelections,
 	defaultPolicyDate: DEFAULT_POLICY_DATE,
 	defaultAMScore: DEFAULT_AM_SCORE,

package/src/defaults/configs/polices.js

@@ -48,14 +48,17 @@ const attributeNames = {
 	occur: 'Occur',
 	text: 'text',
 	limit: 'limit',
-	AdditionalInsuredEndorsement: 'Additional Insured Endorsement',
-	PrimaryNonContributoryProvision: 'Primary Non-Contributory Provision',
-	PrimaryNonContributoryEndorsement: 'Primary Non-Contributory Endorsement',
+	additionalInsuredEndorsement: 'Additional Insured Endorsement',
+	primaryNonContributoryProvision: 'Primary Non-Contributory Provision',
+	primaryNonContributoryEndorsement: 'Primary Non-Contributory Endorsement',
 	indemnityPeriod: 'Indemnity Period',
 	actualLossSustained: 'Actual Loss Sustained',
 	extraExpense: 'Extra Expense',
-	combinedSingleLimit: 'Combined Single Limit'
-
+	combinedSingleLimit: 'Combined Single Limit',
+	followsForm: 'Follows Form',
+	followFormEndorsement: 'Follow-Form Endorsement',
+	waiverOfSubrogation: 'Waiver of Subrogation',
+	waiverOfSubrogationEndorsement: 'Waiver of Subrogation Endorsement'
 };
 
 module.exports = {

package/src/factory/records/records.js

@@ -9,15 +9,18 @@ const compliance = require('../../saas/internal-api/compliance');
 const contractors = require('../../saas/internal-api/contractors');
 const requests = require('../../saas/internal-api/requests');
 
-const { complianceStatuses, getAuditConfigByStatus } = require('../../common/utils/complianceUtil');
+const { complianceStatuses, getAuditConfigByStatus, expiryStatuses } = require('../../common/utils/complianceUtil');
 const httpResponseStatusCodes = require('../../common/httpResponseStatusCodes.json');
 const activationStatuses = require('../../common/consts/activationStatuses');
 const timeUtils = require('../../common/utils/timeUtils');
 const recordFlows = require('../../common/commonFlows/records/records');
+const recordTypes = require('../../common/consts/recordTypes');
 
 const filePath = path.join(__dirname, '../../resources/coi/coi.pdf');
 
-const prepareRecord = async (recordCompany, recordEmail, status, tabId, requirementId, context, { shouldSendNotificationToPM = false, recordConfig } = {}) => {
+const prepareRecord = async (recordCompany, recordEmail, status, tabId, requirementId, context, { expiryStatus, shouldSendNotificationToPM = false, recordConfig } = {}) => {
+	validateInsuranceAndExpiryStatus(status, expiryStatus);
+
 	const requestData = await requests.services.getOrCreateRequest(
 		context,
 		tabId,
@@ -39,6 +42,10 @@ const prepareRecord = async (recordCompany, recordEmail, status, tabId, requirem
 
 	recordConfig && await recordFlows.editRequestAndRecordDetails(requestData, recordConfig, context);
 
+	if (status === complianceStatuses.awaitingCoi) {
+		return recordId;
+	}
+
 	const coiUpload = await coi.utils.uploadCoi(
 		recordId,
 		filePath,
@@ -56,7 +63,7 @@ const prepareRecord = async (recordCompany, recordEmail, status, tabId, requirem
 
 	const auditorContext = await auth.services.getAuditorCookie();
 
-	const auditConfig = getAuditConfigByStatus(status);
+	const auditConfig = getAuditConfigByStatus(status, { expiryStatus });
 
 	let auditResponse, retries = 5;
 	do {
@@ -76,37 +83,60 @@ const prepareRecord = async (recordCompany, recordEmail, status, tabId, requirem
 		throw Error(`Failed to audit record ${recordCompany}\n${auditResponse}`);
 	}
 
+	if (status === complianceStatuses.waived) {
+		await waiveAllGaps(recordId, context);
+	} else if (status === complianceStatuses.awaitingNewCoi) {
+		await sendGaps(recordId, tabId, context);
+	}
+
 	return recordId;
 };
 
-const prepareCompliantRecord = (recordCompany, recordEmail, tabId, requirementId, context, { recordConfig } = {}) => {
-	return prepareRecord(recordCompany, recordEmail, complianceStatuses.complaint, tabId, requirementId, context, { recordConfig });
+const prepareCompliantRecord = (recordCompany, recordEmail, tabId, requirementId, context, { recordConfig, expiryStatus } = {}) => {
+	return prepareRecord(recordCompany, recordEmail, complianceStatuses.complaint, tabId, requirementId, context, { recordConfig, expiryStatus });
 };
 
-const prepareNotCompliantRecord = (recordCompany, recordEmail, tabId, requirementId, context, { shouldSendNotificationToPM = false, recordConfig } = {}) => {
-	return prepareRecord(recordCompany, recordEmail, complianceStatuses.notCompliant, tabId, requirementId, context, {	shouldSendNotificationToPM, recordConfig });
+const prepareNotCompliantRecord = (recordCompany, recordEmail, tabId, requirementId, context, { shouldSendNotificationToPM = false, recordConfig, expiryStatus } = {}) => {
+	return prepareRecord(recordCompany, recordEmail, complianceStatuses.notCompliant, tabId, requirementId, context, {	shouldSendNotificationToPM, recordConfig, expiryStatus });
 };
 
-const prepareExpiredRecord = (recordCompany, recordEmail, tabId, requirementId, context, { recordConfig } = {}) => {
-	return prepareRecord(recordCompany, recordEmail, complianceStatuses.expired, tabId, requirementId, context, { recordConfig });
+const prepareWaivedRecord = async (recordCompany, recordEmail, tabId, requirementId, context, { recordConfig, expiryStatus } = {}) => {
+	const recordId = await prepareRecord(recordCompany, recordEmail, complianceStatuses.notCompliant, tabId, requirementId, context, { recordConfig, expiryStatus });
+	await waiveAllGaps(recordId, context);
+	return recordId;
 };
 
-const prepareAboutToExpiredRecord = (recordCompany, recordEmail, tabId, requirementId, context, { recordConfig } = {}) => {
-	return prepareRecord(recordCompany, recordEmail, complianceStatuses.aboutToExpired, tabId, requirementId, context, { recordConfig });
+const prepareAwaitingNewCoiRecord = async (recordCompany, recordEmail, tabId, requirementId, context, { recordConfig, expiryStatus, isNotResponsive = false } = {}) => {
+	const recordId = await prepareRecord(recordCompany, recordEmail, complianceStatuses.awaitingNewCoi, tabId, requirementId, context, { recordConfig, expiryStatus });
+
+	if (isNotResponsive) {
+		await makeRecordNotResponsive(recordId, context);
+	}
+
+	return recordId;
 };
 
-const prepareWaivedRecord = async (recordCompany, recordEmail, tabId, requirementId, context, { recordConfig } = {}) => {
-	const recordId = await prepareRecord(recordCompany, recordEmail, complianceStatuses.notCompliant, tabId, requirementId, context, { recordConfig });
+const prepareAwaitingCoiRecord = async (recordCompany, recordEmail, tabId, requirementId, context, { recordConfig, isNotResponsive = false } = {}) => {
+	const recordId = await prepareRecord(recordCompany, recordEmail, complianceStatuses.awaitingCoi, tabId, requirementId, context, { recordConfig });
 
-	const { data: record } = await contractors.services.getContractorById(recordId, context);
-	await compliance.services.overrideGap.waiveAll(record, context);
+	if (isNotResponsive) {
+		await makeRecordNotResponsive(recordId, context);
+	}
 
 	return recordId;
 };
 
-const prepareAwaitingNewCoiRecord = async (recordCompany, recordEmail, tabId, requirementId, context, { recordConfig } = {}) => {
-	const recordId = await prepareRecord(recordCompany, recordEmail, complianceStatuses.awaitingNewCoi, tabId, requirementId, context, { recordConfig });
+const prepareUnderReviewRecord = (recordCompany, recordEmail, tabId, requirementId, context, { recordConfig } = {}) => {
+	return prepareRecord(recordCompany, recordEmail, complianceStatuses.underReview, tabId, requirementId, context, { recordConfig });
+};
+
+const makeRecordNotResponsive = async (recordId, context) => {
+	const { data: record } = await contractors.services.getContractorById(recordId, context);
+	const isTenant = record.recordType === recordTypes.TENANTS;
+	await recordFlows.makeRecordNotResponsive(recordId, context, { isTenant });
+};
 
+const sendGaps = async (recordId, tabId, context) => {
 	const { id: requestId } = await requests.services.getRequestFromTabByRecordId(recordId, tabId, context);
 	const recordVerificationModel = await contractors.services.getRecordVerificationModel(recordId, context);
 	const sendGapsResponse = await contractors.services.sendGaps(requestId, recordVerificationModel, context);
@@ -114,12 +144,39 @@ const prepareAwaitingNewCoiRecord = async (recordCompany, recordEmail, tabId, re
 	if (sendGapsResponse.status !== httpResponseStatusCodes.OK) {
 		throw Error(`Failed to send gaps to ${recordCompany}\n${sendGapsResponse}`);
 	}
+};
 
-	return recordId;
+const waiveAllGaps = async (recordId, context) => {
+	const { data: record } = await contractors.services.getContractorById(recordId, context);
+	await compliance.services.overrideGap.waiveAll(record, context);
 };
-const prepareUnderReviewRecord = (recordCompany, recordEmail, tabId, requirementId, context, { recordConfig } = {}) => {
-	return prepareRecord(recordCompany, recordEmail, complianceStatuses.underReview, tabId, requirementId, context, { recordConfig });
+
+const validateInsuranceAndExpiryStatus = async (insuranceStatus, expiryStatus) => {
+	let isValid = false;
+	const isWithoutExpiryStatus = Boolean(expiryStatus);
+
+	switch (insuranceStatus) {
+		case complianceStatuses.complaint:
+		case complianceStatuses.waived:
+			isValid = isWithoutExpiryStatus || expiryStatus === expiryStatuses.aboutToExpired ;
+			break;
+		case complianceStatuses.awaitingNewCoi:
+		case complianceStatuses.notCompliant:
+			isValid = isWithoutExpiryStatus || Object.values(expiryStatuses).includes(expiryStatus) ;
+			break;
+		case complianceStatuses.awaitingCoi:
+		case complianceStatuses.underReview:
+			isValid = true;
+			break;
+		default:
+			throw new Error(`Invalid insurance status: ${insuranceStatus}`);
+	}
+
+	if (!isValid) {
+		throw new Error(`Invalid insurance and expiry status combination: insuranceStatus=${insuranceStatus}, expiryStatus=${expiryStatus}`);
+	}
 };
+
 const prepareDraftRecord = async (recordCompany, tabId, context, { recordEmail, requirementId, uploadCoi, recordConfig } = {}) => {
 	const requestData = await requests.services.getOrCreateRequest(
 		context,
@@ -160,10 +217,9 @@ const prepareDraftRecord = async (recordCompany, tabId, context, { recordEmail,
 module.exports = {
 	prepareCompliantRecord,
 	prepareNotCompliantRecord,
-	prepareExpiredRecord,
 	prepareWaivedRecord,
-	prepareAboutToExpiredRecord,
 	prepareAwaitingNewCoiRecord,
 	prepareUnderReviewRecord,
+	prepareAwaitingCoiRecord,
 	prepareDraftRecord
 };

package/src/saas/internal-api/contractors/api/contractors.api.js

@@ -7,6 +7,7 @@ const Endpoints = {
 	get: `${backendUrl}/saas/contractors`,
 	getContractorById: contractorId => `${backendUrl}/saas/contractor/${contractorId}`,
 	getRecordHistory: contractorId => `${backendUrl}/saas/record/${contractorId}/history`,
+	getRecordOcrStatus: contractorId => `${backendUrl}/saas/contractor/${contractorId}/ocr/status`,
 	delete: contractorId => `${backendUrl}/saas/contractor/${contractorId}`,
 	archive: contractorId => `${backendUrl}/saas/contractor/${contractorId}/archive`,
 	restore: contractorId => `${backendUrl}/saas/contractor/${contractorId}/restore`,
@@ -17,6 +18,8 @@ const Endpoints = {
 	requestNewCoiExpired: requestId => `${backendUrl}/saas/coi/${requestId}/expired`,
 	muteNotifications: `${backendUrl}/saas/record/notifications/mute`,
 	unmuteNotifications: `${backendUrl}/saas/record/notifications/unmute`,
+	unsubscribe: `${backendUrl}/record/email/unsubscribe`,
+	subscribe: `${backendUrl}/record/email/subscribe`,
 	changeRequirement: `${backendUrl}/saas/contractor/requirement`,
 	updateVendorExpiryDate: contractorId => `${backendUrl}/_saas/automation/contractor/${contractorId}/expiry-date`,
 	updateContractorInviteDate: contractorId => `${backendUrl}/_saas/automation/contractor/${contractorId}/invite-date`,
@@ -44,6 +47,10 @@ const getRecordHistory = (contractorId, context) => {
 	return requests.getRequestHandler(Endpoints.getRecordHistory(contractorId), {}, context);
 };
 
+const getRecordOcrStatus = (contractorId, context) => {
+	return requests.getRequestHandler(Endpoints.getRecordOcrStatus(contractorId), {}, context);
+};
+
 const deleteByContractorId = (contractorId, context) => {
 	return requests.deleteRequestHandler(Endpoints.delete(contractorId), context);
 };
@@ -70,6 +77,14 @@ const unmuteNotifications = (recordModifyDateVerificationModel, context) => {
 	return requests.postRequestHandler(Endpoints.unmuteNotifications, recordModifyDateVerificationModel, context);
 };
 
+const unsubscribe = subscriptionModel => {
+	return requests.postRequestHandler(Endpoints.unsubscribe, subscriptionModel);
+};
+
+const subscribe = subscriptionModel => {
+	return requests.postRequestHandler(Endpoints.subscribe, subscriptionModel);
+};
+
 const changeRequirement = (recordModifyDateVerificationModel, context) => {
 	return requests.putRequestHandler(Endpoints.changeRequirement, recordModifyDateVerificationModel, context);
 };
@@ -161,6 +176,7 @@ module.exports = {
 	getContractorsByAccountId,
 	getContractorById,
 	getRecordHistory,
+	getRecordOcrStatus,
 	deleteByContractorId,
 	archiveRecord,
 	restoreRecord,
@@ -176,6 +192,8 @@ module.exports = {
 	resendInvitation,
 	muteNotifications,
 	unmuteNotifications,
+	unsubscribe,
+	subscribe,
 	getLinkedProjectsCount,
 	updateLastInviteActionDate,
 	getInviteLinkStatus,

package/src/saas/internal-api/contractors/api/contractors.service.js

@@ -5,6 +5,7 @@ const { RecordModifyDateVerificationModel } = require('../models/verification.co
 const { AssignRequirementModel } = require('../models/assign.requirement.model');
 const { ContractorDetailsModel } = require('../models/edit.contractor.model');
 const { LinkRequestModel } = require('../models/link.request.model');
+const { SubscriptionModel } = require('../models/subscription.contractor.model');
 const httpResponseStatusCodes = require('../../../../common/httpResponseStatusCodes.json');
 const { waitFor } = require('../../../../common/utils/timeUtils');
 const activationStatuses = require('../../../../common/consts/activationStatuses');
@@ -26,6 +27,10 @@ const getRecordHistory = (contractorId, context) => {
 	return contractorsAPI.getRecordHistory(contractorId, context);
 };
 
+const getRecordOcrStatus = (recordId, context) => {
+	return contractorsAPI.getRecordOcrStatus(recordId, context);
+};
+
 const archiveRecord = (recordVerificationModel, context) => {
 	validateType(recordVerificationModel, RecordModifyDateVerificationModel);
 	return contractorsAPI.archiveRecord(recordVerificationModel, context);
@@ -100,11 +105,59 @@ const muteNotifications = (recordModifyDateVerificationModel, context) => {
 	return contractorsAPI.muteNotifications(recordModifyDateVerificationModel, context);
 };
 
+const muteNotificationsByRecordId = async (recordId, context) => {
+	const recordModifyDateVerificationModel = await getRecordVerificationModel(recordId, context);
+	const muteResponse = await contractorsAPI.muteNotifications(recordModifyDateVerificationModel, context);
+
+	if (muteResponse.status !== httpResponseStatusCodes.NO_CONTENT) {
+		throw new Error(`Failed to mute record: ${muteResponse.statusText}`);
+	}
+
+	return muteResponse;
+};
+
 const unmuteNotifications = (recordModifyDateVerificationModel, context) => {
 	validateType(recordModifyDateVerificationModel, RecordModifyDateVerificationModel);
 	return contractorsAPI.unmuteNotifications(recordModifyDateVerificationModel, context);
 };
 
+const unmuteNotificationsByRecordId = async (recordId, context) => {
+	const recordModifyDateVerificationModel = await getRecordVerificationModel(recordId, context);
+	const unmuteResponse = await contractorsAPI.unmuteNotifications(recordModifyDateVerificationModel, context);
+
+	if (unmuteResponse.status !== httpResponseStatusCodes.NO_CONTENT) {
+		throw new Error(`Failed to unmute record: ${unmuteResponse.statusText}`);
+	}
+
+	return unmuteResponse;
+};
+
+const unsubscribe = async (subscriptionModel, { expectError } = {}) => {
+	validateType(subscriptionModel, SubscriptionModel);
+	const unsubscribeResponse = await contractorsAPI.unsubscribe(subscriptionModel);
+
+	if (unsubscribeResponse.status !== httpResponseStatusCodes.OK && !expectError) {
+		throw new Error(`Failed to unsubscribe record: ${unsubscribeResponse.statusText}`);
+	}
+
+	return unsubscribeResponse;
+};
+
+const subscribe = async (subscriptionModel, { expectError } = {}) => {
+	validateType(subscriptionModel, SubscriptionModel);
+	const subscribeResponse = await contractorsAPI.subscribe(subscriptionModel);
+
+	if (subscribeResponse.status !== httpResponseStatusCodes.OK && !expectError) {
+		throw new Error(`Failed to subscribe record: ${subscribeResponse.statusText}`);
+	}
+
+	return subscribeResponse;
+};
+
+const getSubscriptionModel = (data, { recaptchaResponse = 'recaptchaResponse' } = {}) => {
+	return new SubscriptionModel(data, recaptchaResponse);
+};
+
 const deleteByContractorId = (contractorId, context) => {
 	return contractorsAPI.deleteByContractorId(contractorId, context);
 };
@@ -226,6 +279,7 @@ module.exports = {
 	getContractorsByAccountId,
 	getContractorById,
 	getRecordHistory,
+	getRecordOcrStatus,
 	archiveRecord,
 	restoreRecord,
 	editContractor,
@@ -239,7 +293,12 @@ module.exports = {
 	requestNewCoiExpired,
 	resendInvitation,
 	muteNotifications,
+	muteNotificationsByRecordId,
 	unmuteNotifications,
+	unmuteNotificationsByRecordId,
+	unsubscribe,
+	subscribe,
+	getSubscriptionModel,
 	deleteByContractorId,
 	deleteAllRecordsInAccount,
 	deleteAllActiveRecordsInAccount,

package/src/saas/internal-api/contractors/models/subscription.contractor.model.js

@@ -0,0 +1,13 @@
+class SubscriptionModel {
+	constructor(
+		data,
+		recaptchaResponse
+	) {
+		this.data = data;
+		this.recaptchaResponse = recaptchaResponse;
+	}
+}
+
+module.exports = {
+	SubscriptionModel
+};

package/src/saas/internal-api/dbEmails/api/db.emails.service.js

@@ -137,11 +137,20 @@ const waitForMail = async (emailModel, { maxSecondToWait = 30 } = {}) => {
 	return foundMails;
 };
 
+const getSubscriptionData = async function(recipients) {
+	const regex = util.getUnsubscribeButtonUrlRegex();
+	const unsubscribeButtonUrl = await getLastMessage({ recipients, regex, returnType: 'url' });
+
+	const data = util.getEncryptedDataFromLink(unsubscribeButtonUrl);
+	return decodeURIComponent(data);
+};
+
 module.exports = {
 	util,
 	waitForMail,
 	getAllMessages,
 	getLastMessage,
+	getSubscriptionData,
 	deleteMultipleMessages,
 	deleteAllMessages
 };

package/src/saas/internal-api/dbEmails/utils/util.js

@@ -66,9 +66,13 @@ const getMailActionButtonUrlRegex = () => {
 	return /(https:\/\/[a-zA-Z0-9.].*[a-zA-Z.]+\/CheckCustomersInviteLinkJSON\?data=[^"]+)/g;
 };
 
-const getEncryptedDataFromLink = link => {
+const getUnsubscribeButtonUrlRegex = () => {
+	return /(\/[a-zA-Z0-9.].*[a-zA-Z.]+\/vendor-app\/email\/unsubscribe\?data=[^"]+)/g;
+};
+
+const getEncryptedDataFromLink = (link, { removeLastTwoCharts } = {}) => {
 	const encryptedData = link.split('data=').pop();
-	return encryptedData.slice(0, -2);
+	return removeLastTwoCharts ? encryptedData.slice(0, -2) : encryptedData;
 };
 
 module.exports = {
@@ -78,5 +82,6 @@ module.exports = {
 	logRetrievedEmailInfo,
 	getEmailTextInSubject,
 	getMailActionButtonUrlRegex,
+	getUnsubscribeButtonUrlRegex,
 	getEncryptedDataFromLink
 };