@stablebaseline/sdk 0.5.1 → 0.5.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.cts +262 -29
- package/dist/index.d.ts +262 -29
- package/openapi.json +542 -48
- package/package.json +1 -1
- package/src/types.generated.ts +262 -29
package/src/types.generated.ts
CHANGED
|
@@ -35,7 +35,7 @@ export interface paths {
|
|
|
35
35
|
put?: never;
|
|
36
36
|
/**
|
|
37
37
|
* listDiagramTypes
|
|
38
|
-
* @description List supported diagram types. Use the returned `type` field
|
|
38
|
+
* @description List supported diagram types. Pass `query` to search by name OR intent (keyword + semantic): e.g. 'circuit diagram', 'wiring harness', 'timing waveform', 'network topology', 'database schema'. Use the returned `type` field with getDiagramTypeGuide (DSL instructions + example) and insertDiagramInDocument / renderDiagram.
|
|
39
39
|
*/
|
|
40
40
|
post: operations["listDiagramTypes"];
|
|
41
41
|
delete?: never;
|
|
@@ -235,7 +235,7 @@ export interface paths {
|
|
|
235
235
|
put?: never;
|
|
236
236
|
/**
|
|
237
237
|
* listWorkspaces
|
|
238
|
-
* @description List workspaces you have access to. Supports query filtering by name/slug.
|
|
238
|
+
* @description List workspaces you have access to. Scope to one organisation with organisationId (a structural filter — use it rather than `query`, which only searches names/slugs). Supports query filtering by name/slug.
|
|
239
239
|
*/
|
|
240
240
|
post: operations["listWorkspaces"];
|
|
241
241
|
delete?: never;
|
|
@@ -375,7 +375,7 @@ export interface paths {
|
|
|
375
375
|
put?: never;
|
|
376
376
|
/**
|
|
377
377
|
* listDocuments
|
|
378
|
-
* @description List AND grep documents in a project, workspace, or folder. `query` does a full-content search across each document's body (not just the title) and returns the matching lines — like grep across your docs. Each returned document includes `contentMatches: [{line, text, context?}]` and `matchCount`; the `text` is anchor-ready (paste it straight into editDocument's oldText). Use isRegex:true for regular-expression search (e.g. "TODO\(.*\)", "ACME-\d+"), caseSensitive for exact case, and contextLines for surrounding lines (grep -C). versionTimestamp is returned per document so you can edit straight from the results without a getDocument round-trip. Also supports date filtering.
|
|
378
|
+
* @description List AND grep documents in a project, workspace, or folder. `query` does a full-content search across each document's body (not just the title) and returns the matching lines — like grep across your docs. Each returned document includes `contentMatches: [{line, text, context?}]` and `matchCount`; the `text` is anchor-ready (paste it straight into editDocument's oldText). Use isRegex:true for regular-expression search (e.g. "TODO\(.*\)", "ACME-\d+"), caseSensitive for exact case, and contextLines for surrounding lines (grep -C). versionTimestamp is returned per document so you can edit straight from the results without a getDocument round-trip. Also supports date filtering. SCOPE HONESTY — read this before concluding something is absent: only documents that actually matched are returned (a document is never listed with matchCount 0 just because it was in scope), and the `grep` block reports `scannedDocuments` against `totalDocumentsInScope`. When `truncated` is true the search covered only part of the scope, so an absence is NOT proof; repeat with `scanOffset` set to the returned `nextScanOffset` until that field is gone, and union the results. A document too large to read is returned with `contentSearchSkipped: true` and NO matchCount, because its body was never searched.
|
|
379
379
|
*/
|
|
380
380
|
post: operations["listDocuments"];
|
|
381
381
|
delete?: never;
|
|
@@ -415,7 +415,7 @@ export interface paths {
|
|
|
415
415
|
put?: never;
|
|
416
416
|
/**
|
|
417
417
|
* getFolderHierarchy
|
|
418
|
-
* @description Get the folder and document tree
|
|
418
|
+
* @description Get the folder and document tree. Pass folderId for the subtree under one folder, or projectId for the project's ENTIRE folder tree from the root (no need to reassemble listFolders' flat list by parentId). Alias for getProjectHierarchy.
|
|
419
419
|
*/
|
|
420
420
|
post: operations["getFolderHierarchy"];
|
|
421
421
|
delete?: never;
|
|
@@ -455,7 +455,7 @@ export interface paths {
|
|
|
455
455
|
put?: never;
|
|
456
456
|
/**
|
|
457
457
|
* createDocument
|
|
458
|
-
* @description Create a document from CDMD markdown (standard Markdown plus SB extensions — call getCdmdLanguageGuide if unfamiliar). The body goes in `cdmd` (`content` is accepted as an alias). Do not include DIAGRAM/IMAGE markers — insert them after with dedicated tools. Returns the new document's id and versionTimestamp (the optimistic-lock token for subsequent edits). Supports @-mentioning people: embed `<!-- REFERENCE: {"type":"user","id":"<user_uuid>","label":"Name"} -->` to notify a teammate. Use listAssignablePrincipals to look up the user_id from a name; mentions of users outside the project are silently dropped.
|
|
458
|
+
* @description Create a document from CDMD markdown (standard Markdown plus SB extensions — call getCdmdLanguageGuide if unfamiliar). The body goes in `cdmd` (`content` is accepted as an alias). A leading `---` YAML frontmatter block is stored and preserved: title/exported_at/generator are managed by the platform, and any other key you set (doc_type, authority_state, owner, conforms_to, …) round-trips untouched through reads and later edits. Do not include DIAGRAM/IMAGE markers — insert them after with dedicated tools. Returns the new document's id and versionTimestamp (the optimistic-lock token for subsequent edits). Supports @-mentioning people: embed `<!-- REFERENCE: {"type":"user","id":"<user_uuid>","label":"Name"} -->` to notify a teammate. Use listAssignablePrincipals to look up the user_id from a name; mentions of users outside the project are silently dropped.
|
|
459
459
|
*/
|
|
460
460
|
post: operations["createDocument"];
|
|
461
461
|
delete?: never;
|
|
@@ -695,7 +695,7 @@ export interface paths {
|
|
|
695
695
|
put?: never;
|
|
696
696
|
/**
|
|
697
697
|
* designDeckInWhiteboard
|
|
698
|
-
* @description Create or refine a slide deck INSIDE an existing whiteboard by conversing with the AI design agent. Send a brief for a NEW deck, a change to an EXISTING one, or an answer to the agent's question. The agent builds a polished, on-brand deck and places it on the board; if the brief is ambiguous it asks ONE clarifying question (answer with the same sessionId). Returns immediately; poll getDeckReplyInWhiteboard for the result. Use for building or editing slide decks / presentations. WHITEBOARD IS REQUIRED: a deck always lives inside a whiteboard, so documentId (the whiteboard's id) is required. If you do NOT already have a whiteboard id, ASK THE USER which whiteboard they want the deck designed in — do NOT create a whiteboard automatically. Only call createWhiteboard first if the user explicitly asks for a brand-new board; otherwise use the id of the whiteboard they name. FIRST vs FOLLOW-UP: the first call (from nothing) builds; a follow-up call (an answer, a change, or a new instruction) passes the sessionId (or the deckId) plus the new message. kind:'deck' (default) is the premium on-brand HTML deck; kind:'express' builds the native, deterministic branded-executive deck directly on the whiteboard (faster, lower fidelity, one-shot, not conversational). COST + APPROVAL: a build costs 50 credits and an edit 10; a clarifying question is FREE. Call FIRST without confirm to get the exact cost plus the workspace balance, show it to the user, and only call again with confirm:true once they agree. The fee is auto-refunded if a turn produces no change or fails. Returns sessionId (the conversation), deckId (the deck), status, turnType, started, awaitingUser, needsConfirmation, insufficientCredits, and assistantMessage. Export the finished deck with exportFromWhiteboard.
|
|
698
|
+
* @description Create or refine a slide deck INSIDE an existing whiteboard by conversing with the AI design agent. Send a brief for a NEW deck, a change to an EXISTING one, or an answer to the agent's question. The agent builds a polished, on-brand deck and places it on the board; if the brief is ambiguous it asks ONE clarifying question (answer with the same sessionId). Returns immediately; poll getDeckReplyInWhiteboard for the result. Use for building or editing slide decks / presentations. WHITEBOARD IS REQUIRED: a deck always lives inside a whiteboard, so documentId (the whiteboard's id) is required. If you do NOT already have a whiteboard id, ASK THE USER which whiteboard they want the deck designed in — do NOT create a whiteboard automatically. Only call createWhiteboard first if the user explicitly asks for a brand-new board; otherwise use the id of the whiteboard they name. FIRST vs FOLLOW-UP: the first call (from nothing) builds; a follow-up call (an answer, a change, or a new instruction) passes the sessionId (or the deckId) plus the new message. kind:'deck' (default) is the premium on-brand HTML deck; kind:'express' builds the native, deterministic branded-executive deck directly on the whiteboard (faster, lower fidelity, one-shot, not conversational). COST + APPROVAL: a build costs 50 credits and an edit 10; a clarifying question is FREE. GENERATED IMAGES are extra and OFF by default: decks are type-only unless the user asks for visuals, in which case set imageCount (5 credits each, ceiling scales with slide count and plan tier, max 10) and the exact total is quoted before anything is charged — exactly that many images are produced, and the image surcharge auto-refunds if the build cannot deliver them. ADVANCED DECK BUILDING (optional, OFF by default): set advancedDeckBuilding:true to build the deck over several rounds of redraft and review by a panel of design, brand, accessibility and copy reviewers instead of one composer pass. It usually raises design quality, but it is not a guarantee. It is much slower and it costs more: a standard build takes roughly 2 to 8 minutes, advanced deck building takes roughly 15 to 20 minutes, and it adds 15 credits per depth level on top of the turn fee (advancedDeckBuildingDepth is 1 to 3, default 3, so +45 credits, making a 50-credit build cost 95). Only turn it on when the user asks for the highest quality and accepts the wait and the cost. Call FIRST without confirm to get the exact cost plus the workspace balance, show it to the user, and only call again with confirm:true once they agree. The fee is auto-refunded if a turn produces no change or fails. Returns sessionId (the conversation), deckId (the deck), status, turnType, started, awaitingUser, needsConfirmation, insufficientCredits, slideCount + slideCountClamped (the target the conversation now carries, and whether it was reduced to the maximum), advancedDeckBuilding (whether advanced deck building is on for this conversation), advancedDeckBuildingStatus, and assistantMessage. Export the finished deck with exportFromWhiteboard.
|
|
699
699
|
*/
|
|
700
700
|
post: operations["designDeckInWhiteboard"];
|
|
701
701
|
delete?: never;
|
|
@@ -735,7 +735,7 @@ export interface paths {
|
|
|
735
735
|
put?: never;
|
|
736
736
|
/**
|
|
737
737
|
* getDeckReplyInWhiteboard
|
|
738
|
-
* @description Get the design agent's reply after calling designDeckInWhiteboard OR designIllustrationInWhiteboard: the status (thinking/building/ready) and EITHER the finished result (a deck's slide count + preview, or the placed illustration) OR a clarifying question to answer (call the SAME tool you started with, passing the sessionId + your answer). Poll until ready or a question appears. Give it the whiteboard documentId and the deckId (both returned by the tool you called). It returns the build status ('generating' while working, 'ready' when finished, 'failed' if it failed) plus, once ready, the slide count and a thumbnail image URL. IMPORTANT for the conversation: if the agent asked a CLARIFYING QUESTION instead of doing the work, this returns awaitingUser:true with pendingQuestion (and assistantMessage) — relay that question to the user, then call the SAME design tool again with the same sessionId and the user's answer as message to continue. It also returns the full conversation (history + status + pending question). A turn usually takes about
|
|
738
|
+
* @description Get the design agent's reply after calling designDeckInWhiteboard OR designIllustrationInWhiteboard: the status (thinking/building/ready) and EITHER the finished result (a deck's slide count + preview, or the placed illustration) OR a clarifying question to answer (call the SAME tool you started with, passing the sessionId + your answer). Poll until ready or a question appears. Give it the whiteboard documentId and the deckId (both returned by the tool you called). It returns the build status ('generating' while working, 'ready' when finished, 'failed' if it failed) plus, once ready, the slide count and a thumbnail image URL. IMPORTANT for the conversation: if the agent asked a CLARIFYING QUESTION instead of doing the work, this returns awaitingUser:true with pendingQuestion (and assistantMessage) — relay that question to the user, then call the SAME design tool again with the same sessionId and the user's answer as message to continue. It also returns the full conversation (history + status + pending question). While a turn is running it additionally returns live build state: stage, percent, feed (the agent's real per-step lines), slideTarget (the count it is building to), slides (the finished slides so far, each with a fetchable image url), partialHtml (the deck so far), and, when advanced deck building is on, advancedDeckBuildingProgress (the round-by-round reviewer scores; also emitted as the deprecated `jury` field for one release). Every one of those is optional and absent when there is nothing to report. A standard turn usually takes about 2 to 8 minutes, so poll every 15 to 30 seconds until it is 'ready' or awaitingUser is true; a turn running with advanced deck building takes roughly 15 to 20 minutes, so keep polling for that long before treating it as stuck. When ready, the deck or illustration has already been placed on the whiteboard; a deck can also be exported with exportFromWhiteboard. If a turn failed or produced no change, the user was not charged.
|
|
739
739
|
*/
|
|
740
740
|
post: operations["getDeckReplyInWhiteboard"];
|
|
741
741
|
delete?: never;
|
|
@@ -1155,7 +1155,7 @@ export interface paths {
|
|
|
1155
1155
|
put?: never;
|
|
1156
1156
|
/**
|
|
1157
1157
|
* reorderDocuments
|
|
1158
|
-
* @description
|
|
1158
|
+
* @description MOVE documents between folders and/or reorder them — the batch filing tool. Pass [{documentId, position, folderId?}, ...]: `position` is a non-negative integer (usually renumber siblings sequentially as 0, 1, 2…), and the optional per-item `folderId` MOVES that document into the given folder (use null to move it to the project root; omit it to leave the document where it is). Use this to reorganise a project — file loose documents into subfolders, restructure a folder tree, or reorder siblings — in one call. Filing is metadata only: it does NOT bump the document version and does NOT create a version-history snapshot, so tidying folders never shows up as a content revision. A bad folderId fails the whole call rather than half-applying it. For a single document you can also use editDocument({documentId, folderId, position}), which behaves identically (and likewise creates no version when only the filing changes).
|
|
1159
1159
|
*/
|
|
1160
1160
|
post: operations["reorderDocuments"];
|
|
1161
1161
|
delete?: never;
|
|
@@ -1435,7 +1435,7 @@ export interface paths {
|
|
|
1435
1435
|
put?: never;
|
|
1436
1436
|
/**
|
|
1437
1437
|
* createImprovement
|
|
1438
|
-
* @description Create an improvement item in a project. Requires projectId and title. Auto-assigns friendly ID.
|
|
1438
|
+
* @description Create an improvement item in a project. Requires projectId and title. Auto-assigns friendly ID. Accepts every field updateImprovement accepts, so an item can be created complete in one call rather than create-then-update.
|
|
1439
1439
|
*/
|
|
1440
1440
|
post: operations["createImprovement"];
|
|
1441
1441
|
delete?: never;
|
|
@@ -1455,7 +1455,7 @@ export interface paths {
|
|
|
1455
1455
|
put?: never;
|
|
1456
1456
|
/**
|
|
1457
1457
|
* updateImprovement
|
|
1458
|
-
* @description Update an improvement (or a task — tasks share this row, but prefer the symmetric updateTask alias when working from getTask). Supports the full field set including `checklist` (tick-boxes with due dates + completion attribution) and `acceptance_criteria` (objects with per-row updated_by/at attribution). Requires versionTimestamp from getImprovement for optimistic locking.
|
|
1458
|
+
* @description Update an improvement (or a task — tasks share this row, but prefer the symmetric updateTask alias when working from getTask). Supports the full field set including `checklist` (tick-boxes with due dates + completion attribution) and `acceptance_criteria` (objects with per-row updated_by/at attribution). Requires versionTimestamp from getImprovement for optimistic locking. Statuses are captured / in_progress / blocked / done / rejected / deferred, and FOUR of those are CLOSED: blocked, done, rejected, deferred. Entering one needs its comment (blocked needs blocked_comment, rejected needs rejection_comment, done needs completion_comment); leaving one for an open status needs reopened_comment — including blocked -> in_progress, which surprises people because `blocked` does not sound terminal. `metadata` MERGES into what is stored (null on a key deletes it); pass metadata_replace:true to overwrite the object wholesale. Assignment: pass `owner_id=<uuid>` to assign to a user, `owner_team_id=<uuid>` to assign to a team (mutually exclusive — a DB CHECK constraint enforces this). To unassign, pass `owner_id=null` AND `owner_team_id=null`. To switch from a user owner to a team owner, send `owner_id=null, owner_team_id=<uuid>` in the SAME call (sending only one side leaves the stale value and triggers the XOR check). Use listAssignablePrincipals or listTeams to discover valid IDs.
|
|
1459
1459
|
*/
|
|
1460
1460
|
post: operations["updateImprovement"];
|
|
1461
1461
|
delete?: never;
|
|
@@ -1979,7 +1979,7 @@ export interface paths {
|
|
|
1979
1979
|
put?: never;
|
|
1980
1980
|
/**
|
|
1981
1981
|
* createTask
|
|
1982
|
-
* @description Create a task in a plan. Requires planId and title.
|
|
1982
|
+
* @description Create a task in a plan. Requires planId and title. Accepts every field updateTask accepts, so a task can be created complete in ONE call — no create-then-update, and no window in which other actors read a half-written record.
|
|
1983
1983
|
*/
|
|
1984
1984
|
post: operations["createTask"];
|
|
1985
1985
|
delete?: never;
|
|
@@ -2039,7 +2039,7 @@ export interface paths {
|
|
|
2039
2039
|
put?: never;
|
|
2040
2040
|
/**
|
|
2041
2041
|
* updateTask
|
|
2042
|
-
* @description Update a task. Tasks share a row with improvements (`improvement_items` with `is_task=true`), so this is a thin alias over updateImprovement — every field on updateImprovement is supported, including `checklist`, `acceptance_criteria`,
|
|
2042
|
+
* @description Update a task. Tasks share a row with improvements (`improvement_items` with `is_task=true`), so this is a thin alias over updateImprovement — every field on updateImprovement is supported, including `checklist`, `acceptance_criteria`, dates, owner, percent_complete, etc. Requires versionTimestamp from getTask for optimistic locking. Statuses are captured / in_progress / blocked / done / rejected / deferred, and FOUR of those are CLOSED: blocked, done, rejected, deferred. Entering one needs its comment (blocked_comment / rejection_comment / completion_comment); leaving one for an open status needs reopened_comment — including blocked -> in_progress, which surprises people because `blocked` does not sound terminal. `metadata` MERGES into what is stored (null on a key deletes it); pass metadata_replace:true to overwrite the object wholesale. To edit checklist items: call getTask, modify the `checklist` array (preserving each row's `id` to keep its attribution stamps), and pass the full array back here — array order is the sort order. Assignment: pass `owner_id=<uuid>` to assign to a user, `owner_team_id=<uuid>` to assign to a team (mutually exclusive — the DB enforces with a CHECK constraint). To unassign, pass `owner_id=null` AND `owner_team_id=null`. To switch owner kind, send the new value AND null the old one in the SAME call.
|
|
2043
2043
|
*/
|
|
2044
2044
|
post: operations["updateTask"];
|
|
2045
2045
|
delete?: never;
|
|
@@ -2159,7 +2159,7 @@ export interface paths {
|
|
|
2159
2159
|
put?: never;
|
|
2160
2160
|
/**
|
|
2161
2161
|
* deleteTaskDependency
|
|
2162
|
-
* @description Remove a task-dependency edge. Neither item's dates are changed.
|
|
2162
|
+
* @description Remove a task-dependency edge. Neither item's dates are changed. Needs the same 'write' plan permission as createTaskDependency, so an actor that can draw an edge can also undo it — the edge is fully recreatable from (predecessor, successor, type, lag).
|
|
2163
2163
|
*/
|
|
2164
2164
|
post: operations["deleteTaskDependency"];
|
|
2165
2165
|
delete?: never;
|
|
@@ -4070,6 +4070,7 @@ export interface operations {
|
|
|
4070
4070
|
requestBody?: {
|
|
4071
4071
|
content: {
|
|
4072
4072
|
"application/json": {
|
|
4073
|
+
/** @description Keyword or intent, e.g. 'circuit', 'wiring harness', 'timing'. Semantic-backed: matches descriptions, not just names. */
|
|
4073
4074
|
query?: string;
|
|
4074
4075
|
enabledOnly?: boolean;
|
|
4075
4076
|
limit?: number;
|
|
@@ -4580,6 +4581,8 @@ export interface operations {
|
|
|
4580
4581
|
/** @description Workspace UUID. Optional but recommended — when present, the result includes ALL org members; when omitted, only direct project grants + team-expanded users are returned. */
|
|
4581
4582
|
workspaceId?: string;
|
|
4582
4583
|
/** @description Optional ILIKE search filter — matched against display_name + email (users) and team name (teams). */
|
|
4584
|
+
query?: string;
|
|
4585
|
+
/** @description Deprecated alias for `query`, still accepted. Prefer `query` — that is the name every other list tool uses. */
|
|
4583
4586
|
q?: string;
|
|
4584
4587
|
/**
|
|
4585
4588
|
* @description Filter to one principal kind. Default 'all' returns users first then teams.
|
|
@@ -4676,6 +4679,8 @@ export interface operations {
|
|
|
4676
4679
|
/** @description Workspace UUID. The parent organization is resolved from v_workspaces. */
|
|
4677
4680
|
workspaceId?: string;
|
|
4678
4681
|
/** @description Optional ILIKE search on team name/slug. */
|
|
4682
|
+
query?: string;
|
|
4683
|
+
/** @description Deprecated alias for `query`, still accepted. Prefer `query` — that is the name every other list tool uses. */
|
|
4679
4684
|
q?: string;
|
|
4680
4685
|
/** @description When true, each team gets a `members` array (user_id, role, joined_at). Capped at 500 total members across the page. Default false. */
|
|
4681
4686
|
includeMembers?: boolean;
|
|
@@ -4935,6 +4940,10 @@ export interface operations {
|
|
|
4935
4940
|
requestBody?: {
|
|
4936
4941
|
content: {
|
|
4937
4942
|
"application/json": {
|
|
4943
|
+
/** @description Return only workspaces in this organisation. Use listOrganisations to find the id. (organizationId is accepted as a spelling alias.) */
|
|
4944
|
+
organisationId?: string;
|
|
4945
|
+
/** @description Spelling alias for organisationId. */
|
|
4946
|
+
organizationId?: string;
|
|
4938
4947
|
query?: string;
|
|
4939
4948
|
limit?: number;
|
|
4940
4949
|
offset?: number;
|
|
@@ -5566,7 +5575,10 @@ export interface operations {
|
|
|
5566
5575
|
/** @description Cap on matching lines returned per document. 1-20, default 5. */
|
|
5567
5576
|
maxMatchesPerDocument?: number;
|
|
5568
5577
|
limit?: number;
|
|
5578
|
+
/** @description Pagination offset over the MATCHES. When searching, use scanOffset (not this) to reach documents the scan has not covered. */
|
|
5569
5579
|
offset?: number;
|
|
5580
|
+
/** @description Search-only. Where to start the document scan within the scope. One call examines a bounded window; when the response reports truncated:true it also returns nextScanOffset — repeat with scanOffset set to that value until nextScanOffset is absent, and union the results, to search a scope larger than one window exhaustively. */
|
|
5581
|
+
scanOffset?: number;
|
|
5570
5582
|
/** @description ISO 8601 date filter (from). */
|
|
5571
5583
|
fromDate?: string;
|
|
5572
5584
|
/** @description ISO 8601 date filter (to). */
|
|
@@ -5753,8 +5765,10 @@ export interface operations {
|
|
|
5753
5765
|
requestBody?: {
|
|
5754
5766
|
content: {
|
|
5755
5767
|
"application/json": {
|
|
5756
|
-
/** @description
|
|
5757
|
-
|
|
5768
|
+
/** @description Return the whole project's folder tree from the root. Provide this or folderId. */
|
|
5769
|
+
projectId?: string;
|
|
5770
|
+
/** @description The folder ID to start from. Omit and pass projectId to get the project root hierarchy. */
|
|
5771
|
+
folderId?: string;
|
|
5758
5772
|
/** @description Max nesting depth. Default: 10, max: 20. */
|
|
5759
5773
|
maxDepth?: number;
|
|
5760
5774
|
/** @description Include documents. Default: true. */
|
|
@@ -5848,7 +5862,9 @@ export interface operations {
|
|
|
5848
5862
|
requestBody?: {
|
|
5849
5863
|
content: {
|
|
5850
5864
|
"application/json": {
|
|
5851
|
-
/** @description
|
|
5865
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
5866
|
+
projectId?: string;
|
|
5867
|
+
/** @description The document ID to read. Accepts either the UUID or the friendly id (e.g. DOC-815); friendly ids are resolved within your organisation. */
|
|
5852
5868
|
documentId: string;
|
|
5853
5869
|
/** @description Lines to skip from start. Default: 0. */
|
|
5854
5870
|
offset?: number;
|
|
@@ -6033,15 +6049,19 @@ export interface operations {
|
|
|
6033
6049
|
requestBody?: {
|
|
6034
6050
|
content: {
|
|
6035
6051
|
"application/json": {
|
|
6052
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
6053
|
+
projectId?: string;
|
|
6036
6054
|
documentId: string;
|
|
6037
6055
|
/** @description New title. */
|
|
6038
6056
|
title?: string;
|
|
6039
|
-
/** @description
|
|
6040
|
-
folderId?: string;
|
|
6041
|
-
/** @description Sort position within the parent folder. Use to reposition a single document. For batch sibling reorder, use reorderDocuments. */
|
|
6057
|
+
/** @description MOVE the document into this folder (null moves it to the project root). Send it with patches:[] to file the document without touching its content — a folder-only move updates folder_id, creates NO version-history entry, and does not bump the document version. To move many documents at once use reorderDocuments, which takes folderId per item. */
|
|
6058
|
+
folderId?: string | null;
|
|
6059
|
+
/** @description Sort position within the parent folder. Use to reposition a single document; like folderId, a position-only change creates no version. For batch sibling reorder/move, use reorderDocuments. */
|
|
6042
6060
|
position?: number;
|
|
6043
6061
|
/** @description Optimistic-lock token from getDocument() or any mutating tool's response. Required unless dryRun:true. (Alias accepted: documentVersionTimestamp.) */
|
|
6044
6062
|
versionTimestamp?: number;
|
|
6063
|
+
/** @description Legacy integer version guard, checked in addition to versionTimestamp. Prefer versionTimestamp — this exists for older clients and is optional. */
|
|
6064
|
+
expectedVersion?: number;
|
|
6045
6065
|
/** @description If true, apply the patches and RETURN the resulting document text without saving — no version bump, no lock required. Use to preview/verify a patch before committing. Default false. */
|
|
6046
6066
|
dryRun?: boolean;
|
|
6047
6067
|
/** @description Version history summary. */
|
|
@@ -6145,6 +6165,8 @@ export interface operations {
|
|
|
6145
6165
|
requestBody?: {
|
|
6146
6166
|
content: {
|
|
6147
6167
|
"application/json": {
|
|
6168
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
6169
|
+
projectId?: string;
|
|
6148
6170
|
documentId: string;
|
|
6149
6171
|
/** @description Text to search for. */
|
|
6150
6172
|
find: string;
|
|
@@ -6322,6 +6344,8 @@ export interface operations {
|
|
|
6322
6344
|
requestBody?: {
|
|
6323
6345
|
content: {
|
|
6324
6346
|
"application/json": {
|
|
6347
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
6348
|
+
projectId?: string;
|
|
6325
6349
|
documentId: string;
|
|
6326
6350
|
/** @description Optimistic-lock token: the document's versionTimestamp from getDocument() or any mutating tool's response. (Alias accepted: versionTimestamp.) */
|
|
6327
6351
|
documentVersionTimestamp?: number;
|
|
@@ -6637,6 +6661,8 @@ export interface operations {
|
|
|
6637
6661
|
content: {
|
|
6638
6662
|
"application/json": {
|
|
6639
6663
|
documentId: string;
|
|
6664
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Ignored when documentId is a UUID. */
|
|
6665
|
+
projectId?: string;
|
|
6640
6666
|
};
|
|
6641
6667
|
};
|
|
6642
6668
|
};
|
|
@@ -6925,6 +6951,8 @@ export interface operations {
|
|
|
6925
6951
|
tags?: string[];
|
|
6926
6952
|
/** @description Optional URL of a reference image the component should match; the critic compares the render to it. */
|
|
6927
6953
|
referenceImageUrl?: string;
|
|
6954
|
+
/** @description Optional brand kit id (from listBrandKits) to theme the component. If omitted, the organisation's effective brand is used. */
|
|
6955
|
+
brandKitId?: string;
|
|
6928
6956
|
/** @description Redesign even if a component with this key already exists (default false = reuse). */
|
|
6929
6957
|
force?: boolean;
|
|
6930
6958
|
};
|
|
@@ -7101,7 +7129,7 @@ export interface operations {
|
|
|
7101
7129
|
"application/json": {
|
|
7102
7130
|
/** @description The whiteboard the deck lives in. REQUIRED: a deck cannot exist without a whiteboard, and this is that whiteboard's id. If you do not already have a whiteboard id, ASK THE USER which whiteboard to design the deck in — never create one automatically. Only call createWhiteboard first if the user explicitly wants a new board. */
|
|
7103
7131
|
documentId: string;
|
|
7104
|
-
/** @description This turn's message in plain language: the design brief on the first turn, an edit instruction later, or the user's ANSWER to a clarifying question the agent asked. On a follow-up turn, pass this together with the sessionId (or deckId) from the earlier call. */
|
|
7132
|
+
/** @description This turn's message in plain language: the design brief on the first turn, an edit instruction later, or the user's ANSWER to a clarifying question the agent asked. On a follow-up turn, pass this together with the sessionId (or deckId) from the earlier call. If the user mentioned how many slides they want, ALSO pass slideCount with that number — never leave the count only in prose, and never outline more slides in this message than slideCount. */
|
|
7105
7133
|
message: string;
|
|
7106
7134
|
/** @description The design conversation to continue, as returned by an earlier designDeckInWhiteboard call. Pass it together with message to answer a question, make an edit, or send a follow-up. Omit on the very first call to start a new conversation. */
|
|
7107
7135
|
sessionId?: string;
|
|
@@ -7116,8 +7144,14 @@ export interface operations {
|
|
|
7116
7144
|
title?: string;
|
|
7117
7145
|
/** @description Optional brand kit id (from listBrandKits) to theme the deck. If omitted, the organisation's effective brand is used. */
|
|
7118
7146
|
brandKitId?: string;
|
|
7119
|
-
/** @description
|
|
7147
|
+
/** @description The number of slides to build — a hard requirement: the deck is built with exactly this many slides. SET THIS whenever the user states or implies a count, EXACT OR APPROXIMATE: '12 slides' → 12, 'about 15' / '15 or so' → 15, 'no more than 10' → 10. Never expand the user's number: if they said 'about 15', pass 15 and shape the brief to fit 15 — outlining 19 sections in the message does not raise the count, it just fights this parameter. It is PERSISTED on the conversation, so send it ONCE (on the turn that states it) and every later build turn of the same conversation carries it automatically; send it again only to CHANGE the target. It is honoured on edit turns too ('cut it to 8 slides'). Anything above the 30-slide maximum is reduced to 30 and the reduction is stated back in the response. Omit ONLY when the user gave no count at all; the designer then chooses (typical 6 to 12). */
|
|
7120
7148
|
slideCount?: number;
|
|
7149
|
+
/** @description How many AI-GENERATED images this turn may produce. DEFAULT IS 0 — decks are type-only unless the user asks for visuals. SET THIS when the user wants imagery: 'a cover image' → 1, 'a few images' → 2, 'image-led / very visual' → omit nothing and pass a higher number. Each image costs 5 extra credits, quoted upfront in the confirmation (base fee + images), and EXACTLY this many are produced — never more, never fewer (the image surcharge is auto-refunded if the build cannot deliver them). The ceiling scales with the deck (about one image per three slides, so a 30-slide deck tops out at 10) and with the plan tier; anything above the ceiling is reduced and the reduction is stated back. If omitted, the count is derived conservatively from the user's wording (silence = 0). */
|
|
7150
|
+
imageCount?: number;
|
|
7151
|
+
/** @description Optional, OFF by default. Build the deck with ADVANCED DECK BUILDING: instead of one composer pass, the deck is redrafted and reviewed over several rounds by a panel of design, brand, accessibility and copy reviewers, each round scoring the deck and listing what must be fixed. It usually produces a higher-quality deck, but it is not a guarantee. TIME: a standard build takes roughly 2 to 8 minutes; advanced deck building takes roughly 15 to 20 minutes. COST: 15 extra credits per depth level on top of the turn fee, so the default depth of 3 adds 45 credits and makes a 50-credit build cost 95. This is the user's deliberate choice, so only switch it on when they have asked for the best possible deck and accepted the wait and the cost. Quote the turn FIRST (call without confirm) so the user sees the real total before approving. Set it once and it is remembered for the rest of the conversation; pass false to turn it off again. */
|
|
7152
|
+
advancedDeckBuilding?: boolean;
|
|
7153
|
+
/** @description Optional. How many redraft-and-review rounds advanced deck building may run: 1 to 3, default 3. Each round is a full redraft plus four reviews, adds roughly 5 minutes, and costs 15 credits (depth 1 = +15, depth 2 = +30, depth 3 = +45). Ignored unless advancedDeckBuilding is true. */
|
|
7154
|
+
advancedDeckBuildingDepth?: number;
|
|
7121
7155
|
/** @description Optional reference images for THIS turn (up to 8; images only). The agent lifts palette, layout, and tone from them (it does not pixel-copy). Non-image attachments are ignored. */
|
|
7122
7156
|
attachments?: {
|
|
7123
7157
|
/** @description A public https URL to the image. */
|
|
@@ -7128,6 +7162,8 @@ export interface operations {
|
|
|
7128
7162
|
mediaType?: string;
|
|
7129
7163
|
/** @description Optional human-readable name for the image. */
|
|
7130
7164
|
name?: string;
|
|
7165
|
+
/** @description Optional attachment type hint, passed through to the design worker. */
|
|
7166
|
+
type?: string;
|
|
7131
7167
|
}[];
|
|
7132
7168
|
/** @description Set true ONLY after the user has approved the cost (50 for a build, 10 for an edit). Leave unset/false on the first call of a turn to receive the cost quote plus balance. A clarifying question turn is never charged. */
|
|
7133
7169
|
confirm?: boolean;
|
|
@@ -7234,6 +7270,8 @@ export interface operations {
|
|
|
7234
7270
|
mediaType?: string;
|
|
7235
7271
|
/** @description Optional human-readable name for the image. */
|
|
7236
7272
|
name?: string;
|
|
7273
|
+
/** @description Optional attachment type hint, passed through to the design worker. */
|
|
7274
|
+
type?: string;
|
|
7237
7275
|
}[];
|
|
7238
7276
|
/** @description Set true ONLY after the user has approved the cost (50 for a build, 10 for an edit). Leave unset/false on the first call of a turn to receive the cost quote plus balance. A clarifying question turn is never charged. */
|
|
7239
7277
|
confirm?: boolean;
|
|
@@ -7510,6 +7548,11 @@ export interface operations {
|
|
|
7510
7548
|
label: string;
|
|
7511
7549
|
/** @description Optional stable id; one is minted if omitted. */
|
|
7512
7550
|
id?: string;
|
|
7551
|
+
/**
|
|
7552
|
+
* @description Optional starting status sticker. Default: pending.
|
|
7553
|
+
* @enum {string}
|
|
7554
|
+
*/
|
|
7555
|
+
status?: "pending" | "active" | "done";
|
|
7513
7556
|
}[];
|
|
7514
7557
|
/** @description Optional per-meeting settings: { language (BCP-47, e.g. 'en'), sttProvider ('assemblyai' default, or 'captions'), presentMode ('off' default, or 'camera'/'screenshare' to stream the live board back into the meeting), botName (override the default '{Org} Scribe (Stable Baseline)') }. */
|
|
7515
7558
|
settings?: {
|
|
@@ -7932,6 +7975,9 @@ export interface operations {
|
|
|
7932
7975
|
requestBody?: {
|
|
7933
7976
|
content: {
|
|
7934
7977
|
"application/json": {
|
|
7978
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
7979
|
+
projectId?: string;
|
|
7980
|
+
/** @description Accepts either the UUID or the friendly id (e.g. WBD-12); friendly ids are resolved within your organisation. */
|
|
7935
7981
|
documentId: string;
|
|
7936
7982
|
/** @description When true, returns the full Excalidraw scene so it can be modified and written back. */
|
|
7937
7983
|
includeElements?: boolean;
|
|
@@ -8016,6 +8062,8 @@ export interface operations {
|
|
|
8016
8062
|
requestBody?: {
|
|
8017
8063
|
content: {
|
|
8018
8064
|
"application/json": {
|
|
8065
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
8066
|
+
projectId?: string;
|
|
8019
8067
|
documentId: string;
|
|
8020
8068
|
/** @description Elements to write. For mode 'patch', each may be a partial { id, ...changedFields } merged into the matching element by id; full Excalidraw elements for 'replace'/'append' (or new ids in 'patch'). */
|
|
8021
8069
|
elements?: Record<string, never>[];
|
|
@@ -8115,6 +8163,8 @@ export interface operations {
|
|
|
8115
8163
|
requestBody?: {
|
|
8116
8164
|
content: {
|
|
8117
8165
|
"application/json": {
|
|
8166
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
8167
|
+
projectId?: string;
|
|
8118
8168
|
documentId: string;
|
|
8119
8169
|
/** @description Non-empty array of shape specs to append. Prefer stencils / sticky notes / architecture icons over raw rectangles wherever a standard form fits (see the `type` enum below and the tool description). */
|
|
8120
8170
|
shapes: ({
|
|
@@ -8406,6 +8456,12 @@ export interface operations {
|
|
|
8406
8456
|
fileName?: string;
|
|
8407
8457
|
/** @description Lock the placed image so it cannot be moved, resized, or deleted by hand (e.g. a deck-owned framed slide image that changes only via the deck conversation). Defaults to false. */
|
|
8408
8458
|
locked?: boolean;
|
|
8459
|
+
/** @description Optional plain-language description of the image, stored on the element for accessibility and so agents reading the board later know what it depicts. */
|
|
8460
|
+
nlDescription?: string;
|
|
8461
|
+
/** @description Arbitrary Excalidraw customData stored on the element (e.g. { deckId } so a board image resolves back to its source deck). Merged with any builder-set customData. */
|
|
8462
|
+
customData?: {
|
|
8463
|
+
[key: string]: unknown;
|
|
8464
|
+
};
|
|
8409
8465
|
};
|
|
8410
8466
|
};
|
|
8411
8467
|
};
|
|
@@ -8700,6 +8756,8 @@ export interface operations {
|
|
|
8700
8756
|
requestBody?: {
|
|
8701
8757
|
content: {
|
|
8702
8758
|
"application/json": {
|
|
8759
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
8760
|
+
projectId?: string;
|
|
8703
8761
|
/** @description The whiteboard's documentId. */
|
|
8704
8762
|
documentId: string;
|
|
8705
8763
|
/** @description Rows as arrays of cell strings. If headers is omitted, the first row is treated as the header row. */
|
|
@@ -8886,7 +8944,9 @@ export interface operations {
|
|
|
8886
8944
|
requestBody?: {
|
|
8887
8945
|
content: {
|
|
8888
8946
|
"application/json": {
|
|
8889
|
-
/** @description
|
|
8947
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
8948
|
+
projectId?: string;
|
|
8949
|
+
/** @description The whiteboard's documentId. Accepts either the UUID or the friendly id (e.g. WBD-12); friendly ids are resolved within your organisation. */
|
|
8890
8950
|
documentId: string;
|
|
8891
8951
|
/** @description Render only these element ids (plus their bound labels + group peers) instead of the whole board. */
|
|
8892
8952
|
elementIds?: string[];
|
|
@@ -8990,6 +9050,8 @@ export interface operations {
|
|
|
8990
9050
|
content: {
|
|
8991
9051
|
"application/json": {
|
|
8992
9052
|
documentId: string;
|
|
9053
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Ignored when documentId is a UUID. */
|
|
9054
|
+
projectId?: string;
|
|
8993
9055
|
};
|
|
8994
9056
|
};
|
|
8995
9057
|
};
|
|
@@ -9346,10 +9408,13 @@ export interface operations {
|
|
|
9346
9408
|
requestBody?: {
|
|
9347
9409
|
content: {
|
|
9348
9410
|
"application/json": {
|
|
9349
|
-
/** @description
|
|
9411
|
+
/** @description Documents to file. All must belong to the same project (a batch spanning projects is rejected). */
|
|
9350
9412
|
items: {
|
|
9351
9413
|
documentId: string;
|
|
9414
|
+
/** @description Sort position among siblings. Non-negative integer. */
|
|
9352
9415
|
position: number;
|
|
9416
|
+
/** @description Optional. MOVE the document into this folder; null moves it to the project root. Omit to leave its current folder untouched. The folder must exist and belong to the same project. */
|
|
9417
|
+
folderId?: string | null;
|
|
9353
9418
|
}[];
|
|
9354
9419
|
};
|
|
9355
9420
|
};
|
|
@@ -9432,6 +9497,9 @@ export interface operations {
|
|
|
9432
9497
|
requestBody?: {
|
|
9433
9498
|
content: {
|
|
9434
9499
|
"application/json": {
|
|
9500
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
9501
|
+
projectId?: string;
|
|
9502
|
+
/** @description Accepts either the UUID or the friendly id (e.g. DOC-815); friendly ids are resolved within your organisation. */
|
|
9435
9503
|
documentId: string;
|
|
9436
9504
|
/** @description Filter to a specific version. */
|
|
9437
9505
|
versionNumber?: number;
|
|
@@ -9612,6 +9680,8 @@ export interface operations {
|
|
|
9612
9680
|
requestBody?: {
|
|
9613
9681
|
content: {
|
|
9614
9682
|
"application/json": {
|
|
9683
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
9684
|
+
projectId?: string;
|
|
9615
9685
|
documentId: string;
|
|
9616
9686
|
/** @description Original filename (e.g. screenshot.png). */
|
|
9617
9687
|
fileName: string;
|
|
@@ -9700,6 +9770,8 @@ export interface operations {
|
|
|
9700
9770
|
requestBody?: {
|
|
9701
9771
|
content: {
|
|
9702
9772
|
"application/json": {
|
|
9773
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
9774
|
+
projectId?: string;
|
|
9703
9775
|
documentId: string;
|
|
9704
9776
|
/** @description Optimistic-lock token: the document's versionTimestamp from getDocument() or any mutating tool's response. (Alias accepted: versionTimestamp.) */
|
|
9705
9777
|
documentVersionTimestamp?: number;
|
|
@@ -9992,6 +10064,8 @@ export interface operations {
|
|
|
9992
10064
|
requestBody?: {
|
|
9993
10065
|
content: {
|
|
9994
10066
|
"application/json": {
|
|
10067
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
10068
|
+
projectId?: string;
|
|
9995
10069
|
documentId: string;
|
|
9996
10070
|
/** @description Original filename (e.g. sales-data.csv). Extension auto-detects content type. */
|
|
9997
10071
|
fileName: string;
|
|
@@ -10078,6 +10152,8 @@ export interface operations {
|
|
|
10078
10152
|
requestBody?: {
|
|
10079
10153
|
content: {
|
|
10080
10154
|
"application/json": {
|
|
10155
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
10156
|
+
projectId?: string;
|
|
10081
10157
|
documentId: string;
|
|
10082
10158
|
/** @description Attachment ID to delete. */
|
|
10083
10159
|
attachmentId: string;
|
|
@@ -10542,6 +10618,9 @@ export interface operations {
|
|
|
10542
10618
|
requestBody?: {
|
|
10543
10619
|
content: {
|
|
10544
10620
|
"application/json": {
|
|
10621
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
10622
|
+
projectId?: string;
|
|
10623
|
+
/** @description Accepts either the UUID or the friendly id (e.g. IMP-42); friendly ids are resolved within your organisation. */
|
|
10545
10624
|
improvementId: string;
|
|
10546
10625
|
};
|
|
10547
10626
|
};
|
|
@@ -10626,7 +10705,7 @@ export interface operations {
|
|
|
10626
10705
|
"application/json": {
|
|
10627
10706
|
projectId: string;
|
|
10628
10707
|
title: string;
|
|
10629
|
-
/** @description Type. Default: enhancement. Valid values: feature, bug, tech_debt, architecture_gap, documentation_gap, risk, enhancement, task. Setting type='task' makes the row a task (TAS- prefix); any other type makes it a non-task improvement (IMP- prefix). */
|
|
10708
|
+
/** @description Type. Default: enhancement. Valid values: feature, bug, tech_debt, architecture_gap, documentation_gap, risk, enhancement, task. Despite the tool's name there is no 'improvement' value — pass it and it is accepted as an alias for 'enhancement', which is also the default. Setting type='task' makes the row a task (TAS- prefix); any other type makes it a non-task improvement (IMP- prefix). */
|
|
10630
10709
|
type?: string;
|
|
10631
10710
|
/** @description Priority. Default: medium. */
|
|
10632
10711
|
priority?: string;
|
|
@@ -10648,6 +10727,12 @@ export interface operations {
|
|
|
10648
10727
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
10649
10728
|
id?: string;
|
|
10650
10729
|
text: string;
|
|
10730
|
+
/** @description Server-stamped. Echo back unchanged; ignored on new rows. */
|
|
10731
|
+
updated_at?: string;
|
|
10732
|
+
/** @description Server-stamped user id. Echo back unchanged. */
|
|
10733
|
+
updated_by?: string;
|
|
10734
|
+
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
10735
|
+
updated_by_credential_name?: string;
|
|
10651
10736
|
}[];
|
|
10652
10737
|
/** @description Tick-box checklist shown above acceptance_criteria. The full array REPLACES the stored list on update, and array order = display order — to edit, fetch via getTask/getImprovement, modify, and send back the whole list. Operations: mark done with `completed: true`; un-mark with `completed: false`; add rows by appending `{ text }` (id is auto-minted); remove by omitting; reorder by rearranging. Echo back each existing `id` you keep so per-row attribution (who added/completed it, when) survives. */
|
|
10653
10738
|
checklist?: {
|
|
@@ -10658,6 +10743,18 @@ export interface operations {
|
|
|
10658
10743
|
due_date?: string;
|
|
10659
10744
|
/** @description true = ticked, false/omitted = not done. Server stamps timestamp + actor. */
|
|
10660
10745
|
completed?: boolean;
|
|
10746
|
+
/** @description Server-stamped ISO timestamp. Prefer `completed`; an explicit value here wins if both are sent. */
|
|
10747
|
+
completed_at?: string;
|
|
10748
|
+
/** @description Server-stamped user id. Echo back unchanged. */
|
|
10749
|
+
completed_by?: string;
|
|
10750
|
+
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
10751
|
+
completed_by_credential_name?: string;
|
|
10752
|
+
/** @description Server-stamped. Echo back unchanged; ignored on new rows. */
|
|
10753
|
+
updated_at?: string;
|
|
10754
|
+
/** @description Server-stamped user id. Echo back unchanged. */
|
|
10755
|
+
updated_by?: string;
|
|
10756
|
+
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
10757
|
+
updated_by_credential_name?: string;
|
|
10661
10758
|
}[];
|
|
10662
10759
|
constraints?: string[];
|
|
10663
10760
|
non_goals?: string[];
|
|
@@ -10697,6 +10794,12 @@ export interface operations {
|
|
|
10697
10794
|
wbs_code?: string;
|
|
10698
10795
|
/** @description Progress percentage (0-100). Null means not tracked. */
|
|
10699
10796
|
percent_complete?: number;
|
|
10797
|
+
source_channel?: string;
|
|
10798
|
+
impacted_repositories?: string[];
|
|
10799
|
+
/** @description Free-form JSON for logical links: blocks, blocked_by, duplicates, supersedes, relates_to (arrays of item IDs). */
|
|
10800
|
+
relationships?: Record<string, never>;
|
|
10801
|
+
/** @description Free-form JSON stored alongside the item. On updateImprovement this MERGES rather than replaces. */
|
|
10802
|
+
metadata?: Record<string, never>;
|
|
10700
10803
|
};
|
|
10701
10804
|
};
|
|
10702
10805
|
};
|
|
@@ -10778,6 +10881,8 @@ export interface operations {
|
|
|
10778
10881
|
requestBody?: {
|
|
10779
10882
|
content: {
|
|
10780
10883
|
"application/json": {
|
|
10884
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
10885
|
+
projectId?: string;
|
|
10781
10886
|
improvementId: string;
|
|
10782
10887
|
/** @description Version timestamp from getImprovement() for optimistic locking. */
|
|
10783
10888
|
versionTimestamp: number;
|
|
@@ -10808,6 +10913,12 @@ export interface operations {
|
|
|
10808
10913
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
10809
10914
|
id?: string;
|
|
10810
10915
|
text: string;
|
|
10916
|
+
/** @description Server-stamped. Echo back unchanged; ignored on new rows. */
|
|
10917
|
+
updated_at?: string;
|
|
10918
|
+
/** @description Server-stamped user id. Echo back unchanged. */
|
|
10919
|
+
updated_by?: string;
|
|
10920
|
+
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
10921
|
+
updated_by_credential_name?: string;
|
|
10811
10922
|
}[];
|
|
10812
10923
|
/** @description Tick-box checklist shown above acceptance_criteria. The full array REPLACES the stored list on update, and array order = display order — to edit, fetch via getTask/getImprovement, modify, and send back the whole list. Operations: mark done with `completed: true`; un-mark with `completed: false`; add rows by appending `{ text }` (id is auto-minted); remove by omitting; reorder by rearranging. Echo back each existing `id` you keep so per-row attribution (who added/completed it, when) survives. */
|
|
10813
10924
|
checklist?: {
|
|
@@ -10818,6 +10929,18 @@ export interface operations {
|
|
|
10818
10929
|
due_date?: string;
|
|
10819
10930
|
/** @description true = ticked, false/omitted = not done. Server stamps timestamp + actor. */
|
|
10820
10931
|
completed?: boolean;
|
|
10932
|
+
/** @description Server-stamped ISO timestamp. Prefer `completed`; an explicit value here wins if both are sent. */
|
|
10933
|
+
completed_at?: string;
|
|
10934
|
+
/** @description Server-stamped user id. Echo back unchanged. */
|
|
10935
|
+
completed_by?: string;
|
|
10936
|
+
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
10937
|
+
completed_by_credential_name?: string;
|
|
10938
|
+
/** @description Server-stamped. Echo back unchanged; ignored on new rows. */
|
|
10939
|
+
updated_at?: string;
|
|
10940
|
+
/** @description Server-stamped user id. Echo back unchanged. */
|
|
10941
|
+
updated_by?: string;
|
|
10942
|
+
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
10943
|
+
updated_by_credential_name?: string;
|
|
10821
10944
|
}[];
|
|
10822
10945
|
constraints?: string[];
|
|
10823
10946
|
non_goals?: string[];
|
|
@@ -10843,11 +10966,14 @@ export interface operations {
|
|
|
10843
10966
|
rejection_comment?: string;
|
|
10844
10967
|
/** @description Required when status=done. */
|
|
10845
10968
|
completion_comment?: string;
|
|
10846
|
-
/** @description Required when
|
|
10969
|
+
/** @description Required when moving OUT of a closed status. The closed set is blocked, done, rejected and deferred — note that `blocked` counts as closed, so blocked -> in_progress needs this comment. */
|
|
10847
10970
|
reopened_comment?: string;
|
|
10848
|
-
/** @description Free-form JSON for logical links: blocks, blocked_by, duplicates, supersedes, relates_to (arrays of item IDs). */
|
|
10971
|
+
/** @description Free-form JSON for logical links: blocks, blocked_by, duplicates, supersedes, relates_to (arrays of item IDs). REPLACES the stored object wholesale — read it first and send the complete set. */
|
|
10849
10972
|
relationships?: Record<string, never>;
|
|
10973
|
+
/** @description Free-form JSON. MERGES into the stored object key by key: keys you don't send are left alone, and sending a key with value null deletes it. Send metadata_replace:true to overwrite the whole object instead. (Merging is the default so a partial write can never destroy a sibling key written by another actor.) */
|
|
10850
10974
|
metadata?: Record<string, never>;
|
|
10975
|
+
/** @description Opt out of the metadata merge: true means the object you send REPLACES everything stored, deleting any key you omit. Default false. */
|
|
10976
|
+
metadata_replace?: boolean;
|
|
10851
10977
|
/** @description Link to plan. Null to unlink. */
|
|
10852
10978
|
plan_id?: string;
|
|
10853
10979
|
/** @description Assign to phase. Null to unassign. */
|
|
@@ -10939,6 +11065,8 @@ export interface operations {
|
|
|
10939
11065
|
requestBody?: {
|
|
10940
11066
|
content: {
|
|
10941
11067
|
"application/json": {
|
|
11068
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
11069
|
+
projectId?: string;
|
|
10942
11070
|
improvementId: string;
|
|
10943
11071
|
};
|
|
10944
11072
|
};
|
|
@@ -11453,6 +11581,8 @@ export interface operations {
|
|
|
11453
11581
|
requestBody?: {
|
|
11454
11582
|
content: {
|
|
11455
11583
|
"application/json": {
|
|
11584
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
11585
|
+
projectId?: string;
|
|
11456
11586
|
improvementId: string;
|
|
11457
11587
|
/** @description Summary of the evidence. */
|
|
11458
11588
|
summary: string;
|
|
@@ -11547,6 +11677,8 @@ export interface operations {
|
|
|
11547
11677
|
requestBody?: {
|
|
11548
11678
|
content: {
|
|
11549
11679
|
"application/json": {
|
|
11680
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
11681
|
+
projectId?: string;
|
|
11550
11682
|
improvementId: string;
|
|
11551
11683
|
/** @description Type: comment, agent_update, field_change. Default: comment. */
|
|
11552
11684
|
activityType?: string;
|
|
@@ -12006,6 +12138,9 @@ export interface operations {
|
|
|
12006
12138
|
requestBody?: {
|
|
12007
12139
|
content: {
|
|
12008
12140
|
"application/json": {
|
|
12141
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
12142
|
+
projectId?: string;
|
|
12143
|
+
/** @description Accepts either the UUID or the friendly id (e.g. PLN-3); friendly ids are resolved within your organisation. */
|
|
12009
12144
|
planId: string;
|
|
12010
12145
|
};
|
|
12011
12146
|
};
|
|
@@ -12188,6 +12323,8 @@ export interface operations {
|
|
|
12188
12323
|
requestBody?: {
|
|
12189
12324
|
content: {
|
|
12190
12325
|
"application/json": {
|
|
12326
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
12327
|
+
projectId?: string;
|
|
12191
12328
|
planId: string;
|
|
12192
12329
|
/** @description Version timestamp from getPlan() for optimistic locking. */
|
|
12193
12330
|
versionTimestamp: number;
|
|
@@ -12288,6 +12425,8 @@ export interface operations {
|
|
|
12288
12425
|
requestBody?: {
|
|
12289
12426
|
content: {
|
|
12290
12427
|
"application/json": {
|
|
12428
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
12429
|
+
projectId?: string;
|
|
12291
12430
|
planId: string;
|
|
12292
12431
|
};
|
|
12293
12432
|
};
|
|
@@ -12452,6 +12591,9 @@ export interface operations {
|
|
|
12452
12591
|
requestBody?: {
|
|
12453
12592
|
content: {
|
|
12454
12593
|
"application/json": {
|
|
12594
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
12595
|
+
projectId?: string;
|
|
12596
|
+
/** @description Accepts either the UUID or the friendly id (e.g. PHA-7); friendly ids are resolved within your organisation. */
|
|
12455
12597
|
phaseId: string;
|
|
12456
12598
|
};
|
|
12457
12599
|
};
|
|
@@ -12635,6 +12777,8 @@ export interface operations {
|
|
|
12635
12777
|
requestBody?: {
|
|
12636
12778
|
content: {
|
|
12637
12779
|
"application/json": {
|
|
12780
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
12781
|
+
projectId?: string;
|
|
12638
12782
|
phaseId: string;
|
|
12639
12783
|
/** @description Version timestamp from getPlanPhase() for optimistic locking. */
|
|
12640
12784
|
versionTimestamp: number;
|
|
@@ -12734,6 +12878,8 @@ export interface operations {
|
|
|
12734
12878
|
requestBody?: {
|
|
12735
12879
|
content: {
|
|
12736
12880
|
"application/json": {
|
|
12881
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
12882
|
+
projectId?: string;
|
|
12737
12883
|
phaseId: string;
|
|
12738
12884
|
};
|
|
12739
12885
|
};
|
|
@@ -12902,6 +13048,8 @@ export interface operations {
|
|
|
12902
13048
|
requestBody?: {
|
|
12903
13049
|
content: {
|
|
12904
13050
|
"application/json": {
|
|
13051
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
13052
|
+
projectId?: string;
|
|
12905
13053
|
planId: string;
|
|
12906
13054
|
/** @description Type: comment, agent_update, field_change. Default: comment. */
|
|
12907
13055
|
activityType?: string;
|
|
@@ -13171,17 +13319,35 @@ export interface operations {
|
|
|
13171
13319
|
/** @description Phase to assign to. */
|
|
13172
13320
|
phaseId?: string;
|
|
13173
13321
|
description?: string;
|
|
13174
|
-
/** @description Type. Default: task. Tasks created in plans are typed 'task' (friendly_id prefix TAS-). Override only if you want the row to appear as a non-task improvement (IMP- prefix). */
|
|
13322
|
+
/** @description Type. Default: task. Tasks created in plans are typed 'task' (friendly_id prefix TAS-). Override only if you want the row to appear as a non-task improvement (IMP- prefix). Valid values: feature, bug, tech_debt, architecture_gap, documentation_gap, risk, enhancement, task. */
|
|
13175
13323
|
type?: string;
|
|
13176
13324
|
/** @description Initial status. Default: captured. */
|
|
13177
13325
|
status?: string;
|
|
13178
13326
|
/** @description Priority. Default: medium. */
|
|
13179
13327
|
priority?: string;
|
|
13328
|
+
/** @description e.g. this_week, this_month, this_quarter. */
|
|
13329
|
+
urgency?: string;
|
|
13330
|
+
/** @description Where this task came from (free text, e.g. 'meeting', 'compliance-scan'). Stored for provenance and shown in the improvement/task record. */
|
|
13331
|
+
source?: string;
|
|
13332
|
+
source_channel?: string;
|
|
13333
|
+
/** @description Category ID. */
|
|
13334
|
+
category_id?: string;
|
|
13335
|
+
problem_statement?: string;
|
|
13336
|
+
desired_outcome?: string;
|
|
13337
|
+
business_impact?: string;
|
|
13338
|
+
user_impact?: string;
|
|
13339
|
+
why_now?: string;
|
|
13180
13340
|
/** @description Acceptance criteria — ordered list of pass/fail statements that define "done" for this item. Each row is `{ id, text }` with server-stamped `updated_at / updated_by / updated_by_credential_name`. REPLACES the whole array on update. Echo back existing `id`s on rows you keep so attribution stamps survive. Bare strings are accepted for convenience (e.g. `["row 1", "row 2"]`) and auto-converted to `{ id, text }`. */
|
|
13181
13341
|
acceptance_criteria?: {
|
|
13182
13342
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
13183
13343
|
id?: string;
|
|
13184
13344
|
text: string;
|
|
13345
|
+
/** @description Server-stamped. Echo back unchanged; ignored on new rows. */
|
|
13346
|
+
updated_at?: string;
|
|
13347
|
+
/** @description Server-stamped user id. Echo back unchanged. */
|
|
13348
|
+
updated_by?: string;
|
|
13349
|
+
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
13350
|
+
updated_by_credential_name?: string;
|
|
13185
13351
|
}[];
|
|
13186
13352
|
/** @description Tick-box checklist shown above acceptance_criteria. The full array REPLACES the stored list on update, and array order = display order — to edit, fetch via getTask/getImprovement, modify, and send back the whole list. Operations: mark done with `completed: true`; un-mark with `completed: false`; add rows by appending `{ text }` (id is auto-minted); remove by omitting; reorder by rearranging. Echo back each existing `id` you keep so per-row attribution (who added/completed it, when) survives. */
|
|
13187
13353
|
checklist?: {
|
|
@@ -13192,7 +13358,37 @@ export interface operations {
|
|
|
13192
13358
|
due_date?: string;
|
|
13193
13359
|
/** @description true = ticked, false/omitted = not done. Server stamps timestamp + actor. */
|
|
13194
13360
|
completed?: boolean;
|
|
13361
|
+
/** @description Server-stamped ISO timestamp. Prefer `completed`; an explicit value here wins if both are sent. */
|
|
13362
|
+
completed_at?: string;
|
|
13363
|
+
/** @description Server-stamped user id. Echo back unchanged. */
|
|
13364
|
+
completed_by?: string;
|
|
13365
|
+
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
13366
|
+
completed_by_credential_name?: string;
|
|
13367
|
+
/** @description Server-stamped. Echo back unchanged; ignored on new rows. */
|
|
13368
|
+
updated_at?: string;
|
|
13369
|
+
/** @description Server-stamped user id. Echo back unchanged. */
|
|
13370
|
+
updated_by?: string;
|
|
13371
|
+
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
13372
|
+
updated_by_credential_name?: string;
|
|
13195
13373
|
}[];
|
|
13374
|
+
constraints?: string[];
|
|
13375
|
+
non_goals?: string[];
|
|
13376
|
+
/** @description Array of {id, title}. */
|
|
13377
|
+
impacted_documents?: Record<string, never>[];
|
|
13378
|
+
/** @description Document IDs to link. Titles resolved automatically. */
|
|
13379
|
+
linked_document_ids?: string[];
|
|
13380
|
+
/** @description Array of {id, name}. */
|
|
13381
|
+
impacted_diagrams?: Record<string, never>[];
|
|
13382
|
+
impacted_components?: string[];
|
|
13383
|
+
impacted_repositories?: string[];
|
|
13384
|
+
agent_ready?: boolean;
|
|
13385
|
+
agent_missing_info?: string[];
|
|
13386
|
+
agent_recommended_action?: string;
|
|
13387
|
+
/** @description low, medium, high, very_high. */
|
|
13388
|
+
agent_complexity?: string;
|
|
13389
|
+
/** @description 0.00 to 1.00. */
|
|
13390
|
+
agent_confidence?: number;
|
|
13391
|
+
agent_brief?: string;
|
|
13196
13392
|
/** @description User UUID to assign as owner. MUTUALLY EXCLUSIVE with owner_team_id. Use listAssignablePrincipals(projectId, kind='user') to look up valid UUIDs. */
|
|
13197
13393
|
owner_id?: string;
|
|
13198
13394
|
/** @description Team UUID to assign as owner (assigns the whole team). MUTUALLY EXCLUSIVE with owner_id. Use listTeams or listAssignablePrincipals(kind='team') to look up valid UUIDs. */
|
|
@@ -13207,6 +13403,10 @@ export interface operations {
|
|
|
13207
13403
|
position?: number;
|
|
13208
13404
|
/** @description Progress percentage (0-100). Null means not tracked. */
|
|
13209
13405
|
percent_complete?: number;
|
|
13406
|
+
/** @description Free-form JSON for logical links: blocks, blocked_by, duplicates, supersedes, relates_to (arrays of item IDs). */
|
|
13407
|
+
relationships?: Record<string, never>;
|
|
13408
|
+
/** @description Free-form JSON stored alongside the task. On updateTask this MERGES rather than replaces. */
|
|
13409
|
+
metadata?: Record<string, never>;
|
|
13210
13410
|
};
|
|
13211
13411
|
};
|
|
13212
13412
|
};
|
|
@@ -13390,6 +13590,9 @@ export interface operations {
|
|
|
13390
13590
|
requestBody?: {
|
|
13391
13591
|
content: {
|
|
13392
13592
|
"application/json": {
|
|
13593
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
13594
|
+
projectId?: string;
|
|
13595
|
+
/** @description Accepts either the UUID or the friendly id (e.g. TAS-176); friendly ids are resolved within your organisation. */
|
|
13393
13596
|
taskId: string;
|
|
13394
13597
|
};
|
|
13395
13598
|
};
|
|
@@ -13472,6 +13675,8 @@ export interface operations {
|
|
|
13472
13675
|
requestBody?: {
|
|
13473
13676
|
content: {
|
|
13474
13677
|
"application/json": {
|
|
13678
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
13679
|
+
projectId?: string;
|
|
13475
13680
|
taskId: string;
|
|
13476
13681
|
/** @description Version timestamp from getTask() for optimistic locking. */
|
|
13477
13682
|
versionTimestamp: number;
|
|
@@ -13505,6 +13710,12 @@ export interface operations {
|
|
|
13505
13710
|
/** @description Optional — server mints one if omitted. Preserve on edits. */
|
|
13506
13711
|
id?: string;
|
|
13507
13712
|
text: string;
|
|
13713
|
+
/** @description Server-stamped. Echo back unchanged; ignored on new rows. */
|
|
13714
|
+
updated_at?: string;
|
|
13715
|
+
/** @description Server-stamped user id. Echo back unchanged. */
|
|
13716
|
+
updated_by?: string;
|
|
13717
|
+
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
13718
|
+
updated_by_credential_name?: string;
|
|
13508
13719
|
}[];
|
|
13509
13720
|
/** @description Tick-box checklist shown above acceptance_criteria. The full array REPLACES the stored list on update, and array order = display order — to edit, fetch via getTask/getImprovement, modify, and send back the whole list. Operations: mark done with `completed: true`; un-mark with `completed: false`; add rows by appending `{ text }` (id is auto-minted); remove by omitting; reorder by rearranging. Echo back each existing `id` you keep so per-row attribution (who added/completed it, when) survives. */
|
|
13510
13721
|
checklist?: {
|
|
@@ -13515,6 +13726,18 @@ export interface operations {
|
|
|
13515
13726
|
due_date?: string;
|
|
13516
13727
|
/** @description true = ticked, false/omitted = not done. Server stamps timestamp + actor. */
|
|
13517
13728
|
completed?: boolean;
|
|
13729
|
+
/** @description Server-stamped ISO timestamp. Prefer `completed`; an explicit value here wins if both are sent. */
|
|
13730
|
+
completed_at?: string;
|
|
13731
|
+
/** @description Server-stamped user id. Echo back unchanged. */
|
|
13732
|
+
completed_by?: string;
|
|
13733
|
+
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
13734
|
+
completed_by_credential_name?: string;
|
|
13735
|
+
/** @description Server-stamped. Echo back unchanged; ignored on new rows. */
|
|
13736
|
+
updated_at?: string;
|
|
13737
|
+
/** @description Server-stamped user id. Echo back unchanged. */
|
|
13738
|
+
updated_by?: string;
|
|
13739
|
+
/** @description Server-stamped credential label. Echo back unchanged. */
|
|
13740
|
+
updated_by_credential_name?: string;
|
|
13518
13741
|
}[];
|
|
13519
13742
|
constraints?: string[];
|
|
13520
13743
|
non_goals?: string[];
|
|
@@ -13540,11 +13763,14 @@ export interface operations {
|
|
|
13540
13763
|
rejection_comment?: string;
|
|
13541
13764
|
/** @description Required when status=done. */
|
|
13542
13765
|
completion_comment?: string;
|
|
13543
|
-
/** @description Required when
|
|
13766
|
+
/** @description Required when moving OUT of a closed status. The closed set is blocked, done, rejected and deferred — note that `blocked` counts as closed, so blocked -> in_progress needs this comment. */
|
|
13544
13767
|
reopened_comment?: string;
|
|
13545
|
-
/** @description Free-form JSON for logical links: blocks, blocked_by, duplicates, supersedes, relates_to (arrays of item IDs). */
|
|
13768
|
+
/** @description Free-form JSON for logical links: blocks, blocked_by, duplicates, supersedes, relates_to (arrays of item IDs). REPLACES the stored object wholesale — read it first and send the complete set. */
|
|
13546
13769
|
relationships?: Record<string, never>;
|
|
13770
|
+
/** @description Free-form JSON. MERGES into the stored object key by key: keys you don't send are left alone, and sending a key with value null deletes it. Send metadata_replace:true to overwrite the whole object instead. (Merging is the default so a partial write can never destroy a sibling key written by another actor.) */
|
|
13547
13771
|
metadata?: Record<string, never>;
|
|
13772
|
+
/** @description Opt out of the metadata merge: true means the object you send REPLACES everything stored, deleting any key you omit. Default false. */
|
|
13773
|
+
metadata_replace?: boolean;
|
|
13548
13774
|
/** @description Link to plan. Null to unlink. */
|
|
13549
13775
|
plan_id?: string;
|
|
13550
13776
|
/** @description Assign to phase. Null to unassign. */
|
|
@@ -13630,6 +13856,9 @@ export interface operations {
|
|
|
13630
13856
|
requestBody?: {
|
|
13631
13857
|
content: {
|
|
13632
13858
|
"application/json": {
|
|
13859
|
+
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
13860
|
+
projectId?: string;
|
|
13861
|
+
/** @description Accepts either the UUID or the friendly id (e.g. PLN-3); friendly ids are resolved within your organisation. */
|
|
13633
13862
|
planId: string;
|
|
13634
13863
|
};
|
|
13635
13864
|
};
|
|
@@ -14494,7 +14723,9 @@ export interface operations {
|
|
|
14494
14723
|
* @enum {string}
|
|
14495
14724
|
*/
|
|
14496
14725
|
mode?: "local" | "global" | "graph" | "path" | "ppr";
|
|
14726
|
+
/** @description STRONGLY RECOMMENDED — in practice required. The KG is scoped per project/workspace and there is usually no organisation-wide default, so a call with no projectId and no workspaceId typically matches no scope rule and returns nothing useful. Use listProjects to find the id. */
|
|
14497
14727
|
projectId?: string;
|
|
14728
|
+
/** @description Alternative to projectId — searches the whole workspace subtree. Give one of the two. */
|
|
14498
14729
|
workspaceId?: string;
|
|
14499
14730
|
/** @description Required for mode='path'. Optional source entity for mode='graph'. */
|
|
14500
14731
|
srcEntityId?: string;
|
|
@@ -14673,6 +14904,8 @@ export interface operations {
|
|
|
14673
14904
|
"application/json": {
|
|
14674
14905
|
entityId?: string;
|
|
14675
14906
|
name?: string;
|
|
14907
|
+
/** @description Scope the lookup to one project. Recommended when resolving by `name`, since the same entity name can exist in several projects. */
|
|
14908
|
+
projectId?: string;
|
|
14676
14909
|
};
|
|
14677
14910
|
};
|
|
14678
14911
|
};
|