@kohost/api-client 7.9.0 → 7.10.0

package/dist/lib/emergencyContacts.d.ts

@@ -1,9 +1,14 @@
 import type { SISDriver } from "./sisDrivers.js";
+import type { ExternalAudienceGroup } from "../schemas/definitions.js";
 export interface EmergencyContactRoleGroup {
     role: string;
     total: number;
     reachable: number;
 }
+export interface ExternalGroupCounts {
+    total: number;
+    reachable: number;
+}
 export interface EmergencyContactAudience {
     driver: SISDriver;
     live: boolean;
@@ -11,4 +16,26 @@ export interface EmergencyContactAudience {
     total: number;
     reachable: number;
     byRole: EmergencyContactRoleGroup[];
+    /** Counts for each selectable external group, whatever the send selected. */
+    groups: Record<ExternalAudienceGroup, ExternalGroupCounts>;
+}
+export interface EmergencyContactPerson {
+    id: string;
+    firstName: string;
+    lastName: string;
+    email: string | null;
+    phone: string | null;
+    roles: string[];
+    /** First non-student role, or null when the source system left it unmapped. */
+    relationship: string | null;
+    group: ExternalAudienceGroup;
+    reachable: boolean;
+}
+export interface EmergencyContactPeople {
+    driver: SISDriver;
+    live: boolean;
+    syncedAt: string | null;
+    /** The groups `people` was built for. */
+    groups: ExternalAudienceGroup[];
+    people: EmergencyContactPerson[];
 }

package/dist/lib/index.d.ts

@@ -5,7 +5,7 @@ export { SIS_DRIVERS, isSISDriver, type SISDriver } from "./sisDrivers.js";
 export { SOS_AUDIENCES, type SOSAudience } from "./sosAudiences.js";
 export { MESSAGE_ERROR_CATEGORIES, categoryForMessageErrorCode, isMessageErrorCategory, type MessageErrorCategory, } from "./messageErrorCodes.js";
 export { DELIVERY_OUTCOMES, deliveryOutcomeForStatus, type DeliveryOutcome, } from "./deliveryStatus.js";
-export type { EmergencyContactAudience, EmergencyContactRoleGroup, } from "./emergencyContacts.js";
+export type { EmergencyContactAudience, EmergencyContactPeople, EmergencyContactPerson, EmergencyContactRoleGroup, ExternalGroupCounts, } from "./emergencyContacts.js";
 export { MAX_MESSAGE_ATTACHMENTS } from "./messageAttachments.js";
 export { DEFAULT_MARKUP_TIERS, DEFAULT_DNE_AMOUNT, resolveMarkupTierTable, keyedMarkupPercent, DEFAULT_TAX_RATE, derivePrice, billTotal, billTaxAmount, billGrandTotal, formatMoney, } from "./money.js";
 export { effectiveTaxRate, taxableSubtotal, billTotals, resolveBillTaxExempt, settledBillTotal, billEffectiveDate, type BillTaxFields, type TaxableLine, type SettledBillTotalSource, type BillEffectiveDateSource, } from "./bills.js";

package/dist/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../.generated/lib/index.ts"],"sourcesContent":["export {\n  inferDeviceNotifications,\n  type DeviceNotificationName,\n  type InferDeviceNotificationsInput,\n} from \"./deviceNotifications.js\";\nexport {\n  categoryForDevice,\n  SYSTEM_CATEGORIES,\n  SYSTEM_CATEGORY_LABELS,\n  type SystemCategory,\n  type CategoryForDeviceInput,\n} from \"./systemCategories.js\";\nexport {\n  getAllowedResourceIds,\n  getAllowedDeviceTypes,\n  getAllowedFeatures,\n  type PolicyLike,\n  type PolicyPermissionLike,\n} from \"./policy-resolvers.js\";\nexport { SIS_DRIVERS, isSISDriver, type SISDriver } from \"./sisDrivers.js\";\nexport { SOS_AUDIENCES, type SOSAudience } from \"./sosAudiences.js\";\nexport {\n  MESSAGE_ERROR_CATEGORIES,\n  categoryForMessageErrorCode,\n  isMessageErrorCategory,\n  type MessageErrorCategory,\n} from \"./messageErrorCodes.js\";\nexport {\n  DELIVERY_OUTCOMES,\n  deliveryOutcomeForStatus,\n  type DeliveryOutcome,\n} from \"./deliveryStatus.js\";\nexport type {\n  EmergencyContactAudience,\n  EmergencyContactRoleGroup,\n} from \"./emergencyContacts.js\";\nexport { MAX_MESSAGE_ATTACHMENTS } from \"./messageAttachments.js\";\nexport {\n  DEFAULT_MARKUP_TIERS,\n  DEFAULT_DNE_AMOUNT,\n  resolveMarkupTierTable,\n  keyedMarkupPercent,\n  DEFAULT_TAX_RATE,\n  derivePrice,\n  billTotal,\n  billTaxAmount,\n  billGrandTotal,\n  formatMoney,\n} from \"./money.js\";\nexport {\n  effectiveTaxRate,\n  taxableSubtotal,\n  billTotals,\n  resolveBillTaxExempt,\n  settledBillTotal,\n  billEffectiveDate,\n  type BillTaxFields,\n  type TaxableLine,\n  type SettledBillTotalSource,\n  type BillEffectiveDateSource,\n} from \"./bills.js\";\nexport {\n  KFC_STATS_TIMEZONE,\n  KFC_STATS_DEFAULT_WINDOW_DAYS,\n  KFC_STATS_MAX_RANGE_DAYS,\n  resolveKfcStatsWindowBounds,\n  type KfcStatsWindowBounds,\n} from \"./kfcStatsWindow.js\";\nexport {\n  serializeRichTextBody,\n  isWellFormedRichText,\n  type RichTextContent,\n  type RichTextBlockNode,\n  type RichTextInlineNode,\n  type RichTextListItemNode,\n  type RichTextMentionNode,\n} from \"./ticketRichText.js\";\n"],"mappings":""}
+{"version":3,"file":"index.js","names":[],"sources":["../../.generated/lib/index.ts"],"sourcesContent":["export {\n  inferDeviceNotifications,\n  type DeviceNotificationName,\n  type InferDeviceNotificationsInput,\n} from \"./deviceNotifications.js\";\nexport {\n  categoryForDevice,\n  SYSTEM_CATEGORIES,\n  SYSTEM_CATEGORY_LABELS,\n  type SystemCategory,\n  type CategoryForDeviceInput,\n} from \"./systemCategories.js\";\nexport {\n  getAllowedResourceIds,\n  getAllowedDeviceTypes,\n  getAllowedFeatures,\n  type PolicyLike,\n  type PolicyPermissionLike,\n} from \"./policy-resolvers.js\";\nexport { SIS_DRIVERS, isSISDriver, type SISDriver } from \"./sisDrivers.js\";\nexport { SOS_AUDIENCES, type SOSAudience } from \"./sosAudiences.js\";\nexport {\n  MESSAGE_ERROR_CATEGORIES,\n  categoryForMessageErrorCode,\n  isMessageErrorCategory,\n  type MessageErrorCategory,\n} from \"./messageErrorCodes.js\";\nexport {\n  DELIVERY_OUTCOMES,\n  deliveryOutcomeForStatus,\n  type DeliveryOutcome,\n} from \"./deliveryStatus.js\";\nexport type {\n  EmergencyContactAudience,\n  EmergencyContactPeople,\n  EmergencyContactPerson,\n  EmergencyContactRoleGroup,\n  ExternalGroupCounts,\n} from \"./emergencyContacts.js\";\nexport { MAX_MESSAGE_ATTACHMENTS } from \"./messageAttachments.js\";\nexport {\n  DEFAULT_MARKUP_TIERS,\n  DEFAULT_DNE_AMOUNT,\n  resolveMarkupTierTable,\n  keyedMarkupPercent,\n  DEFAULT_TAX_RATE,\n  derivePrice,\n  billTotal,\n  billTaxAmount,\n  billGrandTotal,\n  formatMoney,\n} from \"./money.js\";\nexport {\n  effectiveTaxRate,\n  taxableSubtotal,\n  billTotals,\n  resolveBillTaxExempt,\n  settledBillTotal,\n  billEffectiveDate,\n  type BillTaxFields,\n  type TaxableLine,\n  type SettledBillTotalSource,\n  type BillEffectiveDateSource,\n} from \"./bills.js\";\nexport {\n  KFC_STATS_TIMEZONE,\n  KFC_STATS_DEFAULT_WINDOW_DAYS,\n  KFC_STATS_MAX_RANGE_DAYS,\n  resolveKfcStatsWindowBounds,\n  type KfcStatsWindowBounds,\n} from \"./kfcStatsWindow.js\";\nexport {\n  serializeRichTextBody,\n  isWellFormedRichText,\n  type RichTextContent,\n  type RichTextBlockNode,\n  type RichTextInlineNode,\n  type RichTextListItemNode,\n  type RichTextMentionNode,\n} from \"./ticketRichText.js\";\n"],"mappings":""}

package/dist/lib/sosAudiences.d.ts

@@ -1,2 +1,2 @@
-export declare const SOS_AUDIENCES: readonly ["internal", "emergencyContacts"];
+export declare const SOS_AUDIENCES: readonly ["internal", "external"];
 export type SOSAudience = (typeof SOS_AUDIENCES)[number];

package/dist/lib/sosAudiences.js

@@ -1,5 +1,5 @@
 //#region .generated/lib/sosAudiences.ts
-const SOS_AUDIENCES = ["internal", "emergencyContacts"];
+const SOS_AUDIENCES = ["internal", "external"];
 //#endregion
 export { SOS_AUDIENCES };
 

package/dist/lib/sosAudiences.js.map

@@ -1 +1 @@
-{"version":3,"file":"sosAudiences.js","names":[],"sources":["../../.generated/lib/sosAudiences.ts"],"sourcesContent":["export const SOS_AUDIENCES = [\"internal\", \"emergencyContacts\"] as const;\n\nexport type SOSAudience = (typeof SOS_AUDIENCES)[number];\n"],"mappings":";AAAA,MAAa,gBAAgB,CAAC,YAAY,mBAAmB"}
+{"version":3,"file":"sosAudiences.js","names":[],"sources":["../../.generated/lib/sosAudiences.ts"],"sourcesContent":["export const SOS_AUDIENCES = [\"internal\", \"external\"] as const;\n\nexport type SOSAudience = (typeof SOS_AUDIENCES)[number];\n"],"mappings":";AAAA,MAAa,gBAAgB,CAAC,YAAY,UAAU"}

package/dist/models/announcement.js

@@ -8,13 +8,17 @@ var Announcement = class extends Entity {
 		this.id = data.id;
 		if (data.propertyId !== void 0) this.propertyId = data.propertyId;
 		this.type = data.type;
+		if (data.status !== void 0) this.status = data.status;
+		if (data.name !== void 0) this.name = data.name;
+		if (data.presetId !== void 0) this.presetId = data.presetId;
 		if (data.audience !== void 0) this.audience = data.audience;
 		if (data.channels !== void 0) this.channels = data.channels;
 		if (data.subject !== void 0) this.subject = data.subject;
 		if (data.surfaces !== void 0) this.surfaces = data.surfaces;
-		this.body = data.body;
+		if (data.body !== void 0) this.body = data.body;
 		if (data.media !== void 0) this.media = data.media;
 		if (data.sentBy !== void 0) this.sentBy = data.sentBy;
+		if (data.result !== void 0) this.result = data.result;
 		if (data.tags !== void 0) this.tags = data.tags;
 		if (data.createdAt !== void 0) this.createdAt = data.createdAt;
 		if (data.updatedAt !== void 0) this.updatedAt = data.updatedAt;

package/dist/models/announcement.js.map

@@ -1 +1 @@
-{"version":3,"file":"announcement.js","names":["validate"],"sources":["../../.generated/models/announcement.ts"],"sourcesContent":["/* This file is automatically generated. Do not modify it manually. */\n\nimport { Entity } from \"./entity.js\";\nimport { validateAnnouncement as validate } from \"../validate.js\";\nimport { announcementSchema, type AnnouncementSchema } from \"../schemas/announcement.js\";\n\n/**\n * Data type for Announcement constructor - exported for backwards compatibility\n */\nexport type AnnouncementData = AnnouncementSchema;\n\n/**\n * Announcement message sent to users\n */\nexport interface Announcement extends AnnouncementSchema {}\nexport class Announcement extends Entity {\n  declare schema: typeof announcementSchema;\n  declare validator: typeof validate;\n\n  constructor(data: AnnouncementSchema) {\n    super(data);\n    this.id = data.id;\n    if (data.propertyId !== undefined) this.propertyId = data.propertyId;\n    this.type = data.type;\n    if (data.audience !== undefined) this.audience = data.audience;\n    if (data.channels !== undefined) this.channels = data.channels;\n    if (data.subject !== undefined) this.subject = data.subject;\n    if (data.surfaces !== undefined) this.surfaces = data.surfaces;\n    this.body = data.body;\n    if (data.media !== undefined) this.media = data.media;\n    if (data.sentBy !== undefined) this.sentBy = data.sentBy;\n    if (data.tags !== undefined) this.tags = data.tags;\n    if (data.createdAt !== undefined) this.createdAt = data.createdAt;\n    if (data.updatedAt !== undefined) this.updatedAt = data.updatedAt;\n    if (data.deletedAt !== undefined) this.deletedAt = data.deletedAt;\n  }\n\n\n\n\n\n\n\n\n}\n\nObject.defineProperty(Announcement.prototype, \"schema\", {\n  value: announcementSchema\n});\n\nObject.defineProperty(Announcement.prototype, \"validator\", {\n  get: function() { return validate; }\n});\n"],"mappings":";;;;AAeA,IAAa,eAAb,cAAkC,OAAO;CAIvC,YAAY,MAA0B;EACpC,MAAM,IAAI;EACV,KAAK,KAAK,KAAK;EACf,IAAI,KAAK,eAAe,KAAA,GAAW,KAAK,aAAa,KAAK;EAC1D,KAAK,OAAO,KAAK;EACjB,IAAI,KAAK,aAAa,KAAA,GAAW,KAAK,WAAW,KAAK;EACtD,IAAI,KAAK,aAAa,KAAA,GAAW,KAAK,WAAW,KAAK;EACtD,IAAI,KAAK,YAAY,KAAA,GAAW,KAAK,UAAU,KAAK;EACpD,IAAI,KAAK,aAAa,KAAA,GAAW,KAAK,WAAW,KAAK;EACtD,KAAK,OAAO,KAAK;EACjB,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,WAAW,KAAA,GAAW,KAAK,SAAS,KAAK;EAClD,IAAI,KAAK,SAAS,KAAA,GAAW,KAAK,OAAO,KAAK;EAC9C,IAAI,KAAK,cAAc,KAAA,GAAW,KAAK,YAAY,KAAK;EACxD,IAAI,KAAK,cAAc,KAAA,GAAW,KAAK,YAAY,KAAK;EACxD,IAAI,KAAK,cAAc,KAAA,GAAW,KAAK,YAAY,KAAK;CAC1D;AASF;AAEA,OAAO,eAAe,aAAa,WAAW,UAAU,EACtD,OAAO,mBACT,CAAC;AAED,OAAO,eAAe,aAAa,WAAW,aAAa,EACzD,KAAK,WAAW;CAAE,OAAOA;AAAU,EACrC,CAAC"}
+{"version":3,"file":"announcement.js","names":["validate"],"sources":["../../.generated/models/announcement.ts"],"sourcesContent":["/* This file is automatically generated. Do not modify it manually. */\n\nimport { Entity } from \"./entity.js\";\nimport { validateAnnouncement as validate } from \"../validate.js\";\nimport { announcementSchema, type AnnouncementSchema } from \"../schemas/announcement.js\";\n\n/**\n * Data type for Announcement constructor - exported for backwards compatibility\n */\nexport type AnnouncementData = AnnouncementSchema;\n\n/**\n * Announcement message sent to users\n */\nexport interface Announcement extends AnnouncementSchema {}\nexport class Announcement extends Entity {\n  declare schema: typeof announcementSchema;\n  declare validator: typeof validate;\n\n  constructor(data: AnnouncementSchema) {\n    super(data);\n    this.id = data.id;\n    if (data.propertyId !== undefined) this.propertyId = data.propertyId;\n    this.type = data.type;\n    if (data.status !== undefined) this.status = data.status;\n    if (data.name !== undefined) this.name = data.name;\n    if (data.presetId !== undefined) this.presetId = data.presetId;\n    if (data.audience !== undefined) this.audience = data.audience;\n    if (data.channels !== undefined) this.channels = data.channels;\n    if (data.subject !== undefined) this.subject = data.subject;\n    if (data.surfaces !== undefined) this.surfaces = data.surfaces;\n    if (data.body !== undefined) this.body = data.body;\n    if (data.media !== undefined) this.media = data.media;\n    if (data.sentBy !== undefined) this.sentBy = data.sentBy;\n    if (data.result !== undefined) this.result = data.result;\n    if (data.tags !== undefined) this.tags = data.tags;\n    if (data.createdAt !== undefined) this.createdAt = data.createdAt;\n    if (data.updatedAt !== undefined) this.updatedAt = data.updatedAt;\n    if (data.deletedAt !== undefined) this.deletedAt = data.deletedAt;\n  }\n\n\n\n\n\n\n\n\n}\n\nObject.defineProperty(Announcement.prototype, \"schema\", {\n  value: announcementSchema\n});\n\nObject.defineProperty(Announcement.prototype, \"validator\", {\n  get: function() { return validate; }\n});\n"],"mappings":";;;;AAeA,IAAa,eAAb,cAAkC,OAAO;CAIvC,YAAY,MAA0B;EACpC,MAAM,IAAI;EACV,KAAK,KAAK,KAAK;EACf,IAAI,KAAK,eAAe,KAAA,GAAW,KAAK,aAAa,KAAK;EAC1D,KAAK,OAAO,KAAK;EACjB,IAAI,KAAK,WAAW,KAAA,GAAW,KAAK,SAAS,KAAK;EAClD,IAAI,KAAK,SAAS,KAAA,GAAW,KAAK,OAAO,KAAK;EAC9C,IAAI,KAAK,aAAa,KAAA,GAAW,KAAK,WAAW,KAAK;EACtD,IAAI,KAAK,aAAa,KAAA,GAAW,KAAK,WAAW,KAAK;EACtD,IAAI,KAAK,aAAa,KAAA,GAAW,KAAK,WAAW,KAAK;EACtD,IAAI,KAAK,YAAY,KAAA,GAAW,KAAK,UAAU,KAAK;EACpD,IAAI,KAAK,aAAa,KAAA,GAAW,KAAK,WAAW,KAAK;EACtD,IAAI,KAAK,SAAS,KAAA,GAAW,KAAK,OAAO,KAAK;EAC9C,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,WAAW,KAAA,GAAW,KAAK,SAAS,KAAK;EAClD,IAAI,KAAK,WAAW,KAAA,GAAW,KAAK,SAAS,KAAK;EAClD,IAAI,KAAK,SAAS,KAAA,GAAW,KAAK,OAAO,KAAK;EAC9C,IAAI,KAAK,cAAc,KAAA,GAAW,KAAK,YAAY,KAAK;EACxD,IAAI,KAAK,cAAc,KAAA,GAAW,KAAK,YAAY,KAAK;EACxD,IAAI,KAAK,cAAc,KAAA,GAAW,KAAK,YAAY,KAAK;CAC1D;AASF;AAEA,OAAO,eAAe,aAAa,WAAW,UAAU,EACtD,OAAO,mBACT,CAAC;AAED,OAAO,eAAe,aAAa,WAAW,aAAa,EACzD,KAAK,WAAW;CAAE,OAAOA;AAAU,EACrC,CAAC"}

package/dist/models/sosEvent.js

@@ -14,6 +14,8 @@ var SOSEvent = class extends Entity {
 		if (data.deactivatedAt !== void 0) this.deactivatedAt = data.deactivatedAt;
 		if (data.deactivatedBy !== void 0) this.deactivatedBy = data.deactivatedBy;
 		this.timeline = data.timeline;
+		if (data.notes !== void 0) this.notes = data.notes;
+		if (data.report !== void 0) this.report = data.report;
 		if (data.createdAt !== void 0) this.createdAt = data.createdAt;
 		if (data.updatedAt !== void 0) this.updatedAt = data.updatedAt;
 		if (data.deletedAt !== void 0) this.deletedAt = data.deletedAt;

package/dist/models/sosEvent.js.map

@@ -1 +1 @@
-{"version":3,"file":"sosEvent.js","names":["validate"],"sources":["../../.generated/models/sosEvent.ts"],"sourcesContent":["/* This file is automatically generated. Do not modify it manually. */\n\nimport { Entity } from \"./entity.js\";\nimport { validateSOSEvent as validate } from \"../validate.js\";\nimport { sosEventSchema, type SOSEventSchema } from \"../schemas/sosEvent.js\";\n\n/**\n * Data type for SOSEvent constructor - exported for backwards compatibility\n */\nexport type SOSEventData = SOSEventSchema;\n\n/**\n * A durable record of a single SOS activation on a Property, with an append-only timeline of updates. Persists as audit history after the SOS is cleared.\n */\nexport interface SOSEvent extends SOSEventSchema {}\nexport class SOSEvent extends Entity {\n  declare schema: typeof sosEventSchema;\n  declare validator: typeof validate;\n\n  constructor(data: SOSEventSchema) {\n    super(data);\n    this.id = data.id;\n    this.type = data.type;\n    if (data.propertyId !== undefined) this.propertyId = data.propertyId;\n    this.sosTypeIds = data.sosTypeIds;\n    this.activatedAt = data.activatedAt;\n    if (data.activatedBy !== undefined) this.activatedBy = data.activatedBy;\n    if (data.deactivatedAt !== undefined) this.deactivatedAt = data.deactivatedAt;\n    if (data.deactivatedBy !== undefined) this.deactivatedBy = data.deactivatedBy;\n    this.timeline = data.timeline;\n    if (data.createdAt !== undefined) this.createdAt = data.createdAt;\n    if (data.updatedAt !== undefined) this.updatedAt = data.updatedAt;\n    if (data.deletedAt !== undefined) this.deletedAt = data.deletedAt;\n  }\n\n\n\n\n\n\n\n\n}\n\nObject.defineProperty(SOSEvent.prototype, \"schema\", {\n  value: sosEventSchema\n});\n\nObject.defineProperty(SOSEvent.prototype, \"validator\", {\n  get: function() { return validate; }\n});\n"],"mappings":";;;;AAeA,IAAa,WAAb,cAA8B,OAAO;CAInC,YAAY,MAAsB;EAChC,MAAM,IAAI;EACV,KAAK,KAAK,KAAK;EACf,KAAK,OAAO,KAAK;EACjB,IAAI,KAAK,eAAe,KAAA,GAAW,KAAK,aAAa,KAAK;EAC1D,KAAK,aAAa,KAAK;EACvB,KAAK,cAAc,KAAK;EACxB,IAAI,KAAK,gBAAgB,KAAA,GAAW,KAAK,cAAc,KAAK;EAC5D,IAAI,KAAK,kBAAkB,KAAA,GAAW,KAAK,gBAAgB,KAAK;EAChE,IAAI,KAAK,kBAAkB,KAAA,GAAW,KAAK,gBAAgB,KAAK;EAChE,KAAK,WAAW,KAAK;EACrB,IAAI,KAAK,cAAc,KAAA,GAAW,KAAK,YAAY,KAAK;EACxD,IAAI,KAAK,cAAc,KAAA,GAAW,KAAK,YAAY,KAAK;EACxD,IAAI,KAAK,cAAc,KAAA,GAAW,KAAK,YAAY,KAAK;CAC1D;AASF;AAEA,OAAO,eAAe,SAAS,WAAW,UAAU,EAClD,OAAO,eACT,CAAC;AAED,OAAO,eAAe,SAAS,WAAW,aAAa,EACrD,KAAK,WAAW;CAAE,OAAOA;AAAU,EACrC,CAAC"}
+{"version":3,"file":"sosEvent.js","names":["validate"],"sources":["../../.generated/models/sosEvent.ts"],"sourcesContent":["/* This file is automatically generated. Do not modify it manually. */\n\nimport { Entity } from \"./entity.js\";\nimport { validateSOSEvent as validate } from \"../validate.js\";\nimport { sosEventSchema, type SOSEventSchema } from \"../schemas/sosEvent.js\";\n\n/**\n * Data type for SOSEvent constructor - exported for backwards compatibility\n */\nexport type SOSEventData = SOSEventSchema;\n\n/**\n * A durable record of a single SOS activation on a Property, with an append-only timeline of updates. Persists as audit history after the SOS is cleared.\n */\nexport interface SOSEvent extends SOSEventSchema {}\nexport class SOSEvent extends Entity {\n  declare schema: typeof sosEventSchema;\n  declare validator: typeof validate;\n\n  constructor(data: SOSEventSchema) {\n    super(data);\n    this.id = data.id;\n    this.type = data.type;\n    if (data.propertyId !== undefined) this.propertyId = data.propertyId;\n    this.sosTypeIds = data.sosTypeIds;\n    this.activatedAt = data.activatedAt;\n    if (data.activatedBy !== undefined) this.activatedBy = data.activatedBy;\n    if (data.deactivatedAt !== undefined) this.deactivatedAt = data.deactivatedAt;\n    if (data.deactivatedBy !== undefined) this.deactivatedBy = data.deactivatedBy;\n    this.timeline = data.timeline;\n    if (data.notes !== undefined) this.notes = data.notes;\n    if (data.report !== undefined) this.report = data.report;\n    if (data.createdAt !== undefined) this.createdAt = data.createdAt;\n    if (data.updatedAt !== undefined) this.updatedAt = data.updatedAt;\n    if (data.deletedAt !== undefined) this.deletedAt = data.deletedAt;\n  }\n\n\n\n\n\n\n\n\n}\n\nObject.defineProperty(SOSEvent.prototype, \"schema\", {\n  value: sosEventSchema\n});\n\nObject.defineProperty(SOSEvent.prototype, \"validator\", {\n  get: function() { return validate; }\n});\n"],"mappings":";;;;AAeA,IAAa,WAAb,cAA8B,OAAO;CAInC,YAAY,MAAsB;EAChC,MAAM,IAAI;EACV,KAAK,KAAK,KAAK;EACf,KAAK,OAAO,KAAK;EACjB,IAAI,KAAK,eAAe,KAAA,GAAW,KAAK,aAAa,KAAK;EAC1D,KAAK,aAAa,KAAK;EACvB,KAAK,cAAc,KAAK;EACxB,IAAI,KAAK,gBAAgB,KAAA,GAAW,KAAK,cAAc,KAAK;EAC5D,IAAI,KAAK,kBAAkB,KAAA,GAAW,KAAK,gBAAgB,KAAK;EAChE,IAAI,KAAK,kBAAkB,KAAA,GAAW,KAAK,gBAAgB,KAAK;EAChE,KAAK,WAAW,KAAK;EACrB,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,WAAW,KAAA,GAAW,KAAK,SAAS,KAAK;EAClD,IAAI,KAAK,cAAc,KAAA,GAAW,KAAK,YAAY,KAAK;EACxD,IAAI,KAAK,cAAc,KAAA,GAAW,KAAK,YAAY,KAAK;EACxD,IAAI,KAAK,cAAc,KAAA,GAAW,KAAK,YAAY,KAAK;CAC1D;AASF;AAEA,OAAO,eAAe,SAAS,WAAW,UAAU,EAClD,OAAO,eACT,CAAC;AAED,OAAO,eAAe,SAAS,WAAW,aAAa,EACrD,KAAK,WAAW;CAAE,OAAOA;AAAU,EACrC,CAAC"}

package/dist/schemas/announcement.d.ts

@@ -6,7 +6,7 @@ export declare const announcementSchema: {
     readonly title: "Announcement";
     readonly description: "Announcement message sent to users";
     readonly type: "object";
-    readonly required: readonly ["id", "type", "body"];
+    readonly required: readonly ["id", "type"];
     readonly properties: {
         readonly id: {
             readonly $ref: "definitions.json#/definitions/id";
@@ -20,6 +20,20 @@ export declare const announcementSchema: {
             readonly enum: readonly ["announcement"];
             readonly default: "announcement";
         };
+        readonly status: {
+            readonly type: "string";
+            readonly description: "`sent` is a real broadcast; `preset` is a named, reusable configuration a sender loads into the composer. Absent on records written before presets existed — read as `sent`.";
+            readonly enum: readonly ["sent", "preset"];
+            readonly default: "sent";
+        };
+        readonly name: {
+            readonly type: "string";
+            readonly description: "Display name of a preset. Sent announcements have none.";
+        };
+        readonly presetId: {
+            readonly type: "string";
+            readonly description: "The preset this sent announcement was loaded from, when it was.";
+        };
         readonly audience: {
             readonly $ref: "definitions.json#/definitions/audience";
             readonly description: "Who this announcement was directed at on the people axis. PA surfaces are the other axis and never reach the emergency-contact roster.";
@@ -38,16 +52,16 @@ export declare const announcementSchema: {
         };
         readonly surfaces: {
             readonly type: "array";
-            readonly description: "Surface channels the announcement was broadcast to, as the sender selected them. `category` is open for future surface kinds; only `pa` ships today.";
+            readonly description: "Surface channels the announcement was broadcast to, as the sender selected them. `discriminator` is the mediaSource `Device.discriminator` targeted, open for future surface types; only `paSystem` ships today.";
             readonly items: {
                 readonly type: "object";
-                readonly required: readonly ["category", "kind"];
+                readonly required: readonly ["discriminator", "scope"];
                 readonly properties: {
-                    readonly category: {
+                    readonly discriminator: {
                         readonly type: "string";
-                        readonly enum: readonly ["pa"];
+                        readonly enum: readonly ["paSystem"];
                     };
-                    readonly kind: {
+                    readonly scope: {
                         readonly type: "string";
                         readonly enum: readonly ["all", "spaces", "devices"];
                     };
@@ -70,12 +84,17 @@ export declare const announcementSchema: {
                             readonly type: "string";
                         };
                     };
+                    readonly playlistId: {
+                        readonly type: "string";
+                        readonly description: "A PA playlist (driver recording) played in place of the spoken body; its zones are the playlist's own.";
+                    };
                 };
                 readonly additionalProperties: false;
             };
         };
         readonly body: {
             readonly type: "string";
+            readonly description: "The spoken/written message. Optional only when every surface plays a preset and no channel is selected.";
         };
         readonly media: {
             readonly $ref: "mediaFile.json";
@@ -83,6 +102,103 @@ export declare const announcementSchema: {
         readonly sentBy: {
             readonly type: "string";
         };
+        readonly result: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["recipientsResolved", "perChannel", "skipped", "surfaces"];
+            readonly description: "What the send actually achieved, written once at send time and never recomputed. Absent on presets and on sends recorded before this was stored. The `audience.delivery` counts are the same send viewed per audience; this is the per-channel and per-device detail behind them.";
+            readonly properties: {
+                readonly recipientsResolved: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "How many internal Users the audience selector resolved to. Zero when no personal channel was selected, however wide the selector — an announcement with no channel reaches no User.";
+                };
+                readonly external: {
+                    readonly type: "object";
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["recipients", "delivery"];
+                    readonly description: "The external SIS roster this send reached. Absent when no external group was named.";
+                    readonly properties: {
+                        readonly recipients: {
+                            readonly type: "integer";
+                            readonly minimum: 0;
+                            readonly description: "Size of the roster the named groups resolved to.";
+                        };
+                        readonly delivery: {
+                            readonly type: "object";
+                            readonly additionalProperties: false;
+                            readonly description: "Per-channel counts, present only for the channels attempted.";
+                            readonly properties: {
+                                readonly sms: {
+                                    readonly $ref: "definitions.json#/definitions/deliveryCounts";
+                                };
+                                readonly email: {
+                                    readonly $ref: "definitions.json#/definitions/deliveryCounts";
+                                };
+                            };
+                        };
+                    };
+                };
+                readonly perChannel: {
+                    readonly type: "object";
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["sms", "email"];
+                    readonly description: "Messages handed to each personal channel; zero for a channel the send did not select.";
+                    readonly properties: {
+                        readonly sms: {
+                            readonly type: "integer";
+                        };
+                        readonly email: {
+                            readonly type: "integer";
+                        };
+                    };
+                };
+                readonly skipped: {
+                    readonly type: "array";
+                    readonly description: "Recipients a selected channel could not carry the announcement to. A missing contact detail is a per-channel skip, not a failed send, so one recipient may appear once per channel.";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly required: readonly ["userId", "channel", "reason"];
+                        readonly additionalProperties: false;
+                        readonly properties: {
+                            readonly userId: {
+                                readonly type: "string";
+                            };
+                            readonly channel: {
+                                readonly type: "string";
+                                readonly enum: readonly ["sms", "email"];
+                            };
+                            readonly reason: {
+                                readonly type: "string";
+                                readonly enum: readonly ["no-phone", "no-email"];
+                            };
+                        };
+                    };
+                };
+                readonly surfaces: {
+                    readonly type: "array";
+                    readonly description: "Per-device outcome of the surface page, one entry per device the selectors resolved to. Distinct from the top-level `surfaces`, which is the selector the sender expressed.";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly required: readonly ["deviceId", "status"];
+                        readonly additionalProperties: false;
+                        readonly properties: {
+                            readonly deviceId: {
+                                readonly type: "string";
+                            };
+                            readonly status: {
+                                readonly type: "string";
+                                readonly enum: readonly ["sent", "failed", "skipped"];
+                            };
+                            readonly reason: {
+                                readonly type: "string";
+                                readonly description: '`unsupported` when the driver advertises no content command; absent otherwise.';
+                            };
+                        };
+                    };
+                };
+            };
+        };
         readonly tags: {
             readonly type: "array";
             readonly items: {

package/dist/schemas/announcement.js

@@ -5,11 +5,7 @@ const announcementSchema = {
 	title: "Announcement",
 	description: "Announcement message sent to users",
 	type: "object",
-	required: [
-		"id",
-		"type",
-		"body"
-	],
+	required: ["id", "type"],
 	properties: {
 		id: { $ref: "definitions.json#/definitions/id" },
 		propertyId: {
@@ -21,6 +17,20 @@ const announcementSchema = {
 			enum: ["announcement"],
 			default: "announcement"
 		},
+		status: {
+			type: "string",
+			description: "`sent` is a real broadcast; `preset` is a named, reusable configuration a sender loads into the composer. Absent on records written before presets existed — read as `sent`.",
+			enum: ["sent", "preset"],
+			default: "sent"
+		},
+		name: {
+			type: "string",
+			description: "Display name of a preset. Sent announcements have none."
+		},
+		presetId: {
+			type: "string",
+			description: "The preset this sent announcement was loaded from, when it was."
+		},
 		audience: {
 			$ref: "definitions.json#/definitions/audience",
 			description: "Who this announcement was directed at on the people axis. PA surfaces are the other axis and never reach the emergency-contact roster."
@@ -39,16 +49,16 @@ const announcementSchema = {
 		},
 		surfaces: {
 			type: "array",
-			description: "Surface channels the announcement was broadcast to, as the sender selected them. `category` is open for future surface kinds; only `pa` ships today.",
+			description: "Surface channels the announcement was broadcast to, as the sender selected them. `discriminator` is the mediaSource `Device.discriminator` targeted, open for future surface types; only `paSystem` ships today.",
 			items: {
 				type: "object",
-				required: ["category", "kind"],
+				required: ["discriminator", "scope"],
 				properties: {
-					category: {
+					discriminator: {
 						type: "string",
-						enum: ["pa"]
+						enum: ["paSystem"]
 					},
-					kind: {
+					scope: {
 						type: "string",
 						enum: [
 							"all",
@@ -68,14 +78,119 @@ const announcementSchema = {
 						type: "array",
 						description: "PA output zones to page; all zones when omitted.",
 						items: { type: "string" }
+					},
+					playlistId: {
+						type: "string",
+						description: "A PA playlist (driver recording) played in place of the spoken body; its zones are the playlist's own."
 					}
 				},
 				additionalProperties: false
 			}
 		},
-		body: { type: "string" },
+		body: {
+			type: "string",
+			description: "The spoken/written message. Optional only when every surface plays a preset and no channel is selected."
+		},
 		media: { $ref: "mediaFile.json" },
 		sentBy: { type: "string" },
+		result: {
+			type: "object",
+			additionalProperties: false,
+			required: [
+				"recipientsResolved",
+				"perChannel",
+				"skipped",
+				"surfaces"
+			],
+			description: "What the send actually achieved, written once at send time and never recomputed. Absent on presets and on sends recorded before this was stored. The `audience.delivery` counts are the same send viewed per audience; this is the per-channel and per-device detail behind them.",
+			properties: {
+				recipientsResolved: {
+					type: "integer",
+					minimum: 0,
+					description: "How many internal Users the audience selector resolved to. Zero when no personal channel was selected, however wide the selector — an announcement with no channel reaches no User."
+				},
+				external: {
+					type: "object",
+					additionalProperties: false,
+					required: ["recipients", "delivery"],
+					description: "The external SIS roster this send reached. Absent when no external group was named.",
+					properties: {
+						recipients: {
+							type: "integer",
+							minimum: 0,
+							description: "Size of the roster the named groups resolved to."
+						},
+						delivery: {
+							type: "object",
+							additionalProperties: false,
+							description: "Per-channel counts, present only for the channels attempted.",
+							properties: {
+								sms: { $ref: "definitions.json#/definitions/deliveryCounts" },
+								email: { $ref: "definitions.json#/definitions/deliveryCounts" }
+							}
+						}
+					}
+				},
+				perChannel: {
+					type: "object",
+					additionalProperties: false,
+					required: ["sms", "email"],
+					description: "Messages handed to each personal channel; zero for a channel the send did not select.",
+					properties: {
+						sms: { type: "integer" },
+						email: { type: "integer" }
+					}
+				},
+				skipped: {
+					type: "array",
+					description: "Recipients a selected channel could not carry the announcement to. A missing contact detail is a per-channel skip, not a failed send, so one recipient may appear once per channel.",
+					items: {
+						type: "object",
+						required: [
+							"userId",
+							"channel",
+							"reason"
+						],
+						additionalProperties: false,
+						properties: {
+							userId: { type: "string" },
+							channel: {
+								type: "string",
+								enum: ["sms", "email"]
+							},
+							reason: {
+								type: "string",
+								enum: ["no-phone", "no-email"]
+							}
+						}
+					}
+				},
+				surfaces: {
+					type: "array",
+					description: "Per-device outcome of the surface page, one entry per device the selectors resolved to. Distinct from the top-level `surfaces`, which is the selector the sender expressed.",
+					items: {
+						type: "object",
+						required: ["deviceId", "status"],
+						additionalProperties: false,
+						properties: {
+							deviceId: { type: "string" },
+							status: {
+								type: "string",
+								enum: [
+									"sent",
+									"failed",
+									"skipped"
+								]
+							},
+							reason: {
+								type: "string",
+								description: "`unsupported` when the driver advertises no content command; absent otherwise."
+							}
+						}
+					}
+				}
+			}
+		},
 		tags: {
 			type: "array",
 			items: { type: "string" }

package/dist/schemas/announcement.js.map

@@ -1 +1 @@
-{"version":3,"file":"announcement.js","names":[],"sources":["../../.generated/schemas/announcement.ts"],"sourcesContent":["import defs, { ISODateString } from \"./definitions\";\nimport type { FromSchema } from \"json-schema-to-ts\";\n\nexport const announcementSchema = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"announcement.json\",\n  title: \"Announcement\",\n  description: \"Announcement message sent to users\",\n  type: \"object\",\n  required: [\"id\", \"type\", \"body\"],\n  properties: {\n    id: { $ref: \"definitions.json#/definitions/id\" },\n    propertyId: {\n      type: \"string\",\n      description:\n        \"ID of the property this entity belongs to. Optional — used as a per-document filter inside the org-scoped database.\",\n    },\n    type: {\n      type: \"string\",\n      enum: [\"announcement\"],\n      default: \"announcement\",\n    },\n    audience: {\n      $ref: \"definitions.json#/definitions/audience\",\n      description:\n        \"Who this announcement was directed at on the people axis. PA surfaces are the other axis and never reach the emergency-contact roster.\",\n    },\n    channels: {\n      type: \"array\",\n      description: \"Personal channels this announcement was sent over.\",\n      items: {\n        type: \"string\",\n        enum: [\"sms\", \"email\"],\n      },\n    },\n    subject: {\n      type: \"string\",\n      description: \"Email subject, and the title shown on a surface.\",\n    },\n    surfaces: {\n      type: \"array\",\n      description:\n        \"Surface channels the announcement was broadcast to, as the sender selected them. `category` is open for future surface kinds; only `pa` ships today.\",\n      items: {\n        type: \"object\",\n        required: [\"category\", \"kind\"],\n        properties: {\n          category: {\n            type: \"string\",\n            enum: [\"pa\"],\n          },\n          kind: {\n            type: \"string\",\n            enum: [\"all\", \"spaces\", \"devices\"],\n          },\n          spaceIds: {\n            type: \"array\",\n            items: { type: \"string\" },\n          },\n          deviceIds: {\n            type: \"array\",\n            items: { type: \"string\" },\n          },\n          outputs: {\n            type: \"array\",\n            description: \"PA output zones to page; all zones when omitted.\",\n            items: { type: \"string\" },\n          },\n        },\n        additionalProperties: false,\n      },\n    },\n    body: {\n      type: \"string\",\n    },\n    media: {\n      $ref: \"mediaFile.json\",\n    },\n    sentBy: {\n      type: \"string\",\n    },\n    tags: {\n      type: \"array\",\n      items: {\n        type: \"string\",\n      },\n    },\n    createdAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n    updatedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n    deletedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n  },\n  additionalProperties: false,\n} as const;\n\nexport type AnnouncementSchema = FromSchema<\n  typeof announcementSchema,\n  {\n    references: [typeof defs];\n    deserialize: [\n      {\n        pattern: {\n          format: \"date-time\";\n        };\n        output: Date | ISODateString;\n      },\n    ];\n  }\n>;\n"],"mappings":";AAGA,MAAa,qBAAqB;CAChC,SAAS;CACT,KAAK;CACL,OAAO;CACP,aAAa;CACb,MAAM;CACN,UAAU;EAAC;EAAM;EAAQ;CAAM;CAC/B,YAAY;EACV,IAAI,EAAE,MAAM,mCAAmC;EAC/C,YAAY;GACV,MAAM;GACN,aACE;EACJ;EACA,MAAM;GACJ,MAAM;GACN,MAAM,CAAC,cAAc;GACrB,SAAS;EACX;EACA,UAAU;GACR,MAAM;GACN,aACE;EACJ;EACA,UAAU;GACR,MAAM;GACN,aAAa;GACb,OAAO;IACL,MAAM;IACN,MAAM,CAAC,OAAO,OAAO;GACvB;EACF;EACA,SAAS;GACP,MAAM;GACN,aAAa;EACf;EACA,UAAU;GACR,MAAM;GACN,aACE;GACF,OAAO;IACL,MAAM;IACN,UAAU,CAAC,YAAY,MAAM;IAC7B,YAAY;KACV,UAAU;MACR,MAAM;MACN,MAAM,CAAC,IAAI;KACb;KACA,MAAM;MACJ,MAAM;MACN,MAAM;OAAC;OAAO;OAAU;MAAS;KACnC;KACA,UAAU;MACR,MAAM;MACN,OAAO,EAAE,MAAM,SAAS;KAC1B;KACA,WAAW;MACT,MAAM;MACN,OAAO,EAAE,MAAM,SAAS;KAC1B;KACA,SAAS;MACP,MAAM;MACN,aAAa;MACb,OAAO,EAAE,MAAM,SAAS;KAC1B;IACF;IACA,sBAAsB;GACxB;EACF;EACA,MAAM,EACJ,MAAM,SACR;EACA,OAAO,EACL,MAAM,iBACR;EACA,QAAQ,EACN,MAAM,SACR;EACA,MAAM;GACJ,MAAM;GACN,OAAO,EACL,MAAM,SACR;EACF;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;CACF;CACA,sBAAsB;AACxB"}
+{"version":3,"file":"announcement.js","names":[],"sources":["../../.generated/schemas/announcement.ts"],"sourcesContent":["import defs, { ISODateString } from \"./definitions\";\nimport type { FromSchema } from \"json-schema-to-ts\";\n\nexport const announcementSchema = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"announcement.json\",\n  title: \"Announcement\",\n  description: \"Announcement message sent to users\",\n  type: \"object\",\n  required: [\"id\", \"type\"],\n  properties: {\n    id: { $ref: \"definitions.json#/definitions/id\" },\n    propertyId: {\n      type: \"string\",\n      description:\n        \"ID of the property this entity belongs to. Optional — used as a per-document filter inside the org-scoped database.\",\n    },\n    type: {\n      type: \"string\",\n      enum: [\"announcement\"],\n      default: \"announcement\",\n    },\n    status: {\n      type: \"string\",\n      description:\n        \"`sent` is a real broadcast; `preset` is a named, reusable configuration a sender loads into the composer. Absent on records written before presets existed — read as `sent`.\",\n      enum: [\"sent\", \"preset\"],\n      default: \"sent\",\n    },\n    name: {\n      type: \"string\",\n      description: \"Display name of a preset. Sent announcements have none.\",\n    },\n    presetId: {\n      type: \"string\",\n      description:\n        \"The preset this sent announcement was loaded from, when it was.\",\n    },\n    audience: {\n      $ref: \"definitions.json#/definitions/audience\",\n      description:\n        \"Who this announcement was directed at on the people axis. PA surfaces are the other axis and never reach the emergency-contact roster.\",\n    },\n    channels: {\n      type: \"array\",\n      description: \"Personal channels this announcement was sent over.\",\n      items: {\n        type: \"string\",\n        enum: [\"sms\", \"email\"],\n      },\n    },\n    subject: {\n      type: \"string\",\n      description: \"Email subject, and the title shown on a surface.\",\n    },\n    surfaces: {\n      type: \"array\",\n      description:\n        \"Surface channels the announcement was broadcast to, as the sender selected them. `discriminator` is the mediaSource `Device.discriminator` targeted, open for future surface types; only `paSystem` ships today.\",\n      items: {\n        type: \"object\",\n        required: [\"discriminator\", \"scope\"],\n        properties: {\n          discriminator: {\n            type: \"string\",\n            enum: [\"paSystem\"],\n          },\n          scope: {\n            type: \"string\",\n            enum: [\"all\", \"spaces\", \"devices\"],\n          },\n          spaceIds: {\n            type: \"array\",\n            items: { type: \"string\" },\n          },\n          deviceIds: {\n            type: \"array\",\n            items: { type: \"string\" },\n          },\n          outputs: {\n            type: \"array\",\n            description: \"PA output zones to page; all zones when omitted.\",\n            items: { type: \"string\" },\n          },\n          playlistId: {\n            type: \"string\",\n            description:\n              \"A PA playlist (driver recording) played in place of the spoken body; its zones are the playlist's own.\",\n          },\n        },\n        additionalProperties: false,\n      },\n    },\n    body: {\n      type: \"string\",\n      description:\n        \"The spoken/written message. Optional only when every surface plays a preset and no channel is selected.\",\n    },\n    media: {\n      $ref: \"mediaFile.json\",\n    },\n    sentBy: {\n      type: \"string\",\n    },\n    result: {\n      type: \"object\",\n      additionalProperties: false,\n      required: [\"recipientsResolved\", \"perChannel\", \"skipped\", \"surfaces\"],\n      description:\n        \"What the send actually achieved, written once at send time and never recomputed. Absent on presets and on sends recorded before this was stored. The `audience.delivery` counts are the same send viewed per audience; this is the per-channel and per-device detail behind them.\",\n      properties: {\n        recipientsResolved: {\n          type: \"integer\",\n          minimum: 0,\n          description:\n            \"How many internal Users the audience selector resolved to. Zero when no personal channel was selected, however wide the selector — an announcement with no channel reaches no User.\",\n        },\n        external: {\n          type: \"object\",\n          additionalProperties: false,\n          required: [\"recipients\", \"delivery\"],\n          description:\n            \"The external SIS roster this send reached. Absent when no external group was named.\",\n          properties: {\n            recipients: {\n              type: \"integer\",\n              minimum: 0,\n              description: \"Size of the roster the named groups resolved to.\",\n            },\n            delivery: {\n              type: \"object\",\n              additionalProperties: false,\n              description:\n                \"Per-channel counts, present only for the channels attempted.\",\n              properties: {\n                sms: { $ref: \"definitions.json#/definitions/deliveryCounts\" },\n                email: { $ref: \"definitions.json#/definitions/deliveryCounts\" },\n              },\n            },\n          },\n        },\n        perChannel: {\n          type: \"object\",\n          additionalProperties: false,\n          required: [\"sms\", \"email\"],\n          description:\n            \"Messages handed to each personal channel; zero for a channel the send did not select.\",\n          properties: {\n            sms: { type: \"integer\" },\n            email: { type: \"integer\" },\n          },\n        },\n        skipped: {\n          type: \"array\",\n          description:\n            \"Recipients a selected channel could not carry the announcement to. A missing contact detail is a per-channel skip, not a failed send, so one recipient may appear once per channel.\",\n          items: {\n            type: \"object\",\n            required: [\"userId\", \"channel\", \"reason\"],\n            additionalProperties: false,\n            properties: {\n              userId: { type: \"string\" },\n              channel: { type: \"string\", enum: [\"sms\", \"email\"] },\n              reason: { type: \"string\", enum: [\"no-phone\", \"no-email\"] },\n            },\n          },\n        },\n        surfaces: {\n          type: \"array\",\n          description:\n            \"Per-device outcome of the surface page, one entry per device the selectors resolved to. Distinct from the top-level `surfaces`, which is the selector the sender expressed.\",\n          items: {\n            type: \"object\",\n            required: [\"deviceId\", \"status\"],\n            additionalProperties: false,\n            properties: {\n              deviceId: { type: \"string\" },\n              status: {\n                type: \"string\",\n                enum: [\"sent\", \"failed\", \"skipped\"],\n              },\n              reason: {\n                type: \"string\",\n                description:\n                  '`unsupported` when the driver advertises no content command; absent otherwise.',\n              },\n            },\n          },\n        },\n      },\n    },\n    tags: {\n      type: \"array\",\n      items: {\n        type: \"string\",\n      },\n    },\n    createdAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n    updatedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n    deletedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n  },\n  additionalProperties: false,\n} as const;\n\nexport type AnnouncementSchema = FromSchema<\n  typeof announcementSchema,\n  {\n    references: [typeof defs];\n    deserialize: [\n      {\n        pattern: {\n          format: \"date-time\";\n        };\n        output: Date | ISODateString;\n      },\n    ];\n  }\n>;\n"],"mappings":";AAGA,MAAa,qBAAqB;CAChC,SAAS;CACT,KAAK;CACL,OAAO;CACP,aAAa;CACb,MAAM;CACN,UAAU,CAAC,MAAM,MAAM;CACvB,YAAY;EACV,IAAI,EAAE,MAAM,mCAAmC;EAC/C,YAAY;GACV,MAAM;GACN,aACE;EACJ;EACA,MAAM;GACJ,MAAM;GACN,MAAM,CAAC,cAAc;GACrB,SAAS;EACX;EACA,QAAQ;GACN,MAAM;GACN,aACE;GACF,MAAM,CAAC,QAAQ,QAAQ;GACvB,SAAS;EACX;EACA,MAAM;GACJ,MAAM;GACN,aAAa;EACf;EACA,UAAU;GACR,MAAM;GACN,aACE;EACJ;EACA,UAAU;GACR,MAAM;GACN,aACE;EACJ;EACA,UAAU;GACR,MAAM;GACN,aAAa;GACb,OAAO;IACL,MAAM;IACN,MAAM,CAAC,OAAO,OAAO;GACvB;EACF;EACA,SAAS;GACP,MAAM;GACN,aAAa;EACf;EACA,UAAU;GACR,MAAM;GACN,aACE;GACF,OAAO;IACL,MAAM;IACN,UAAU,CAAC,iBAAiB,OAAO;IACnC,YAAY;KACV,eAAe;MACb,MAAM;MACN,MAAM,CAAC,UAAU;KACnB;KACA,OAAO;MACL,MAAM;MACN,MAAM;OAAC;OAAO;OAAU;MAAS;KACnC;KACA,UAAU;MACR,MAAM;MACN,OAAO,EAAE,MAAM,SAAS;KAC1B;KACA,WAAW;MACT,MAAM;MACN,OAAO,EAAE,MAAM,SAAS;KAC1B;KACA,SAAS;MACP,MAAM;MACN,aAAa;MACb,OAAO,EAAE,MAAM,SAAS;KAC1B;KACA,YAAY;MACV,MAAM;MACN,aACE;KACJ;IACF;IACA,sBAAsB;GACxB;EACF;EACA,MAAM;GACJ,MAAM;GACN,aACE;EACJ;EACA,OAAO,EACL,MAAM,iBACR;EACA,QAAQ,EACN,MAAM,SACR;EACA,QAAQ;GACN,MAAM;GACN,sBAAsB;GACtB,UAAU;IAAC;IAAsB;IAAc;IAAW;GAAU;GACpE,aACE;GACF,YAAY;IACV,oBAAoB;KAClB,MAAM;KACN,SAAS;KACT,aACE;IACJ;IACA,UAAU;KACR,MAAM;KACN,sBAAsB;KACtB,UAAU,CAAC,cAAc,UAAU;KACnC,aACE;KACF,YAAY;MACV,YAAY;OACV,MAAM;OACN,SAAS;OACT,aAAa;MACf;MACA,UAAU;OACR,MAAM;OACN,sBAAsB;OACtB,aACE;OACF,YAAY;QACV,KAAK,EAAE,MAAM,+CAA+C;QAC5D,OAAO,EAAE,MAAM,+CAA+C;OAChE;MACF;KACF;IACF;IACA,YAAY;KACV,MAAM;KACN,sBAAsB;KACtB,UAAU,CAAC,OAAO,OAAO;KACzB,aACE;KACF,YAAY;MACV,KAAK,EAAE,MAAM,UAAU;MACvB,OAAO,EAAE,MAAM,UAAU;KAC3B;IACF;IACA,SAAS;KACP,MAAM;KACN,aACE;KACF,OAAO;MACL,MAAM;MACN,UAAU;OAAC;OAAU;OAAW;MAAQ;MACxC,sBAAsB;MACtB,YAAY;OACV,QAAQ,EAAE,MAAM,SAAS;OACzB,SAAS;QAAE,MAAM;QAAU,MAAM,CAAC,OAAO,OAAO;OAAE;OAClD,QAAQ;QAAE,MAAM;QAAU,MAAM,CAAC,YAAY,UAAU;OAAE;MAC3D;KACF;IACF;IACA,UAAU;KACR,MAAM;KACN,aACE;KACF,OAAO;MACL,MAAM;MACN,UAAU,CAAC,YAAY,QAAQ;MAC/B,sBAAsB;MACtB,YAAY;OACV,UAAU,EAAE,MAAM,SAAS;OAC3B,QAAQ;QACN,MAAM;QACN,MAAM;SAAC;SAAQ;SAAU;QAAS;OACpC;OACA,QAAQ;QACN,MAAM;QACN,aACE;OACJ;MACF;KACF;IACF;GACF;EACF;EACA,MAAM;GACJ,MAAM;GACN,OAAO,EACL,MAAM,SACR;EACF;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;CACF;CACA,sBAAsB;AACxB"}

package/dist/schemas/definitions.d.ts

@@ -8,6 +8,14 @@ export type NotificationChannel = (typeof NOTIFICATION_CHANNELS)[number];
  */
 export declare const PLATFORM_ROLE_NAMES: readonly ["SuperAdmin", "Administrator", "Manager", "Agent", "User"];
 export type PlatformRoleName = (typeof PLATFORM_ROLE_NAMES)[number];
+/**
+ * The people outside the platform a broadcast may name, sourced from the SIS
+ * roster. `students` is every system user the SIS marks as a Student;
+ * `parents` is everybody else on the roster — every emergency-contact
+ * relationship the source system carries, whatever it calls it.
+ */
+export declare const EXTERNAL_AUDIENCE_GROUPS: readonly ["students", "parents"];
+export type ExternalAudienceGroup = (typeof EXTERNAL_AUDIENCE_GROUPS)[number];
 declare const defs: {
     readonly $schema: "http://json-schema.org/draft-07/schema";
     readonly $id: "definitions.json";
@@ -234,9 +242,18 @@ declare const defs: {
                         };
                     };
                 };
+                readonly external: {
+                    readonly type: "array";
+                    readonly uniqueItems: true;
+                    readonly description: "Which groups of the external SIS roster were included. Human-triggered sends only; an Automation can never set it.";
+                    readonly items: {
+                        readonly type: "string";
+                        readonly enum: readonly ["students", "parents"];
+                    };
+                };
                 readonly emergencyContacts: {
                     readonly type: "boolean";
-                    readonly description: "Whether the external SIS emergency-contact roster was included. Human-triggered sends only; an Automation can never set it.";
+                    readonly description: 'Deprecated: superseded by `external`. A stored `true` reads as `external: ["parents"]`.';
                 };
                 readonly users: {
                     readonly type: "array";
@@ -269,10 +286,75 @@ declare const defs: {
                                 };
                             };
                         };
+                        readonly external: {
+                            readonly type: "object";
+                            readonly additionalProperties: false;
+                            readonly required: readonly ["recipients", "sent", "failed"];
+                            readonly properties: {
+                                readonly recipients: {
+                                    readonly type: "integer";
+                                    readonly minimum: 0;
+                                };
+                                readonly sent: {
+                                    readonly type: "integer";
+                                    readonly minimum: 0;
+                                };
+                                readonly failed: {
+                                    readonly type: "integer";
+                                    readonly minimum: 0;
+                                };
+                                readonly byChannel: {
+                                    readonly type: "object";
+                                    readonly additionalProperties: false;
+                                    readonly description: "Per-channel counts, present only for the channels attempted.";
+                                    readonly properties: {
+                                        readonly sms: {
+                                            readonly type: "object";
+                                            readonly additionalProperties: false;
+                                            readonly required: readonly ["recipients", "sent", "failed"];
+                                            readonly properties: {
+                                                readonly recipients: {
+                                                    readonly type: "integer";
+                                                    readonly minimum: 0;
+                                                };
+                                                readonly sent: {
+                                                    readonly type: "integer";
+                                                    readonly minimum: 0;
+                                                };
+                                                readonly failed: {
+                                                    readonly type: "integer";
+                                                    readonly minimum: 0;
+                                                };
+                                            };
+                                        };
+                                        readonly email: {
+                                            readonly type: "object";
+                                            readonly additionalProperties: false;
+                                            readonly required: readonly ["recipients", "sent", "failed"];
+                                            readonly properties: {
+                                                readonly recipients: {
+                                                    readonly type: "integer";
+                                                    readonly minimum: 0;
+                                                };
+                                                readonly sent: {
+                                                    readonly type: "integer";
+                                                    readonly minimum: 0;
+                                                };
+                                                readonly failed: {
+                                                    readonly type: "integer";
+                                                    readonly minimum: 0;
+                                                };
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
                         readonly emergencyContacts: {
                             readonly type: "object";
                             readonly additionalProperties: false;
                             readonly required: readonly ["recipients", "sent", "failed"];
+                            readonly description: "Deprecated: superseded by `external`.";
                             readonly properties: {
                                 readonly recipients: {
                                     readonly type: "integer";