@serviceai/api-spec 1.2.432 → 1.2.434

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serviceai/api-spec",
-  "version": "1.2.432",
+  "version": "1.2.434",
   "description": "ServiceAi OpenAPI 3.1 contract + generated TS types. Auto-published from the desktop repo.",
   "main": "index.js",
   "types": "index.d.ts",

package/types.d.ts

@@ -746,6 +746,7 @@ export interface paths {
                             customFields?: string | number | boolean | null | {
                                 [key: string]: unknown;
                             } | unknown[];
+                            /** Format: date-time */
                             lastContactDate?: string | null;
                             parentContactId?: number | null;
                             relationship?: string | null;
@@ -771,9 +772,11 @@ export interface paths {
                             cachedLng?: number | null;
                             qboId?: string | null;
                             qboSyncToken?: string | null;
+                            /** Format: date-time */
                             qboLastPushedAt?: string | null;
                             qboLastPushedHash?: string | null;
                             qboLastError?: string | null;
+                            /** Format: date-time */
                             deletedAt?: string | null;
                             deletedBy?: string | null;
                         } & {
@@ -819,6 +822,7 @@ export interface paths {
                         customFields?: string | number | boolean | null | {
                             [key: string]: unknown;
                         } | unknown[];
+                        /** Format: date-time */
                         lastContactDate?: string | null;
                         parentContactId?: number | null;
                         relationship?: string | null;
@@ -844,9 +848,11 @@ export interface paths {
                         cachedLng?: number | null;
                         qboId?: string | null;
                         qboSyncToken?: string | null;
+                        /** Format: date-time */
                         qboLastPushedAt?: string | null;
                         qboLastPushedHash?: string | null;
                         qboLastError?: string | null;
+                        /** Format: date-time */
                         deletedAt?: string | null;
                         deletedBy?: string | null;
                     };
@@ -872,6 +878,7 @@ export interface paths {
                             customFields?: string | number | boolean | null | {
                                 [key: string]: unknown;
                             } | unknown[];
+                            /** Format: date-time */
                             lastContactDate?: string | null;
                             parentContactId?: number | null;
                             relationship?: string | null;
@@ -897,9 +904,11 @@ export interface paths {
                             cachedLng?: number | null;
                             qboId?: string | null;
                             qboSyncToken?: string | null;
+                            /** Format: date-time */
                             qboLastPushedAt?: string | null;
                             qboLastPushedHash?: string | null;
                             qboLastError?: string | null;
+                            /** Format: date-time */
                             deletedAt?: string | null;
                             deletedBy?: string | null;
                         } & {
@@ -1073,6 +1082,7 @@ export interface paths {
                                 };
                                 width: number;
                                 height: number;
+                                sillHeightM?: number;
                                 hostWallIndex?: number | null;
                                 wallIndex?: number;
                                 /** @enum {string} */
@@ -1095,6 +1105,7 @@ export interface paths {
                                 };
                                 width: number;
                                 height: number;
+                                sillHeightM?: number;
                                 hostWallIndex?: number | null;
                                 wallIndex?: number;
                                 /** @enum {string} */
@@ -1110,6 +1121,7 @@ export interface paths {
                                 };
                                 width: number;
                                 height: number;
+                                sillHeightM?: number;
                                 hostWallIndex?: number | null;
                                 wallIndex?: number;
                                 /** @enum {string} */
@@ -1211,6 +1223,7 @@ export interface paths {
                                     };
                                     width: number;
                                     height: number;
+                                    sillHeightM?: number;
                                     hostWallIndex?: number | null;
                                     wallIndex?: number;
                                     /** @enum {string} */
@@ -1233,6 +1246,7 @@ export interface paths {
                                     };
                                     width: number;
                                     height: number;
+                                    sillHeightM?: number;
                                     hostWallIndex?: number | null;
                                     wallIndex?: number;
                                     /** @enum {string} */
@@ -1248,6 +1262,7 @@ export interface paths {
                                     };
                                     width: number;
                                     height: number;
+                                    sillHeightM?: number;
                                     hostWallIndex?: number | null;
                                     wallIndex?: number;
                                     /** @enum {string} */
@@ -3649,6 +3664,174 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/sketches/{sketchId}/doorway-edits": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Save a confirmed shared-doorway edit atomically, or undo it.
+         * @description Requires authenticated organization and job access. Delete removes both linked openings and only their doorway connection. Undo receipts are user/scope-bound, expire after eight hours, and reject intervening geometry or connection changes. Connect is supported for sketches only. Room reads provide openingId and openingRevision; existing records are not backfilled.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    sketchId: number;
+                };
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": components["schemas"]["DoorwayEditCommand"];
+                };
+            };
+            responses: {
+                /** @description Committed both rooms and their connection changes; token reverses this action. */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["DoorwayEditResult"];
+                    };
+                };
+                /** @description Invalid command or missing explicit confirmation. */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+                /** @description Authentication required. */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Job access denied. */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Scope not found in the organization. */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Stale or ambiguous opening identity, or undo would overwrite newer work. */
+                409: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/floors/{floorId}/doorway-edits": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Save a confirmed shared-doorway edit atomically, or undo it.
+         * @description Requires authenticated organization and job access. Delete removes both linked openings and only their doorway connection. Undo receipts are user/scope-bound, expire after eight hours, and reject intervening geometry or connection changes. Connect is supported for sketches only. Room reads provide openingId and openingRevision; existing records are not backfilled.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    floorId: number;
+                };
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": components["schemas"]["DoorwayEditCommand"];
+                };
+            };
+            responses: {
+                /** @description Committed both rooms and their connection changes; token reverses this action. */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["DoorwayEditResult"];
+                    };
+                };
+                /** @description Invalid command or missing explicit confirmation. */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+                /** @description Authentication required. */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Job access denied. */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Scope not found in the organization. */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Stale or ambiguous opening identity, or undo would overwrite newer work. */
+                409: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorEnvelope"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
@@ -3673,7 +3856,7 @@ export interface components {
         };
         /** @description Cross-platform version handshake manifest. See docs/api-versioning.md. */
         VersionManifest: {
-            /** @example 1.2.432 */
+            /** @example 1.2.434 */
             apiVersion: string;
             /** @example 1.0.0 */
             minClientVersion: string;
@@ -3698,6 +3881,7 @@ export interface components {
             customFields?: string | number | boolean | null | {
                 [key: string]: unknown;
             } | unknown[];
+            /** Format: date-time */
             lastContactDate?: string | null;
             parentContactId?: number | null;
             relationship?: string | null;
@@ -3723,9 +3907,11 @@ export interface components {
             cachedLng?: number | null;
             qboId?: string | null;
             qboSyncToken?: string | null;
+            /** Format: date-time */
             qboLastPushedAt?: string | null;
             qboLastPushedHash?: string | null;
             qboLastError?: string | null;
+            /** Format: date-time */
             deletedAt?: string | null;
             deletedBy?: string | null;
         };
@@ -3790,25 +3976,35 @@ export interface components {
             deviceTrack?: string | number | boolean | null | {
                 [key: string]: unknown;
             } | unknown[];
-            referencePhotoKeys?: (string | null)[] | null;
+            referencePhotoKeys?: string[] | null;
             metricCorrection?: number | null;
             squareUpAngleRad?: number | null;
             clientMirrorApplied?: boolean | null;
             deviceModel?: string | null;
             appVersion?: string | null;
+            /** Format: date-time */
             captureTimestamp?: string | null;
             captureMode?: string | null;
             sessionId?: string | null;
+            /** Format: date-time */
             sessionCapturedAt?: string | null;
+            clientScanId?: string | null;
             floorPlanAssetId?: string | null;
             floorPlanPixelsPerMeter?: number | null;
             floorPlanOffsetX?: number | null;
             floorPlanOffsetY?: number | null;
             floorPlanWidthPx?: number | null;
             floorPlanHeightPx?: number | null;
+            sourceSketchId?: number | null;
+            takeoffPagePixelsPerMeter?: number | null;
+            takeoffPageOffsetX?: number | null;
+            takeoffPageOffsetY?: number | null;
+            takeoffPageWidthPx?: number | null;
+            takeoffPageHeightPx?: number | null;
             floorId?: number | null;
             shareToVendor?: boolean | null;
             createdBy?: string | null;
+            /** Format: date-time */
             deletedAt?: string | null;
             deletedBy?: string | null;
         };
@@ -3822,7 +4018,9 @@ export interface components {
             description?: string | null;
             taskType?: string | null;
             location?: string | null;
+            /** Format: date-time */
             startDate?: string | null;
+            /** Format: date-time */
             dueDate?: string | null;
             allDay?: boolean | null;
             status?: string | null;
@@ -3847,14 +4045,17 @@ export interface components {
             isRecurring?: boolean | null;
             recurrencePattern?: string | null;
             recurrenceInterval?: number | null;
+            /** Format: date-time */
             recurrenceEndDate?: string | null;
             parentTaskId?: number | null;
+            /** Format: date-time */
             recurrenceDate?: string | null;
             isRecurrenceException?: boolean | null;
             excludedDates?: string | number | boolean | null | {
                 [key: string]: unknown;
             } | unknown[];
             displayIndex?: number | null;
+            /** Format: date-time */
             deletedAt?: string | null;
             deletedBy?: string | null;
         };
@@ -3865,6 +4066,7 @@ export interface components {
             content: string;
             userName?: string | null;
             userEmail?: string | null;
+            /** Format: date-time */
             deletedAt?: string | null;
             deletedBy?: string | null;
         };
@@ -3881,8 +4083,9 @@ export interface components {
             metadata?: string | number | boolean | null | {
                 [key: string]: unknown;
             } | unknown[];
-            tags?: (string | null)[] | null;
+            tags?: string[] | null;
             uploadedBy?: string | null;
+            /** Format: date-time */
             deletedAt?: string | null;
             deletedBy?: string | null;
         };
@@ -3893,6 +4096,7 @@ export interface components {
             isSystemFolder?: boolean | null;
             folderType?: string | null;
             createdBy?: string | null;
+            /** Format: date-time */
             deletedAt?: string | null;
             deletedBy?: string | null;
         };
@@ -3920,12 +4124,17 @@ export interface components {
             terms?: string | null;
             notes?: string | null;
             internalNotes?: string | null;
+            /** Format: date-time */
             validUntil?: string | null;
+            /** Format: date-time */
             sentAt?: string | null;
+            /** Format: date-time */
             approvedAt?: string | null;
             approvedBy?: string | null;
+            /** Format: date-time */
             rejectedAt?: string | null;
             rejectionReason?: string | null;
+            /** Format: date-time */
             signedAt?: string | null;
             signatureMeta?: string | number | boolean | null | {
                 [key: string]: unknown;
@@ -3935,10 +4144,13 @@ export interface components {
             signerName?: string | null;
             signerEmail?: string | null;
             signerIp?: string | null;
+            /** Format: date-time */
             revisionRequestedAt?: string | null;
             revisionNotes?: string | null;
+            /** Format: date-time */
             customerResponseAt?: string | null;
             convertedToInvoiceId?: number | null;
+            /** Format: date-time */
             voidedAt?: string | null;
             voidedBy?: string | null;
             voidedReason?: string | null;
@@ -3947,16 +4159,22 @@ export interface components {
             signNowRoleId?: string | null;
             signNowRoleName?: string | null;
             portalVisible?: boolean | null;
+            /** Format: date-time */
             signedCompletionEmailSentAt?: string | null;
             qboId?: string | null;
             qboSyncToken?: string | null;
+            /** Format: date-time */
             qboLastPushedAt?: string | null;
             qboLastPushedHash?: string | null;
             qboLastError?: string | null;
             qboTotalTax?: string | null;
             qboTotalAmount?: string | null;
+            /** Format: date-time */
             qboTotalsAt?: string | null;
+            sourceKind?: string | null;
+            takeoffScanId?: number | null;
             createdBy?: string | null;
+            /** Format: date-time */
             deletedAt?: string | null;
             deletedBy?: string | null;
         };
@@ -3981,12 +4199,12 @@ export interface components {
         MobileUploadRequest: {
             /** @description RoomPlan JSON envelope. `rooms[]` carries the per-room geometry (walls/doors/windows/openings/pins/objects/boundaryPolygon). iOS continues to upload positions in the RoomPlan-native frame; the server applies the view-alignment intake transform once at `/scans/mobile-upload` (see docs/lidar-contract-v4.md). */
             roomPlanJSON: {
-                rooms: {
+                rooms: ({
                     label?: string;
                     name?: string;
                     category?: string;
                     roomLocalId?: string;
-                    walls?: {
+                    walls?: ({
                         start?: {
                             x: number;
                             y: number;
@@ -4001,9 +4219,13 @@ export interface components {
                             identifier?: string;
                             isDoor?: boolean;
                             isOpening?: boolean;
+                        } & {
+                            [key: string]: unknown;
                         };
                         captureMethod?: string;
-                    }[];
+                    } & {
+                        [key: string]: unknown;
+                    })[];
                     doors?: {
                         position: {
                             x: number;
@@ -4011,6 +4233,7 @@ export interface components {
                         };
                         width: number;
                         height: number;
+                        sillHeightM?: number;
                         hostWallIndex?: number | null;
                         wallIndex?: number;
                         /** @enum {string} */
@@ -4025,6 +4248,7 @@ export interface components {
                         };
                         width: number;
                         height: number;
+                        sillHeightM?: number;
                         hostWallIndex?: number | null;
                         wallIndex?: number;
                         /** @enum {string} */
@@ -4039,6 +4263,7 @@ export interface components {
                         };
                         width: number;
                         height: number;
+                        sillHeightM?: number;
                         hostWallIndex?: number | null;
                         wallIndex?: number;
                         /** @enum {string} */
@@ -4046,7 +4271,7 @@ export interface components {
                         /** @enum {string} */
                         placementSource?: "auto" | "manual";
                     }[];
-                    pins?: {
+                    pins?: ({
                         id: string;
                         position: {
                             x: number;
@@ -4056,8 +4281,10 @@ export interface components {
                         roomLocalId?: string;
                         kind?: string;
                         note?: string;
-                    }[];
-                    objects?: {
+                    } & {
+                        [key: string]: unknown;
+                    })[];
+                    objects?: ({
                         category?: string;
                         position?: {
                             x: number;
@@ -4069,14 +4296,20 @@ export interface components {
                             depth?: number;
                         };
                         rotation?: number;
-                    }[];
+                    } & {
+                        [key: string]: unknown;
+                    })[];
                     boundaryPolygon?: {
                         x: number;
                         y: number;
                     }[];
                     roomNote?: string;
                     entryDoorwayId?: string;
-                }[];
+                } & {
+                    [key: string]: unknown;
+                })[];
+            } & {
+                [key: string]: unknown;
             };
             name: string;
             description?: string;
@@ -4123,6 +4356,8 @@ export interface components {
                 x: number;
                 y: number;
             };
+        } & {
+            [key: string]: unknown;
         };
         MobileUploadResponse: {
             scanId: number;
@@ -4759,6 +4994,41 @@ export interface components {
             /** Format: date-time */
             requestedAt: string;
         };
+        DoorwayEditCommand: {
+            /** @enum {string} */
+            action: "delete";
+            roomId: number;
+            openingId: string;
+            revision: string;
+            /** @enum {boolean} */
+            confirmed: true;
+        } | {
+            /** @enum {string} */
+            action: "undo";
+            token: string;
+        } | {
+            /** @enum {string} */
+            action: "connect";
+            rooms: {
+                id: number;
+                revision: string;
+                geometry: {
+                    [key: string]: unknown;
+                };
+            }[];
+            links: {
+                roomAId: number;
+                roomBId: number;
+                doorAIndex: number;
+                doorBIndex: number;
+            }[];
+        };
+        DoorwayEditResult: {
+            /** @enum {boolean} */
+            ok: true;
+            token: string;
+            roomIds: number[];
+        };
     };
     responses: never;
     parameters: never;