placementt-core 1.400.1012 → 1.400.1014

package/lib/typeDefinitions.d.ts

@@ -875,6 +875,11 @@ export type RiskAssessmentFieldDef = {
     type: "string" | "dropdown";
     options?: string[];
 };
+export type RiskAssessmentOptions = {
+    template?: boolean;
+    columns?: boolean;
+    form?: boolean;
+};
 export type EmployerField = {
     name: string;
     label?: string;
@@ -974,6 +979,12 @@ export type InstituteData = {
         employerSharingScope: "membership" | "unrestricted";
     };
     emailDomain: string;
+    /** Kill switch for all outbound email associated with this institute. When true the
+     * backend drops every email it sends on the institute's behalf — students, parents,
+     * employers, linked hubs/trusts and the public — before it reaches Brevo. The only
+     * exception is mail to the institute's own staff, so the account stays usable while
+     * the block is on. Set from Organisation > Overview. */
+    blockAllEmails?: boolean;
     splitBilling?: boolean;
     adminBillingContactId?: string;
     employerEvents?: boolean;
@@ -1056,11 +1067,7 @@ export type InstituteData = {
     riskAssessmentTemplate?: Timestamp;
     riskAssessmentColumns?: RiskAssessmentFieldDef[];
     riskAssessmentFormId?: string;
-    riskAssessmentEnabled?: {
-        template?: boolean;
-        columns?: boolean;
-        form?: boolean;
-    };
+    riskAssessmentEnabled?: RiskAssessmentOptions;
     privacyPolicy: Timestamp;
     demo?: boolean;
     emailTemplates?: {
@@ -1430,6 +1437,7 @@ export type PlacementReviewDetails = {
     trackAttendance?: boolean;
     daysEachWeek?: ("Mon" | "Tue" | "Wed" | "Thu" | "Fri" | "Sat" | "Sun")[];
     riskAssessmentColumns?: RiskAssessmentFieldDef[];
+    riskAssessmentEnabled?: RiskAssessmentOptions;
     employerFields?: EmployerField[];
 };
 export type ProviderMatch = {
@@ -3045,6 +3053,10 @@ export type EmailInteraction = {
     recipientEmail: string;
     recipientForename: string;
     recipientSurname: string;
+    /** The institute this email was sent on behalf of. Written on every send that
+     * knows its institute, so a reminder resent weeks later can still resolve the
+     * institute's email settings (e.g. `blockAllEmails`) without the original context. */
+    oId?: string;
     messageType?: MessageTypes;
     reminderNumber?: number;
     sendReminders?: boolean;

package/package.json

@@ -2,7 +2,7 @@
   "private": false,
   "name": "placementt-core",
   "author": "Placementt",
-  "version": "1.400.1012",
+  "version": "1.400.1014",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "scripts": {

package/src/typeDefinitions.ts

@@ -897,6 +897,13 @@ export type RiskAssessmentFieldDef = {
     options?: string[]
 }
 
+// Which routes an institute lets employers use to submit a risk assessment.
+export type RiskAssessmentOptions = {
+    template?: boolean,
+    columns?: boolean,
+    form?: boolean,
+}
+
 export type EmployerField = {
     name: string,
     label?: string,
@@ -982,6 +989,12 @@ export type InstituteData = {
         employerSharingScope: "membership"|"unrestricted",
     },
     emailDomain: string,
+    /** Kill switch for all outbound email associated with this institute. When true the
+     * backend drops every email it sends on the institute's behalf — students, parents,
+     * employers, linked hubs/trusts and the public — before it reaches Brevo. The only
+     * exception is mail to the institute's own staff, so the account stays usable while
+     * the block is on. Set from Organisation > Overview. */
+    blockAllEmails?: boolean,
     splitBilling?: boolean,
     adminBillingContactId?: string,
     // Packages institutes can be signed up to
@@ -1076,11 +1089,7 @@ export type InstituteData = {
     riskAssessmentTemplate?: Timestamp,
     riskAssessmentColumns?: RiskAssessmentFieldDef[],
     riskAssessmentFormId?: string,
-    riskAssessmentEnabled?: {
-        template?: boolean,
-        columns?: boolean,
-        form?: boolean,
-    },
+    riskAssessmentEnabled?: RiskAssessmentOptions,
     privacyPolicy: Timestamp,
     demo?: boolean,
     emailTemplates?: {
@@ -1426,6 +1435,7 @@ export type PlacementReviewDetails = {
     trackAttendance?: boolean,
     daysEachWeek?: ("Mon"|"Tue"|"Wed"|"Thu"|"Fri"|"Sat"|"Sun")[],
     riskAssessmentColumns?: RiskAssessmentFieldDef[],
+    riskAssessmentEnabled?: RiskAssessmentOptions,
     employerFields?: EmployerField[],
 }
 
@@ -2993,6 +3003,10 @@ export type EmailInteraction = {
     recipientEmail: string,
     recipientForename: string,
     recipientSurname: string,
+    /** The institute this email was sent on behalf of. Written on every send that
+     * knows its institute, so a reminder resent weeks later can still resolve the
+     * institute's email settings (e.g. `blockAllEmails`) without the original context. */
+    oId?: string,
     // Email reminders values
     messageType?: MessageTypes, // This will be used to determine which test is necessary to decide to send a reminder
     reminderNumber?: number, // Which of the reminders is this?