@kohost/api-client 7.12.0 → 7.14.0

package/dist/schemas/ticket.d.ts

@@ -693,7 +693,7 @@ export declare const ticketSchema: {
                                 readonly amount: {
                                     readonly type: "integer";
                                     readonly minimum: 0;
-                                    readonly description: "Customer price in integer cents.";
+                                    readonly description: "The amount in integer cents.";
                                 };
                                 readonly recordedBy: {
                                     readonly type: "string";
@@ -709,12 +709,12 @@ export declare const ticketSchema: {
                             readonly type: "object";
                             readonly additionalProperties: false;
                             readonly required: readonly ["amount", "recordedBy", "recordedAt"];
-                            readonly description: "The vendor cost estimate phase of the entry.";
+                            readonly description: string;
                             readonly properties: {
                                 readonly amount: {
                                     readonly type: "integer";
                                     readonly minimum: 0;
-                                    readonly description: "Vendor cost estimate in integer cents.";
+                                    readonly description: "The amount in integer cents.";
                                 };
                                 readonly recordedBy: {
                                     readonly type: "string";
@@ -730,12 +730,12 @@ export declare const ticketSchema: {
                             readonly type: "object";
                             readonly additionalProperties: false;
                             readonly required: readonly ["amount", "recordedBy", "recordedAt"];
-                            readonly description: "The actual vendor cost phase of the entry, recorded after the work.";
+                            readonly description: string;
                             readonly properties: {
                                 readonly amount: {
                                     readonly type: "integer";
                                     readonly minimum: 0;
-                                    readonly description: "Actual vendor cost in integer cents.";
+                                    readonly description: "The amount in integer cents.";
                                 };
                                 readonly recordedBy: {
                                     readonly type: "string";
@@ -754,40 +754,34 @@ export declare const ticketSchema: {
                             readonly properties: {
                                 readonly percent: {
                                     readonly type: "number";
-                                    readonly minimum: 0;
                                     readonly description: string;
                                 };
                                 readonly custom: {
                                     readonly type: "boolean";
                                     readonly default: false;
-                                    readonly description: "Whether the percent was manually overridden rather than keyed from the configured markup tiers. Custom percents are never re-keyed on estimate edits.";
+                                    readonly description: string;
                                 };
                             };
                         };
-                        readonly vendorInvoices: {
-                            readonly type: "array";
-                            readonly items: {
-                                readonly $ref: "mediaFile.json";
-                            };
-                            readonly default: readonly [];
-                            readonly description: string;
-                        };
-                        readonly vendorInvoiceNumber: {
+                        readonly vendorId: {
                             readonly type: readonly ["string", "null"];
                             readonly default: null;
                             readonly description: string;
                         };
-                        readonly vendorId: {
+                        readonly categoryId: {
                             readonly type: readonly ["string", "null"];
                             readonly default: null;
                             readonly description: string;
                         };
-                        readonly workItemId: {
-                            readonly type: readonly ["string", "null"];
-                            readonly default: null;
+                        readonly vendorInvoices: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly $ref: "mediaFile.json";
+                            };
+                            readonly default: readonly [];
                             readonly description: string;
                         };
-                        readonly categoryId: {
+                        readonly vendorInvoiceNumber: {
                             readonly type: readonly ["string", "null"];
                             readonly default: null;
                             readonly description: string;
@@ -802,11 +796,6 @@ export declare const ticketSchema: {
                             readonly default: false;
                             readonly description: string;
                         };
-                        readonly voided: {
-                            readonly type: "boolean";
-                            readonly default: false;
-                            readonly description: string;
-                        };
                         readonly billingReview: {
                             readonly type: "array";
                             readonly default: readonly [];
@@ -851,6 +840,16 @@ export declare const ticketSchema: {
                                 };
                             };
                         };
+                        readonly workItemId: {
+                            readonly type: readonly ["string", "null"];
+                            readonly default: null;
+                            readonly description: string;
+                        };
+                        readonly voided: {
+                            readonly type: "boolean";
+                            readonly default: false;
+                            readonly description: string;
+                        };
                     };
                 }, {
                     readonly type: "object";

package/dist/schemas/ticket.js

@@ -1,3 +1,4 @@
+import { costBillingReview, costEntryProperties, costEntryRequired } from "./costEntry.js";
 //#region .generated/schemas/ticket.ts
 const richTextInlineNodes = {
 	type: "array",
@@ -91,6 +92,62 @@ const richTextListItemNode = {
 		content: richTextInlineNodes
 	}
 };
+const richTextBulletListNode = {
+	type: "object",
+	additionalProperties: false,
+	required: ["type", "content"],
+	properties: {
+		type: {
+			type: "string",
+			enum: ["bulletList"]
+		},
+		content: {
+			type: "array",
+			minItems: 1,
+			items: richTextListItemNode
+		}
+	}
+};
+const richTextOrderedListNode = {
+	type: "object",
+	additionalProperties: false,
+	required: ["type", "content"],
+	properties: {
+		type: {
+			type: "string",
+			enum: ["orderedList"]
+		},
+		content: {
+			type: "array",
+			minItems: 1,
+			items: richTextListItemNode
+		}
+	}
+};
+const fullCostEntrySchema = {
+	type: "object",
+	additionalProperties: false,
+	required: costEntryRequired,
+	properties: {
+		...costEntryProperties,
+		billingReview: costBillingReview([
+			"writtenOff",
+			"voided",
+			"reinstated",
+			"divergenceAcknowledged"
+		]),
+		workItemId: {
+			type: ["string", "null"],
+			default: null,
+			description: "The Work item on this ticket that produced the cost. Many entries may name one visit, so a single trip's labor and materials can be itemized. Cleared when the Work item is removed — the money record outlives the scheduling record. Internal, redacted org-side."
+		},
+		voided: {
+			type: "boolean",
+			default: false,
+			description: "Server-maintained denormalization of billingReview (writtenOff pattern): true after a voided entry until a reinstated entry follows. A voided cost is withdrawn: it counts toward neither the approval gate nor financial completion and leaves the uninvoiced pool, but stays on the ticket so every viewer sees it was voided. Never set by clients."
+		}
+	}
+};
 const ticketSchema = {
 	$schema: "http://json-schema.org/draft-07/schema",
 	$id: "ticket.json",
@@ -233,38 +290,8 @@ const ticketSchema = {
 								description: "Rich-text block nodes (ADR 0012). Present = rich message: `body` is the server-derived plain-text projection of this tree, and the legacy text/mentions fields are not written.",
 								items: { anyOf: [
 									richTextParagraphNode,
-									{
-										type: "object",
-										additionalProperties: false,
-										required: ["type", "content"],
-										properties: {
-											type: {
-												type: "string",
-												enum: ["bulletList"]
-											},
-											content: {
-												type: "array",
-												minItems: 1,
-												items: richTextListItemNode
-											}
-										}
-									},
-									{
-										type: "object",
-										additionalProperties: false,
-										required: ["type", "content"],
-										properties: {
-											type: {
-												type: "string",
-												enum: ["orderedList"]
-											},
-											content: {
-												type: "array",
-												minItems: 1,
-												items: richTextListItemNode
-											}
-										}
-									}
+									richTextBulletListNode,
+									richTextOrderedListNode
 								] }
 							},
 							text: {
@@ -635,219 +662,7 @@ const ticketSchema = {
 			type: "array",
 			default: [],
 			description: "Cost line items recorded on the ticket. Each entry stores the customer price and the vendor cost side by side and keeps them independent: the price is seeded from the estimate and markup at recording, and nothing about the vendor side moves it afterwards. Every entry arrives as either the full vendor shape or the redacted price-only shape depending on whether the viewer may see the cost split.",
-			items: { oneOf: [{
-				type: "object",
-				additionalProperties: false,
-				required: [
-					"id",
-					"description",
-					"currency",
-					"price",
-					"estimate",
-					"markup"
-				],
-				properties: {
-					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: {
-						type: "object",
-						additionalProperties: false,
-						required: [
-							"amount",
-							"recordedBy",
-							"recordedAt"
-						],
-						description: "The authoritative customer price of the entry — 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.",
-						properties: {
-							amount: {
-								type: "integer",
-								minimum: 0,
-								description: "Customer price 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."
-							}
-						}
-					},
-					estimate: {
-						type: "object",
-						additionalProperties: false,
-						required: [
-							"amount",
-							"recordedBy",
-							"recordedAt"
-						],
-						description: "The vendor cost estimate phase of the entry.",
-						properties: {
-							amount: {
-								type: "integer",
-								minimum: 0,
-								description: "Vendor cost estimate 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."
-							}
-						}
-					},
-					actual: {
-						type: "object",
-						additionalProperties: false,
-						required: [
-							"amount",
-							"recordedBy",
-							"recordedAt"
-						],
-						description: "The actual vendor cost phase of the entry, recorded after the work.",
-						properties: {
-							amount: {
-								type: "integer",
-								minimum: 0,
-								description: "Actual vendor cost 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."
-							}
-						}
-					},
-					markup: {
-						type: "object",
-						additionalProperties: false,
-						required: ["percent"],
-						properties: {
-							percent: {
-								type: "number",
-								minimum: 0,
-								description: "Markup percent the initial price was quoted at, uncapped. Context for how that quote was arrived at, not the source of truth for any amount: `price` is stored, so re-keying this percent prices nothing."
-							},
-							custom: {
-								type: "boolean",
-								default: false,
-								description: "Whether the percent was manually overridden rather than keyed from the configured markup tiers. Custom percents are never re-keyed on estimate edits."
-							}
-						}
-					},
-					vendorInvoices: {
-						type: "array",
-						items: { $ref: "mediaFile.json" },
-						default: [],
-						description: "The vendor's paperwork backing the entry's amounts, attached around recording the actual (or later) — 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 — 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."
-					},
-					vendorId: {
-						type: ["string", "null"],
-						default: null,
-						description: "The Vendor the cost came from. A plain reference — no rollups — recorded alongside the vendor invoice and redacted org-side with the rest of the cost split. Independent of `workItemId`: a vendor cost need not trace to a scheduled visit."
-					},
-					workItemId: {
-						type: ["string", "null"],
-						default: null,
-						description: "The Work item on this ticket that produced the cost. Many entries may name one visit, so a single trip's labor and materials can be itemized. Cleared when the Work item is removed — the money record outlives the scheduling record. Internal, redacted org-side."
-					},
-					categoryId: {
-						type: ["string", "null"],
-						default: null,
-						description: "The billing category classifying this cost, picked on the reconciliation pool before any bill claims the entry. `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."
-					},
-					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."
-					},
-					voided: {
-						type: "boolean",
-						default: false,
-						description: "Server-maintained denormalization of billingReview (writtenOff pattern): true after a voided entry until a reinstated entry follows. A voided cost is withdrawn: it counts toward neither the approval gate nor financial completion and leaves the uninvoiced pool, but stays on the ticket so every viewer sees it was voided. Never set by clients."
-					},
-					billingReview: {
-						type: "array",
-						default: [],
-						description: "Append-only billing review history for the entry (approval-history pattern): reversible write-offs and voids, 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: [
-										"writtenOff",
-										"voided",
-										"reinstated",
-										"divergenceAcknowledged"
-									]
-								},
-								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."
-								}
-							}
-						}
-					}
-				}
-			}, {
+			items: { oneOf: [fullCostEntrySchema, {
 				type: "object",
 				additionalProperties: false,
 				required: [