@stablebaseline/sdk 0.6.2 → 0.7.0
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 +54 -31
- package/dist/index.d.ts +54 -31
- package/openapi.json +111 -33
- package/package.json +1 -1
- package/src/types.generated.ts +54 -31
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. 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.
|
|
38
|
+
* @description List supported diagram types (renderers such as default, mermaid, plantuml, bpmn and d2; 'default' is the platform default renderer). Pass `query` to search by name OR intent (keyword + semantic): e.g. 'circuit diagram', 'wiring harness', 'timing waveform', 'network topology', 'database schema', 'BPMN process'. Each type lists supportedDiagrams: the diagram families it draws (BPMN process, ERD, flowchart, C4, system architecture and more), each with its defaultRenderer. A query that names a family also returns matchedDiagramFamilies. Use a family's defaultRenderer as the type unless you need another renderer's own format (for example BPMN 2.0 XML). Use the returned `type` field with getDiagramTypeGuide (DSL instructions + example) and insertDiagramInDocument / renderDiagram.
|
|
39
39
|
*/
|
|
40
40
|
post: operations["listDiagramTypes"];
|
|
41
41
|
delete?: never;
|
|
@@ -55,7 +55,7 @@ export interface paths {
|
|
|
55
55
|
put?: never;
|
|
56
56
|
/**
|
|
57
57
|
* getDiagramTypeGuide
|
|
58
|
-
* @description Get DSL writing instructions for a diagram type. Call before writing diagramCode.
|
|
58
|
+
* @description Get DSL writing instructions and an example for a diagram type (a renderer such as 'default', 'mermaid' or 'bpmn'). Also accepts a diagram family slug or name from supportedDiagrams (e.g. 'bpmn-process'), which resolves to that family's default renderer (see resolvedFrom). supportedDiagrams lists the families the type draws, each with its defaultRenderer. Call before writing diagramCode.
|
|
59
59
|
*/
|
|
60
60
|
post: operations["getDiagramTypeGuide"];
|
|
61
61
|
delete?: never;
|
|
@@ -75,7 +75,7 @@ export interface paths {
|
|
|
75
75
|
put?: never;
|
|
76
76
|
/**
|
|
77
77
|
* listArchitectureIcons
|
|
78
|
-
* @description
|
|
78
|
+
* @description List and search the full Stable Baseline icon library, including 3,850 library icons. The AWS, Azure, GCP, Development, Essentials and other categories stay intact; library icons join matching categories, with specific Oracle Cloud, Kubernetes, Networking and General categories for the rest. The same logical name is shown once. iconKey is the exact icon string for a platform default diagram (type 'default'; e.g. {icon:'aws-account'}); iconKeys lists every exact key for that logical icon, and iconKeyUrl is its SVG. Results without an iconKey are not available in platform default diagrams. Use d2IconPath for compact relative D2 source (e.g. icon-library/azure-function-apps.svg); the renderer expands storage URLs. Existing iconPath values remain relative whiteboard paths; library-only icons supply iconUrl for a whiteboard imageUrl.
|
|
79
79
|
*/
|
|
80
80
|
post: operations["listArchitectureIcons"];
|
|
81
81
|
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
|
|
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 per 30 slides (1 to 30 slides is 50, 31 to 60 is 100, and so on, with the second and later blocks charged once the deck is built and never charged twice for the same block), an edit costs a flat 50, and a clarifying question is FREE. It can also generate imagery for the deck where the design calls for it. 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 (the target the conversation now carries) and slideCountClamped (always false; nothing reduces a slide count), 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;
|
|
@@ -715,7 +715,7 @@ export interface paths {
|
|
|
715
715
|
put?: never;
|
|
716
716
|
/**
|
|
717
717
|
* designIllustrationInWhiteboard
|
|
718
|
-
* @description Create or refine a standalone ILLUSTRATION INSIDE an existing whiteboard by conversing with the AI design agent. This is the illustration sibling of designDeckInWhiteboard: same conversation, same follow-up flow, but it makes ONE on-brand illustration placed on the board (not a slide deck). Send a brief for a NEW illustration, a change to an existing one, or an answer to the agent's question. The agent generates the illustration, places it on the board, and if the brief is ambiguous it asks ONE clarifying question (answer with the same sessionId). Returns immediately; poll getDeckReplyInWhiteboard for the result. Use it when the user wants a picture they can talk about and refine turn by turn (e.g. 'draw a friendly robot onboarding a new team', then 'make it warmer', 'add a second robot'). For a quick one-shot illustration with no follow-up, use generateIllustrationInWhiteboard instead. WHITEBOARD IS REQUIRED: an illustration 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 illustration 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. COST + APPROVAL: a build costs 50 credits and an edit
|
|
718
|
+
* @description Create or refine a standalone ILLUSTRATION INSIDE an existing whiteboard by conversing with the AI design agent. This is the illustration sibling of designDeckInWhiteboard: same conversation, same follow-up flow, but it makes ONE on-brand illustration placed on the board (not a slide deck). Send a brief for a NEW illustration, a change to an existing one, or an answer to the agent's question. The agent generates the illustration, places it on the board, and if the brief is ambiguous it asks ONE clarifying question (answer with the same sessionId). Returns immediately; poll getDeckReplyInWhiteboard for the result. Use it when the user wants a picture they can talk about and refine turn by turn (e.g. 'draw a friendly robot onboarding a new team', then 'make it warmer', 'add a second robot'). For a quick one-shot illustration with no follow-up, use generateIllustrationInWhiteboard instead. WHITEBOARD IS REQUIRED: an illustration 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 illustration 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. COST + APPROVAL: a build costs 50 credits per 30 slides (1 to 30 slides is 50, 31 to 60 is 100, and so on, with the second and later blocks charged once the deck is built and never charged twice for the same block), an edit costs a flat 50, and 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 illustration's id), status, turnType, started, awaitingUser, needsConfirmation, insufficientCredits, and assistantMessage.
|
|
719
719
|
*/
|
|
720
720
|
post: operations["designIllustrationInWhiteboard"];
|
|
721
721
|
delete?: never;
|
|
@@ -1095,7 +1095,7 @@ export interface paths {
|
|
|
1095
1095
|
put?: never;
|
|
1096
1096
|
/**
|
|
1097
1097
|
* renderDiagram
|
|
1098
|
-
* @description Generate a diagram from its DSL/code and get the IMAGE back — WITHOUT inserting it into any document or whiteboard. For acting as a pure diagram generator. Provide diagramType (e.g. 'mermaid', 'd2', 'plantuml', 'graphviz', 'bpmn', 'vegalite'; call listDiagramTypes for the full set) and source (the diagram code). Choose format 'png' (default), 'jpeg', or 'svg'; for raster choose scale 1/2/3 for 1x/2x/3x; optional background (png only). Returns a TEMPORARY imageUrl that stays available for 1 hour (the render is then deleted), and for png/jpeg the image inline so you can see it. The link carries no signing token, so it survives being rendered as a citation. To render a diagram that already lives in a document/whiteboard use getDiagramImage; to persist a new one use insertDiagramInDocument or insertWhiteboardDiagram.
|
|
1098
|
+
* @description Generate a diagram from its DSL/code and get the IMAGE back — WITHOUT inserting it into any document or whiteboard. For acting as a pure diagram generator. Provide diagramType (e.g. 'default', 'mermaid', 'd2', 'plantuml', 'graphviz', 'bpmn', 'vegalite'; call listDiagramTypes for the full set) and source (the diagram code). Choose format 'png' (default), 'jpeg', or 'svg'; for raster choose scale 1/2/3 for 1x/2x/3x; optional background (png only). Returns a TEMPORARY imageUrl that stays available for 1 hour (the render is then deleted), and for png/jpeg the image inline so you can see it. The link carries no signing token, so it survives being rendered as a citation. To render a diagram that already lives in a document/whiteboard use getDiagramImage; to persist a new one use insertDiagramInDocument or insertWhiteboardDiagram.
|
|
1099
1099
|
*/
|
|
1100
1100
|
post: operations["renderDiagram"];
|
|
1101
1101
|
delete?: never;
|
|
@@ -2261,6 +2261,8 @@ export interface paths {
|
|
|
2261
2261
|
* kg_search
|
|
2262
2262
|
* @description Unified Knowledge Graph KNOWLEDGE retrieval — facts, themes and relationships from INSIDE document CONTENT. To LOCATE AN ARTEFACT BY NAME OR ID rather than answer a question, pass artefactMetadataOnly:true — see below. Without that flag this tool retrieves knowledge from inside content and will not reliably find a thing by its title.
|
|
2263
2263
|
*
|
|
2264
|
+
* DATED FACTS: the response also carries `datedFacts` for the entities the query names: what holds now by default, what held on a day with asOf, or the whole history with history:true, each fact with its dates, how it ended if it has, and its sources. Prefer them for "who owns X now", "what was X in March", "when did X change".
|
|
2265
|
+
*
|
|
2264
2266
|
* PICK THE MODE THAT FITS THE QUERY:
|
|
2265
2267
|
*
|
|
2266
2268
|
* • mode='local' (default) — for SPECIFIC factual questions ("what does section 15 say about deposits?", "who is the Chief Counsel?"). FTS+vector RRF over individual document chunks. Returns precise excerpts with citations.
|
|
@@ -2321,7 +2323,7 @@ export interface paths {
|
|
|
2321
2323
|
put?: never;
|
|
2322
2324
|
/**
|
|
2323
2325
|
* kg_get_entity
|
|
2324
|
-
* @description Fetch a KG entity by id or name, with 1-hop neighbours.
|
|
2326
|
+
* @description Fetch a KG entity by id or name, with 1-hop neighbours. The response also carries `datedFacts`: what holds now about the entity by default, what held on a day with asOf, or the whole history with history:true, each fact with its dates, how it ended if it has, and the sources that state it.
|
|
2325
2327
|
*/
|
|
2326
2328
|
post: operations["kg_get_entity"];
|
|
2327
2329
|
delete?: never;
|
|
@@ -4073,12 +4075,12 @@ export interface operations {
|
|
|
4073
4075
|
requestBody?: {
|
|
4074
4076
|
content: {
|
|
4075
4077
|
"application/json": {
|
|
4076
|
-
/** @description Keyword or intent, e.g. 'circuit', 'wiring harness', 'timing'. Semantic-backed: matches descriptions, not just names. */
|
|
4078
|
+
/** @description Keyword or intent, e.g. 'circuit', 'wiring harness', 'timing', 'BPMN process'. Semantic-backed: matches descriptions and diagram family names, not just type names. */
|
|
4077
4079
|
query?: string;
|
|
4078
4080
|
enabledOnly?: boolean;
|
|
4079
4081
|
limit?: number;
|
|
4080
4082
|
offset?: number;
|
|
4081
|
-
/** @description Field projection. Valid fields: type, label, description, whenToUse, dslLanguage, dslInstructions, exampleDsl, enabled, availableOnFree, sortOrder, updatedAt. */
|
|
4083
|
+
/** @description Field projection. Valid fields: type, label, description, whenToUse, dslLanguage, dslInstructions, exampleDsl, enabled, availableOnFree, sortOrder, updatedAt, supportedDiagrams. */
|
|
4082
4084
|
fields?: string[];
|
|
4083
4085
|
};
|
|
4084
4086
|
};
|
|
@@ -4161,6 +4163,7 @@ export interface operations {
|
|
|
4161
4163
|
requestBody?: {
|
|
4162
4164
|
content: {
|
|
4163
4165
|
"application/json": {
|
|
4166
|
+
/** @description A diagram type from listDiagramTypes (e.g. 'default', 'mermaid', 'bpmn'), or a diagram family slug or name (e.g. 'bpmn-process'), which resolves to the family's default renderer. */
|
|
4164
4167
|
type: string;
|
|
4165
4168
|
/** @description Field projection. Valid fields: type, label, description, whenToUse, dslLanguage, dslInstructions, exampleDsl, enabled, sortOrder, updatedAt. */
|
|
4166
4169
|
fields?: string[];
|
|
@@ -4245,13 +4248,13 @@ export interface operations {
|
|
|
4245
4248
|
requestBody?: {
|
|
4246
4249
|
content: {
|
|
4247
4250
|
"application/json": {
|
|
4248
|
-
/** @description Search by name, category, vendor, or
|
|
4251
|
+
/** @description Search by icon name, exact iconKey, category, vendor, description or aliases. */
|
|
4249
4252
|
query?: string;
|
|
4250
|
-
/** @description Filter by category
|
|
4253
|
+
/** @description Filter by category, e.g. AWS, Azure, GCP, Technology, Oracle Cloud, Kubernetes, Networking, General. */
|
|
4251
4254
|
category?: string;
|
|
4252
4255
|
limit?: number;
|
|
4253
4256
|
offset?: number;
|
|
4254
|
-
/** @description Field projection. Valid fields: id, iconPath, iconName, category, subcategory, vendor, description, searchTerms, tags, useCases, aliases, isFeatured, displayOrder. */
|
|
4257
|
+
/** @description Field projection. Valid fields: id, iconPath (existing relative paths only), iconUrl, iconName, category, categories, sources, iconKey, iconKeys, iconKeyUrl, d2IconPath, subcategory, vendor, description, searchTerms, tags, useCases, aliases, isFeatured, displayOrder. */
|
|
4255
4258
|
fields?: string[];
|
|
4256
4259
|
};
|
|
4257
4260
|
};
|
|
@@ -6352,9 +6355,9 @@ export interface operations {
|
|
|
6352
6355
|
documentId: string;
|
|
6353
6356
|
/** @description Optimistic-lock token: the document's versionTimestamp from getDocument() or any mutating tool's response. (Alias accepted: versionTimestamp.) */
|
|
6354
6357
|
documentVersionTimestamp?: number;
|
|
6355
|
-
/** @description Diagram type (e.g. mermaid, plantuml, bpmn, d2). Call listDiagramTypes for all types. */
|
|
6358
|
+
/** @description Diagram type, meaning the renderer (e.g. default, mermaid, plantuml, bpmn, d2; 'default' is the platform default renderer). For a diagram family such as a BPMN process, an ERD or a flowchart, use the family's defaultRenderer from listDiagramTypes or getDiagramTypeGuide. Call listDiagramTypes for all types. */
|
|
6356
6359
|
type: string;
|
|
6357
|
-
/** @description Diagram DSL code. Call getDiagramTypeGuide for syntax. EXCEPTION — for type 'infographic', put a plain-English DESCRIPTION of the infographic here (NOT code); the system designs the AntV spec and renders it. */
|
|
6360
|
+
/** @description Diagram DSL code. Call getDiagramTypeGuide for syntax. For 'default', provide MDP JSON with stable IDs and omit every entity x/y for automatic layout; fully positioned manual diagrams are also supported, and icons must be exact iconKey values from listArchitectureIcons. EXCEPTION — for type 'infographic', put a plain-English DESCRIPTION of the infographic here (NOT code); the system designs the AntV spec and renders it. */
|
|
6358
6361
|
diagramCode: string;
|
|
6359
6362
|
/** @description Short description of what the diagram shows (1-2 sentences). */
|
|
6360
6363
|
prompt: string;
|
|
@@ -6477,7 +6480,7 @@ export interface operations {
|
|
|
6477
6480
|
"application/json": {
|
|
6478
6481
|
/** @description Diagram ID from DIAGRAM_OMITTED markers. */
|
|
6479
6482
|
diagramId: string;
|
|
6480
|
-
/** @description New diagram DSL source code. REQUIRED to change what the diagram visually renders. Call getDiagramTypeGuide for syntax. Must provide the COMPLETE updated DSL, not just the changed parts. EXCEPTION — for type 'infographic', pass either a plain-English DESCRIPTION of the new infographic (the system designs, renders, and stores the AntV spec, same as insert) or complete AntV Infographic DSL (first line `infographic <template-name>`). */
|
|
6483
|
+
/** @description New diagram DSL source code. REQUIRED to change what the diagram visually renders. Call getDiagramTypeGuide for syntax. Must provide the COMPLETE updated DSL, not just the changed parts. For 'default', provide complete MDP JSON and preserve stable IDs; omit entity x/y for automatic layout, or preserve all x/y in a manually positioned legacy diagram. Root layout.mode='auto' can explicitly rearrange an existing diagram. Its icons must be exact iconKey values from listArchitectureIcons. EXCEPTION — for type 'infographic', pass either a plain-English DESCRIPTION of the new infographic (the system designs, renders, and stores the AntV spec, same as insert) or complete AntV Infographic DSL (first line `infographic <template-name>`). */
|
|
6481
6484
|
diagramCode?: string;
|
|
6482
6485
|
/** @description New short description (metadata only — does NOT change the rendered diagram). */
|
|
6483
6486
|
prompt?: string;
|
|
@@ -7055,7 +7058,7 @@ export interface operations {
|
|
|
7055
7058
|
maskBase64: string;
|
|
7056
7059
|
/** @description What to put in the masked area, in plain language (e.g. 'replace the car with a red bicycle'). */
|
|
7057
7060
|
prompt: string;
|
|
7058
|
-
/** @description Optional 0..1
|
|
7061
|
+
/** @description Optional 0..1: how far the regenerated area may diverge from the original. The editing model may balance this from the prompt instead, so leave it unset unless you need it. */
|
|
7059
7062
|
strength?: number;
|
|
7060
7063
|
};
|
|
7061
7064
|
};
|
|
@@ -7155,7 +7158,7 @@ export interface operations {
|
|
|
7155
7158
|
title?: string;
|
|
7156
7159
|
/** @description Optional brand kit id (from listBrandKits) to theme the deck. If omitted, the organisation's effective brand is used. */
|
|
7157
7160
|
brandKitId?: string;
|
|
7158
|
-
/** @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').
|
|
7161
|
+
/** @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'). THERE IS NO MAXIMUM: ask for 40, 60 or 100 slides and that is what gets built. Longer decks cost proportionally more (50 credits per 30 slides) and take proportionally longer. Omit ONLY when the user gave no count at all; the designer then chooses (typical 6 to 12). */
|
|
7159
7162
|
slideCount?: number;
|
|
7160
7163
|
/** @description Deprecated and ignored. Still accepted so existing callers do not break; passing it changes nothing. */
|
|
7161
7164
|
imageCount?: number;
|
|
@@ -8183,8 +8186,8 @@ export interface operations {
|
|
|
8183
8186
|
/** @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. */
|
|
8184
8187
|
projectId?: string;
|
|
8185
8188
|
documentId: string;
|
|
8186
|
-
/** @description Optional
|
|
8187
|
-
|
|
8189
|
+
/** @description Optional. Arrows and lines bound to a shape at BOTH ends (start.id and end.id) are always routed around the other shapes on the board unless you give them points. true: ignore the points you gave for such connectors and route them too. Omit to keep the points you supply. */
|
|
8190
|
+
rerouteConnectors?: boolean;
|
|
8188
8191
|
/** @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). */
|
|
8189
8192
|
shapes: ({
|
|
8190
8193
|
/**
|
|
@@ -8564,9 +8567,9 @@ export interface operations {
|
|
|
8564
8567
|
"application/json": {
|
|
8565
8568
|
/** @description The whiteboard's documentId. */
|
|
8566
8569
|
documentId: string;
|
|
8567
|
-
/** @description Diagram language, e.g. 'bpmn', 'mermaid', 'd2', 'plantuml', 'graphviz'.
|
|
8570
|
+
/** @description Diagram language, e.g. 'default', 'bpmn', 'mermaid', 'd2', 'plantuml', 'graphviz'. For a diagram family, use its defaultRenderer from listDiagramTypes. */
|
|
8568
8571
|
diagramType: string;
|
|
8569
|
-
/** @description The diagram DSL / code. For
|
|
8572
|
+
/** @description The diagram DSL / code. For 'default', provide MDP JSON with stable IDs and omit entity x/y for automatic layout; fully positioned manual sources remain valid; icons must be exact iconKey values from listArchitectureIcons. For 'infographic', provide a plain-English description instead (the system designs the AntV infographic spec). */
|
|
8570
8573
|
source: string;
|
|
8571
8574
|
/** @description Optional caption shown beneath the diagram. */
|
|
8572
8575
|
caption?: string;
|
|
@@ -9156,12 +9159,12 @@ export interface operations {
|
|
|
9156
9159
|
requestBody?: {
|
|
9157
9160
|
content: {
|
|
9158
9161
|
"application/json": {
|
|
9159
|
-
/** @description Diagram language, e.g. 'mermaid', 'd2', 'plantuml', 'graphviz', 'bpmn', 'vegalite'.
|
|
9162
|
+
/** @description Diagram language, e.g. 'default', 'mermaid', 'd2', 'plantuml', 'graphviz', 'bpmn', 'vegalite'. For a diagram family, use its defaultRenderer from listDiagramTypes. */
|
|
9160
9163
|
diagramType: string;
|
|
9161
|
-
/** @description The diagram DSL / code to render. For
|
|
9164
|
+
/** @description The diagram DSL / code to render. For 'default', provide MDP JSON with stable IDs and omit entity x/y for automatic layout; fully positioned manual sources remain valid; icons must be exact iconKey values from listArchitectureIcons. For 'infographic', provide a plain-English description instead (the system designs the AntV infographic spec). */
|
|
9162
9165
|
source: string;
|
|
9163
9166
|
/**
|
|
9164
|
-
* @description png (default) or jpeg = raster; svg
|
|
9167
|
+
* @description png (default) or jpeg = raster; svg is scalable. A platform default diagram's SVG contains a browser foreignObject scene, so use PNG/JPEG where foreignObject SVG is unsupported.
|
|
9165
9168
|
* @enum {string}
|
|
9166
9169
|
*/
|
|
9167
9170
|
format?: "png" | "jpeg" | "svg";
|
|
@@ -9262,7 +9265,7 @@ export interface operations {
|
|
|
9262
9265
|
/** @description The diagram's id (from getDocument markers / getDiagramInDocument). */
|
|
9263
9266
|
diagramId: string;
|
|
9264
9267
|
/**
|
|
9265
|
-
* @description png (default) or jpeg = raster; svg
|
|
9268
|
+
* @description png (default) or jpeg = raster; svg is scalable. A platform default diagram's SVG contains a browser foreignObject scene, so use PNG/JPEG where foreignObject SVG is unsupported.
|
|
9266
9269
|
* @enum {string}
|
|
9267
9270
|
*/
|
|
9268
9271
|
format?: "png" | "jpeg" | "svg";
|
|
@@ -10740,8 +10743,11 @@ export interface operations {
|
|
|
10740
10743
|
type?: string;
|
|
10741
10744
|
/** @description Priority. Default: medium. */
|
|
10742
10745
|
priority?: string;
|
|
10743
|
-
/**
|
|
10744
|
-
|
|
10746
|
+
/**
|
|
10747
|
+
* @description Initial status. Default: captured.
|
|
10748
|
+
* @enum {string}
|
|
10749
|
+
*/
|
|
10750
|
+
status?: "captured" | "triaging" | "shaped" | "approved" | "ready_for_agent" | "in_progress" | "ready_for_review" | "in_review" | "blocked" | "done" | "rejected" | "deferred";
|
|
10745
10751
|
/** @description Source (e.g. human_manual, agent_review). */
|
|
10746
10752
|
source?: string;
|
|
10747
10753
|
/** @description e.g. this_week, this_month, this_quarter. */
|
|
@@ -10919,7 +10925,8 @@ export interface operations {
|
|
|
10919
10925
|
versionTimestamp: number;
|
|
10920
10926
|
title?: string;
|
|
10921
10927
|
type?: string;
|
|
10922
|
-
|
|
10928
|
+
/** @enum {string} */
|
|
10929
|
+
status?: "captured" | "triaging" | "shaped" | "approved" | "ready_for_agent" | "in_progress" | "ready_for_review" | "in_review" | "blocked" | "done" | "rejected" | "deferred";
|
|
10923
10930
|
priority?: string;
|
|
10924
10931
|
urgency?: string;
|
|
10925
10932
|
/** @description User UUID to assign as owner, or null to unassign. MUTUALLY EXCLUSIVE with owner_team_id — when switching from a user to a team owner, send `owner_id: null` in the same call as `owner_team_id`. Use listAssignablePrincipals(projectId, kind='user', q='…') to look up valid UUIDs. */
|
|
@@ -13353,8 +13360,11 @@ export interface operations {
|
|
|
13353
13360
|
description?: string;
|
|
13354
13361
|
/** @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. */
|
|
13355
13362
|
type?: string;
|
|
13356
|
-
/**
|
|
13357
|
-
|
|
13363
|
+
/**
|
|
13364
|
+
* @description Initial status. Default: captured.
|
|
13365
|
+
* @enum {string}
|
|
13366
|
+
*/
|
|
13367
|
+
status?: "captured" | "triaging" | "shaped" | "approved" | "ready_for_agent" | "in_progress" | "ready_for_review" | "in_review" | "blocked" | "done" | "rejected" | "deferred";
|
|
13358
13368
|
/** @description Priority. Default: medium. */
|
|
13359
13369
|
priority?: string;
|
|
13360
13370
|
/** @description e.g. this_week, this_month, this_quarter. */
|
|
@@ -13714,7 +13724,8 @@ export interface operations {
|
|
|
13714
13724
|
versionTimestamp: number;
|
|
13715
13725
|
title?: string;
|
|
13716
13726
|
type?: string;
|
|
13717
|
-
|
|
13727
|
+
/** @enum {string} */
|
|
13728
|
+
status?: "captured" | "triaging" | "shaped" | "approved" | "ready_for_agent" | "in_progress" | "ready_for_review" | "in_review" | "blocked" | "done" | "rejected" | "deferred";
|
|
13718
13729
|
priority?: string;
|
|
13719
13730
|
urgency?: string;
|
|
13720
13731
|
/** @description User UUID to assign as owner, or null to unassign. MUTUALLY EXCLUSIVE with owner_team_id — when switching from a user to a team owner, send `owner_id: null` in the same call as `owner_team_id`. Use listAssignablePrincipals(projectId, kind='user', q='…') to look up valid UUIDs. */
|
|
@@ -14779,6 +14790,12 @@ export interface operations {
|
|
|
14779
14790
|
depth?: number;
|
|
14780
14791
|
/** @default 20 */
|
|
14781
14792
|
limit?: number;
|
|
14793
|
+
/** @description Dated facts: return what held on this day (YYYY-MM-DD) instead of what holds now. For example the owner, status or supplier as it was on a past date. */
|
|
14794
|
+
asOf?: string;
|
|
14795
|
+
/** @description Dated facts: return every fact with its dates, including facts that have ended (and how they ended) and planned ones, oldest first. Use for "how did X change" or "what was X before". */
|
|
14796
|
+
history?: boolean;
|
|
14797
|
+
/** @description Dated facts: the IANA time zone to give days in (for example Australia/Sydney, Asia/Kolkata, America/New_York). Defaults to the user's saved time zone, else UTC. Pass the user's zone when you know it, so "today" and dates match their calendar. */
|
|
14798
|
+
timeZone?: string;
|
|
14782
14799
|
};
|
|
14783
14800
|
};
|
|
14784
14801
|
};
|
|
@@ -14947,6 +14964,12 @@ export interface operations {
|
|
|
14947
14964
|
name?: string;
|
|
14948
14965
|
/** @description Scope the lookup to one project. Recommended when resolving by `name`, since the same entity name can exist in several projects. */
|
|
14949
14966
|
projectId?: string;
|
|
14967
|
+
/** @description Dated facts: return what held on this day (YYYY-MM-DD) instead of what holds now. For example the owner, status or supplier as it was on a past date. */
|
|
14968
|
+
asOf?: string;
|
|
14969
|
+
/** @description Dated facts: return every fact with its dates, including facts that have ended (and how they ended) and planned ones, oldest first. Use for "how did X change" or "what was X before". */
|
|
14970
|
+
history?: boolean;
|
|
14971
|
+
/** @description Dated facts: the IANA time zone to give days in (for example Australia/Sydney, Asia/Kolkata, America/New_York). Defaults to the user's saved time zone, else UTC. */
|
|
14972
|
+
timeZone?: string;
|
|
14950
14973
|
};
|
|
14951
14974
|
};
|
|
14952
14975
|
};
|