@kohost/api-client 7.8.2 → 7.10.0

package/dist/schemas/definitions.d.ts

@@ -2,6 +2,20 @@ 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];
+/**
+ * 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";
@@ -177,6 +191,234 @@ 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 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: 'Deprecated: superseded by `external`. A stored `true` reads as `external: ["parents"]`.';
+                };
+                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 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";
+                                    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,47 @@ 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"
+];
+/**
+* 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.
+*/
+const EXTERNAL_AUDIENCE_GROUPS = ["students", "parents"];
+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 +342,110 @@ 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" }
+						}
+					}
+				},
+				external: {
+					type: "array",
+					uniqueItems: true,
+					description: "Which groups of the external SIS roster were included. Human-triggered sends only; an Automation can never set it.",
+					items: {
+						type: "string",
+						enum: EXTERNAL_AUDIENCE_GROUPS
+					}
+				},
+				emergencyContacts: {
+					type: "boolean",
+					description: "Deprecated: superseded by `external`. A stored `true` reads as `external: [\"parents\"]`."
+				},
+				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,
+						external: {
+							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
+									}
+								}
+							}
+						},
+						emergencyContacts: {
+							type: "object",
+							additionalProperties: false,
+							required: [
+								"recipients",
+								"sent",
+								"failed"
+							],
+							description: "Deprecated: superseded by `external`.",
+							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 { EXTERNAL_AUDIENCE_GROUPS, NOTIFICATION_CHANNELS, PLATFORM_ROLE_NAMES, TICKET_NOTIFICATION_EVENTS, defs as default, defs as definitionsSchema };
 
 //# sourceMappingURL=definitions.js.map

package/dist/schemas/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","names":[],"sources":["../../.generated/schemas/definitions.ts"],"sourcesContent":["export const TICKET_NOTIFICATION_EVENTS = [\n  \"ticketCreated\",\n  \"ticketAssignedToMe\",\n  \"addedAsCollaborator\",\n  \"mentionedInTicket\",\n  \"messageOnMyTicket\",\n  \"ticketResolved\",\n  \"ticketCreatedAsObserver\",\n  \"messageAsObserver\",\n  \"ticketResolvedAsObserver\",\n  \"approvalRequested\",\n  \"approvalDecided\",\n] as const;\n\nexport type TicketNotificationEvent =\n  (typeof TICKET_NOTIFICATION_EVENTS)[number];\n\nexport const NOTIFICATION_CHANNELS = [\"email\", \"sms\", \"push\"] as const;\n\nexport type NotificationChannel = (typeof NOTIFICATION_CHANNELS)[number];\n\nconst defs = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"definitions.json\",\n  title: \"Definitions\",\n  definitions: {\n    id: {\n      type: \"string\",\n      description: \"Identifier of the object.\",\n    },\n    systemId: {\n      type: \"string\",\n      description: \"Identifier of the object, directly related to the system.\",\n    },\n    systemData: {\n      type: \"object\",\n    },\n    metadata: {\n      type: \"object\",\n      default: {},\n    },\n    date: {\n      type: [\"string\", \"object\"],\n      format: \"date-time\",\n    },\n    file: {\n      type: \"object\",\n      required: [\"name\", \"type\", \"data\"],\n      properties: {\n        name: {\n          type: \"string\",\n          description: \"Name of the file.\",\n        },\n        type: {\n          type: \"string\",\n          description: \"MIME type of the file (e.g. application/pdf).\",\n        },\n        data: {\n          type: \"string\",\n          description: \"Base64-encoded data of the file.\",\n        },\n      },\n    },\n    address: {\n      type: \"object\",\n      additionalProperties: false,\n      properties: {\n        id: {\n          type: \"string\",\n        },\n        line1: {\n          type: \"string\",\n        },\n        line2: {\n          type: \"string\",\n        },\n        line3: {\n          type: \"string\",\n        },\n        city: {\n          type: \"string\",\n        },\n        state: {\n          type: \"string\",\n        },\n        postalCode: {\n          type: \"string\",\n        },\n        countryCode: {\n          type: \"string\",\n          minLength: 2,\n          maxLength: 2,\n        },\n      },\n    },\n    driver: {\n      type: \"string\",\n      description: \"Driver used to communicate with the object.\",\n      enum: [\n        \"adlink\",\n        \"apex-american-audio\",\n        \"avigilon-alta\",\n        \"aws-kinesis\",\n        \"bacnet\",\n        \"benq\",\n        \"butler\",\n        \"comelit\",\n        \"cool-automation\",\n        \"crestron\",\n        \"dell\",\n        \"digital-watchdog\",\n        \"distech\",\n        \"dmp\",\n        \"doorbird\",\n        \"dormakaba\",\n        \"dsc\",\n        \"dsc-itv2\",\n        \"earbridge\",\n        \"ecobee\",\n        \"epson\",\n        \"geovision-rs\",\n        \"geovision-as-manager\",\n        \"honeywell-vista\",\n        \"honeywell-resideo\",\n        \"igor\",\n        \"inncom\",\n        \"isapi\",\n        \"kohost-k7\",\n        \"kohost\",\n        \"lapi\",\n        \"lg\",\n        \"lg-webos\",\n        \"linortek\",\n        \"lirc\",\n        \"mews\",\n        \"mht\",\n        \"mobile-mule\",\n        \"mock\",\n        \"modbus\",\n        \"napco\",\n        \"newline\",\n        \"obix\",\n        \"one-roster\",\n        \"onvif\",\n        \"orchid-fusion\",\n        \"paxton\",\n        \"pdk\",\n        \"pelican-wireless\",\n        \"power-shades\",\n        \"rachio\",\n        \"rebrandly\",\n        \"relay\",\n        \"reolink\",\n        \"rtsp\",\n        \"salto\",\n        \"salto-irn\",\n        \"samsung\",\n        \"se\",\n        \"sendgrid\",\n        \"singlewire\",\n        \"smartboard\",\n        \"sonifi\",\n        \"stay-n-touch\",\n        \"storable\",\n        \"twilio\",\n        \"unifi\",\n        \"valcom\",\n        \"veracross\",\n        \"verkada\",\n        \"vivotek\",\n        \"vizio\",\n        \"wisenet\",\n        \"zkteco\",\n        \"cloudflare-images\",\n        \"cloudflare-stream\",\n        \"insperia-privacy\",\n      ],\n    },\n    type: {\n      type: \"string\",\n      enum: [\n        \"alarm\",\n        \"camera\",\n        \"courtesy\",\n        \"dimmer\",\n        \"gateway\",\n        \"lock\",\n        \"mediaSource\",\n        \"motionSensor\",\n        \"switch\",\n        \"thermostat\",\n        \"windowCovering\",\n      ],\n    },\n    name: {\n      type: \"string\",\n    },\n    alerts: {\n      type: \"array\",\n      uniqueItems: true,\n      items: {\n        type: \"object\",\n        additionalProperties: false,\n        required: [\"type\", \"status\", \"message\"],\n        properties: {\n          id: {\n            type: \"string\"\n          },\n          type: {\n            type: \"string\",\n            enum: [\n              \"Battery\",\n              \"Button\",\n              \"Communication\",\n              \"Config\",\n              \"Cost\",\n              \"Door Ajar\",\n              \"Equipment\",\n              \"Maintenance\",\n              \"Motion\",\n              \"Registration\",\n              \"Temperature\",\n            ],\n          },\n          status: {\n            type: \"string\",\n            enum: [\"Active\", \"Resolved\"],\n          },\n          message: {\n            type: \"string\",\n          },\n        },\n      },\n    },\n    supportedNotifications: {\n      type: \"array\",\n      uniqueItems: true,\n      items: {\n        enum: [\n          \"button 1\",\n          \"button 2\",\n          \"button 3\",\n          \"button 4\",\n          \"button 5\",\n          \"idle\",\n          \"powerHasBeedApplied\",\n          \"acMainsDisconnected\",\n          \"acMainsReconnected\",\n          \"replaceBattery\",\n          \"replaceBatterySoon\",\n          \"replaceBatteryNow\",\n          \"batteryOk\",\n          \"hardwareFailure\",\n          \"softwareFailure\",\n          \"hardwareFailureWithCode\",\n          \"softwareFailureWithCode\",\n          \"motionDetection\",\n          \"airFilterNeedsCleaned\",\n          \"airFilterNeedsReplaced\",\n          \"smokeDetected\",\n          \"outsideSafeTemperatureRange\",\n          \"outsideSafeHumidityRange\",\n          \"scheduleMaintenance\",\n          \"doorAjar\",\n          \"communicationFailure\",\n          \"communicationOk\",\n          \"burglarAlarm\",\n          \"fireAlarm\",\n          \"powerTrouble\",\n          \"monitoringTrouble\",\n          \"bellTrouble\",\n          \"configIssue\",\n        ],\n      },\n    },\n    notification: {\n      type: [\"object\", \"null\"],\n      properties: {\n        name: {\n          type: \"string\",\n          $ref: \"#/definitions/supportedNotifications/items\",\n        },\n        timestamp: {\n          type: \"number\",\n          minimum: 1655907956593,\n        },\n        description: {\n          type: \"string\",\n        },\n      },\n    },\n    batteryLevel: {\n      type: \"number\",\n      minimum: 0,\n      maximum: 100,\n    },\n    watts: {\n      type: \"number\",\n      minimum: 0,\n    },\n    revenue: {\n      type: \"array\",\n      items: {\n        type: \"object\",\n        properties: {\n          id: {\n            $ref: \"definitions.json#/definitions/id\",\n          },\n          name: {\n            type: \"string\",\n          },\n          date: {\n            type: \"string\",\n            format: \"date-time\",\n          },\n          price: {\n            type: \"number\",\n          },\n          tax: {\n            type: [\"number\", \"null\"],\n          },\n        },\n      },\n    },\n    ticketNotificationEvent: {\n      type: \"string\",\n      enum: TICKET_NOTIFICATION_EVENTS,\n    },\n    notificationChannel: {\n      type: \"string\",\n      enum: NOTIFICATION_CHANNELS,\n    },\n  },\n} as const;\n\nexport type ISODateString = ReturnType<Date[\"toISOString\"]>;\n\nexport { defs as definitionsSchema };\nexport default defs;\n"],"mappings":";AAAA,MAAa,6BAA6B;CACxC;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACF;AAKA,MAAa,wBAAwB;CAAC;CAAS;CAAO;AAAM;AAI5D,MAAM,OAAO;CACX,SAAS;CACT,KAAK;CACL,OAAO;CACP,aAAa;EACX,IAAI;GACF,MAAM;GACN,aAAa;EACf;EACA,UAAU;GACR,MAAM;GACN,aAAa;EACf;EACA,YAAY,EACV,MAAM,SACR;EACA,UAAU;GACR,MAAM;GACN,SAAS,CAAC;EACZ;EACA,MAAM;GACJ,MAAM,CAAC,UAAU,QAAQ;GACzB,QAAQ;EACV;EACA,MAAM;GACJ,MAAM;GACN,UAAU;IAAC;IAAQ;IAAQ;GAAM;GACjC,YAAY;IACV,MAAM;KACJ,MAAM;KACN,aAAa;IACf;IACA,MAAM;KACJ,MAAM;KACN,aAAa;IACf;IACA,MAAM;KACJ,MAAM;KACN,aAAa;IACf;GACF;EACF;EACA,SAAS;GACP,MAAM;GACN,sBAAsB;GACtB,YAAY;IACV,IAAI,EACF,MAAM,SACR;IACA,OAAO,EACL,MAAM,SACR;IACA,OAAO,EACL,MAAM,SACR;IACA,OAAO,EACL,MAAM,SACR;IACA,MAAM,EACJ,MAAM,SACR;IACA,OAAO,EACL,MAAM,SACR;IACA,YAAY,EACV,MAAM,SACR;IACA,aAAa;KACX,MAAM;KACN,WAAW;KACX,WAAW;IACb;GACF;EACF;EACA,QAAQ;GACN,MAAM;GACN,aAAa;GACb,MAAM;IACJ;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;GACF;EACF;EACA,MAAM;GACJ,MAAM;GACN,MAAM;IACJ;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;GACF;EACF;EACA,MAAM,EACJ,MAAM,SACR;EACA,QAAQ;GACN,MAAM;GACN,aAAa;GACb,OAAO;IACL,MAAM;IACN,sBAAsB;IACtB,UAAU;KAAC;KAAQ;KAAU;IAAS;IACtC,YAAY;KACV,IAAI,EACF,MAAM,SACR;KACA,MAAM;MACJ,MAAM;MACN,MAAM;OACJ;OACA;OACA;OACA;OACA;OACA;OACA;OACA;OACA;OACA;OACA;MACF;KACF;KACA,QAAQ;MACN,MAAM;MACN,MAAM,CAAC,UAAU,UAAU;KAC7B;KACA,SAAS,EACP,MAAM,SACR;IACF;GACF;EACF;EACA,wBAAwB;GACtB,MAAM;GACN,aAAa;GACb,OAAO,EACL,MAAM;IACJ;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;GACF,EACF;EACF;EACA,cAAc;GACZ,MAAM,CAAC,UAAU,MAAM;GACvB,YAAY;IACV,MAAM;KACJ,MAAM;KACN,MAAM;IACR;IACA,WAAW;KACT,MAAM;KACN,SAAS;IACX;IACA,aAAa,EACX,MAAM,SACR;GACF;EACF;EACA,cAAc;GACZ,MAAM;GACN,SAAS;GACT,SAAS;EACX;EACA,OAAO;GACL,MAAM;GACN,SAAS;EACX;EACA,SAAS;GACP,MAAM;GACN,OAAO;IACL,MAAM;IACN,YAAY;KACV,IAAI,EACF,MAAM,mCACR;KACA,MAAM,EACJ,MAAM,SACR;KACA,MAAM;MACJ,MAAM;MACN,QAAQ;KACV;KACA,OAAO,EACL,MAAM,SACR;KACA,KAAK,EACH,MAAM,CAAC,UAAU,MAAM,EACzB;IACF;GACF;EACF;EACA,yBAAyB;GACvB,MAAM;GACN,MAAM;EACR;EACA,qBAAqB;GACnB,MAAM;GACN,MAAM;EACR;CACF;AACF"}
+{"version":3,"file":"definitions.js","names":[],"sources":["../../.generated/schemas/definitions.ts"],"sourcesContent":["export const TICKET_NOTIFICATION_EVENTS = [\n  \"ticketCreated\",\n  \"ticketAssignedToMe\",\n  \"addedAsCollaborator\",\n  \"mentionedInTicket\",\n  \"messageOnMyTicket\",\n  \"ticketResolved\",\n  \"ticketCreatedAsObserver\",\n  \"messageAsObserver\",\n  \"ticketResolvedAsObserver\",\n  \"approvalRequested\",\n  \"approvalDecided\",\n] as const;\n\nexport type TicketNotificationEvent =\n  (typeof TICKET_NOTIFICATION_EVENTS)[number];\n\nexport const NOTIFICATION_CHANNELS = [\"email\", \"sms\", \"push\"] as const;\n\nexport type NotificationChannel = (typeof NOTIFICATION_CHANNELS)[number];\n\n/**\n * The platform roles an Audience may be selected by. The legacy `Guest` role a\n * permission entry may still carry is deliberately absent: nothing targets it.\n */\nexport const PLATFORM_ROLE_NAMES = [\n  \"SuperAdmin\",\n  \"Administrator\",\n  \"Manager\",\n  \"Agent\",\n  \"User\",\n] as const;\n\nexport type PlatformRoleName = (typeof PLATFORM_ROLE_NAMES)[number];\n\n/**\n * The people outside the platform a broadcast may name, sourced from the SIS\n * roster. `students` is every system user the SIS marks as a Student;\n * `parents` is everybody else on the roster — every emergency-contact\n * relationship the source system carries, whatever it calls it.\n */\nexport const EXTERNAL_AUDIENCE_GROUPS = [\"students\", \"parents\"] as const;\n\nexport type ExternalAudienceGroup = (typeof EXTERNAL_AUDIENCE_GROUPS)[number];\n\nconst deliveryCountsNode = {\n  type: \"object\",\n  additionalProperties: false,\n  required: [\"recipients\", \"sent\", \"failed\"],\n  properties: {\n    recipients: { type: \"integer\", minimum: 0 },\n    sent: { type: \"integer\", minimum: 0 },\n    failed: { type: \"integer\", minimum: 0 },\n  },\n} as const;\n\nconst defs = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"definitions.json\",\n  title: \"Definitions\",\n  definitions: {\n    id: {\n      type: \"string\",\n      description: \"Identifier of the object.\",\n    },\n    systemId: {\n      type: \"string\",\n      description: \"Identifier of the object, directly related to the system.\",\n    },\n    systemData: {\n      type: \"object\",\n    },\n    metadata: {\n      type: \"object\",\n      default: {},\n    },\n    date: {\n      type: [\"string\", \"object\"],\n      format: \"date-time\",\n    },\n    file: {\n      type: \"object\",\n      required: [\"name\", \"type\", \"data\"],\n      properties: {\n        name: {\n          type: \"string\",\n          description: \"Name of the file.\",\n        },\n        type: {\n          type: \"string\",\n          description: \"MIME type of the file (e.g. application/pdf).\",\n        },\n        data: {\n          type: \"string\",\n          description: \"Base64-encoded data of the file.\",\n        },\n      },\n    },\n    address: {\n      type: \"object\",\n      additionalProperties: false,\n      properties: {\n        id: {\n          type: \"string\",\n        },\n        line1: {\n          type: \"string\",\n        },\n        line2: {\n          type: \"string\",\n        },\n        line3: {\n          type: \"string\",\n        },\n        city: {\n          type: \"string\",\n        },\n        state: {\n          type: \"string\",\n        },\n        postalCode: {\n          type: \"string\",\n        },\n        countryCode: {\n          type: \"string\",\n          minLength: 2,\n          maxLength: 2,\n        },\n      },\n    },\n    driver: {\n      type: \"string\",\n      description: \"Driver used to communicate with the object.\",\n      enum: [\n        \"adlink\",\n        \"apex-american-audio\",\n        \"avigilon-alta\",\n        \"aws-kinesis\",\n        \"bacnet\",\n        \"benq\",\n        \"butler\",\n        \"comelit\",\n        \"cool-automation\",\n        \"crestron\",\n        \"dell\",\n        \"digital-watchdog\",\n        \"distech\",\n        \"dmp\",\n        \"doorbird\",\n        \"dormakaba\",\n        \"dsc\",\n        \"dsc-itv2\",\n        \"earbridge\",\n        \"ecobee\",\n        \"epson\",\n        \"geovision-rs\",\n        \"geovision-as-manager\",\n        \"honeywell-vista\",\n        \"honeywell-resideo\",\n        \"igor\",\n        \"inncom\",\n        \"isapi\",\n        \"kohost-k7\",\n        \"kohost\",\n        \"lapi\",\n        \"lg\",\n        \"lg-webos\",\n        \"linortek\",\n        \"lirc\",\n        \"mews\",\n        \"mht\",\n        \"mobile-mule\",\n        \"mock\",\n        \"modbus\",\n        \"napco\",\n        \"newline\",\n        \"obix\",\n        \"one-roster\",\n        \"onvif\",\n        \"orchid-fusion\",\n        \"paxton\",\n        \"pdk\",\n        \"pelican-wireless\",\n        \"power-shades\",\n        \"rachio\",\n        \"rebrandly\",\n        \"relay\",\n        \"reolink\",\n        \"rtsp\",\n        \"salto\",\n        \"salto-irn\",\n        \"samsung\",\n        \"se\",\n        \"sendgrid\",\n        \"singlewire\",\n        \"smartboard\",\n        \"sonifi\",\n        \"stay-n-touch\",\n        \"storable\",\n        \"twilio\",\n        \"unifi\",\n        \"valcom\",\n        \"veracross\",\n        \"verkada\",\n        \"vivotek\",\n        \"vizio\",\n        \"wisenet\",\n        \"zkteco\",\n        \"cloudflare-images\",\n        \"cloudflare-stream\",\n        \"insperia-privacy\",\n      ],\n    },\n    type: {\n      type: \"string\",\n      enum: [\n        \"alarm\",\n        \"camera\",\n        \"courtesy\",\n        \"dimmer\",\n        \"gateway\",\n        \"lock\",\n        \"mediaSource\",\n        \"motionSensor\",\n        \"switch\",\n        \"thermostat\",\n        \"windowCovering\",\n      ],\n    },\n    name: {\n      type: \"string\",\n    },\n    alerts: {\n      type: \"array\",\n      uniqueItems: true,\n      items: {\n        type: \"object\",\n        additionalProperties: false,\n        required: [\"type\", \"status\", \"message\"],\n        properties: {\n          id: {\n            type: \"string\",\n          },\n          type: {\n            type: \"string\",\n            enum: [\n              \"Battery\",\n              \"Button\",\n              \"Communication\",\n              \"Config\",\n              \"Cost\",\n              \"Door Ajar\",\n              \"Equipment\",\n              \"Maintenance\",\n              \"Motion\",\n              \"Registration\",\n              \"Temperature\",\n            ],\n          },\n          status: {\n            type: \"string\",\n            enum: [\"Active\", \"Resolved\"],\n          },\n          message: {\n            type: \"string\",\n          },\n        },\n      },\n    },\n    supportedNotifications: {\n      type: \"array\",\n      uniqueItems: true,\n      items: {\n        enum: [\n          \"button 1\",\n          \"button 2\",\n          \"button 3\",\n          \"button 4\",\n          \"button 5\",\n          \"idle\",\n          \"powerHasBeedApplied\",\n          \"acMainsDisconnected\",\n          \"acMainsReconnected\",\n          \"replaceBattery\",\n          \"replaceBatterySoon\",\n          \"replaceBatteryNow\",\n          \"batteryOk\",\n          \"hardwareFailure\",\n          \"softwareFailure\",\n          \"hardwareFailureWithCode\",\n          \"softwareFailureWithCode\",\n          \"motionDetection\",\n          \"airFilterNeedsCleaned\",\n          \"airFilterNeedsReplaced\",\n          \"smokeDetected\",\n          \"outsideSafeTemperatureRange\",\n          \"outsideSafeHumidityRange\",\n          \"scheduleMaintenance\",\n          \"doorAjar\",\n          \"communicationFailure\",\n          \"communicationOk\",\n          \"burglarAlarm\",\n          \"fireAlarm\",\n          \"powerTrouble\",\n          \"monitoringTrouble\",\n          \"bellTrouble\",\n          \"configIssue\",\n        ],\n      },\n    },\n    notification: {\n      type: [\"object\", \"null\"],\n      properties: {\n        name: {\n          type: \"string\",\n          $ref: \"#/definitions/supportedNotifications/items\",\n        },\n        timestamp: {\n          type: \"number\",\n          minimum: 1655907956593,\n        },\n        description: {\n          type: \"string\",\n        },\n      },\n    },\n    batteryLevel: {\n      type: \"number\",\n      minimum: 0,\n      maximum: 100,\n    },\n    watts: {\n      type: \"number\",\n      minimum: 0,\n    },\n    revenue: {\n      type: \"array\",\n      items: {\n        type: \"object\",\n        properties: {\n          id: {\n            $ref: \"definitions.json#/definitions/id\",\n          },\n          name: {\n            type: \"string\",\n          },\n          date: {\n            type: \"string\",\n            format: \"date-time\",\n          },\n          price: {\n            type: \"number\",\n          },\n          tax: {\n            type: [\"number\", \"null\"],\n          },\n        },\n      },\n    },\n    ticketNotificationEvent: {\n      type: \"string\",\n      enum: TICKET_NOTIFICATION_EVENTS,\n    },\n    notificationChannel: {\n      type: \"string\",\n      enum: NOTIFICATION_CHANNELS,\n    },\n    deliveryCounts: deliveryCountsNode,\n    audience: {\n      type: \"object\",\n      additionalProperties: false,\n      description:\n        \"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.\",\n      properties: {\n        to: {\n          type: \"object\",\n          additionalProperties: false,\n          description:\n            'The User selector, one kind at a time. Absent or empty selects nobody; everyone is only ever the explicit `id: [\"*\"]` wildcard.',\n          properties: {\n            id: {\n              type: \"array\",\n              description:\n                \"Named User ids, or the single wildcard `*` meaning everyone in scope.\",\n              items: { type: \"string\" },\n            },\n            roles: {\n              type: \"array\",\n              items: { type: \"string\", enum: PLATFORM_ROLE_NAMES },\n            },\n            departmentIds: {\n              type: \"array\",\n              items: { type: \"string\" },\n            },\n          },\n        },\n        external: {\n          type: \"array\",\n          uniqueItems: true,\n          description:\n            \"Which groups of the external SIS roster were included. Human-triggered sends only; an Automation can never set it.\",\n          items: { type: \"string\", enum: EXTERNAL_AUDIENCE_GROUPS },\n        },\n        emergencyContacts: {\n          type: \"boolean\",\n          description:\n            'Deprecated: superseded by `external`. A stored `true` reads as `external: [\"parents\"]`.',\n        },\n        users: {\n          type: \"array\",\n          description:\n            \"Snapshot of the User ids the selector resolved to at send time.\",\n          items: { type: \"string\" },\n        },\n        delivery: {\n          type: \"object\",\n          additionalProperties: false,\n          description:\n            \"Send-time delivery counts per audience. Absent for an audience that was not sent to.\",\n          properties: {\n            internal: deliveryCountsNode,\n            external: {\n              type: \"object\",\n              additionalProperties: false,\n              required: [\"recipients\", \"sent\", \"failed\"],\n              properties: {\n                ...deliveryCountsNode.properties,\n                byChannel: {\n                  type: \"object\",\n                  additionalProperties: false,\n                  description:\n                    \"Per-channel counts, present only for the channels attempted.\",\n                  properties: {\n                    sms: deliveryCountsNode,\n                    email: deliveryCountsNode,\n                  },\n                },\n              },\n            },\n            emergencyContacts: {\n              type: \"object\",\n              additionalProperties: false,\n              required: [\"recipients\", \"sent\", \"failed\"],\n              description: \"Deprecated: superseded by `external`.\",\n              properties: {\n                ...deliveryCountsNode.properties,\n                byChannel: {\n                  type: \"object\",\n                  additionalProperties: false,\n                  description:\n                    \"Per-channel counts, present only for the channels attempted.\",\n                  properties: {\n                    sms: deliveryCountsNode,\n                    email: deliveryCountsNode,\n                  },\n                },\n              },\n            },\n          },\n        },\n      },\n    },\n  },\n} as const;\n\nexport type ISODateString = ReturnType<Date[\"toISOString\"]>;\n\nexport { defs as definitionsSchema };\nexport default defs;\n"],"mappings":";AAAA,MAAa,6BAA6B;CACxC;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACF;AAKA,MAAa,wBAAwB;CAAC;CAAS;CAAO;AAAM;;;;;AAQ5D,MAAa,sBAAsB;CACjC;CACA;CACA;CACA;CACA;AACF;;;;;;;AAUA,MAAa,2BAA2B,CAAC,YAAY,SAAS;AAI9D,MAAM,qBAAqB;CACzB,MAAM;CACN,sBAAsB;CACtB,UAAU;EAAC;EAAc;EAAQ;CAAQ;CACzC,YAAY;EACV,YAAY;GAAE,MAAM;GAAW,SAAS;EAAE;EAC1C,MAAM;GAAE,MAAM;GAAW,SAAS;EAAE;EACpC,QAAQ;GAAE,MAAM;GAAW,SAAS;EAAE;CACxC;AACF;AAEA,MAAM,OAAO;CACX,SAAS;CACT,KAAK;CACL,OAAO;CACP,aAAa;EACX,IAAI;GACF,MAAM;GACN,aAAa;EACf;EACA,UAAU;GACR,MAAM;GACN,aAAa;EACf;EACA,YAAY,EACV,MAAM,SACR;EACA,UAAU;GACR,MAAM;GACN,SAAS,CAAC;EACZ;EACA,MAAM;GACJ,MAAM,CAAC,UAAU,QAAQ;GACzB,QAAQ;EACV;EACA,MAAM;GACJ,MAAM;GACN,UAAU;IAAC;IAAQ;IAAQ;GAAM;GACjC,YAAY;IACV,MAAM;KACJ,MAAM;KACN,aAAa;IACf;IACA,MAAM;KACJ,MAAM;KACN,aAAa;IACf;IACA,MAAM;KACJ,MAAM;KACN,aAAa;IACf;GACF;EACF;EACA,SAAS;GACP,MAAM;GACN,sBAAsB;GACtB,YAAY;IACV,IAAI,EACF,MAAM,SACR;IACA,OAAO,EACL,MAAM,SACR;IACA,OAAO,EACL,MAAM,SACR;IACA,OAAO,EACL,MAAM,SACR;IACA,MAAM,EACJ,MAAM,SACR;IACA,OAAO,EACL,MAAM,SACR;IACA,YAAY,EACV,MAAM,SACR;IACA,aAAa;KACX,MAAM;KACN,WAAW;KACX,WAAW;IACb;GACF;EACF;EACA,QAAQ;GACN,MAAM;GACN,aAAa;GACb,MAAM;IACJ;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;GACF;EACF;EACA,MAAM;GACJ,MAAM;GACN,MAAM;IACJ;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;GACF;EACF;EACA,MAAM,EACJ,MAAM,SACR;EACA,QAAQ;GACN,MAAM;GACN,aAAa;GACb,OAAO;IACL,MAAM;IACN,sBAAsB;IACtB,UAAU;KAAC;KAAQ;KAAU;IAAS;IACtC,YAAY;KACV,IAAI,EACF,MAAM,SACR;KACA,MAAM;MACJ,MAAM;MACN,MAAM;OACJ;OACA;OACA;OACA;OACA;OACA;OACA;OACA;OACA;OACA;OACA;MACF;KACF;KACA,QAAQ;MACN,MAAM;MACN,MAAM,CAAC,UAAU,UAAU;KAC7B;KACA,SAAS,EACP,MAAM,SACR;IACF;GACF;EACF;EACA,wBAAwB;GACtB,MAAM;GACN,aAAa;GACb,OAAO,EACL,MAAM;IACJ;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;GACF,EACF;EACF;EACA,cAAc;GACZ,MAAM,CAAC,UAAU,MAAM;GACvB,YAAY;IACV,MAAM;KACJ,MAAM;KACN,MAAM;IACR;IACA,WAAW;KACT,MAAM;KACN,SAAS;IACX;IACA,aAAa,EACX,MAAM,SACR;GACF;EACF;EACA,cAAc;GACZ,MAAM;GACN,SAAS;GACT,SAAS;EACX;EACA,OAAO;GACL,MAAM;GACN,SAAS;EACX;EACA,SAAS;GACP,MAAM;GACN,OAAO;IACL,MAAM;IACN,YAAY;KACV,IAAI,EACF,MAAM,mCACR;KACA,MAAM,EACJ,MAAM,SACR;KACA,MAAM;MACJ,MAAM;MACN,QAAQ;KACV;KACA,OAAO,EACL,MAAM,SACR;KACA,KAAK,EACH,MAAM,CAAC,UAAU,MAAM,EACzB;IACF;GACF;EACF;EACA,yBAAyB;GACvB,MAAM;GACN,MAAM;EACR;EACA,qBAAqB;GACnB,MAAM;GACN,MAAM;EACR;EACA,gBAAgB;EAChB,UAAU;GACR,MAAM;GACN,sBAAsB;GACtB,aACE;GACF,YAAY;IACV,IAAI;KACF,MAAM;KACN,sBAAsB;KACtB,aACE;KACF,YAAY;MACV,IAAI;OACF,MAAM;OACN,aACE;OACF,OAAO,EAAE,MAAM,SAAS;MAC1B;MACA,OAAO;OACL,MAAM;OACN,OAAO;QAAE,MAAM;QAAU,MAAM;OAAoB;MACrD;MACA,eAAe;OACb,MAAM;OACN,OAAO,EAAE,MAAM,SAAS;MAC1B;KACF;IACF;IACA,UAAU;KACR,MAAM;KACN,aAAa;KACb,aACE;KACF,OAAO;MAAE,MAAM;MAAU,MAAM;KAAyB;IAC1D;IACA,mBAAmB;KACjB,MAAM;KACN,aACE;IACJ;IACA,OAAO;KACL,MAAM;KACN,aACE;KACF,OAAO,EAAE,MAAM,SAAS;IAC1B;IACA,UAAU;KACR,MAAM;KACN,sBAAsB;KACtB,aACE;KACF,YAAY;MACV,UAAU;MACV,UAAU;OACR,MAAM;OACN,sBAAsB;OACtB,UAAU;QAAC;QAAc;QAAQ;OAAQ;OACzC,YAAY;QACV,GAAG,mBAAmB;QACtB,WAAW;SACT,MAAM;SACN,sBAAsB;SACtB,aACE;SACF,YAAY;UACV,KAAK;UACL,OAAO;SACT;QACF;OACF;MACF;MACA,mBAAmB;OACjB,MAAM;OACN,sBAAsB;OACtB,UAAU;QAAC;QAAc;QAAQ;OAAQ;OACzC,aAAa;OACb,YAAY;QACV,GAAG,mBAAmB;QACtB,WAAW;SACT,MAAM;SACN,sBAAsB;SACtB,aACE;SACF,YAAY;UACV,KAAK;UACL,OAAO;SACT;QACF;OACF;MACF;KACF;IACF;GACF;EACF;CACF;AACF"}

package/dist/schemas/emailMessage.d.ts

@@ -37,6 +37,10 @@ export declare const emailMessageSchema: {
         readonly statusMessage: {
             readonly type: "string";
         };
+        readonly errorCode: {
+            readonly type: "string";
+            readonly description: "Raw vendor delivery-failure code, e.g. Twilio 21610.";
+        };
         readonly html: {
             readonly type: "string";
         };

package/dist/schemas/emailMessage.js

@@ -50,6 +50,10 @@ const emailMessageSchema = {
 			]
 		},
 		statusMessage: { type: "string" },
+		errorCode: {
+			type: "string",
+			description: "Raw vendor delivery-failure code, e.g. Twilio 21610."
+		},
 		html: { type: "string" },
 		text: { type: "string" },
 		driver: { type: "string" },

package/dist/schemas/emailMessage.js.map

@@ -1 +1 @@
-{"version":3,"file":"emailMessage.js","names":[],"sources":["../../.generated/schemas/emailMessage.ts"],"sourcesContent":["import defs, { ISODateString } from \"./definitions\";\nimport type { FromSchema } from \"json-schema-to-ts\";\n\nexport const emailMessageSchema = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"emailMessage.json\",\n  title: \"Email Message\",\n  type: \"object\",\n  required: [\"id\", \"type\", \"to\", \"from\", \"status\", \"subject\"],\n  additionalProperties: false,\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      default: \"emailMessage\",\n      enum: [\"emailMessage\"],\n    },\n    to: {\n      type: \"string\",\n    },\n    from: {\n      type: \"string\",\n      description: \"Must be in the format of 'Sender <email@example.com>\",\n    },\n    subject: {\n      type: \"string\",\n    },\n    status: {\n      type: \"string\",\n      enum: [\n        \"queued\",\n        \"sending\",\n        \"sent\",\n        \"deferred\",\n        \"delivered\",\n        \"undelivered\",\n        \"bounced\",\n        \"blocked\",\n        \"receiving\",\n        \"received\",\n        \"opened\",\n        \"clicked\",\n        \"unsubscribed\",\n        \"spamReport\",\n      ],\n    },\n    statusMessage: {\n      type: \"string\",\n    },\n    html: {\n      type: \"string\",\n    },\n    text: {\n      type: \"string\",\n    },\n    driver: {\n      type: \"string\",\n    },\n    headers: {\n      type: \"object\",\n      additionalProperties: { type: \"string\" },\n      description: \"Additional headers for the email message, key/value pairs\",\n    },\n    replyTo: {\n      type: [\"string\", \"array\"],\n    },\n    appData: {\n      type: \"object\",\n      additionalProperties: true,\n      description:\n        \"Additional data for the email message, used for custom data\",\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    systemId: {\n      $ref: \"definitions.json#/definitions/systemId\",\n    },\n  },\n} as const;\n\nexport type EmailMessageSchema = FromSchema<\n  typeof emailMessageSchema,\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,MAAM;CACN,UAAU;EAAC;EAAM;EAAQ;EAAM;EAAQ;EAAU;CAAS;CAC1D,sBAAsB;CACtB,YAAY;EACV,IAAI,EACF,MAAM,mCACR;EACA,YAAY;GACV,MAAM;GACN,aAAa;EACf;EACA,MAAM;GACJ,MAAM;GACN,SAAS;GACT,MAAM,CAAC,cAAc;EACvB;EACA,IAAI,EACF,MAAM,SACR;EACA,MAAM;GACJ,MAAM;GACN,aAAa;EACf;EACA,SAAS,EACP,MAAM,SACR;EACA,QAAQ;GACN,MAAM;GACN,MAAM;IACJ;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;GACF;EACF;EACA,eAAe,EACb,MAAM,SACR;EACA,MAAM,EACJ,MAAM,SACR;EACA,MAAM,EACJ,MAAM,SACR;EACA,QAAQ,EACN,MAAM,SACR;EACA,SAAS;GACP,MAAM;GACN,sBAAsB,EAAE,MAAM,SAAS;GACvC,aAAa;EACf;EACA,SAAS,EACP,MAAM,CAAC,UAAU,OAAO,EAC1B;EACA,SAAS;GACP,MAAM;GACN,sBAAsB;GACtB,aACE;EACJ;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;EACA,UAAU,EACR,MAAM,yCACR;CACF;AACF"}
+{"version":3,"file":"emailMessage.js","names":[],"sources":["../../.generated/schemas/emailMessage.ts"],"sourcesContent":["import defs, { ISODateString } from \"./definitions\";\nimport type { FromSchema } from \"json-schema-to-ts\";\n\nexport const emailMessageSchema = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"emailMessage.json\",\n  title: \"Email Message\",\n  type: \"object\",\n  required: [\"id\", \"type\", \"to\", \"from\", \"status\", \"subject\"],\n  additionalProperties: false,\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      default: \"emailMessage\",\n      enum: [\"emailMessage\"],\n    },\n    to: {\n      type: \"string\",\n    },\n    from: {\n      type: \"string\",\n      description: \"Must be in the format of 'Sender <email@example.com>\",\n    },\n    subject: {\n      type: \"string\",\n    },\n    status: {\n      type: \"string\",\n      enum: [\n        \"queued\",\n        \"sending\",\n        \"sent\",\n        \"deferred\",\n        \"delivered\",\n        \"undelivered\",\n        \"bounced\",\n        \"blocked\",\n        \"receiving\",\n        \"received\",\n        \"opened\",\n        \"clicked\",\n        \"unsubscribed\",\n        \"spamReport\",\n      ],\n    },\n    statusMessage: {\n      type: \"string\",\n    },\n    errorCode: {\n      type: \"string\",\n      description: \"Raw vendor delivery-failure code, e.g. Twilio 21610.\",\n    },\n    html: {\n      type: \"string\",\n    },\n    text: {\n      type: \"string\",\n    },\n    driver: {\n      type: \"string\",\n    },\n    headers: {\n      type: \"object\",\n      additionalProperties: { type: \"string\" },\n      description: \"Additional headers for the email message, key/value pairs\",\n    },\n    replyTo: {\n      type: [\"string\", \"array\"],\n    },\n    appData: {\n      type: \"object\",\n      additionalProperties: true,\n      description:\n        \"Additional data for the email message, used for custom data\",\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    systemId: {\n      $ref: \"definitions.json#/definitions/systemId\",\n    },\n  },\n} as const;\n\nexport type EmailMessageSchema = FromSchema<\n  typeof emailMessageSchema,\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,MAAM;CACN,UAAU;EAAC;EAAM;EAAQ;EAAM;EAAQ;EAAU;CAAS;CAC1D,sBAAsB;CACtB,YAAY;EACV,IAAI,EACF,MAAM,mCACR;EACA,YAAY;GACV,MAAM;GACN,aAAa;EACf;EACA,MAAM;GACJ,MAAM;GACN,SAAS;GACT,MAAM,CAAC,cAAc;EACvB;EACA,IAAI,EACF,MAAM,SACR;EACA,MAAM;GACJ,MAAM;GACN,aAAa;EACf;EACA,SAAS,EACP,MAAM,SACR;EACA,QAAQ;GACN,MAAM;GACN,MAAM;IACJ;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;GACF;EACF;EACA,eAAe,EACb,MAAM,SACR;EACA,WAAW;GACT,MAAM;GACN,aAAa;EACf;EACA,MAAM,EACJ,MAAM,SACR;EACA,MAAM,EACJ,MAAM,SACR;EACA,QAAQ,EACN,MAAM,SACR;EACA,SAAS;GACP,MAAM;GACN,sBAAsB,EAAE,MAAM,SAAS;GACvC,aAAa;EACf;EACA,SAAS,EACP,MAAM,CAAC,UAAU,OAAO,EAC1B;EACA,SAAS;GACP,MAAM;GACN,sBAAsB;GACtB,aACE;EACJ;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;EACA,UAAU,EACR,MAAM,yCACR;CACF;AACF"}

package/dist/schemas/index.d.ts

@@ -30,10 +30,12 @@ export { policySchema, type PolicySchema } from "./policy.js";
 export { productSchema, type ProductSchema } from "./product.js";
 export { propertySchema, type PropertySchema } from "./property.js";
 export { reservationSchema, type ReservationSchema } from "./reservation.js";
+export { resourceSchema, type ResourceSchema } from "./resource.js";
 export { serverSchema, type ServerSchema } from "./server.js";
 export { sessionSchema, type SessionSchema } from "./session.js";
 export { shortLinkSchema, type ShortLinkSchema } from "./shortLink.js";
 export { smsMessageSchema, type SmsMessageSchema } from "./smsMessage.js";
+export { sosEventSchema, type SOSEventSchema } from "./sosEvent.js";
 export { sosTypeSchema, type SOSTypeSchema } from "./sosType.js";
 export { spaceSchema, type SpaceSchema } from "./space.js";
 export { switchSchema, type SwitchSchema } from "./switch.js";

package/dist/schemas/index.js

@@ -30,10 +30,12 @@ import { policySchema } from "./policy.js";
 import { productSchema } from "./product.js";
 import { propertySchema } from "./property.js";
 import { reservationSchema } from "./reservation.js";
+import { resourceSchema } from "./resource.js";
 import { serverSchema } from "./server.js";
 import { sessionSchema } from "./session.js";
 import { shortLinkSchema } from "./shortLink.js";
 import { smsMessageSchema } from "./smsMessage.js";
+import { sosEventSchema } from "./sosEvent.js";
 import { sosTypeSchema } from "./sosType.js";
 import { spaceSchema } from "./space.js";
 import { switchSchema } from "./switch.js";
@@ -45,4 +47,4 @@ import { timeSheetSchema } from "./timeSheet.js";
 import { getters, userSchema } from "./user.js";
 import { vendorSchema } from "./vendor.js";
 import { windowCoveringSchema } from "./windowCovering.js";
-export { alarmSchema, announcementSchema, automationSchema, billSchema, billingCategorySchema, cameraSchema, categorySchema, courtesySchema, credentialSchema, departmentSchema, dimmerSchema, discoveredDeviceSchema, emailMessageSchema, energyReportSchema, energyReportShardSchema, gatewaySchema, groupSchema, identificationSchema, integrationSchema, issueSchema, lockSchema, logSchema, methods as mediaFileMethods, mediaFileSchema, mediaSourceSchema, motionSensorSchema, notificationSchema, organizationSchema, paymentSchema, policySchema, productSchema, propertySchema, reservationSchema, serverSchema, sessionSchema, shortLinkSchema, smsMessageSchema, sosTypeSchema, spaceSchema, switchSchema, systemSchema, systemUserSchema, thermostatSchema, ticketSchema, timeSheetSchema, getters as userGetters, userSchema, vendorSchema, windowCoveringSchema };
+export { alarmSchema, announcementSchema, automationSchema, billSchema, billingCategorySchema, cameraSchema, categorySchema, courtesySchema, credentialSchema, departmentSchema, dimmerSchema, discoveredDeviceSchema, emailMessageSchema, energyReportSchema, energyReportShardSchema, gatewaySchema, groupSchema, identificationSchema, integrationSchema, issueSchema, lockSchema, logSchema, methods as mediaFileMethods, mediaFileSchema, mediaSourceSchema, motionSensorSchema, notificationSchema, organizationSchema, paymentSchema, policySchema, productSchema, propertySchema, reservationSchema, resourceSchema, serverSchema, sessionSchema, shortLinkSchema, smsMessageSchema, sosEventSchema, sosTypeSchema, spaceSchema, switchSchema, systemSchema, systemUserSchema, thermostatSchema, ticketSchema, timeSheetSchema, getters as userGetters, userSchema, vendorSchema, windowCoveringSchema };

package/dist/schemas/organization.d.ts

@@ -302,6 +302,25 @@ export declare const organizationSchema: {
                         };
                     };
                 };
+                readonly Resources: {
+                    readonly type: "object";
+                    readonly additionalProperties: false;
+                    readonly properties: {
+                        readonly categories: {
+                            readonly type: "object";
+                            readonly additionalProperties: false;
+                            readonly properties: {
+                                readonly order: {
+                                    readonly type: "array";
+                                    readonly description: string;
+                                    readonly items: {
+                                        readonly type: "string";
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
             };
         };
         readonly credentials: {

package/dist/schemas/organization.js

@@ -248,6 +248,19 @@ const organizationSchema = {
 							items: { type: "string" }
 						} }
 					} }
+				},
+				Resources: {
+					type: "object",
+					additionalProperties: false,
+					properties: { categories: {
+						type: "object",
+						additionalProperties: false,
+						properties: { order: {
+							type: "array",
+							description: "Org-wide curated Resource Category ID order, shared by every Property's view of the Resource Library. IDs for deleted Categories are ignored on read; Categories not yet listed sort to the end alphabetically.",
+							items: { type: "string" }
+						} }
+					} }
 				}
 			}
 		},