@getjones/test-infra 1.7.2 → 1.8.0

package/package.json

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

package/src/index.js

@@ -46,7 +46,6 @@ const getInternalAPI = () => {
 		globalRecord,
 		vendorProfile,
 		serviceArea,
-
 		threadScheduler
 	};
 

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

@@ -9,11 +9,15 @@ const Endpoints = {
 	archive: contractorId => `${backendUrl}/saas/contractor/${contractorId}/archive`,
 	restore: contractorId => `${backendUrl}/saas/contractor/${contractorId}/restore`,
 	edit: contractorId => `${backendUrl}/saas/contractors/${contractorId}/update`,
+	muteNotifications: `${backendUrl}/saas/record/notifications/mute`,
+	unmuteNotifications: `${backendUrl}/saas/record/notifications/unmute`,
+	changeRequirement: `${backendUrl}/saas/contractor/requirement`,
 	updateVendorExpiryDate: contractorId => `${backendUrl}/_saas/automation/contractor/${contractorId}/expiry-date`,
 	assignMptToProperties: (accountId, tenantId) => `${backendUrl}/saas/account/${accountId}/multi-properties/${tenantId}`,
 	searchInAutocomplete: ({ tabId, searchWord }) =>
 		`${backendUrl}/saas/contractors/search/audited?&tabId=${tabId}&searchWord=${searchWord}`,
-	automationUpdateContractorUploadDate: contractorId => `${backendUrl}/saas/automation/contractor/${contractorId}/upload-date`
+	automationUpdateContractorUploadDate: contractorId => `${backendUrl}/saas/automation/contractor/${contractorId}/upload-date`,
+	publicLinkInvite: `${backendUrl}/_saas/contractors/publicinvite`
 };
 
 const createContractor = (createContractorModel, context) => {
@@ -45,6 +49,18 @@ const editContractor = (editContractorModel, context) => {
 	return requests.postRequestHandler(Endpoints.edit(editContractorModel.contractorId), editContractorModel, context, {}, params);
 };
 
+const muteNotifications = (recordModifyDateVerificationModel, context) => {
+	return requests.postRequestHandler(Endpoints.muteNotifications, recordModifyDateVerificationModel, context);
+};
+
+const unmuteNotifications = (recordModifyDateVerificationModel, context) => {
+	return requests.postRequestHandler(Endpoints.unmuteNotifications, recordModifyDateVerificationModel, context);
+};
+
+const changeRequirement = (recordModifyDateVerificationModel, context) => {
+	return requests.putRequestHandler(Endpoints.changeRequirement, recordModifyDateVerificationModel, context);
+};
+
 const updateExpiryDate = (contractorId, expiryDate, policyName) => {
 	const data = { [policyName]: expiryDate };
 	return requests.postRequestHandler(Endpoints.updateVendorExpiryDate(contractorId), data);
@@ -81,8 +97,13 @@ const updateContractorUploadDate = (contractorId, uploadDate, context) => {
 	return requests.patchRequestHandler(url, context);
 };
 
+const inviteContractorViaPublicLink = (createContractorModel, context) => {
+	return requests.postRequestHandler(Endpoints.publicLinkInvite, createContractorModel, context);
+};
+
 module.exports = {
 	createContractor,
+	changeRequirement,
 	getContractorsByAccountId,
 	getContractorById,
 	deleteByContractorId,
@@ -93,5 +114,8 @@ module.exports = {
 	assignMptToProperties,
 	getContractorsByTabId,
 	searchInAutocomplete,
-	updateContractorUploadDate
+	updateContractorUploadDate,
+	inviteContractorViaPublicLink,
+	muteNotifications,
+	unmuteNotifications
 };

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

@@ -61,8 +61,29 @@ const updateContractorUploadDate = (contractorId, uploadDate, context) => {
 	return contractorsAPI.updateContractorUploadDate(contractorId, uploadDate, context);
 };
 
+const inviteContractorViaPublicLink = async (createContractorModel, context) => {
+	validateType(createContractorModel, CreateContractorModel);
+	return contractorsAPI.inviteContractorViaPublicLink(createContractorModel, context);
+};
+
+const changeRequirement = (recordModifyDateVerificationModel, context) => {
+	validateType(recordModifyDateVerificationModel, RecordModifyDateVerificationModel);
+	return contractorsAPI.changeRequirement(recordModifyDateVerificationModel, context);
+};
+
+const muteNotifications = (recordModifyDateVerificationModel, context) => {
+	validateType(recordModifyDateVerificationModel, RecordModifyDateVerificationModel);
+	return contractorsAPI.muteNotifications(recordModifyDateVerificationModel, context);
+};
+
+const unmuteNotifications = (recordModifyDateVerificationModel, context) => {
+	validateType(recordModifyDateVerificationModel, RecordModifyDateVerificationModel);
+	return contractorsAPI.unmuteNotifications(recordModifyDateVerificationModel, context);
+};
+
 module.exports = {
 	createContractor,
+	changeRequirement,
 	getContractorsByAccountId,
 	getContractorById,
 	deleteByContractorId,
@@ -73,5 +94,8 @@ module.exports = {
 	getContractorsByTabId,
 	assignMptToProperties,
 	searchInAutoComplete,
-	updateContractorUploadDate
+	updateContractorUploadDate,
+	inviteContractorViaPublicLink,
+	muteNotifications,
+	unmuteNotifications
 };

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

@@ -1,12 +1,12 @@
 const { validateType } = require('../../../../common/validations/typeValidations');
 
-function CreateContractorModel(requirementId, inviterEmail, vendorInfo, { tabId = null, disableMail = true, sendCovid19Form = false } = {}) {
+function CreateContractorModel(requirementId, inviterEmail, vendorInfo, { tabId = null, disableMail = true, publicLink } = {}) {
 	this.reqId = requirementId;
 	this.inviterEmail = inviterEmail;
 	this.vendorInfo = vendorInfo;
 	this.disableMail = disableMail;
-	this.sendCovid19Form = sendCovid19Form;
 	this.tabId = tabId;
+	this.publicLink = publicLink;
 
 	vendorInfo && validateType(vendorInfo, ContractorInfo);
 }

package/src/saas/internal-api/projects/api/core/projects.api.js

@@ -6,7 +6,8 @@ const Endpoints = {
 	delete: projectId => `${backendUrl}/saas/project/${projectId}`,
 	getByAccountId: `${backendUrl}/saas/project/list`,
 	update: `${backendUrl}/saas/project`,
-	getProjectByProjectId: projectId => `${backendUrl}/saas/project/${projectId}`
+	getProjectByProjectId: projectId => `${backendUrl}/saas/project/${projectId}`,
+	getProjectServiceAreaByProjectId: projectId => `${backendUrl}/saas/integration-tests/project/${projectId}/service-area`
 };
 
 const create = (project, context) => {
@@ -31,4 +32,8 @@ const update = (project, context) => {
 	return requests.postRequestHandler(Endpoints.update, project, context);
 };
 
-module.exports = { create, getProjectsByAccountId, deleteProjectById, update, getProjectByProjectId };
+const getProjectServiceAreaByProjectId = (projectId, context) => {
+	return requests.getRequestHandler(Endpoints.getProjectServiceAreaByProjectId(projectId), {}, context);
+};
+
+module.exports = { create, getProjectsByAccountId, deleteProjectById, update, getProjectByProjectId, getProjectServiceAreaByProjectId };

package/src/saas/internal-api/projects/api/core/projects.service.js

@@ -17,6 +17,10 @@ const getProjectByName = async (accountId, projectName, context) => {
 	return requestedProject ? requestedProject : null;
 };
 
+const getProjectServiceArea = (projectId, context) => {
+	return projectsApi.getProjectServiceAreaByProjectId(projectId, context);
+};
+
 const deleteProjectByName = async (accountId, projectName, context) => {
 	const { data: projects } = await getProjectsByAccountId(accountId, context);
 	const filteredProjects = projects.filter(project => project.projectName === projectName);
@@ -56,5 +60,6 @@ module.exports = {
 	getProjectByName,
 	createProject,
 	deleteProjectByName,
-	updateProject
+	updateProject,
+	getProjectServiceArea
 };

package/src/saas/internal-api/reports/consts/consts.js

@@ -6,6 +6,10 @@ const REPORT_COMPLIANCE_STATUSES = {
 	EXPIRED: 'EXPIRED'
 };
 
+const EXPIRING_RECORDS_REPORT_COMPLIANCE_STATUSES = {
+	EXPIRING_SOON: 'EXPIRING_SOON'
+};
+
 const REPORT_CONTRACTOR_TYPES = {
 	VENDORS: 'Vendors',
 	TENANTS: 'Tenants',
@@ -30,7 +34,9 @@ const XlsxReportTypes = {
 	HIGH_LEVEL_PROPERTY_METRICS: 'HighLevelPropertyMetrics',
 	MASTER_COMPLIANCE_REPORT: 'MasterComplianceReport',
 	WAIVERS_REPORT: 'WaiversReport',
-	USER_MANAGEMENT_REPORT: 'UserManagementReport'
+	USER_MANAGEMENT_REPORT: 'UserManagementReport',
+	COVERAGE_GAPS_REPORT: 'CoverageGapsReport',
+	EXPIRING_RECORDS_REPORT: 'ExpiringRecordsReport'
 };
 
 const ScheduledReportFrequency = {
@@ -49,6 +55,7 @@ module.exports = {
 	REPORT_COMPLIANCE_STATUSES,
 	REPORT_CONTRACTOR_TYPES,
 	ALL_REPORT_COMPLIANCE_STATUSES,
+	EXPIRING_RECORDS_REPORT_COMPLIANCE_STATUSES,
 	ALL_REPORT_CONTRACTOR_TYPES,
 	XlsxReportTypes,
 	ScheduledReportFrequency,

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

@@ -1,13 +1,13 @@
 const tabsAPI = require('./tabs.api');
+const { CreateTabModel, UpdateTabModel } = require('../models/tabs.model');
 
 const createTab = async (projectId, tabName, tabType, context) => {
-	const tabModel = { projectId, tabName, type: tabType };
+	const tabModel = new CreateTabModel(projectId, tabName, tabType);
 	return tabsAPI.createTab(tabModel, context);
 };
 
-const updateTab = async (projectId, tabName, tabType, tabId, context) => {
-	const tabModel = { projectId, tabName, type: tabType, tabId };
-	return tabsAPI.updateTab(tabModel, context);
+const getTabById = async (tabId, context) => {
+	return tabsAPI.getTabByTabId(tabId, context);
 };
 
 const getTabsByProjectId = async (projectId, context) => {
@@ -15,21 +15,13 @@ const getTabsByProjectId = async (projectId, context) => {
 };
 
 const getTabsByName = async (projectId, tabName, context, { tabType } = {}) => {
-	const { data: tabs } = await tabsAPI.getTabsByProjectId(projectId, context);
+	const { data: tabs } = await getTabsByProjectId(projectId, context);
 	const requestedTab = tabType ?
 		tabs.find(tab => tab.tabName === tabName && tab.type === tabType) :
 		tabs.find(tab => tab.tabName === tabName);
 	return requestedTab;
 };
 
-const getTabById = async (tabId, context) => {
-	return tabsAPI.getTabByTabId(tabId, context);
-};
-
-const deleteTabById = async (tabId, context) => {
-	return tabsAPI.deleteTab(tabId, context);
-};
-
 const getOrCreateTab = async (projectId, tabName, tabType, context) => {
 	const { data: tabs } = await getTabsByProjectId(projectId, context);
 	const existingTab = tabs.find(tab => tab.tabName === tabName && tab.type === tabType);
@@ -42,12 +34,21 @@ const getOrCreateTab = async (projectId, tabName, tabType, context) => {
 	return createResponse.data;
 };
 
+const updateTab = async (projectId, tabName, tabType, tabId, context) => {
+	const tabModel = new UpdateTabModel(projectId, tabName, tabType, tabId);
+	return tabsAPI.updateTab(tabModel, context);
+};
+
+const deleteTabById = async (tabId, context) => {
+	return tabsAPI.deleteTab(tabId, context);
+};
+
 module.exports = {
+	createTab,
 	getTabById,
 	getTabsByProjectId,
-	createTab,
-	updateTab,
-	deleteTabById,
+	getTabsByName,
 	getOrCreateTab,
-	getTabsByName
+	updateTab,
+	deleteTabById
 };

package/src/saas/internal-api/tabs/models/tabs.model.js

@@ -0,0 +1,18 @@
+class CreateTabModel {
+	constructor(projectId, tabName, tabType) {
+		this.projectId = projectId;
+		this.tabName = tabName;
+		this.type = tabType;
+	}
+}
+
+class UpdateTabModel {
+	constructor(projectId, tabName, tabType, tabId) {
+		this.projectId = projectId;
+		this.tabName = tabName;
+		this.type = tabType;
+		this.tabId = tabId;
+	}
+}
+
+module.exports = { CreateTabModel, UpdateTabModel };

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

@@ -10,7 +10,9 @@ const Endpoints = {
 	getByEmail: email => `${backendUrl}/saas/team-member/by-email/${email}`,
 	delete: userId => `${backendUrl}/saas/users/${userId}`,
 	deleteSingleProject: (userId, projectId) => `${backendUrl}/saas/project/${projectId}/sub-account/${userId}`,
-	reinvite: `${backendUrl}/saas/project/team-member/reinvite`
+	reinvite: `${backendUrl}/saas/project/team-member/reinvite`,
+	getUserEncryptedData: (email, userRole) => `${backendUrl}/saas/team-member/email/${email}/role/${userRole}/signup-data`,
+	signupUser: `${backendUrl}/_saas/guests/signup`
 };
 
 const invite = (invitedUser, context) => {
@@ -18,6 +20,10 @@ const invite = (invitedUser, context) => {
 	return requests.putRequestHandler(Endpoints.invite, invitedUser, context, {}, params);
 };
 
+const signupUser = (signupUserModel, context) => {
+	return requests.postRequestHandler(Endpoints.signupUser, signupUserModel, context, {}, {});
+};
+
 const editUserRole = (userId, data, context) => {
 	return requests.patchRequestHandler(Endpoints.editUserRole(userId), context, data);
 };
@@ -35,6 +41,10 @@ const getUserByEmail = (email, context) => {
 	return requests.getRequestHandler(Endpoints.getByEmail(email), null, context);
 };
 
+const getUserEncryptedData = (email, role, context) => {
+	return requests.getRequestHandler(Endpoints.getUserEncryptedData(email, role), null, context);
+};
+
 const deleteUser = (userId, context) => {
 	return requests.deleteRequestHandler(Endpoints.delete(userId), context);
 };
@@ -48,4 +58,15 @@ const reinviteUser = (userId, context) => {
 	return requests.postRequestHandler(Endpoints.reinvite, {}, context, {}, params);
 };
 
-module.exports = { invite, getUsersByProjectId, getUserByEmail, deleteUser, deleteUserFromSingleProject, editUserRole, editUserProjects, reinviteUser };
+module.exports = {
+	invite,
+	signupUser,
+	getUsersByProjectId,
+	getUserByEmail,
+	getUserEncryptedData,
+	deleteUser,
+	deleteUserFromSingleProject,
+	editUserRole,
+	editUserProjects,
+	reinviteUser
+};

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

@@ -1,11 +1,20 @@
-const EditUserModel = require('../models/edit.user.model');
-const userAPI = require('./users.api');
+const { InviteUserModel, SignupUserModel, EditUserModel } = require('../models/users.model');
 const { validateType } = require('../../../../common/validations/typeValidations');
+const { getEnv } = require('../../../../env');
+const { credentials } = getEnv();
+const userAPI = require('./users.api');
+const util = require('../utils/util');
+const httpResponseStatusCodes = require('../../../../common/httpResponseStatusCodes.json');
 
 const inviteUser = async (invitedUser, context) => {
 	return userAPI.invite(invitedUser, context);
 };
 
+const signupUser = (signupUserModel, context) => {
+	validateType(signupUserModel, SignupUserModel);
+	return userAPI.signupUser(signupUserModel, context);
+};
+
 const editUserRole = async (userId, data, context) => {
 	return userAPI.editUserRole(userId, data, context);
 };
@@ -23,6 +32,38 @@ const getUserByEmail = async (email, context) => {
 	return userAPI.getUserByEmail(email, context);
 };
 
+const getOrCreateUser = async (email, role, projectsIds, context, { fullName = role, password = credentials.strongPassword } = {}) => {
+	let userResponse = await getUserByEmail(email, context);
+
+	if (userResponse.data.subuserId) {
+		return userResponse.data;
+	}
+
+	const inviteUserModel = new InviteUserModel(email, role, projectsIds, context);
+	const inviteResponse = await inviteUser([inviteUserModel], context);
+
+	if (inviteResponse.status !== httpResponseStatusCodes.NO_CONTENT) {
+		throw new Error(`Failed to invite user with email: ${email}`, inviteResponse);
+	}
+
+	userResponse = await getUserByEmail(email, context);
+
+	//Already signup user
+	if (userResponse.data.isVerified) {
+		return userResponse.data;
+	}
+
+	const signupUserModel = await util.getSignupUserModel(email, role, fullName, password, context);
+	const signupResponse = await signupUser(signupUserModel, context);
+
+	if (signupResponse.status !== httpResponseStatusCodes.OK) {
+		throw new Error(`Failed to signup user with email: ${email}`, signupResponse);
+	}
+
+	userResponse = await getUserByEmail(email, context);
+	return userResponse.data;
+};
+
 const deleteUser = (userId, context) => {
 	return userAPI.deleteUser(userId, context);
 };
@@ -35,4 +76,15 @@ const reinviteUser = (userId, context) => {
 	return userAPI.reinviteUser(userId, context);
 };
 
-module.exports = { inviteUser, getUsersByProjectId, getUserByEmail, deleteUser, deleteUserFromSingleProject, editUserRole, editUserProjects, reinviteUser };
+module.exports = {
+	inviteUser,
+	signupUser,
+	getUsersByProjectId,
+	getUserByEmail,
+	getOrCreateUser,
+	deleteUser,
+	deleteUserFromSingleProject,
+	editUserRole,
+	editUserProjects,
+	reinviteUser
+};

package/src/saas/internal-api/users/index.js

@@ -1,4 +1,4 @@
-const EditUserModel = require('./models/edit.user.model');
+const { EditUserModel } = require('./models/users.model');
 const coreModels = { EditUserModel };
 
 const models = { core: coreModels };

package/src/saas/internal-api/users/models/users.model.js

@@ -0,0 +1,31 @@
+class InviteUserModel {
+	constructor(email, role, projects = []) {
+		this.email = email;
+		this.role = role;
+		this.projects = projects;
+	}
+}
+
+class SignupUserModel {
+	constructor(fullName, role, password, encryptedData) {
+		this.fullName = fullName;
+		this.role = role;
+		this.password = password;
+		this.encryptedData = encryptedData;
+	}
+}
+
+class EditUserModel {
+	constructor(subUserId, email, role, projects = []) {
+		this.subUserId = subUserId;
+		this.email = email;
+		this.role = role;
+		this.projects = projects;
+	}
+}
+
+module.exports = {
+	InviteUserModel,
+	SignupUserModel,
+	EditUserModel
+};

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

@@ -0,0 +1,14 @@
+const { SignupUserModel } = require('../models/users.model');
+const usersApi = require('../api/users.api');
+
+const getUserEncryptedData = async (email, role, context) => {
+	const response = await usersApi.getUserEncryptedData(email, role, context);
+	return response.data;
+};
+
+const getSignupUserModel = async (email, role, fullName, password, context) => {
+	const userEncryptedData = await getUserEncryptedData(email, role, context);
+	return new SignupUserModel(fullName, role, password, userEncryptedData);
+};
+
+module.exports = { getSignupUserModel };

package/src/saas/openapi/projects/projects.api.js

@@ -8,7 +8,8 @@ const Endpoints = {
 	createProject: `${openapiUrl}/properties`,
 	updateProject: projectId => `${openapiUrl}/properties/${projectId}`,
 	getProjectSettings: projectId => `${openapiUrl}/properties/${projectId}/settings`,
-	updateProjectSettings: projectId => `${openapiUrl}/properties/${projectId}/settings`
+	updateProjectSettings: projectId => `${openapiUrl}/properties/${projectId}/settings`,
+	getProjectServiceArea: (city, state) => `${openapiUrl}/properties/service-area?city=${city}&state=${state}`
 };
 
 const getProjectsByName = async (apiKey, params) => {
@@ -42,6 +43,10 @@ const getProjectSettings = async (apiKey, projectId) => {
 		apiKey).then(res => res.data);
 };
 
+const getProjectServiceArea = async (apiKey, city, state) => {
+	return requests.getRequestHandler(Endpoints.getProjectServiceArea(city, state), apiKey);
+};
+
 module.exports = {
 	getProjectsByName,
 	getAllProjects,
@@ -49,5 +54,6 @@ module.exports = {
 	createProject,
 	updateProject,
 	updateProjectSettings,
-	getProjectSettings
+	getProjectSettings,
+	getProjectServiceArea
 };

package/src/saas/openapi/projects/projects.service.js

@@ -28,6 +28,10 @@ const getProjectSettings = async (apiKey, projectId) => {
 	return projectsApi.getProjectSettings(apiKey, projectId);
 };
 
+const getProjectServiceArea = async (apiKey, city, state) => {
+	return projectsApi.getProjectServiceArea(apiKey, city, state);
+};
+
 module.exports = {
 	getProjectsByName,
 	createProject,
@@ -35,5 +39,6 @@ module.exports = {
 	getAllProjects,
 	getModifiedProjects,
 	updateProjectSettings,
-	getProjectSettings
+	getProjectSettings,
+	getProjectServiceArea
 };

package/README.md

@@ -1,329 +0,0 @@
-# Package Name: @getjones/test-infra
-
-## Package Goal
-
-- Providing an easy and reusable interface for the backend system. Means, both by the OpenAPI, and the internal API.
-
-## Interface
-
-### init
-
-- require the package with settled up configuration json
-
-```node
-const { internalAPI } = require("@getjones/test-infra")(conf);
-```
-
-- configuration example
-
-```node
-const dotenv = require("dotenv");
-
-dotenv.config();
-
-module.exports = {
-  backendUrl: process.env.BACKEND_URL,
-  credentials: {
-    superUser: process.env.CREDENTIALS_SUPER_USER,
-    superUserPassword: process.env.CREDENTIALS_SUPER_USER_PASSWORD,
-    strongPassword: process.env.CREDENTIALS_STRONG_PASSWORD,
-  },
-  accountCreationSecret: process.env.ACCOUNT_CREATION_SECRET,
-  environment: process.env.ENVIRONMENT,
-  email: process.env.EMAIL,
-};
-```
-
-### internalAPI
-
-- internalAPI contains the next services:
-  - auth
-  - accounts
-  - accountSettings
-  - projects
-  - projectSettings
-
-```node
-const { auth, accounts, accountSettings, projects } = internalAPI;
-```
-
-### auth
-
-```node
-/**
- *
- * @param email (string)
- * @param password (string)
- * @return Auth cookie (string) with given email privileges.
- */
-const getAuthCookie = async (email, password) => {};
-
-/**
- *
- * Required Configuration: {
- * credentials.superUser,
- * credentials.superUserPassword
- * }
- * @return ICS cookie (String)
- */
-const getIcsCookie = async () => {};
-
-/**
- *
- * Required Configuration: {
-  * credentials.auditorUser,
-  * credentials.auditorPassword
- * }
- * @return Auditor cookie (String)
- */
-const getAuditorCookie = async () => {};
-
-/**
- *
- * Required Configuration: {
- * credentials.operatorUser,
- * credentials.operatorPassword
- * }
- * @return Operator cookie (String)
- */
-const getOperatorCookie = async () => {};
-```
-
-### accounts
-
-```node
-/**
- *
- * Required Configuration: {
- *  accountCreationSecret: accountCreationSecret,
- * }
- *
- * If you want to use default password so
- * 'credentials.strongPassword' is needed
- * to be a part of the configuration.
- *
- * @param email (string)
- * @param accountName (string)
- * @param context (string): Should contain ICS cookie
- * @return Account (object)
- */
-
-const createAccount = async (
-  email,
-  accountName,
-  context,
-  password = credentials.strongPassword,
-  propertyType = PROPERTY_TYPE
-) => {};
-
-/**
- *
- * @param accountName (string)
- * @param context (string): Should contains ICS cookie
- * @return Account (object)
- */
-const getAccount = async (accountName, context) => {};
-
-/**
- *
- * @param email (string)
- * @param accountName (string)
- * @param context (string): Should contain ICS cookie
- * @param password (string)
- * @return Account (object)
- */
-const getOrCreateAccount = async (
-  email,
-  accountName,
-  context,
-  password = credentials.strongPassword
-) => {};
-
-/**
- *
- * @param accountName (string)
- * @param context (string): Should contain ICS cookie
- * @return Account ID (String)
- */
-const getAccountId = async (accountName, context) => {};
-
-/**
- *
- * @param accountName (string)
- * @param context (string): Should contains ICS cookie
- * @return Http Response
- */
-const deleteAccountByName = async (accountName, context) => {};
-
-/**
- *
- * @param accountId (string)
- * @param context (string): Should contain ICS cookie
- * @return Http Response
- */
-const deleteAccountById = async (accountId, context) => {};
-```
-
-### accountSettings
-
-```node
-/**
- *
- * @param accountId (string)
- * @param context (string): Should contain ICS cookie
- * @return Account Settings (object)
- */
-const getAccountSettings = async (accountId, context) => {};
-
-/**
- *
- * @param accountId (string)
- * @param AccountSettings (object) Should Contain:
- * isMultiPropertyTenants (boolean)
- * isHighPriority (boolean)
- * @param context (string): Should contain ICS cookie
- * @return Http Response
- */
-const updateAccountSettings = async (
-  accountId,
-  isMultiPropertyTenants,
-  isHighPriority,
-  context
-) => {};
-
-/**
- * Summary: Change account settings to default
- * Description:
- * Update The Next Account Settings:
- * isMultiPropertyTenants: false
- * isHighPriority: false
- * @param accountId (string)
- * @param context (string): Should Contain ICS cookie
- * @return Http Response
- */
-const restoreAccountSettings = async (accountId, context) => {};
-```
-
-### projects
-
-```node
-/**
- *
- * @param accountName (string)
- * @param context (string): Should contain cookie
- * User's cookie that is related to this account or ICS cookie
- * @return List of projects ([objects])
- */
-const getProjectsByAccountName = async (accountName, context) => {};
-
-/**
- *
- * @param accountId (String)
- * @param context (string): Should contain cookie
- * User's cookie that is related to this account or ICS cookie
- * @return List of projects ([objects])
- */
-const getProjectsByAccountId = async (accountId, context) => {};
-
-/**
- *
- * @param accountId (string)
- * @param projectName (string)
- * @param context (string): Should contain cookie
- * User's cookie that is related to this account or ICS cookie
- * @return List of projects ([objects])
- */
-const getProjectsByName = async (accountId, projectName, context) => {};
-
-/**
- * Summary: Delete project by given details
- * @param accountId (string)
- * @param projectName (string)
- * @param context (string): Should contain cookie
- * User's cookie that is related to this account or ICS cookie
- * @return List of projects ([objects])
- */
-const deleteProjectByName = async (accountId, projectName, context) => {};
-
-/**
- *
- * @param project (object)
- * @param accountName (string)
- * @param context (string): Should contain cookie
- * User's cookie that is related to this account or ICS cookie
- * @return object contains generated projectId
- */
-
-// Example for project input (Not all of them are required):
-const createProjectInput = {
-  projectName: project.name,
-  userId: "",
-  regionOrDivision: project.description,
-  address: project.address,
-  projectNumber: project.number,
-  projectStartDate: project.startDate,
-  projectEndDate: project.endDate,
-  city: project.city,
-  state: project.state,
-  zipCode: project.zipCode,
-  companyNameForProject: project.companyNameForProject,
-  certificateHolder: "",
-  additionalInsured: "",
-  tenantSolutionEnabled: "",
-  onboardingEnabled: "",
-  automaticRenewalEnabled: "",
-};
-
-const createProject = async (project, accountName, context) => {};
-```
-
-### projectSettings
-
-```node
-/**
- *
- * @param accountName (string)
- * @param context (string): Should contain cookie
- */
-
-const getProjectsByAccountName = async (accountName, context) => {};
-
-/**
- *
- * @param settings (object)
- * @param context (string): Should contain cookie
- */
-
-const updateProjectSettingsByProjectId = async (settings, context) => {};
-
-// Example for settings input (Not all of them are required):
-const updateProjectSettingsInput = {
-  autoGaps: {
-    Guests: false,
-    Tenants: false,
-    Vendors: false,
-  },
-  autoRenewals: false,
-  marketplace: {
-    marketplaceEnabled: false,
-    marketplacePreApproved: false,
-    marketplacePublicLink: false,
-  },
-  ocrEnabled: false,
-  onboardingPhase: false,
-  projectId: null,
-  qrEnabled: false,
-  tenantSolution: false,
-};
-```
-### serviceArea
-
-```node
-/**
-* @param city (string)
-* @param state (string)
-* @param context (string): Should contain cookie
-*/
-
-const getCoordinatesByAddress = (city, state, context) => {}
-```

package/src/saas/internal-api/users/models/edit.user.model.js

@@ -1,10 +0,0 @@
-class EditUserModel {
-	constructor(subUserId, email, role, projects = []) {
-		this.subUserId = subUserId;
-		this.email = email;
-		this.role = role;
-		this.projects = projects;
-	}
-}
-
-module.exports = EditUserModel;