@kohost/api-client 7.16.0 → 7.18.0

package/dist/schemas/definitions.d.ts

@@ -11,11 +11,14 @@ 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
+ * `staff` is everybody synced with nothing but the Staff role (faculty and
+ * staff); `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 declare const EXTERNAL_AUDIENCE_GROUPS: readonly ["students", "parents", "staff"];
 export type ExternalAudienceGroup = (typeof EXTERNAL_AUDIENCE_GROUPS)[number];
+export declare const SMS_OPT_OUT_REASONS: readonly ["stop", "vendor"];
+export declare const EMAIL_OPT_OUT_REASONS: readonly ["unsubscribe", "spamReport", "bounce"];
 declare const defs: {
     readonly $schema: "http://json-schema.org/draft-07/schema";
     readonly $id: "definitions.json";
@@ -208,6 +211,61 @@ declare const defs: {
                     readonly type: "integer";
                     readonly minimum: 0;
                 };
+                readonly optedOut: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "Recipients skipped because they opted out of this channel. Counted apart from `failed`; absent on sends recorded before opt-out tracking.";
+                };
+            };
+        };
+        readonly consent: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly properties: {
+                readonly sms: {
+                    readonly type: "object";
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["optedOutAt"];
+                    readonly properties: {
+                        readonly optedOutAt: {
+                            readonly anyOf: readonly [{
+                                readonly type: readonly ["string", "object"];
+                                readonly format: "date-time";
+                            }, {
+                                readonly type: "null";
+                            }];
+                            readonly description: "When the person opted out of this channel; null while they are reachable.";
+                        };
+                        readonly reason: {
+                            readonly type: "string";
+                            readonly enum: readonly ["stop", "vendor"];
+                        };
+                        readonly lastOptOutNoticeAt: {
+                            readonly type: readonly ["string", "object"];
+                            readonly format: "date-time";
+                        };
+                    };
+                };
+                readonly email: {
+                    readonly type: "object";
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["optedOutAt"];
+                    readonly properties: {
+                        readonly optedOutAt: {
+                            readonly anyOf: readonly [{
+                                readonly type: readonly ["string", "object"];
+                                readonly format: "date-time";
+                            }, {
+                                readonly type: "null";
+                            }];
+                            readonly description: "When the person opted out of this channel; null while they are reachable.";
+                        };
+                        readonly reason: {
+                            readonly type: "string";
+                            readonly enum: readonly ["unsubscribe", "spamReport", "bounce"];
+                        };
+                    };
+                };
             };
         };
         readonly audience: {
@@ -248,7 +306,7 @@ declare const defs: {
                     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 enum: readonly ["students", "parents", "staff"];
                     };
                 };
                 readonly emergencyContacts: {
@@ -284,6 +342,11 @@ declare const defs: {
                                     readonly type: "integer";
                                     readonly minimum: 0;
                                 };
+                                readonly optedOut: {
+                                    readonly type: "integer";
+                                    readonly minimum: 0;
+                                    readonly description: "Recipients skipped because they opted out of this channel. Counted apart from `failed`; absent on sends recorded before opt-out tracking.";
+                                };
                             };
                         };
                         readonly external: {
@@ -303,6 +366,11 @@ declare const defs: {
                                     readonly type: "integer";
                                     readonly minimum: 0;
                                 };
+                                readonly optedOut: {
+                                    readonly type: "integer";
+                                    readonly minimum: 0;
+                                    readonly description: "Recipients skipped because they opted out of this channel. Counted apart from `failed`; absent on sends recorded before opt-out tracking.";
+                                };
                                 readonly byChannel: {
                                     readonly type: "object";
                                     readonly additionalProperties: false;
@@ -325,6 +393,11 @@ declare const defs: {
                                                     readonly type: "integer";
                                                     readonly minimum: 0;
                                                 };
+                                                readonly optedOut: {
+                                                    readonly type: "integer";
+                                                    readonly minimum: 0;
+                                                    readonly description: "Recipients skipped because they opted out of this channel. Counted apart from `failed`; absent on sends recorded before opt-out tracking.";
+                                                };
                                             };
                                         };
                                         readonly email: {
@@ -344,6 +417,11 @@ declare const defs: {
                                                     readonly type: "integer";
                                                     readonly minimum: 0;
                                                 };
+                                                readonly optedOut: {
+                                                    readonly type: "integer";
+                                                    readonly minimum: 0;
+                                                    readonly description: "Recipients skipped because they opted out of this channel. Counted apart from `failed`; absent on sends recorded before opt-out tracking.";
+                                                };
                                             };
                                         };
                                     };
@@ -368,6 +446,11 @@ declare const defs: {
                                     readonly type: "integer";
                                     readonly minimum: 0;
                                 };
+                                readonly optedOut: {
+                                    readonly type: "integer";
+                                    readonly minimum: 0;
+                                    readonly description: "Recipients skipped because they opted out of this channel. Counted apart from `failed`; absent on sends recorded before opt-out tracking.";
+                                };
                                 readonly byChannel: {
                                     readonly type: "object";
                                     readonly additionalProperties: false;
@@ -390,6 +473,11 @@ declare const defs: {
                                                     readonly type: "integer";
                                                     readonly minimum: 0;
                                                 };
+                                                readonly optedOut: {
+                                                    readonly type: "integer";
+                                                    readonly minimum: 0;
+                                                    readonly description: "Recipients skipped because they opted out of this channel. Counted apart from `failed`; absent on sends recorded before opt-out tracking.";
+                                                };
                                             };
                                         };
                                         readonly email: {
@@ -409,6 +497,11 @@ declare const defs: {
                                                     readonly type: "integer";
                                                     readonly minimum: 0;
                                                 };
+                                                readonly optedOut: {
+                                                    readonly type: "integer";
+                                                    readonly minimum: 0;
+                                                    readonly description: "Recipients skipped because they opted out of this channel. Counted apart from `failed`; absent on sends recorded before opt-out tracking.";
+                                                };
                                             };
                                         };
                                     };

package/dist/schemas/definitions.js

@@ -31,10 +31,15 @@ const PLATFORM_ROLE_NAMES = [
 /**
 * 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
+* `staff` is everybody synced with nothing but the Staff role (faculty and
+* staff); `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 EXTERNAL_AUDIENCE_GROUPS = [
+	"students",
+	"parents",
+	"staff"
+];
 const deliveryCountsNode = {
 	type: "object",
 	additionalProperties: false,
@@ -55,9 +60,28 @@ const deliveryCountsNode = {
 		failed: {
 			type: "integer",
 			minimum: 0
+		},
+		optedOut: {
+			type: "integer",
+			minimum: 0,
+			description: "Recipients skipped because they opted out of this channel. Counted apart from `failed`; absent on sends recorded before opt-out tracking."
 		}
 	}
 };
+const SMS_OPT_OUT_REASONS = ["stop", "vendor"];
+const EMAIL_OPT_OUT_REASONS = [
+	"unsubscribe",
+	"spamReport",
+	"bounce"
+];
+const dateNode = {
+	type: ["string", "object"],
+	format: "date-time"
+};
+const optedOutAtNode = {
+	anyOf: [dateNode, { type: "null" }],
+	description: "When the person opted out of this channel; null while they are reachable."
+};
 const defs = {
 	$schema: "http://json-schema.org/draft-07/schema",
 	$id: "definitions.json",
@@ -347,6 +371,37 @@ const defs = {
 			enum: NOTIFICATION_CHANNELS
 		},
 		deliveryCounts: deliveryCountsNode,
+		consent: {
+			type: "object",
+			additionalProperties: false,
+			properties: {
+				sms: {
+					type: "object",
+					additionalProperties: false,
+					required: ["optedOutAt"],
+					properties: {
+						optedOutAt: optedOutAtNode,
+						reason: {
+							type: "string",
+							enum: SMS_OPT_OUT_REASONS
+						},
+						lastOptOutNoticeAt: dateNode
+					}
+				},
+				email: {
+					type: "object",
+					additionalProperties: false,
+					required: ["optedOutAt"],
+					properties: {
+						optedOutAt: optedOutAtNode,
+						reason: {
+							type: "string",
+							enum: EMAIL_OPT_OUT_REASONS
+						}
+					}
+				}
+			}
+		},
 		audience: {
 			type: "object",
 			additionalProperties: false,
@@ -449,6 +504,6 @@ const defs = {
 	}
 };
 //#endregion
-export { EXTERNAL_AUDIENCE_GROUPS, NOTIFICATION_CHANNELS, PLATFORM_ROLE_NAMES, TICKET_NOTIFICATION_EVENTS, defs as default, defs as definitionsSchema };
+export { EMAIL_OPT_OUT_REASONS, EXTERNAL_AUDIENCE_GROUPS, NOTIFICATION_CHANNELS, PLATFORM_ROLE_NAMES, SMS_OPT_OUT_REASONS, 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\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        \"hanwha\",\n        \"honeywell-vista\",\n        \"honeywell-resideo\",\n        \"honeywell-total-connect\",\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        \"unifi-access\",\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;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"}
+{"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 * `staff` is everybody synced with nothing but the Staff role (faculty and\n * staff); `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 = [\n  \"students\",\n  \"parents\",\n  \"staff\",\n] 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    optedOut: {\n      type: \"integer\",\n      minimum: 0,\n      description:\n        \"Recipients skipped because they opted out of this channel. Counted apart from `failed`; absent on sends recorded before opt-out tracking.\",\n    },\n  },\n} as const;\n\nexport const SMS_OPT_OUT_REASONS = [\"stop\", \"vendor\"] as const;\nexport const EMAIL_OPT_OUT_REASONS = [\n  \"unsubscribe\",\n  \"spamReport\",\n  \"bounce\",\n] as const;\n\nconst dateNode = { type: [\"string\", \"object\"], format: \"date-time\" } as const;\n\nconst optedOutAtNode = {\n  anyOf: [dateNode, { type: \"null\" }],\n  description:\n    \"When the person opted out of this channel; null while they are reachable.\",\n} as const;\n\n/**\n * Per-channel opt-out state for a person reached over external messaging.\n * Written by inbound STOP/START and vendor suppression events; read before\n * every external send. A channel is opted out exactly when `optedOutAt` holds\n * a date. Lives on SystemUser today; the same\n * node could later sit in a User's per-Organization preferences entry.\n */\nconst consentNode = {\n  type: \"object\",\n  additionalProperties: false,\n  properties: {\n    sms: {\n      type: \"object\",\n      additionalProperties: false,\n      required: [\"optedOutAt\"],\n      properties: {\n        optedOutAt: optedOutAtNode,\n        reason: { type: \"string\", enum: SMS_OPT_OUT_REASONS },\n        lastOptOutNoticeAt: dateNode,\n      },\n    },\n    email: {\n      type: \"object\",\n      additionalProperties: false,\n      required: [\"optedOutAt\"],\n      properties: {\n        optedOutAt: optedOutAtNode,\n        reason: { type: \"string\", enum: EMAIL_OPT_OUT_REASONS },\n      },\n    },\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        \"hanwha\",\n        \"honeywell-vista\",\n        \"honeywell-resideo\",\n        \"honeywell-total-connect\",\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        \"unifi-access\",\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    consent: consentNode,\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;;;;;;;;AAWA,MAAa,2BAA2B;CACtC;CACA;CACA;AACF;AAIA,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;EACtC,UAAU;GACR,MAAM;GACN,SAAS;GACT,aACE;EACJ;CACF;AACF;AAEA,MAAa,sBAAsB,CAAC,QAAQ,QAAQ;AACpD,MAAa,wBAAwB;CACnC;CACA;CACA;AACF;AAEA,MAAM,WAAW;CAAE,MAAM,CAAC,UAAU,QAAQ;CAAG,QAAQ;AAAY;AAEnE,MAAM,iBAAiB;CACrB,OAAO,CAAC,UAAU,EAAE,MAAM,OAAO,CAAC;CAClC,aACE;AACJ;AAmCA,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;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,SAAS;GApVX,MAAM;GACN,sBAAsB;GACtB,YAAY;IACV,KAAK;KACH,MAAM;KACN,sBAAsB;KACtB,UAAU,CAAC,YAAY;KACvB,YAAY;MACV,YAAY;MACZ,QAAQ;OAAE,MAAM;OAAU,MAAM;MAAoB;MACpD,oBAAoB;KACtB;IACF;IACA,OAAO;KACL,MAAM;KACN,sBAAsB;KACtB,UAAU,CAAC,YAAY;KACvB,YAAY;MACV,YAAY;MACZ,QAAQ;OAAE,MAAM;OAAU,MAAM;MAAsB;KACxD;IACF;GACF;EA8TqB;EACnB,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/group.d.ts

@@ -18,6 +18,10 @@ export declare const groupSchema: {
         readonly driver: {
             readonly $ref: "definitions.json#/definitions/driver";
         };
+        readonly propertyId: {
+            readonly type: "string";
+            readonly description: "ID of the Property this synced group belongs to. Used as a per-document filter inside the org-scoped database.";
+        };
         readonly type: {
             readonly type: "string";
             readonly enum: readonly ["group"];

package/dist/schemas/group.js

@@ -15,6 +15,10 @@ const groupSchema = {
 		id: { $ref: "definitions.json#/definitions/id" },
 		systemId: { $ref: "definitions.json#/definitions/systemId" },
 		driver: { $ref: "definitions.json#/definitions/driver" },
+		propertyId: {
+			type: "string",
+			description: "ID of the Property this synced group belongs to. Used as a per-document filter inside the org-scoped database."
+		},
 		type: {
 			type: "string",
 			enum: ["group"],

package/dist/schemas/group.js.map

@@ -1 +1 @@
-{"version":3,"file":"group.js","names":[],"sources":["../../.generated/schemas/group.ts"],"sourcesContent":["import defs, { ISODateString } from \"./definitions\";\nimport type { FromSchema } from \"json-schema-to-ts\";\n\nexport const groupSchema = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"group.json\",\n  title: \"Group\",\n  description: \"A named collection of members.\",\n  type: \"object\",\n  required: [\"id\", \"type\", \"discriminator\"],\n  additionalProperties: false,\n  properties: {\n    id: {\n      $ref: \"definitions.json#/definitions/id\",\n    },\n    systemId: {\n      $ref: \"definitions.json#/definitions/systemId\",\n    },\n    driver: {\n      $ref: \"definitions.json#/definitions/driver\",\n    },\n    type: {\n      type: \"string\",\n      enum: [\"group\"],\n      default: \"group\",\n    },\n    discriminator: {\n      type: \"string\",\n      enum: [\n        \"social\",\n        \"department\",\n      ],\n    },\n    name: {\n      type: \"string\",\n    },\n    members: {\n      type: \"array\",\n      items: {\n        type: \"object\",\n        required: [\"id\", \"type\"],\n        additionalProperties: false,\n        properties: {\n          id: {\n            $ref: \"definitions.json#/definitions/id\",\n          },\n          name: {\n            type: \"string\",\n          },\n          type: {\n            type: \"string\",\n            description: \"The type of the member resource.\",\n          },\n          role: {\n            type: \"string\",\n            description: \"The role of the member within this group.\",\n          },\n        },\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} as const;\n\nexport type GroupSchema = FromSchema<\n  typeof groupSchema,\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,cAAc;CACzB,SAAS;CACT,KAAK;CACL,OAAO;CACP,aAAa;CACb,MAAM;CACN,UAAU;EAAC;EAAM;EAAQ;CAAe;CACxC,sBAAsB;CACtB,YAAY;EACV,IAAI,EACF,MAAM,mCACR;EACA,UAAU,EACR,MAAM,yCACR;EACA,QAAQ,EACN,MAAM,uCACR;EACA,MAAM;GACJ,MAAM;GACN,MAAM,CAAC,OAAO;GACd,SAAS;EACX;EACA,eAAe;GACb,MAAM;GACN,MAAM,CACJ,UACA,YACF;EACF;EACA,MAAM,EACJ,MAAM,SACR;EACA,SAAS;GACP,MAAM;GACN,OAAO;IACL,MAAM;IACN,UAAU,CAAC,MAAM,MAAM;IACvB,sBAAsB;IACtB,YAAY;KACV,IAAI,EACF,MAAM,mCACR;KACA,MAAM,EACJ,MAAM,SACR;KACA,MAAM;MACJ,MAAM;MACN,aAAa;KACf;KACA,MAAM;MACJ,MAAM;MACN,aAAa;KACf;IACF;GACF;EACF;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;CACF;AACF"}
+{"version":3,"file":"group.js","names":[],"sources":["../../.generated/schemas/group.ts"],"sourcesContent":["import defs, { ISODateString } from \"./definitions\";\nimport type { FromSchema } from \"json-schema-to-ts\";\n\nexport const groupSchema = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"group.json\",\n  title: \"Group\",\n  description: \"A named collection of members.\",\n  type: \"object\",\n  required: [\"id\", \"type\", \"discriminator\"],\n  additionalProperties: false,\n  properties: {\n    id: {\n      $ref: \"definitions.json#/definitions/id\",\n    },\n    systemId: {\n      $ref: \"definitions.json#/definitions/systemId\",\n    },\n    driver: {\n      $ref: \"definitions.json#/definitions/driver\",\n    },\n    propertyId: {\n      type: \"string\",\n      description:\n        \"ID of the Property this synced group belongs to. Used as a per-document filter inside the org-scoped database.\",\n    },\n    type: {\n      type: \"string\",\n      enum: [\"group\"],\n      default: \"group\",\n    },\n    discriminator: {\n      type: \"string\",\n      enum: [\"social\", \"department\"],\n    },\n    name: {\n      type: \"string\",\n    },\n    members: {\n      type: \"array\",\n      items: {\n        type: \"object\",\n        required: [\"id\", \"type\"],\n        additionalProperties: false,\n        properties: {\n          id: {\n            $ref: \"definitions.json#/definitions/id\",\n          },\n          name: {\n            type: \"string\",\n          },\n          type: {\n            type: \"string\",\n            description: \"The type of the member resource.\",\n          },\n          role: {\n            type: \"string\",\n            description: \"The role of the member within this group.\",\n          },\n        },\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} as const;\n\nexport type GroupSchema = FromSchema<\n  typeof groupSchema,\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,cAAc;CACzB,SAAS;CACT,KAAK;CACL,OAAO;CACP,aAAa;CACb,MAAM;CACN,UAAU;EAAC;EAAM;EAAQ;CAAe;CACxC,sBAAsB;CACtB,YAAY;EACV,IAAI,EACF,MAAM,mCACR;EACA,UAAU,EACR,MAAM,yCACR;EACA,QAAQ,EACN,MAAM,uCACR;EACA,YAAY;GACV,MAAM;GACN,aACE;EACJ;EACA,MAAM;GACJ,MAAM;GACN,MAAM,CAAC,OAAO;GACd,SAAS;EACX;EACA,eAAe;GACb,MAAM;GACN,MAAM,CAAC,UAAU,YAAY;EAC/B;EACA,MAAM,EACJ,MAAM,SACR;EACA,SAAS;GACP,MAAM;GACN,OAAO;IACL,MAAM;IACN,UAAU,CAAC,MAAM,MAAM;IACvB,sBAAsB;IACtB,YAAY;KACV,IAAI,EACF,MAAM,mCACR;KACA,MAAM,EACJ,MAAM,SACR;KACA,MAAM;MACJ,MAAM;MACN,aAAa;KACf;KACA,MAAM;MACJ,MAAM;MACN,aAAa;KACf;IACF;GACF;EACF;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;CACF;AACF"}

package/dist/schemas/system.d.ts

@@ -17,6 +17,10 @@ export declare const systemSchema: {
             readonly default: "system";
             readonly enum: readonly ["system"];
         };
+        readonly discriminator: {
+            readonly type: "string";
+            readonly enum: readonly ["accessControl", "lighting", "hvac", "av", "alarm", "camera"];
+        };
         readonly name: {
             readonly type: "string";
         };
@@ -105,6 +109,12 @@ export declare const systemSchema: {
                 };
             };
         };
+        readonly emergency: {
+            readonly type: readonly ["string", "null"];
+            readonly enum: readonly ["lockdown", "evacuate", null];
+            readonly default: null;
+            readonly description: "Active system wide emergency state";
+        };
         readonly health: {
             readonly type: "object";
             readonly properties: {
@@ -119,6 +129,10 @@ export declare const systemSchema: {
                 };
             };
         };
+        readonly syncedAt: {
+            readonly $ref: "definitions.json#/definitions/date";
+            readonly description: "When the system's roster (people and households) was last synced into the platform.";
+        };
         readonly createdAt: {
             readonly $ref: "definitions.json#/definitions/date";
         };
@@ -129,6 +143,19 @@ export declare const systemSchema: {
             readonly $ref: "definitions.json#/definitions/date";
         };
     };
+    readonly allOf: readonly [{
+        readonly if: {
+            readonly properties: {
+                readonly discriminator: {
+                    readonly const: "accessControl";
+                };
+            };
+            readonly required: readonly ["discriminator"];
+        };
+        readonly then: {
+            readonly required: readonly ["emergency"];
+        };
+    }];
 };
 export type SystemSchema = FromSchema<typeof systemSchema, {
     references: [typeof defs, typeof mediaFileSchema];

package/dist/schemas/system.js

@@ -18,6 +18,17 @@ const systemSchema = {
 			default: "system",
 			enum: ["system"]
 		},
+		discriminator: {
+			type: "string",
+			enum: [
+				"accessControl",
+				"lighting",
+				"hvac",
+				"av",
+				"alarm",
+				"camera"
+			]
+		},
 		name: { type: "string" },
 		driver: {
 			$ref: "definitions.json#/definitions/driver",
@@ -100,6 +111,16 @@ const systemSchema = {
 				}
 			}
 		},
+		emergency: {
+			type: ["string", "null"],
+			enum: [
+				"lockdown",
+				"evacuate",
+				null
+			],
+			default: null,
+			description: "Active system wide emergency state"
+		},
 		health: {
 			type: "object",
 			properties: {
@@ -114,10 +135,21 @@ const systemSchema = {
 				}
 			}
 		},
+		syncedAt: {
+			$ref: "definitions.json#/definitions/date",
+			description: "When the system's roster (people and households) was last synced into the platform."
+		},
 		createdAt: { $ref: "definitions.json#/definitions/date" },
 		updatedAt: { $ref: "definitions.json#/definitions/date" },
 		deletedAt: { $ref: "definitions.json#/definitions/date" }
-	}
+	},
+	allOf: [{
+		if: {
+			properties: { discriminator: { const: "accessControl" } },
+			required: ["discriminator"]
+		},
+		then: { required: ["emergency"] }
+	}]
 };
 //#endregion
 export { systemSchema };

package/dist/schemas/system.js.map

@@ -1 +1 @@
-{"version":3,"file":"system.js","names":[],"sources":["../../.generated/schemas/system.ts"],"sourcesContent":["import defs, { ISODateString } from \"./definitions\";\nimport type { FromSchema } from \"json-schema-to-ts\";\nimport type { mediaFileSchema } from \"./mediaFile\";\n\nexport const systemSchema = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"system.json\",\n  title: \"System\",\n  type: \"object\",\n  required: [\"id\", \"type\", \"driver\", \"entities\"],\n  additionalProperties: false,\n  properties: {\n    id: {\n      type: \"string\",\n    },\n    type: {\n      type: \"string\",\n      default: \"system\",\n      enum: [\"system\"],\n    },\n    name: {\n      type: \"string\",\n    },\n    driver: {\n      $ref: \"definitions.json#/definitions/driver\",\n      example: \"salto\",\n      description: \"The driver value that implements the system\",\n    },\n    organizationId: {\n      type: \"string\",\n      description: \"The id of the organization that uses the system\",\n    },\n    propertyId: {\n      type: \"string\",\n      description: \"The id of the property that uses the system\",\n    },\n    entities: {\n      type: \"array\",\n      description: \"The entities produced by the system\",\n      default: [],\n      items: {\n        type: \"object\",\n        required: [\"systemId\"],\n        properties: {\n          id: {\n            type: \"string\",\n            description: \"The id of the entity\",\n          },\n          systemId: {\n            type: \"string\",\n            description: \"The id of the entity as known by the system\",\n          },\n          type: {\n            type: \"string\",\n            description: \"The type of the entity\",\n          },\n          discriminator: {\n            type: \"string\",\n            description: \"The discriminator of the entity\",\n          },\n          propertyIds: {\n            type: \"array\",\n            description:\n              \"The ids of the properties where the entity is located\",\n            items: {\n              type: \"string\",\n            },\n          },\n        },\n      },\n    },\n    driverApiVersion: {\n      type: \"string\",\n      description: \"The version of the driver API used by the system\",\n    },\n    logo: {\n      $ref: \"mediaFile.json#\",\n    },\n    config: {\n      type: \"object\",\n      additionalProperties: true,\n      description: \"The runtime configuration of the system\",\n    },\n    contactInfo: {\n      type: \"object\",\n      additionalProperties: false,\n      properties: {\n        websiteUrl: {\n          type: \"string\",\n          description: \"The website URL of the system\",\n        },\n        email: {\n          type: \"string\",\n          description: \"The email address of the system\",\n        },\n        phone: {\n          type: \"string\",\n          description: \"The phone number of the system\",\n        },\n        itunesAppId: {\n          type: \"string\",\n          example: \"807316865\",\n        },\n        googleAppId: {\n          type: \"string\",\n          example: \"tw.com.geovision.gvaccesscontrol\",\n        },\n      },\n    },\n    health: {\n      type: \"object\",\n      properties: {\n        offline: {\n          type: \"boolean\",\n          description: \"Whether the system is offline\",\n        },\n        lastHeartbeatAt: {\n          type: \"string\",\n          description:\n            \"The date and time of the last communication with the system\",\n          format: \"date-time\",\n        },\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} as const;\n\nexport type SystemSchema = FromSchema<\n  typeof systemSchema,\n  {\n    references: [typeof defs, typeof mediaFileSchema];\n    deserialize: [\n      {\n        pattern: {\n          format: \"date-time\";\n        };\n        output: Date | ISODateString;\n      },\n    ];\n  }\n>;\n"],"mappings":";AAIA,MAAa,eAAe;CAC1B,SAAS;CACT,KAAK;CACL,OAAO;CACP,MAAM;CACN,UAAU;EAAC;EAAM;EAAQ;EAAU;CAAU;CAC7C,sBAAsB;CACtB,YAAY;EACV,IAAI,EACF,MAAM,SACR;EACA,MAAM;GACJ,MAAM;GACN,SAAS;GACT,MAAM,CAAC,QAAQ;EACjB;EACA,MAAM,EACJ,MAAM,SACR;EACA,QAAQ;GACN,MAAM;GACN,SAAS;GACT,aAAa;EACf;EACA,gBAAgB;GACd,MAAM;GACN,aAAa;EACf;EACA,YAAY;GACV,MAAM;GACN,aAAa;EACf;EACA,UAAU;GACR,MAAM;GACN,aAAa;GACb,SAAS,CAAC;GACV,OAAO;IACL,MAAM;IACN,UAAU,CAAC,UAAU;IACrB,YAAY;KACV,IAAI;MACF,MAAM;MACN,aAAa;KACf;KACA,UAAU;MACR,MAAM;MACN,aAAa;KACf;KACA,MAAM;MACJ,MAAM;MACN,aAAa;KACf;KACA,eAAe;MACb,MAAM;MACN,aAAa;KACf;KACA,aAAa;MACX,MAAM;MACN,aACE;MACF,OAAO,EACL,MAAM,SACR;KACF;IACF;GACF;EACF;EACA,kBAAkB;GAChB,MAAM;GACN,aAAa;EACf;EACA,MAAM,EACJ,MAAM,kBACR;EACA,QAAQ;GACN,MAAM;GACN,sBAAsB;GACtB,aAAa;EACf;EACA,aAAa;GACX,MAAM;GACN,sBAAsB;GACtB,YAAY;IACV,YAAY;KACV,MAAM;KACN,aAAa;IACf;IACA,OAAO;KACL,MAAM;KACN,aAAa;IACf;IACA,OAAO;KACL,MAAM;KACN,aAAa;IACf;IACA,aAAa;KACX,MAAM;KACN,SAAS;IACX;IACA,aAAa;KACX,MAAM;KACN,SAAS;IACX;GACF;EACF;EACA,QAAQ;GACN,MAAM;GACN,YAAY;IACV,SAAS;KACP,MAAM;KACN,aAAa;IACf;IACA,iBAAiB;KACf,MAAM;KACN,aACE;KACF,QAAQ;IACV;GACF;EACF;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;CACF;AACF"}
+{"version":3,"file":"system.js","names":[],"sources":["../../.generated/schemas/system.ts"],"sourcesContent":["import defs, { ISODateString } from \"./definitions\";\nimport type { FromSchema } from \"json-schema-to-ts\";\nimport type { mediaFileSchema } from \"./mediaFile\";\n\nexport const systemSchema = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"system.json\",\n  title: \"System\",\n  type: \"object\",\n  required: [\"id\", \"type\", \"driver\", \"entities\"],\n  additionalProperties: false,\n  properties: {\n    id: {\n      type: \"string\",\n    },\n    type: {\n      type: \"string\",\n      default: \"system\",\n      enum: [\"system\"],\n    },\n    discriminator: {\n      type: \"string\",\n      enum: [\"accessControl\", \"lighting\", \"hvac\", \"av\", \"alarm\", \"camera\"],\n    },\n    name: {\n      type: \"string\",\n    },\n    driver: {\n      $ref: \"definitions.json#/definitions/driver\",\n      example: \"salto\",\n      description: \"The driver value that implements the system\",\n    },\n    organizationId: {\n      type: \"string\",\n      description: \"The id of the organization that uses the system\",\n    },\n    propertyId: {\n      type: \"string\",\n      description: \"The id of the property that uses the system\",\n    },\n    entities: {\n      type: \"array\",\n      description: \"The entities produced by the system\",\n      default: [],\n      items: {\n        type: \"object\",\n        required: [\"systemId\"],\n        properties: {\n          id: {\n            type: \"string\",\n            description: \"The id of the entity\",\n          },\n          systemId: {\n            type: \"string\",\n            description: \"The id of the entity as known by the system\",\n          },\n          type: {\n            type: \"string\",\n            description: \"The type of the entity\",\n          },\n          discriminator: {\n            type: \"string\",\n            description: \"The discriminator of the entity\",\n          },\n          propertyIds: {\n            type: \"array\",\n            description:\n              \"The ids of the properties where the entity is located\",\n            items: {\n              type: \"string\",\n            },\n          },\n        },\n      },\n    },\n    driverApiVersion: {\n      type: \"string\",\n      description: \"The version of the driver API used by the system\",\n    },\n    logo: {\n      $ref: \"mediaFile.json#\",\n    },\n    config: {\n      type: \"object\",\n      additionalProperties: true,\n      description: \"The runtime configuration of the system\",\n    },\n    contactInfo: {\n      type: \"object\",\n      additionalProperties: false,\n      properties: {\n        websiteUrl: {\n          type: \"string\",\n          description: \"The website URL of the system\",\n        },\n        email: {\n          type: \"string\",\n          description: \"The email address of the system\",\n        },\n        phone: {\n          type: \"string\",\n          description: \"The phone number of the system\",\n        },\n        itunesAppId: {\n          type: \"string\",\n          example: \"807316865\",\n        },\n        googleAppId: {\n          type: \"string\",\n          example: \"tw.com.geovision.gvaccesscontrol\",\n        },\n      },\n    },\n    emergency: {\n      type: [\"string\", \"null\"],\n      enum: [\"lockdown\", \"evacuate\", null],\n      default: null,\n      description: \"Active system wide emergency state\",\n    },\n    health: {\n      type: \"object\",\n      properties: {\n        offline: {\n          type: \"boolean\",\n          description: \"Whether the system is offline\",\n        },\n        lastHeartbeatAt: {\n          type: \"string\",\n          description:\n            \"The date and time of the last communication with the system\",\n          format: \"date-time\",\n        },\n      },\n    },\n    syncedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n      description:\n        \"When the system's roster (people and households) was last synced into the platform.\",\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  allOf: [\n    {\n      if: {\n        properties: { discriminator: { const: \"accessControl\" } },\n        required: [\"discriminator\"],\n      },\n      then: { required: [\"emergency\"] },\n    }\n  ]\n} as const;\n\nexport type SystemSchema = FromSchema<\n  typeof systemSchema,\n  {\n    references: [typeof defs, typeof mediaFileSchema];\n    deserialize: [\n      {\n        pattern: {\n          format: \"date-time\";\n        };\n        output: Date | ISODateString;\n      },\n    ];\n  }\n>;\n"],"mappings":";AAIA,MAAa,eAAe;CAC1B,SAAS;CACT,KAAK;CACL,OAAO;CACP,MAAM;CACN,UAAU;EAAC;EAAM;EAAQ;EAAU;CAAU;CAC7C,sBAAsB;CACtB,YAAY;EACV,IAAI,EACF,MAAM,SACR;EACA,MAAM;GACJ,MAAM;GACN,SAAS;GACT,MAAM,CAAC,QAAQ;EACjB;EACA,eAAe;GACb,MAAM;GACN,MAAM;IAAC;IAAiB;IAAY;IAAQ;IAAM;IAAS;GAAQ;EACrE;EACA,MAAM,EACJ,MAAM,SACR;EACA,QAAQ;GACN,MAAM;GACN,SAAS;GACT,aAAa;EACf;EACA,gBAAgB;GACd,MAAM;GACN,aAAa;EACf;EACA,YAAY;GACV,MAAM;GACN,aAAa;EACf;EACA,UAAU;GACR,MAAM;GACN,aAAa;GACb,SAAS,CAAC;GACV,OAAO;IACL,MAAM;IACN,UAAU,CAAC,UAAU;IACrB,YAAY;KACV,IAAI;MACF,MAAM;MACN,aAAa;KACf;KACA,UAAU;MACR,MAAM;MACN,aAAa;KACf;KACA,MAAM;MACJ,MAAM;MACN,aAAa;KACf;KACA,eAAe;MACb,MAAM;MACN,aAAa;KACf;KACA,aAAa;MACX,MAAM;MACN,aACE;MACF,OAAO,EACL,MAAM,SACR;KACF;IACF;GACF;EACF;EACA,kBAAkB;GAChB,MAAM;GACN,aAAa;EACf;EACA,MAAM,EACJ,MAAM,kBACR;EACA,QAAQ;GACN,MAAM;GACN,sBAAsB;GACtB,aAAa;EACf;EACA,aAAa;GACX,MAAM;GACN,sBAAsB;GACtB,YAAY;IACV,YAAY;KACV,MAAM;KACN,aAAa;IACf;IACA,OAAO;KACL,MAAM;KACN,aAAa;IACf;IACA,OAAO;KACL,MAAM;KACN,aAAa;IACf;IACA,aAAa;KACX,MAAM;KACN,SAAS;IACX;IACA,aAAa;KACX,MAAM;KACN,SAAS;IACX;GACF;EACF;EACA,WAAW;GACT,MAAM,CAAC,UAAU,MAAM;GACvB,MAAM;IAAC;IAAY;IAAY;GAAI;GACnC,SAAS;GACT,aAAa;EACf;EACA,QAAQ;GACN,MAAM;GACN,YAAY;IACV,SAAS;KACP,MAAM;KACN,aAAa;IACf;IACA,iBAAiB;KACf,MAAM;KACN,aACE;KACF,QAAQ;IACV;GACF;EACF;EACA,UAAU;GACR,MAAM;GACN,aACE;EACJ;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;CACF;CACA,OAAO,CACL;EACE,IAAI;GACF,YAAY,EAAE,eAAe,EAAE,OAAO,gBAAgB,EAAE;GACxD,UAAU,CAAC,eAAe;EAC5B;EACA,MAAM,EAAE,UAAU,CAAC,WAAW,EAAE;CAClC,CACF;AACF"}

package/dist/schemas/systemUser.d.ts

@@ -101,9 +101,8 @@ export declare const systemUserSchema: {
             readonly type: "string";
             readonly description: "ID of the Property this synced user belongs to. Used as a per-document filter inside the org-scoped database.";
         };
-        readonly syncedAt: {
-            readonly $ref: "definitions.json#/definitions/date";
-            readonly description: "When this user was last written through from its source system.";
+        readonly consent: {
+            readonly $ref: "definitions.json#/definitions/consent";
         };
     };
 };

package/dist/schemas/systemUser.js

@@ -92,10 +92,7 @@ const systemUserSchema = {
 			type: "string",
 			description: "ID of the Property this synced user belongs to. Used as a per-document filter inside the org-scoped database."
 		},
-		syncedAt: {
-			$ref: "definitions.json#/definitions/date",
-			description: "When this user was last written through from its source system."
-		}
+		consent: { $ref: "definitions.json#/definitions/consent" }
 	}
 };
 //#endregion

package/dist/schemas/systemUser.js.map

@@ -1 +1 @@
-{"version":3,"file":"systemUser.js","names":[],"sources":["../../.generated/schemas/systemUser.ts"],"sourcesContent":["import defs, { ISODateString } from \"./definitions\";\nimport type { FromSchema } from \"json-schema-to-ts\";\n\nexport const systemUserSchema = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"systemUser.json\",\n  title: \"System User\",\n  description:\n    \"A system user is a user that originated from an external 3rd party system.\",\n  type: \"object\",\n  required: [\"id\", \"firstName\", \"lastName\"],\n  properties: {\n    id: {\n      $ref: \"definitions.json#/definitions/id\",\n    },\n    type: {\n      type: \"string\",\n      default: \"systemUser\",\n      enum: [\"systemUser\"],\n    },\n    driver: {\n      $ref: \"definitions.json#/definitions/driver\",\n    },\n    firstName: {\n      type: \"string\",\n    },\n    lastName: {\n      type: \"string\",\n    },\n    phone: {\n      type: [\"string\", \"null\"],\n      pattern: \"^\\\\+[0-9]{1,14}$\",\n    },\n    email: {\n      type: [\"string\", \"null\"],\n      format: \"email\",\n    },\n    address: {\n      $ref: \"definitions.json#/definitions/address\",\n    },\n    photo: {\n      type: \"string\",\n    },\n    jobTitle: {\n      type: \"string\",\n    },\n    dob: {\n      type: \"string\",\n    },\n    gender: {\n      type: [\"string\", \"null\"],\n      enum: [\"male\", \"female\", null],\n    },\n    roles: {\n      type: \"array\",\n      items: {\n        type: \"string\",\n        enum: [\n          \"Administrator\",\n          \"Caretaker\",\n          \"Colleague\",\n          \"Friend\",\n          \"Guardian\",\n          \"Guest\",\n          \"Maintenance\",\n          \"Manager\",\n          \"Neighbor\",\n          \"Parent\",\n          \"Relative\",\n          \"Staff\",\n          \"Student\",\n          \"SuperAdmin\",\n          \"User\",\n        ],\n      },\n    },\n    nationality: {\n      type: \"string\",\n      minLength: 2,\n      maxLength: 2,\n    },\n    notes: {\n      type: \"array\",\n      items: {\n        type: \"string\",\n      },\n    },\n    files: {\n      type: \"array\",\n      items: {\n        $ref: \"mediaFile.json#\",\n      },\n    },\n    identifications: {\n      type: \"array\",\n      items: {\n        $ref: \"identification.json#\",\n      },\n    },\n    payments: {\n      type: \"array\",\n      items: {\n        $ref: \"payment.json#\",\n      },\n    },\n    revenue: {\n      $ref: \"definitions.json#/definitions/revenue\",\n    },\n    createdAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n    updatedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n    systemId: {\n      $ref: \"definitions.json#/definitions/systemId\",\n    },\n    propertyId: {\n      type: \"string\",\n      description:\n        \"ID of the Property this synced user belongs to. Used as a per-document filter inside the org-scoped database.\",\n    },\n    syncedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n      description:\n        \"When this user was last written through from its source system.\",\n    },\n  },\n} as const;\n\nexport type SystemUserSchema = FromSchema<\n  typeof systemUserSchema,\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,mBAAmB;CAC9B,SAAS;CACT,KAAK;CACL,OAAO;CACP,aACE;CACF,MAAM;CACN,UAAU;EAAC;EAAM;EAAa;CAAU;CACxC,YAAY;EACV,IAAI,EACF,MAAM,mCACR;EACA,MAAM;GACJ,MAAM;GACN,SAAS;GACT,MAAM,CAAC,YAAY;EACrB;EACA,QAAQ,EACN,MAAM,uCACR;EACA,WAAW,EACT,MAAM,SACR;EACA,UAAU,EACR,MAAM,SACR;EACA,OAAO;GACL,MAAM,CAAC,UAAU,MAAM;GACvB,SAAS;EACX;EACA,OAAO;GACL,MAAM,CAAC,UAAU,MAAM;GACvB,QAAQ;EACV;EACA,SAAS,EACP,MAAM,wCACR;EACA,OAAO,EACL,MAAM,SACR;EACA,UAAU,EACR,MAAM,SACR;EACA,KAAK,EACH,MAAM,SACR;EACA,QAAQ;GACN,MAAM,CAAC,UAAU,MAAM;GACvB,MAAM;IAAC;IAAQ;IAAU;GAAI;EAC/B;EACA,OAAO;GACL,MAAM;GACN,OAAO;IACL,MAAM;IACN,MAAM;KACJ;KACA;KACA;KACA;KACA;KACA;KACA;KACA;KACA;KACA;KACA;KACA;KACA;KACA;KACA;IACF;GACF;EACF;EACA,aAAa;GACX,MAAM;GACN,WAAW;GACX,WAAW;EACb;EACA,OAAO;GACL,MAAM;GACN,OAAO,EACL,MAAM,SACR;EACF;EACA,OAAO;GACL,MAAM;GACN,OAAO,EACL,MAAM,kBACR;EACF;EACA,iBAAiB;GACf,MAAM;GACN,OAAO,EACL,MAAM,uBACR;EACF;EACA,UAAU;GACR,MAAM;GACN,OAAO,EACL,MAAM,gBACR;EACF;EACA,SAAS,EACP,MAAM,wCACR;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;EACA,UAAU,EACR,MAAM,yCACR;EACA,YAAY;GACV,MAAM;GACN,aACE;EACJ;EACA,UAAU;GACR,MAAM;GACN,aACE;EACJ;CACF;AACF"}
+{"version":3,"file":"systemUser.js","names":[],"sources":["../../.generated/schemas/systemUser.ts"],"sourcesContent":["import defs, { ISODateString } from \"./definitions\";\nimport type { FromSchema } from \"json-schema-to-ts\";\n\nexport const systemUserSchema = {\n  $schema: \"http://json-schema.org/draft-07/schema\",\n  $id: \"systemUser.json\",\n  title: \"System User\",\n  description:\n    \"A system user is a user that originated from an external 3rd party system.\",\n  type: \"object\",\n  required: [\"id\", \"firstName\", \"lastName\"],\n  properties: {\n    id: {\n      $ref: \"definitions.json#/definitions/id\",\n    },\n    type: {\n      type: \"string\",\n      default: \"systemUser\",\n      enum: [\"systemUser\"],\n    },\n    driver: {\n      $ref: \"definitions.json#/definitions/driver\",\n    },\n    firstName: {\n      type: \"string\",\n    },\n    lastName: {\n      type: \"string\",\n    },\n    phone: {\n      type: [\"string\", \"null\"],\n      pattern: \"^\\\\+[0-9]{1,14}$\",\n    },\n    email: {\n      type: [\"string\", \"null\"],\n      format: \"email\",\n    },\n    address: {\n      $ref: \"definitions.json#/definitions/address\",\n    },\n    photo: {\n      type: \"string\",\n    },\n    jobTitle: {\n      type: \"string\",\n    },\n    dob: {\n      type: \"string\",\n    },\n    gender: {\n      type: [\"string\", \"null\"],\n      enum: [\"male\", \"female\", null],\n    },\n    roles: {\n      type: \"array\",\n      items: {\n        type: \"string\",\n        enum: [\n          \"Administrator\",\n          \"Caretaker\",\n          \"Colleague\",\n          \"Friend\",\n          \"Guardian\",\n          \"Guest\",\n          \"Maintenance\",\n          \"Manager\",\n          \"Neighbor\",\n          \"Parent\",\n          \"Relative\",\n          \"Staff\",\n          \"Student\",\n          \"SuperAdmin\",\n          \"User\",\n        ],\n      },\n    },\n    nationality: {\n      type: \"string\",\n      minLength: 2,\n      maxLength: 2,\n    },\n    notes: {\n      type: \"array\",\n      items: {\n        type: \"string\",\n      },\n    },\n    files: {\n      type: \"array\",\n      items: {\n        $ref: \"mediaFile.json#\",\n      },\n    },\n    identifications: {\n      type: \"array\",\n      items: {\n        $ref: \"identification.json#\",\n      },\n    },\n    payments: {\n      type: \"array\",\n      items: {\n        $ref: \"payment.json#\",\n      },\n    },\n    revenue: {\n      $ref: \"definitions.json#/definitions/revenue\",\n    },\n    createdAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n    updatedAt: {\n      $ref: \"definitions.json#/definitions/date\",\n    },\n    systemId: {\n      $ref: \"definitions.json#/definitions/systemId\",\n    },\n    propertyId: {\n      type: \"string\",\n      description:\n        \"ID of the Property this synced user belongs to. Used as a per-document filter inside the org-scoped database.\",\n    },\n    consent: {\n      $ref: \"definitions.json#/definitions/consent\",\n    },\n  },\n} as const;\n\nexport type SystemUserSchema = FromSchema<\n  typeof systemUserSchema,\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,mBAAmB;CAC9B,SAAS;CACT,KAAK;CACL,OAAO;CACP,aACE;CACF,MAAM;CACN,UAAU;EAAC;EAAM;EAAa;CAAU;CACxC,YAAY;EACV,IAAI,EACF,MAAM,mCACR;EACA,MAAM;GACJ,MAAM;GACN,SAAS;GACT,MAAM,CAAC,YAAY;EACrB;EACA,QAAQ,EACN,MAAM,uCACR;EACA,WAAW,EACT,MAAM,SACR;EACA,UAAU,EACR,MAAM,SACR;EACA,OAAO;GACL,MAAM,CAAC,UAAU,MAAM;GACvB,SAAS;EACX;EACA,OAAO;GACL,MAAM,CAAC,UAAU,MAAM;GACvB,QAAQ;EACV;EACA,SAAS,EACP,MAAM,wCACR;EACA,OAAO,EACL,MAAM,SACR;EACA,UAAU,EACR,MAAM,SACR;EACA,KAAK,EACH,MAAM,SACR;EACA,QAAQ;GACN,MAAM,CAAC,UAAU,MAAM;GACvB,MAAM;IAAC;IAAQ;IAAU;GAAI;EAC/B;EACA,OAAO;GACL,MAAM;GACN,OAAO;IACL,MAAM;IACN,MAAM;KACJ;KACA;KACA;KACA;KACA;KACA;KACA;KACA;KACA;KACA;KACA;KACA;KACA;KACA;KACA;IACF;GACF;EACF;EACA,aAAa;GACX,MAAM;GACN,WAAW;GACX,WAAW;EACb;EACA,OAAO;GACL,MAAM;GACN,OAAO,EACL,MAAM,SACR;EACF;EACA,OAAO;GACL,MAAM;GACN,OAAO,EACL,MAAM,kBACR;EACF;EACA,iBAAiB;GACf,MAAM;GACN,OAAO,EACL,MAAM,uBACR;EACF;EACA,UAAU;GACR,MAAM;GACN,OAAO,EACL,MAAM,gBACR;EACF;EACA,SAAS,EACP,MAAM,wCACR;EACA,WAAW,EACT,MAAM,qCACR;EACA,WAAW,EACT,MAAM,qCACR;EACA,UAAU,EACR,MAAM,yCACR;EACA,YAAY;GACV,MAAM;GACN,aACE;EACJ;EACA,SAAS,EACP,MAAM,wCACR;CACF;AACF"}