notification-interfaces.md

INotificationRequest

Comes off the queue.

interface INotificationRequest {
	templateId: string;
	templateContext: any;
	subject: string;
	message?: string;
	groupId?: string;
	users: string | string[]
}

INotificationParams

Accepted by SendService.sendNotification

interface INotificationParams {
	subject: string;
	message: string;
	groupId?: string;
	users: string | string[];
}

IAppConfig

App-wide configuration object. May need to change based on our architecture decisions.

interface IAppConfig {
	templateBucket: string;
	queueUrl: string;
	notificationKeyPair: {
		key: string;
		// probably resolved at startup with a call to KMS
		secret: string;
	};
	defaultPortalUrl: string;
}