@kohost/api-client 7.12.0 → 7.14.0

package/dist/schemas/costEntry.d.ts

@@ -0,0 +1,222 @@
+/**
+ * The append-only billing review history, over whichever actions the host
+ * admits. A ticket cost can be voided (withdrawn from the customer); a
+ * standalone cost has no ticket to withdraw it from, so its history stops at
+ * write-offs and divergence acknowledgements.
+ */
+export declare const costBillingReview: <const Actions extends readonly string[]>(actions: Actions) => {
+    readonly type: "array";
+    readonly default: readonly [];
+    readonly description: string;
+    readonly items: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["id", "action", "performedAt"];
+        readonly properties: {
+            readonly id: {
+                readonly type: "string";
+                readonly description: "The ID of the billing review entry.";
+            };
+            readonly action: {
+                readonly type: "string";
+                readonly enum: Actions;
+            };
+            readonly performedBy: {
+                readonly type: readonly ["string", "null"];
+                readonly default: null;
+                readonly description: string;
+            };
+            readonly performedAt: {
+                readonly $ref: "definitions.json#/definitions/date";
+                readonly description: "When the entry was appended.";
+            };
+            readonly note: {
+                readonly type: readonly ["string", "null"];
+                readonly default: null;
+                readonly description: "Free-text rationale for the action.";
+            };
+            readonly billedAmount: {
+                readonly type: "integer";
+                readonly minimum: 0;
+                readonly description: string;
+            };
+            readonly priceAmount: {
+                readonly type: "integer";
+                readonly minimum: 0;
+                readonly description: string;
+            };
+        };
+    };
+};
+export declare const costEntryRequired: readonly ["id", "description", "currency", "price", "estimate", "markup"];
+export declare const costEntryProperties: {
+    readonly id: {
+        readonly type: "string";
+        readonly description: "The ID of the cost entry.";
+    };
+    readonly description: {
+        readonly type: "string";
+        readonly description: "What the cost covers.";
+    };
+    readonly currency: {
+        readonly type: "string";
+        readonly default: "USD";
+        readonly description: "ISO 4217 currency code of the entry's amounts.";
+    };
+    readonly price: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["amount", "recordedBy", "recordedAt"];
+        readonly description: string;
+        readonly properties: {
+            readonly amount: {
+                readonly type: "integer";
+                readonly minimum: 0;
+                readonly description: "The amount in integer cents.";
+            };
+            readonly recordedBy: {
+                readonly type: "string";
+                readonly description: "The ID of the user who recorded the amount.";
+            };
+            readonly recordedAt: {
+                readonly $ref: "definitions.json#/definitions/date";
+                readonly description: "When the amount was recorded.";
+            };
+        };
+    };
+    readonly estimate: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["amount", "recordedBy", "recordedAt"];
+        readonly description: string;
+        readonly properties: {
+            readonly amount: {
+                readonly type: "integer";
+                readonly minimum: 0;
+                readonly description: "The amount in integer cents.";
+            };
+            readonly recordedBy: {
+                readonly type: "string";
+                readonly description: "The ID of the user who recorded the amount.";
+            };
+            readonly recordedAt: {
+                readonly $ref: "definitions.json#/definitions/date";
+                readonly description: "When the amount was recorded.";
+            };
+        };
+    };
+    readonly actual: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["amount", "recordedBy", "recordedAt"];
+        readonly description: string;
+        readonly properties: {
+            readonly amount: {
+                readonly type: "integer";
+                readonly minimum: 0;
+                readonly description: "The amount in integer cents.";
+            };
+            readonly recordedBy: {
+                readonly type: "string";
+                readonly description: "The ID of the user who recorded the amount.";
+            };
+            readonly recordedAt: {
+                readonly $ref: "definitions.json#/definitions/date";
+                readonly description: "When the amount was recorded.";
+            };
+        };
+    };
+    readonly markup: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["percent"];
+        readonly properties: {
+            readonly percent: {
+                readonly type: "number";
+                readonly description: string;
+            };
+            readonly custom: {
+                readonly type: "boolean";
+                readonly default: false;
+                readonly description: string;
+            };
+        };
+    };
+    readonly vendorId: {
+        readonly type: readonly ["string", "null"];
+        readonly default: null;
+        readonly description: string;
+    };
+    readonly categoryId: {
+        readonly type: readonly ["string", "null"];
+        readonly default: null;
+        readonly description: string;
+    };
+    readonly vendorInvoices: {
+        readonly type: "array";
+        readonly items: {
+            readonly $ref: "mediaFile.json";
+        };
+        readonly default: readonly [];
+        readonly description: string;
+    };
+    readonly vendorInvoiceNumber: {
+        readonly type: readonly ["string", "null"];
+        readonly default: null;
+        readonly description: string;
+    };
+    readonly billId: {
+        readonly type: readonly ["string", "null"];
+        readonly default: null;
+        readonly description: string;
+    };
+    readonly writtenOff: {
+        readonly type: "boolean";
+        readonly default: false;
+        readonly description: string;
+    };
+    readonly billingReview: {
+        readonly type: "array";
+        readonly default: readonly [];
+        readonly description: string;
+        readonly items: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["id", "action", "performedAt"];
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                    readonly description: "The ID of the billing review entry.";
+                };
+                readonly action: {
+                    readonly type: "string";
+                    readonly enum: readonly ["writtenOff", "reinstated", "divergenceAcknowledged"];
+                };
+                readonly performedBy: {
+                    readonly type: readonly ["string", "null"];
+                    readonly default: null;
+                    readonly description: string;
+                };
+                readonly performedAt: {
+                    readonly $ref: "definitions.json#/definitions/date";
+                    readonly description: "When the entry was appended.";
+                };
+                readonly note: {
+                    readonly type: readonly ["string", "null"];
+                    readonly default: null;
+                    readonly description: "Free-text rationale for the action.";
+                };
+                readonly billedAmount: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: string;
+                };
+                readonly priceAmount: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: string;
+                };
+            };
+        };
+    };
+};

package/dist/schemas/costEntry.js

@@ -0,0 +1,162 @@
+//#region .generated/schemas/costEntry.ts
+const money = (description) => ({
+	type: "object",
+	additionalProperties: false,
+	required: [
+		"amount",
+		"recordedBy",
+		"recordedAt"
+	],
+	description,
+	properties: {
+		amount: {
+			type: "integer",
+			minimum: 0,
+			description: "The amount in integer cents."
+		},
+		recordedBy: {
+			type: "string",
+			description: "The ID of the user who recorded the amount."
+		},
+		recordedAt: {
+			$ref: "definitions.json#/definitions/date",
+			description: "When the amount was recorded."
+		}
+	}
+});
+/**
+* The append-only billing review history, over whichever actions the host
+* admits. A ticket cost can be voided (withdrawn from the customer); a
+* standalone cost has no ticket to withdraw it from, so its history stops at
+* write-offs and divergence acknowledgements.
+*/
+const costBillingReview = (actions) => ({
+	type: "array",
+	default: [],
+	description: "Append-only billing review history for the entry (approval-history pattern): reversible write-offs, and billed-vs-price divergence acknowledgements. Internal, redacted org-side.",
+	items: {
+		type: "object",
+		additionalProperties: false,
+		required: [
+			"id",
+			"action",
+			"performedAt"
+		],
+		properties: {
+			id: {
+				type: "string",
+				description: "The ID of the billing review entry."
+			},
+			action: {
+				type: "string",
+				enum: actions
+			},
+			performedBy: {
+				type: ["string", "null"],
+				default: null,
+				description: "The ID of the user whose write appended this entry. Null when the write was not user-attributable."
+			},
+			performedAt: {
+				$ref: "definitions.json#/definitions/date",
+				description: "When the entry was appended."
+			},
+			note: {
+				type: ["string", "null"],
+				default: null,
+				description: "Free-text rationale for the action."
+			},
+			billedAmount: {
+				type: "integer",
+				minimum: 0,
+				description: "divergenceAcknowledged only: the amount a bill line already charged for this entry, in integer cents, frozen at ack time."
+			},
+			priceAmount: {
+				type: "integer",
+				minimum: 0,
+				description: "divergenceAcknowledged only: the entry's stored customer price in integer cents at ack time. A divergence is a billed line that no longer matches the price behind it — a price corrected after the cost was claimed — so the ack silences this one pair and any later price move re-flags it. A vendor actual arriving after billing is not a divergence: it moves margin, not what the customer owes."
+			}
+		}
+	}
+});
+const costEntryRequired = [
+	"id",
+	"description",
+	"currency",
+	"price",
+	"estimate",
+	"markup"
+];
+const costEntryProperties = {
+	id: {
+		type: "string",
+		description: "The ID of the cost entry."
+	},
+	description: {
+		type: "string",
+		description: "What the cost covers."
+	},
+	currency: {
+		type: "string",
+		default: "USD",
+		description: "ISO 4217 currency code of the entry's amounts."
+	},
+	price: money("The authoritative customer price — what the org is charged, what the approval gate totals, and what a bill line bills. Seeded at recording from the estimate and the markup, and from then on independent of all three: editing `estimate`, `actual`, or `markup` never moves it. Only an explicit price write does."),
+	estimate: money("The vendor cost estimate phase of the entry."),
+	actual: money("The settled vendor cost, recorded once the vendor's figure is known."),
+	markup: {
+		type: "object",
+		additionalProperties: false,
+		required: ["percent"],
+		properties: {
+			percent: {
+				type: "number",
+				description: "Markup percent the price was derived at, uncapped in either direction. Context for how the price was arrived at, not the source of truth for any amount: `price` is stored, so re-keying this percent prices nothing. A biller may charge under the vendor cost as a deliberate comp, and this records that as the negative percent it is rather than as a floor of zero the price never came from."
+			},
+			custom: {
+				type: "boolean",
+				default: false,
+				description: "Whether the percent was overridden by hand rather than keyed from the configured markup tiers. Custom percents are never re-keyed on estimate edits."
+			}
+		}
+	},
+	vendorId: {
+		type: ["string", "null"],
+		default: null,
+		description: "The Vendor the charge is owed to. A plain reference — no rollups — resolved inside the entry's own organization. Internal, redacted org-side with the rest of the cost split."
+	},
+	categoryId: {
+		type: ["string", "null"],
+		default: null,
+		description: "The billing category classifying this cost. `AddBillLine` snapshots it onto the claiming line, which owns its own category from then on. Internal, redacted org-side with the rest of the cost split."
+	},
+	vendorInvoices: {
+		type: "array",
+		items: { $ref: "mediaFile.json" },
+		default: [],
+		description: "The vendor's paperwork backing the entry's amounts — an invoice plus whatever came with it. Internal: the file-store cannot enforce roster-only reads, so the boundary is this field living on the full shape only, and the redacted projection never carries it."
+	},
+	vendorInvoiceNumber: {
+		type: ["string", "null"],
+		default: null,
+		description: "The vendor's own invoice number. Internal, redacted org-side like the rest of the cost split."
+	},
+	billId: {
+		type: ["string", "null"],
+		default: null,
+		description: "Backlink to the bill whose draft claimed this cost as a line. Written when a draft bill adds the line, cleared on line removal, draft delete, or bill void; a claimed cost leaves the uninvoiced pool, making double-invoicing structurally impossible. Server-maintained at the repository, never set by clients."
+	},
+	writtenOff: {
+		type: "boolean",
+		default: false,
+		description: "Server-maintained denormalization of billingReview (approvalState pattern): true after a writtenOff entry until a reinstated entry follows. A written-off cost leaves the uninvoiced pool. Never set by clients."
+	},
+	billingReview: costBillingReview([
+		"writtenOff",
+		"reinstated",
+		"divergenceAcknowledged"
+	])
+};
+//#endregion
+export { costBillingReview, costEntryProperties, costEntryRequired };
+
+//# sourceMappingURL=costEntry.js.map

package/dist/schemas/costEntry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"costEntry.js","names":[],"sources":["../../.generated/schemas/costEntry.ts"],"sourcesContent":["// The cost-entry core: the money shape and reconciliation lifecycle every\n// OneBill cost carries, whether a Ticket embeds it or it stands alone in the\n// costs collection. Both hosts spread these consts into their own `properties`\n// and `required` rather than `$ref`-ing this file: draft-07 resolves `allOf`\n// against `additionalProperties: false` per subschema, so a composed entry\n// would reject every field the other half declared, and `FromSchema` derives\n// nothing useful from a reference it cannot inline.\n//\n// Nothing here is exported with a name ending in \"Schema\" and the model\n// generator skips this file by name (`scripts/generate-source-models.js`):\n// these are fragments, not an entity.\n\nconst money = (description: string) =>\n  ({\n    type: \"object\",\n    additionalProperties: false,\n    required: [\"amount\", \"recordedBy\", \"recordedAt\"],\n    description,\n    properties: {\n      amount: {\n        type: \"integer\",\n        minimum: 0,\n        description: \"The amount in integer cents.\",\n      },\n      recordedBy: {\n        type: \"string\",\n        description: \"The ID of the user who recorded the amount.\",\n      },\n      recordedAt: {\n        $ref: \"definitions.json#/definitions/date\",\n        description: \"When the amount was recorded.\",\n      },\n    },\n  }) as const;\n\n/**\n * The append-only billing review history, over whichever actions the host\n * admits. A ticket cost can be voided (withdrawn from the customer); a\n * standalone cost has no ticket to withdraw it from, so its history stops at\n * write-offs and divergence acknowledgements.\n */\nexport const costBillingReview = <const Actions extends readonly string[]>(\n  actions: Actions,\n) =>\n  ({\n    type: \"array\",\n    default: [],\n    description:\n      \"Append-only billing review history for the entry (approval-history \" +\n      \"pattern): reversible write-offs, and billed-vs-price divergence \" +\n      \"acknowledgements. Internal, redacted org-side.\",\n    items: {\n      type: \"object\",\n      additionalProperties: false,\n      required: [\"id\", \"action\", \"performedAt\"],\n      properties: {\n        id: {\n          type: \"string\",\n          description: \"The ID of the billing review entry.\",\n        },\n        action: {\n          type: \"string\",\n          enum: actions,\n        },\n        performedBy: {\n          type: [\"string\", \"null\"],\n          default: null,\n          description:\n            \"The ID of the user whose write appended this entry. Null when \" +\n            \"the write was not user-attributable.\",\n        },\n        performedAt: {\n          $ref: \"definitions.json#/definitions/date\",\n          description: \"When the entry was appended.\",\n        },\n        note: {\n          type: [\"string\", \"null\"],\n          default: null,\n          description: \"Free-text rationale for the action.\",\n        },\n        billedAmount: {\n          type: \"integer\",\n          minimum: 0,\n          description:\n            \"divergenceAcknowledged only: the amount a bill line already \" +\n            \"charged for this entry, in integer cents, frozen at ack time.\",\n        },\n        priceAmount: {\n          type: \"integer\",\n          minimum: 0,\n          description:\n            \"divergenceAcknowledged only: the entry's stored customer price \" +\n            \"in integer cents at ack time. A divergence is a billed line \" +\n            \"that no longer matches the price behind it — a price corrected \" +\n            \"after the cost was claimed — so the ack silences this one pair \" +\n            \"and any later price move re-flags it. A vendor actual arriving \" +\n            \"after billing is not a divergence: it moves margin, not what \" +\n            \"the customer owes.\",\n        },\n      },\n    },\n  }) as const;\n\nexport const costEntryRequired = [\n  \"id\",\n  \"description\",\n  \"currency\",\n  \"price\",\n  \"estimate\",\n  \"markup\",\n] as const;\n\nexport const costEntryProperties = {\n  id: {\n    type: \"string\",\n    description: \"The ID of the cost entry.\",\n  },\n  description: {\n    type: \"string\",\n    description: \"What the cost covers.\",\n  },\n  currency: {\n    type: \"string\",\n    default: \"USD\",\n    description: \"ISO 4217 currency code of the entry's amounts.\",\n  },\n  price: money(\n    \"The authoritative customer price — what the org is charged, what the \" +\n      \"approval gate totals, and what a bill line bills. Seeded at recording \" +\n      \"from the estimate and the markup, and from then on independent of all \" +\n      \"three: editing `estimate`, `actual`, or `markup` never moves it. Only \" +\n      \"an explicit price write does.\",\n  ),\n  estimate: money(\"The vendor cost estimate phase of the entry.\"),\n  actual: money(\n    \"The settled vendor cost, recorded once the vendor's figure is known.\",\n  ),\n  markup: {\n    type: \"object\",\n    additionalProperties: false,\n    required: [\"percent\"],\n    properties: {\n      percent: {\n        type: \"number\",\n        description:\n          \"Markup percent the price was derived at, uncapped in either \" +\n          \"direction. Context for how the price was arrived at, not the \" +\n          \"source of truth for any amount: `price` is stored, so re-keying \" +\n          \"this percent prices nothing. A biller may charge under the vendor \" +\n          \"cost as a deliberate comp, and this records that as the negative \" +\n          \"percent it is rather than as a floor of zero the price never came \" +\n          \"from.\",\n      },\n      custom: {\n        type: \"boolean\",\n        default: false,\n        description:\n          \"Whether the percent was overridden by hand rather than keyed from \" +\n          \"the configured markup tiers. Custom percents are never re-keyed on \" +\n          \"estimate edits.\",\n      },\n    },\n  },\n  vendorId: {\n    type: [\"string\", \"null\"],\n    default: null,\n    description:\n      \"The Vendor the charge is owed to. A plain reference — no rollups — \" +\n      \"resolved inside the entry's own organization. Internal, redacted \" +\n      \"org-side with the rest of the cost split.\",\n  },\n  categoryId: {\n    type: [\"string\", \"null\"],\n    default: null,\n    description:\n      \"The billing category classifying this cost. `AddBillLine` snapshots \" +\n      \"it onto the claiming line, which owns its own category from then on. \" +\n      \"Internal, redacted org-side with the rest of the cost split.\",\n  },\n  vendorInvoices: {\n    type: \"array\",\n    items: { $ref: \"mediaFile.json\" },\n    default: [],\n    description:\n      \"The vendor's paperwork backing the entry's amounts — an invoice plus \" +\n      \"whatever came with it. Internal: the file-store cannot enforce \" +\n      \"roster-only reads, so the boundary is this field living on the full \" +\n      \"shape only, and the redacted projection never carries it.\",\n  },\n  vendorInvoiceNumber: {\n    type: [\"string\", \"null\"],\n    default: null,\n    description:\n      \"The vendor's own invoice number. Internal, redacted org-side like the \" +\n      \"rest of the cost split.\",\n  },\n  billId: {\n    type: [\"string\", \"null\"],\n    default: null,\n    description:\n      \"Backlink to the bill whose draft claimed this cost as a line. Written \" +\n      \"when a draft bill adds the line, cleared on line removal, draft \" +\n      \"delete, or bill void; a claimed cost leaves the uninvoiced pool, \" +\n      \"making double-invoicing structurally impossible. Server-maintained at \" +\n      \"the repository, never set by clients.\",\n  },\n  writtenOff: {\n    type: \"boolean\",\n    default: false,\n    description:\n      \"Server-maintained denormalization of billingReview (approvalState \" +\n      \"pattern): true after a writtenOff entry until a reinstated entry \" +\n      \"follows. A written-off cost leaves the uninvoiced pool. Never set by \" +\n      \"clients.\",\n  },\n  billingReview: costBillingReview([\n    \"writtenOff\",\n    \"reinstated\",\n    \"divergenceAcknowledged\",\n  ]),\n} as const;\n"],"mappings":";AAYA,MAAM,SAAS,iBACZ;CACC,MAAM;CACN,sBAAsB;CACtB,UAAU;EAAC;EAAU;EAAc;CAAY;CAC/C;CACA,YAAY;EACV,QAAQ;GACN,MAAM;GACN,SAAS;GACT,aAAa;EACf;EACA,YAAY;GACV,MAAM;GACN,aAAa;EACf;EACA,YAAY;GACV,MAAM;GACN,aAAa;EACf;CACF;AACF;;;;;;;AAQF,MAAa,qBACX,aAEC;CACC,MAAM;CACN,SAAS,CAAC;CACV,aACE;CAGF,OAAO;EACL,MAAM;EACN,sBAAsB;EACtB,UAAU;GAAC;GAAM;GAAU;EAAa;EACxC,YAAY;GACV,IAAI;IACF,MAAM;IACN,aAAa;GACf;GACA,QAAQ;IACN,MAAM;IACN,MAAM;GACR;GACA,aAAa;IACX,MAAM,CAAC,UAAU,MAAM;IACvB,SAAS;IACT,aACE;GAEJ;GACA,aAAa;IACX,MAAM;IACN,aAAa;GACf;GACA,MAAM;IACJ,MAAM,CAAC,UAAU,MAAM;IACvB,SAAS;IACT,aAAa;GACf;GACA,cAAc;IACZ,MAAM;IACN,SAAS;IACT,aACE;GAEJ;GACA,aAAa;IACX,MAAM;IACN,SAAS;IACT,aACE;GAOJ;EACF;CACF;AACF;AAEF,MAAa,oBAAoB;CAC/B;CACA;CACA;CACA;CACA;CACA;AACF;AAEA,MAAa,sBAAsB;CACjC,IAAI;EACF,MAAM;EACN,aAAa;CACf;CACA,aAAa;EACX,MAAM;EACN,aAAa;CACf;CACA,UAAU;EACR,MAAM;EACN,SAAS;EACT,aAAa;CACf;CACA,OAAO,MACL,sTAKF;CACA,UAAU,MAAM,8CAA8C;CAC9D,QAAQ,MACN,sEACF;CACA,QAAQ;EACN,MAAM;EACN,sBAAsB;EACtB,UAAU,CAAC,SAAS;EACpB,YAAY;GACV,SAAS;IACP,MAAM;IACN,aACE;GAOJ;GACA,QAAQ;IACN,MAAM;IACN,SAAS;IACT,aACE;GAGJ;EACF;CACF;CACA,UAAU;EACR,MAAM,CAAC,UAAU,MAAM;EACvB,SAAS;EACT,aACE;CAGJ;CACA,YAAY;EACV,MAAM,CAAC,UAAU,MAAM;EACvB,SAAS;EACT,aACE;CAGJ;CACA,gBAAgB;EACd,MAAM;EACN,OAAO,EAAE,MAAM,iBAAiB;EAChC,SAAS,CAAC;EACV,aACE;CAIJ;CACA,qBAAqB;EACnB,MAAM,CAAC,UAAU,MAAM;EACvB,SAAS;EACT,aACE;CAEJ;CACA,QAAQ;EACN,MAAM,CAAC,UAAU,MAAM;EACvB,SAAS;EACT,aACE;CAKJ;CACA,YAAY;EACV,MAAM;EACN,SAAS;EACT,aACE;CAIJ;CACA,eAAe,kBAAkB;EAC/B;EACA;EACA;CACF,CAAC;AACH"}

package/dist/schemas/definitions.d.ts

@@ -93,7 +93,7 @@ declare const defs: {
         readonly driver: {
             readonly type: "string";
             readonly description: "Driver used to communicate with the object.";
-            readonly enum: readonly ["adlink", "apex-american-audio", "avigilon-alta", "aws-kinesis", "bacnet", "benq", "butler", "comelit", "cool-automation", "crestron", "dell", "digital-watchdog", "distech", "dmp", "doorbird", "dormakaba", "dsc", "dsc-itv2", "earbridge", "ecobee", "epson", "geovision-rs", "geovision-as-manager", "hanwha", "honeywell-vista", "honeywell-resideo", "igor", "inncom", "isapi", "kohost-k7", "kohost", "lapi", "lg", "lg-webos", "linortek", "lirc", "mews", "mht", "mobile-mule", "mock", "modbus", "napco", "newline", "obix", "one-roster", "onvif", "orchid-fusion", "paxton", "pdk", "pelican-wireless", "power-shades", "rachio", "rebrandly", "relay", "reolink", "rtsp", "salto", "salto-irn", "samsung", "se", "sendgrid", "singlewire", "smartboard", "sonifi", "stay-n-touch", "storable", "twilio", "unifi", "valcom", "veracross", "verkada", "vivotek", "vizio", "wisenet", "zkteco", "cloudflare-images", "cloudflare-stream", "insperia-privacy"];
+            readonly enum: readonly ["adlink", "apex-american-audio", "avigilon-alta", "aws-kinesis", "bacnet", "benq", "butler", "comelit", "cool-automation", "crestron", "dell", "digital-watchdog", "distech", "dmp", "doorbird", "dormakaba", "dsc", "dsc-itv2", "earbridge", "ecobee", "epson", "geovision-rs", "geovision-as-manager", "hanwha", "honeywell-vista", "honeywell-resideo", "honeywell-total-connect", "igor", "inncom", "isapi", "kohost-k7", "kohost", "lapi", "lg", "lg-webos", "linortek", "lirc", "mews", "mht", "mobile-mule", "mock", "modbus", "napco", "newline", "obix", "one-roster", "onvif", "orchid-fusion", "paxton", "pdk", "pelican-wireless", "power-shades", "rachio", "rebrandly", "relay", "reolink", "rtsp", "salto", "salto-irn", "samsung", "se", "sendgrid", "singlewire", "smartboard", "sonifi", "stay-n-touch", "storable", "twilio", "unifi", "valcom", "veracross", "verkada", "vivotek", "vizio", "wisenet", "zkteco", "cloudflare-images", "cloudflare-stream", "insperia-privacy"];
         };
         readonly type: {
             readonly type: "string";

package/dist/schemas/definitions.js

@@ -150,6 +150,7 @@ const defs = {
 				"hanwha",
 				"honeywell-vista",
 				"honeywell-resideo",
+				"honeywell-total-connect",
 				"igor",
 				"inncom",
 				"isapi",

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        \"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;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 * `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        \"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;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

@@ -60,6 +60,18 @@ export declare const emailMessageSchema: {
         readonly replyTo: {
             readonly type: readonly ["string", "array"];
         };
+        readonly cc: {
+            readonly type: readonly ["string", "array"];
+            readonly items: {
+                readonly type: "string";
+            };
+        };
+        readonly bcc: {
+            readonly type: readonly ["string", "array"];
+            readonly items: {
+                readonly type: "string";
+            };
+        };
         readonly appData: {
             readonly type: "object";
             readonly additionalProperties: true;

package/dist/schemas/emailMessage.js

@@ -63,6 +63,14 @@ const emailMessageSchema = {
 			description: "Additional headers for the email message, key/value pairs"
 		},
 		replyTo: { type: ["string", "array"] },
+		cc: {
+			type: ["string", "array"],
+			items: { type: "string" }
+		},
+		bcc: {
+			type: ["string", "array"],
+			items: { type: "string" }
+		},
 		appData: {
 			type: "object",
 			additionalProperties: true,

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    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"}
+{"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    cc: {\n      type: [\"string\", \"array\"],\n      items: { type: \"string\" },\n    },\n    bcc: {\n      type: [\"string\", \"array\"],\n      items: { type: \"string\" },\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,IAAI;GACF,MAAM,CAAC,UAAU,OAAO;GACxB,OAAO,EAAE,MAAM,SAAS;EAC1B;EACA,KAAK;GACH,MAAM,CAAC,UAAU,OAAO;GACxB,OAAO,EAAE,MAAM,SAAS;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

@@ -2,25 +2,26 @@ export { alarmSchema, type AlarmSchema } from "./alarm.js";
 export { announcementSchema, type AnnouncementSchema } from "./announcement.js";
 export { automationSchema, type AutomationSchema } from "./automation.js";
 export { billSchema, type BillSchema, type BillLine } from "./bill.js";
-export { billingCategorySchema, type BillingCategorySchema } from "./billingCategory.js";
+export { billingCategorySchema, type BillingCategorySchema, } from "./billingCategory.js";
 export { cameraSchema, type CameraSchema } from "./camera.js";
 export { categorySchema, type CategorySchema } from "./category.js";
+export { costSchema, type CostSchema, type CostBillingReviewEntry, } from "./cost.js";
 export { courtesySchema, type CourtesySchema } from "./courtesy.js";
 export { credentialSchema, type CredentialSchema } from "./credential.js";
 export { departmentSchema, type DepartmentSchema } from "./department.js";
 export { dimmerSchema, type DimmerSchema } from "./dimmer.js";
-export { discoveredDeviceSchema, type DiscoveredDeviceSchema } from "./discoveredDevice.js";
+export { discoveredDeviceSchema, type DiscoveredDeviceSchema, } from "./discoveredDevice.js";
 export { emailMessageSchema, type EmailMessageSchema } from "./emailMessage.js";
 export { energyReportSchema, type EnergyReportSchema } from "./energyReport.js";
-export { energyReportShardSchema, type EnergyReportShardSchema } from "./energyReportShard.js";
+export { energyReportShardSchema, type EnergyReportShardSchema, } from "./energyReportShard.js";
 export { gatewaySchema, type GatewaySchema } from "./gateway.js";
 export { groupSchema, type GroupSchema } from "./group.js";
-export { identificationSchema, type IdentificationSchema } from "./identification.js";
+export { identificationSchema, type IdentificationSchema, } from "./identification.js";
 export { integrationSchema, type IntegrationSchema } from "./integration.js";
 export { issueSchema, type IssueSchema } from "./issue.js";
 export { lockSchema, type LockSchema } from "./lock.js";
 export { logSchema, type LogSchema } from "./log.js";
-export { mediaFileSchema, type MediaFileSchema, methods as mediaFileMethods } from "./mediaFile.js";
+export { mediaFileSchema, type MediaFileSchema, methods as mediaFileMethods, } from "./mediaFile.js";
 export { mediaSourceSchema, type MediaSourceSchema } from "./mediaSource.js";
 export { motionSensorSchema, type MotionSensorSchema } from "./motionSensor.js";
 export { notificationSchema, type NotificationSchema } from "./notification.js";
@@ -46,4 +47,4 @@ export { ticketSchema, type TicketSchema } from "./ticket.js";
 export { timeSheetSchema, type TimeSheetSchema } from "./timeSheet.js";
 export { userSchema, type UserSchema, getters as userGetters } from "./user.js";
 export { vendorSchema, type VendorSchema } from "./vendor.js";
-export { windowCoveringSchema, type WindowCoveringSchema } from "./windowCovering.js";
+export { windowCoveringSchema, type WindowCoveringSchema, } from "./windowCovering.js";

package/dist/schemas/index.js

@@ -5,6 +5,7 @@ import { billSchema } from "./bill.js";
 import { billingCategorySchema } from "./billingCategory.js";
 import { cameraSchema } from "./camera.js";
 import { categorySchema } from "./category.js";
+import { costSchema } from "./cost.js";
 import { courtesySchema } from "./courtesy.js";
 import { credentialSchema } from "./credential.js";
 import { departmentSchema } from "./department.js";
@@ -47,4 +48,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, resourceSchema, serverSchema, sessionSchema, shortLinkSchema, smsMessageSchema, sosEventSchema, sosTypeSchema, spaceSchema, switchSchema, systemSchema, systemUserSchema, thermostatSchema, ticketSchema, timeSheetSchema, getters as userGetters, userSchema, vendorSchema, windowCoveringSchema };
+export { alarmSchema, announcementSchema, automationSchema, billSchema, billingCategorySchema, cameraSchema, categorySchema, costSchema, 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 };