@kohost/api-client 7.8.1 → 7.9.0

package/dist/models/smsMessage.js.map

@@ -1 +1 @@
-{"version":3,"file":"smsMessage.js","names":["validate"],"sources":["../../.generated/models/smsMessage.ts"],"sourcesContent":["/* This file is automatically generated. Do not modify it manually. */\n\nimport { Entity } from \"./entity.js\";\nimport { validateSmsMessage as validate } from \"../validate.js\";\nimport { smsMessageSchema, type SmsMessageSchema } from \"../schemas/smsMessage.js\";\n\n/**\n * Data type for SmsMessage constructor - exported for backwards compatibility\n */\nexport type SmsMessageData = SmsMessageSchema;\n\n/**\n * SmsMessage\n */\nexport interface SmsMessage extends SmsMessageSchema {}\nexport class SmsMessage extends Entity {\n  declare schema: typeof smsMessageSchema;\n  declare validator: typeof validate;\n\n  constructor(data: SmsMessageSchema) {\n    super(data);\n    this.id = data.id;\n    if (data.propertyId !== undefined) this.propertyId = data.propertyId;\n    this.type = data.type;\n    this.to = data.to;\n    this.from = data.from;\n    if (data.media !== undefined) this.media = data.media;\n    this.status = data.status;\n    if (data.body !== undefined) this.body = data.body;\n    if (data.driver !== undefined) this.driver = data.driver;\n    if (data.appData !== undefined) this.appData = data.appData;\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    if (data.systemId !== undefined) this.systemId = data.systemId;\n  }\n\n\n\n\n\n\n\n\n}\n\nObject.defineProperty(SmsMessage.prototype, \"schema\", {\n  value: smsMessageSchema\n});\n\nObject.defineProperty(SmsMessage.prototype, \"validator\", {\n  get: function() { return validate; }\n});\n"],"mappings":";;;;AAeA,IAAa,aAAb,cAAgC,OAAO;CAIrC,YAAY,MAAwB;EAClC,MAAM,IAAI;EACV,KAAK,KAAK,KAAK;EACf,IAAI,KAAK,eAAe,KAAA,GAAW,KAAK,aAAa,KAAK;EAC1D,KAAK,OAAO,KAAK;EACjB,KAAK,KAAK,KAAK;EACf,KAAK,OAAO,KAAK;EACjB,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,KAAK,SAAS,KAAK;EACnB,IAAI,KAAK,SAAS,KAAA,GAAW,KAAK,OAAO,KAAK;EAC9C,IAAI,KAAK,WAAW,KAAA,GAAW,KAAK,SAAS,KAAK;EAClD,IAAI,KAAK,YAAY,KAAA,GAAW,KAAK,UAAU,KAAK;EACpD,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;EACxD,IAAI,KAAK,aAAa,KAAA,GAAW,KAAK,WAAW,KAAK;CACxD;AASF;AAEA,OAAO,eAAe,WAAW,WAAW,UAAU,EACpD,OAAO,iBACT,CAAC;AAED,OAAO,eAAe,WAAW,WAAW,aAAa,EACvD,KAAK,WAAW;CAAE,OAAOA;AAAU,EACrC,CAAC"}
+{"version":3,"file":"smsMessage.js","names":["validate"],"sources":["../../.generated/models/smsMessage.ts"],"sourcesContent":["/* This file is automatically generated. Do not modify it manually. */\n\nimport { Entity } from \"./entity.js\";\nimport { validateSmsMessage as validate } from \"../validate.js\";\nimport { smsMessageSchema, type SmsMessageSchema } from \"../schemas/smsMessage.js\";\n\n/**\n * Data type for SmsMessage constructor - exported for backwards compatibility\n */\nexport type SmsMessageData = SmsMessageSchema;\n\n/**\n * SmsMessage\n */\nexport interface SmsMessage extends SmsMessageSchema {}\nexport class SmsMessage extends Entity {\n  declare schema: typeof smsMessageSchema;\n  declare validator: typeof validate;\n\n  constructor(data: SmsMessageSchema) {\n    super(data);\n    this.id = data.id;\n    if (data.propertyId !== undefined) this.propertyId = data.propertyId;\n    this.type = data.type;\n    this.to = data.to;\n    this.from = data.from;\n    if (data.media !== undefined) this.media = data.media;\n    this.status = data.status;\n    if (data.errorCode !== undefined) this.errorCode = data.errorCode;\n    if (data.body !== undefined) this.body = data.body;\n    if (data.driver !== undefined) this.driver = data.driver;\n    if (data.appData !== undefined) this.appData = data.appData;\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    if (data.systemId !== undefined) this.systemId = data.systemId;\n  }\n\n\n\n\n\n\n\n\n}\n\nObject.defineProperty(SmsMessage.prototype, \"schema\", {\n  value: smsMessageSchema\n});\n\nObject.defineProperty(SmsMessage.prototype, \"validator\", {\n  get: function() { return validate; }\n});\n"],"mappings":";;;;AAeA,IAAa,aAAb,cAAgC,OAAO;CAIrC,YAAY,MAAwB;EAClC,MAAM,IAAI;EACV,KAAK,KAAK,KAAK;EACf,IAAI,KAAK,eAAe,KAAA,GAAW,KAAK,aAAa,KAAK;EAC1D,KAAK,OAAO,KAAK;EACjB,KAAK,KAAK,KAAK;EACf,KAAK,OAAO,KAAK;EACjB,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,KAAK,SAAS,KAAK;EACnB,IAAI,KAAK,cAAc,KAAA,GAAW,KAAK,YAAY,KAAK;EACxD,IAAI,KAAK,SAAS,KAAA,GAAW,KAAK,OAAO,KAAK;EAC9C,IAAI,KAAK,WAAW,KAAA,GAAW,KAAK,SAAS,KAAK;EAClD,IAAI,KAAK,YAAY,KAAA,GAAW,KAAK,UAAU,KAAK;EACpD,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;EACxD,IAAI,KAAK,aAAa,KAAA,GAAW,KAAK,WAAW,KAAK;CACxD;AASF;AAEA,OAAO,eAAe,WAAW,WAAW,UAAU,EACpD,OAAO,iBACT,CAAC;AAED,OAAO,eAAe,WAAW,WAAW,aAAa,EACvD,KAAK,WAAW;CAAE,OAAOA;AAAU,EACrC,CAAC"}

package/dist/models/sosEvent.d.ts

@@ -0,0 +1,17 @@
+import { Entity } from "./entity.js";
+import { validateSOSEvent as validate } from "../validate.js";
+import { sosEventSchema, type SOSEventSchema } from "../schemas/sosEvent.js";
+/**
+ * Data type for SOSEvent constructor - exported for backwards compatibility
+ */
+export type SOSEventData = SOSEventSchema;
+/**
+ * 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.
+ */
+export interface SOSEvent extends SOSEventSchema {
+}
+export declare class SOSEvent extends Entity {
+    schema: typeof sosEventSchema;
+    validator: typeof validate;
+    constructor(data: SOSEventSchema);
+}

package/dist/models/sosEvent.js

@@ -0,0 +1,29 @@
+import { Entity } from "./entity.js";
+import { sosEventSchema } from "../schemas/sosEvent.js";
+import { validateSOSEvent } from "../validate.js";
+//#region .generated/models/sosEvent.ts
+var SOSEvent = class extends Entity {
+	constructor(data) {
+		super(data);
+		this.id = data.id;
+		this.type = data.type;
+		if (data.propertyId !== void 0) this.propertyId = data.propertyId;
+		this.sosTypeIds = data.sosTypeIds;
+		this.activatedAt = data.activatedAt;
+		if (data.activatedBy !== void 0) this.activatedBy = data.activatedBy;
+		if (data.deactivatedAt !== void 0) this.deactivatedAt = data.deactivatedAt;
+		if (data.deactivatedBy !== void 0) this.deactivatedBy = data.deactivatedBy;
+		this.timeline = data.timeline;
+		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;
+	}
+};
+Object.defineProperty(SOSEvent.prototype, "schema", { value: sosEventSchema });
+Object.defineProperty(SOSEvent.prototype, "validator", { get: function() {
+	return validateSOSEvent;
+} });
+//#endregion
+export { SOSEvent };
+
+//# sourceMappingURL=sosEvent.js.map

package/dist/models/sosEvent.js.map

@@ -0,0 +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"}

package/dist/models/systemUser.js

@@ -27,6 +27,8 @@ var SystemUser = class extends Entity {
 		if (data.createdAt !== void 0) this.createdAt = data.createdAt;
 		if (data.updatedAt !== void 0) this.updatedAt = data.updatedAt;
 		if (data.systemId !== void 0) this.systemId = data.systemId;
+		if (data.propertyId !== void 0) this.propertyId = data.propertyId;
+		if (data.syncedAt !== void 0) this.syncedAt = data.syncedAt;
 	}
 };
 Object.defineProperty(SystemUser.prototype, "schema", { value: systemUserSchema });

package/dist/models/systemUser.js.map

@@ -1 +1 @@
-{"version":3,"file":"systemUser.js","names":["validate"],"sources":["../../.generated/models/systemUser.ts"],"sourcesContent":["/* This file is automatically generated. Do not modify it manually. */\n\nimport { Entity } from \"./entity.js\";\nimport { validateSystemUser as validate } from \"../validate.js\";\nimport { systemUserSchema, type SystemUserSchema } from \"../schemas/systemUser.js\";\n\n/**\n * Data type for SystemUser constructor - exported for backwards compatibility\n */\nexport type SystemUserData = SystemUserSchema;\n\n/**\n * A system user is a user that originated from an external 3rd party system.\n */\nexport interface SystemUser extends SystemUserSchema {}\nexport class SystemUser extends Entity {\n  declare schema: typeof systemUserSchema;\n  declare validator: typeof validate;\n\n  constructor(data: SystemUserSchema) {\n    super(data);\n    this.id = data.id;\n    if (data.type !== undefined) this.type = data.type;\n    if (data.driver !== undefined) this.driver = data.driver;\n    this.firstName = data.firstName;\n    this.lastName = data.lastName;\n    if (data.phone !== undefined) this.phone = data.phone;\n    if (data.email !== undefined) this.email = data.email;\n    if (data.address !== undefined) this.address = data.address;\n    if (data.photo !== undefined) this.photo = data.photo;\n    if (data.jobTitle !== undefined) this.jobTitle = data.jobTitle;\n    if (data.dob !== undefined) this.dob = data.dob;\n    if (data.gender !== undefined) this.gender = data.gender;\n    if (data.roles !== undefined) this.roles = data.roles;\n    if (data.nationality !== undefined) this.nationality = data.nationality;\n    if (data.notes !== undefined) this.notes = data.notes;\n    if (data.files !== undefined) this.files = data.files;\n    if (data.identifications !== undefined) this.identifications = data.identifications;\n    if (data.payments !== undefined) this.payments = data.payments;\n    if (data.revenue !== undefined) this.revenue = data.revenue;\n    if (data.createdAt !== undefined) this.createdAt = data.createdAt;\n    if (data.updatedAt !== undefined) this.updatedAt = data.updatedAt;\n    if (data.systemId !== undefined) this.systemId = data.systemId;\n  }\n\n\n\n\n\n\n\n\n}\n\nObject.defineProperty(SystemUser.prototype, \"schema\", {\n  value: systemUserSchema\n});\n\nObject.defineProperty(SystemUser.prototype, \"validator\", {\n  get: function() { return validate; }\n});\n"],"mappings":";;;;AAeA,IAAa,aAAb,cAAgC,OAAO;CAIrC,YAAY,MAAwB;EAClC,MAAM,IAAI;EACV,KAAK,KAAK,KAAK;EACf,IAAI,KAAK,SAAS,KAAA,GAAW,KAAK,OAAO,KAAK;EAC9C,IAAI,KAAK,WAAW,KAAA,GAAW,KAAK,SAAS,KAAK;EAClD,KAAK,YAAY,KAAK;EACtB,KAAK,WAAW,KAAK;EACrB,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,YAAY,KAAA,GAAW,KAAK,UAAU,KAAK;EACpD,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,aAAa,KAAA,GAAW,KAAK,WAAW,KAAK;EACtD,IAAI,KAAK,QAAQ,KAAA,GAAW,KAAK,MAAM,KAAK;EAC5C,IAAI,KAAK,WAAW,KAAA,GAAW,KAAK,SAAS,KAAK;EAClD,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,gBAAgB,KAAA,GAAW,KAAK,cAAc,KAAK;EAC5D,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,oBAAoB,KAAA,GAAW,KAAK,kBAAkB,KAAK;EACpE,IAAI,KAAK,aAAa,KAAA,GAAW,KAAK,WAAW,KAAK;EACtD,IAAI,KAAK,YAAY,KAAA,GAAW,KAAK,UAAU,KAAK;EACpD,IAAI,KAAK,cAAc,KAAA,GAAW,KAAK,YAAY,KAAK;EACxD,IAAI,KAAK,cAAc,KAAA,GAAW,KAAK,YAAY,KAAK;EACxD,IAAI,KAAK,aAAa,KAAA,GAAW,KAAK,WAAW,KAAK;CACxD;AASF;AAEA,OAAO,eAAe,WAAW,WAAW,UAAU,EACpD,OAAO,iBACT,CAAC;AAED,OAAO,eAAe,WAAW,WAAW,aAAa,EACvD,KAAK,WAAW;CAAE,OAAOA;AAAU,EACrC,CAAC"}
+{"version":3,"file":"systemUser.js","names":["validate"],"sources":["../../.generated/models/systemUser.ts"],"sourcesContent":["/* This file is automatically generated. Do not modify it manually. */\n\nimport { Entity } from \"./entity.js\";\nimport { validateSystemUser as validate } from \"../validate.js\";\nimport { systemUserSchema, type SystemUserSchema } from \"../schemas/systemUser.js\";\n\n/**\n * Data type for SystemUser constructor - exported for backwards compatibility\n */\nexport type SystemUserData = SystemUserSchema;\n\n/**\n * A system user is a user that originated from an external 3rd party system.\n */\nexport interface SystemUser extends SystemUserSchema {}\nexport class SystemUser extends Entity {\n  declare schema: typeof systemUserSchema;\n  declare validator: typeof validate;\n\n  constructor(data: SystemUserSchema) {\n    super(data);\n    this.id = data.id;\n    if (data.type !== undefined) this.type = data.type;\n    if (data.driver !== undefined) this.driver = data.driver;\n    this.firstName = data.firstName;\n    this.lastName = data.lastName;\n    if (data.phone !== undefined) this.phone = data.phone;\n    if (data.email !== undefined) this.email = data.email;\n    if (data.address !== undefined) this.address = data.address;\n    if (data.photo !== undefined) this.photo = data.photo;\n    if (data.jobTitle !== undefined) this.jobTitle = data.jobTitle;\n    if (data.dob !== undefined) this.dob = data.dob;\n    if (data.gender !== undefined) this.gender = data.gender;\n    if (data.roles !== undefined) this.roles = data.roles;\n    if (data.nationality !== undefined) this.nationality = data.nationality;\n    if (data.notes !== undefined) this.notes = data.notes;\n    if (data.files !== undefined) this.files = data.files;\n    if (data.identifications !== undefined) this.identifications = data.identifications;\n    if (data.payments !== undefined) this.payments = data.payments;\n    if (data.revenue !== undefined) this.revenue = data.revenue;\n    if (data.createdAt !== undefined) this.createdAt = data.createdAt;\n    if (data.updatedAt !== undefined) this.updatedAt = data.updatedAt;\n    if (data.systemId !== undefined) this.systemId = data.systemId;\n    if (data.propertyId !== undefined) this.propertyId = data.propertyId;\n    if (data.syncedAt !== undefined) this.syncedAt = data.syncedAt;\n  }\n\n\n\n\n\n\n\n\n}\n\nObject.defineProperty(SystemUser.prototype, \"schema\", {\n  value: systemUserSchema\n});\n\nObject.defineProperty(SystemUser.prototype, \"validator\", {\n  get: function() { return validate; }\n});\n"],"mappings":";;;;AAeA,IAAa,aAAb,cAAgC,OAAO;CAIrC,YAAY,MAAwB;EAClC,MAAM,IAAI;EACV,KAAK,KAAK,KAAK;EACf,IAAI,KAAK,SAAS,KAAA,GAAW,KAAK,OAAO,KAAK;EAC9C,IAAI,KAAK,WAAW,KAAA,GAAW,KAAK,SAAS,KAAK;EAClD,KAAK,YAAY,KAAK;EACtB,KAAK,WAAW,KAAK;EACrB,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,YAAY,KAAA,GAAW,KAAK,UAAU,KAAK;EACpD,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,aAAa,KAAA,GAAW,KAAK,WAAW,KAAK;EACtD,IAAI,KAAK,QAAQ,KAAA,GAAW,KAAK,MAAM,KAAK;EAC5C,IAAI,KAAK,WAAW,KAAA,GAAW,KAAK,SAAS,KAAK;EAClD,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,gBAAgB,KAAA,GAAW,KAAK,cAAc,KAAK;EAC5D,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,UAAU,KAAA,GAAW,KAAK,QAAQ,KAAK;EAChD,IAAI,KAAK,oBAAoB,KAAA,GAAW,KAAK,kBAAkB,KAAK;EACpE,IAAI,KAAK,aAAa,KAAA,GAAW,KAAK,WAAW,KAAK;EACtD,IAAI,KAAK,YAAY,KAAA,GAAW,KAAK,UAAU,KAAK;EACpD,IAAI,KAAK,cAAc,KAAA,GAAW,KAAK,YAAY,KAAK;EACxD,IAAI,KAAK,cAAc,KAAA,GAAW,KAAK,YAAY,KAAK;EACxD,IAAI,KAAK,aAAa,KAAA,GAAW,KAAK,WAAW,KAAK;EACtD,IAAI,KAAK,eAAe,KAAA,GAAW,KAAK,aAAa,KAAK;EAC1D,IAAI,KAAK,aAAa,KAAA,GAAW,KAAK,WAAW,KAAK;CACxD;AASF;AAEA,OAAO,eAAe,WAAW,WAAW,UAAU,EACpD,OAAO,iBACT,CAAC;AAED,OAAO,eAAe,WAAW,WAAW,aAAa,EACvD,KAAK,WAAW;CAAE,OAAOA;AAAU,EACrC,CAAC"}

package/dist/schemas/announcement.d.ts

@@ -20,15 +20,59 @@ export declare const announcementSchema: {
             readonly enum: readonly ["announcement"];
             readonly default: "announcement";
         };
-        readonly users: {
+        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.";
+        };
+        readonly channels: {
             readonly type: "array";
+            readonly description: "Personal channels this announcement was sent over.";
             readonly items: {
                 readonly type: "string";
+                readonly enum: readonly ["sms", "email"];
             };
-            readonly minItems: 1;
         };
-        readonly group: {
+        readonly subject: {
             readonly type: "string";
+            readonly description: "Email subject, and the title shown on a surface.";
+        };
+        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 items: {
+                readonly type: "object";
+                readonly required: readonly ["category", "kind"];
+                readonly properties: {
+                    readonly category: {
+                        readonly type: "string";
+                        readonly enum: readonly ["pa"];
+                    };
+                    readonly kind: {
+                        readonly type: "string";
+                        readonly enum: readonly ["all", "spaces", "devices"];
+                    };
+                    readonly spaceIds: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly deviceIds: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly outputs: {
+                        readonly type: "array";
+                        readonly description: "PA output zones to page; all zones when omitted.";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                    };
+                };
+                readonly additionalProperties: false;
+            };
         };
         readonly body: {
             readonly type: "string";

package/dist/schemas/announcement.js

@@ -21,12 +21,58 @@ const announcementSchema = {
 			enum: ["announcement"],
 			default: "announcement"
 		},
-		users: {
+		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."
+		},
+		channels: {
+			type: "array",
+			description: "Personal channels this announcement was sent over.",
+			items: {
+				type: "string",
+				enum: ["sms", "email"]
+			}
+		},
+		subject: {
+			type: "string",
+			description: "Email subject, and the title shown on a surface."
+		},
+		surfaces: {
 			type: "array",
-			items: { type: "string" },
-			minItems: 1
+			description: "Surface channels the announcement was broadcast to, as the sender selected them. `category` is open for future surface kinds; only `pa` ships today.",
+			items: {
+				type: "object",
+				required: ["category", "kind"],
+				properties: {
+					category: {
+						type: "string",
+						enum: ["pa"]
+					},
+					kind: {
+						type: "string",
+						enum: [
+							"all",
+							"spaces",
+							"devices"
+						]
+					},
+					spaceIds: {
+						type: "array",
+						items: { type: "string" }
+					},
+					deviceIds: {
+						type: "array",
+						items: { type: "string" }
+					},
+					outputs: {
+						type: "array",
+						description: "PA output zones to page; all zones when omitted.",
+						items: { type: "string" }
+					}
+				},
+				additionalProperties: false
+			}
 		},
-		group: { type: "string" },
 		body: { type: "string" },
 		media: { $ref: "mediaFile.json" },
 		sentBy: { 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: \"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    users: {\n      type: \"array\",\n      items: {\n        type: \"string\",\n      },\n      minItems: 1,\n    },\n    group: {\n      type: \"string\",\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,aAAa;EACf;EACA,MAAM;GACJ,MAAM;GACN,MAAM,CAAC,cAAc;GACrB,SAAS;EACX;EACA,OAAO;GACL,MAAM;GACN,OAAO,EACL,MAAM,SACR;GACA,UAAU;EACZ;EACA,OAAO,EACL,MAAM,SACR;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\", \"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"}

package/dist/schemas/category.d.ts

@@ -40,7 +40,17 @@ export declare const categorySchema: {
         };
         readonly discriminator: {
             readonly type: "string";
-            readonly enum: readonly ["space", "product", "mediaFile", "property", "user"];
+            readonly enum: readonly ["space", "product", "mediaFile", "property", "user", "resource"];
+        };
+        readonly iconKey: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly description: "Key into the app's curated icon gallery for this category's discriminator, selecting the glyph shown beside the name. Used by `resource` categories; the app falls back to a default glyph when unset or unrecognized.";
+        };
+        readonly color: {
+            readonly type: readonly ["string", "null"];
+            readonly pattern: "^#[0-9a-fA-F]{6}$";
+            readonly description: "Accent color for the category as a hex value, e.g. #3B93F0";
         };
         readonly systemId: {
             readonly $ref: "definitions.json#/definitions/systemId";

package/dist/schemas/category.js

@@ -40,9 +40,20 @@ const categorySchema = {
 				"product",
 				"mediaFile",
 				"property",
-				"user"
+				"user",
+				"resource"
 			]
 		},
+		iconKey: {
+			type: "string",
+			minLength: 1,
+			description: "Key into the app's curated icon gallery for this category's discriminator, selecting the glyph shown beside the name. Used by `resource` categories; the app falls back to a default glyph when unset or unrecognized."
+		},
+		color: {
+			type: ["string", "null"],
+			pattern: "^#[0-9a-fA-F]{6}$",
+			description: "Accent color for the category as a hex value, e.g. #3B93F0"
+		},
 		systemId: { $ref: "definitions.json#/definitions/systemId" },
 		createdAt: { $ref: "definitions.json#/definitions/date" },
 		updatedAt: { $ref: "definitions.json#/definitions/date" },

package/dist/schemas/category.js.map

@@ -1 +1 @@
-{"version":3,"file":"category.js","names":[],"sources":["../../.generated/schemas/category.ts"],"sourcesContent":["import defs, { ISODateString } from \"./definitions\";\nimport type { FromSchema } from \"json-schema-to-ts\";\n\nexport const categorySchema = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"category.json\",\n  title: \"Category\",\n  type: \"object\",\n  required: [\"id\", \"type\", \"discriminator\"],\n  properties: {\n    id: {\n      $ref: \"definitions.json#/definitions/id\",\n    },\n    propertyId: {\n      type: \"string\",\n      description: \"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: [\"category\"],\n      default: \"category\",\n    },\n    name: {\n      type: \"string\",\n      minLength: 1,\n    },\n    driver: {\n      $ref: \"definitions.json#/definitions/driver\",\n    },\n    description: {\n      type: \"string\",\n    },\n    image: {\n      $ref: \"mediaFile.json\",\n    },\n    rating: {\n      type: \"number\",\n      minimum: 0,\n      maximum: 10,\n      default: 9,\n    },\n    discriminator: {\n      type: \"string\",\n      enum: [\"space\", \"product\", \"mediaFile\", \"property\", \"user\"],\n    },\n    systemId: {\n      $ref: \"definitions.json#/definitions/systemId\",\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 CategorySchema = FromSchema<\n  typeof categorySchema,\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,iBAAiB;CAC5B,SAAS;CACT,KAAK;CACL,OAAO;CACP,MAAM;CACN,UAAU;EAAC;EAAM;EAAQ;CAAe;CACxC,YAAY;EACV,IAAI,EACF,MAAM,mCACR;EACA,YAAY;GACV,MAAM;GACN,aAAa;EACf;EACA,MAAM;GACJ,MAAM;GACN,MAAM,CAAC,UAAU;GACjB,SAAS;EACX;EACA,MAAM;GACJ,MAAM;GACN,WAAW;EACb;EACA,QAAQ,EACN,MAAM,uCACR;EACA,aAAa,EACX,MAAM,SACR;EACA,OAAO,EACL,MAAM,iBACR;EACA,QAAQ;GACN,MAAM;GACN,SAAS;GACT,SAAS;GACT,SAAS;EACX;EACA,eAAe;GACb,MAAM;GACN,MAAM;IAAC;IAAS;IAAW;IAAa;IAAY;GAAM;EAC5D;EACA,UAAU,EACR,MAAM,yCACR;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;CACF;CACA,sBAAsB;AACxB"}
+{"version":3,"file":"category.js","names":[],"sources":["../../.generated/schemas/category.ts"],"sourcesContent":["import defs, { ISODateString } from \"./definitions\";\nimport type { FromSchema } from \"json-schema-to-ts\";\n\nexport const categorySchema = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"category.json\",\n  title: \"Category\",\n  type: \"object\",\n  required: [\"id\", \"type\", \"discriminator\"],\n  properties: {\n    id: {\n      $ref: \"definitions.json#/definitions/id\",\n    },\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: [\"category\"],\n      default: \"category\",\n    },\n    name: {\n      type: \"string\",\n      minLength: 1,\n    },\n    driver: {\n      $ref: \"definitions.json#/definitions/driver\",\n    },\n    description: {\n      type: \"string\",\n    },\n    image: {\n      $ref: \"mediaFile.json\",\n    },\n    rating: {\n      type: \"number\",\n      minimum: 0,\n      maximum: 10,\n      default: 9,\n    },\n    discriminator: {\n      type: \"string\",\n      enum: [\"space\", \"product\", \"mediaFile\", \"property\", \"user\", \"resource\"],\n    },\n    iconKey: {\n      type: \"string\",\n      minLength: 1,\n      description:\n        \"Key into the app's curated icon gallery for this category's discriminator, selecting the glyph shown beside the name. Used by `resource` categories; the app falls back to a default glyph when unset or unrecognized.\",\n    },\n    color: {\n      type: [\"string\", \"null\"],\n      pattern: \"^#[0-9a-fA-F]{6}$\",\n      description:\n        \"Accent color for the category as a hex value, e.g. #3B93F0\",\n    },\n    systemId: {\n      $ref: \"definitions.json#/definitions/systemId\",\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 CategorySchema = FromSchema<\n  typeof categorySchema,\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,iBAAiB;CAC5B,SAAS;CACT,KAAK;CACL,OAAO;CACP,MAAM;CACN,UAAU;EAAC;EAAM;EAAQ;CAAe;CACxC,YAAY;EACV,IAAI,EACF,MAAM,mCACR;EACA,YAAY;GACV,MAAM;GACN,aACE;EACJ;EACA,MAAM;GACJ,MAAM;GACN,MAAM,CAAC,UAAU;GACjB,SAAS;EACX;EACA,MAAM;GACJ,MAAM;GACN,WAAW;EACb;EACA,QAAQ,EACN,MAAM,uCACR;EACA,aAAa,EACX,MAAM,SACR;EACA,OAAO,EACL,MAAM,iBACR;EACA,QAAQ;GACN,MAAM;GACN,SAAS;GACT,SAAS;GACT,SAAS;EACX;EACA,eAAe;GACb,MAAM;GACN,MAAM;IAAC;IAAS;IAAW;IAAa;IAAY;IAAQ;GAAU;EACxE;EACA,SAAS;GACP,MAAM;GACN,WAAW;GACX,aACE;EACJ;EACA,OAAO;GACL,MAAM,CAAC,UAAU,MAAM;GACvB,SAAS;GACT,aACE;EACJ;EACA,UAAU,EACR,MAAM,yCACR;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

@@ -2,6 +2,12 @@ export declare const TICKET_NOTIFICATION_EVENTS: readonly ["ticketCreated", "tic
 export type TicketNotificationEvent = (typeof TICKET_NOTIFICATION_EVENTS)[number];
 export declare const NOTIFICATION_CHANNELS: readonly ["email", "sms", "push"];
 export type NotificationChannel = (typeof NOTIFICATION_CHANNELS)[number];
+/**
+ * The platform roles an Audience may be selected by. The legacy `Guest` role a
+ * permission entry may still carry is deliberately absent: nothing targets it.
+ */
+export declare const PLATFORM_ROLE_NAMES: readonly ["SuperAdmin", "Administrator", "Manager", "Agent", "User"];
+export type PlatformRoleName = (typeof PLATFORM_ROLE_NAMES)[number];
 declare const defs: {
     readonly $schema: "http://json-schema.org/draft-07/schema";
     readonly $id: "definitions.json";
@@ -177,6 +183,160 @@ declare const defs: {
             readonly type: "string";
             readonly enum: readonly ["email", "sms", "push"];
         };
+        readonly deliveryCounts: {
+            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 audience: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly description: "Who a people-facing broadcast was directed at, as the sender expressed it, plus the snapshot it resolved to. One shape for Announcements, SOS broadcasts and Automation notifications.";
+            readonly properties: {
+                readonly to: {
+                    readonly type: "object";
+                    readonly additionalProperties: false;
+                    readonly description: 'The User selector, one kind at a time. Absent or empty selects nobody; everyone is only ever the explicit `id: ["*"]` wildcard.';
+                    readonly properties: {
+                        readonly id: {
+                            readonly type: "array";
+                            readonly description: "Named User ids, or the single wildcard `*` meaning everyone in scope.";
+                            readonly items: {
+                                readonly type: "string";
+                            };
+                        };
+                        readonly roles: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "string";
+                                readonly enum: readonly ["SuperAdmin", "Administrator", "Manager", "Agent", "User"];
+                            };
+                        };
+                        readonly departmentIds: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "string";
+                            };
+                        };
+                    };
+                };
+                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 users: {
+                    readonly type: "array";
+                    readonly description: "Snapshot of the User ids the selector resolved to at send time.";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+                readonly delivery: {
+                    readonly type: "object";
+                    readonly additionalProperties: false;
+                    readonly description: "Send-time delivery counts per audience. Absent for an audience that was not sent to.";
+                    readonly properties: {
+                        readonly internal: {
+                            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 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;
+                                                };
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
     };
 };
 export type ISODateString = ReturnType<Date["toISOString"]>;

package/dist/schemas/definitions.js

@@ -17,6 +17,40 @@ const NOTIFICATION_CHANNELS = [
 	"sms",
 	"push"
 ];
+/**
+* The platform roles an Audience may be selected by. The legacy `Guest` role a
+* permission entry may still carry is deliberately absent: nothing targets it.
+*/
+const PLATFORM_ROLE_NAMES = [
+	"SuperAdmin",
+	"Administrator",
+	"Manager",
+	"Agent",
+	"User"
+];
+const deliveryCountsNode = {
+	type: "object",
+	additionalProperties: false,
+	required: [
+		"recipients",
+		"sent",
+		"failed"
+	],
+	properties: {
+		recipients: {
+			type: "integer",
+			minimum: 0
+		},
+		sent: {
+			type: "integer",
+			minimum: 0
+		},
+		failed: {
+			type: "integer",
+			minimum: 0
+		}
+	}
+};
 const defs = {
 	$schema: "http://json-schema.org/draft-07/schema",
 	$id: "definitions.json",
@@ -301,10 +335,79 @@ const defs = {
 		notificationChannel: {
 			type: "string",
 			enum: NOTIFICATION_CHANNELS
+		},
+		deliveryCounts: deliveryCountsNode,
+		audience: {
+			type: "object",
+			additionalProperties: false,
+			description: "Who a people-facing broadcast was directed at, as the sender expressed it, plus the snapshot it resolved to. One shape for Announcements, SOS broadcasts and Automation notifications.",
+			properties: {
+				to: {
+					type: "object",
+					additionalProperties: false,
+					description: "The User selector, one kind at a time. Absent or empty selects nobody; everyone is only ever the explicit `id: [\"*\"]` wildcard.",
+					properties: {
+						id: {
+							type: "array",
+							description: "Named User ids, or the single wildcard `*` meaning everyone in scope.",
+							items: { type: "string" }
+						},
+						roles: {
+							type: "array",
+							items: {
+								type: "string",
+								enum: PLATFORM_ROLE_NAMES
+							}
+						},
+						departmentIds: {
+							type: "array",
+							items: { type: "string" }
+						}
+					}
+				},
+				emergencyContacts: {
+					type: "boolean",
+					description: "Whether the external SIS emergency-contact roster was included. Human-triggered sends only; an Automation can never set it."
+				},
+				users: {
+					type: "array",
+					description: "Snapshot of the User ids the selector resolved to at send time.",
+					items: { type: "string" }
+				},
+				delivery: {
+					type: "object",
+					additionalProperties: false,
+					description: "Send-time delivery counts per audience. Absent for an audience that was not sent to.",
+					properties: {
+						internal: deliveryCountsNode,
+						emergencyContacts: {
+							type: "object",
+							additionalProperties: false,
+							required: [
+								"recipients",
+								"sent",
+								"failed"
+							],
+							properties: {
+								...deliveryCountsNode.properties,
+								byChannel: {
+									type: "object",
+									additionalProperties: false,
+									description: "Per-channel counts, present only for the channels attempted.",
+									properties: {
+										sms: deliveryCountsNode,
+										email: deliveryCountsNode
+									}
+								}
+							}
+						}
+					}
+				}
+			}
 		}
 	}
 };
 //#endregion
-export { NOTIFICATION_CHANNELS, TICKET_NOTIFICATION_EVENTS, defs as default, defs as definitionsSchema };
+export { NOTIFICATION_CHANNELS, PLATFORM_ROLE_NAMES, TICKET_NOTIFICATION_EVENTS, defs as default, defs as definitionsSchema };
 
 //# sourceMappingURL=definitions.js.map