@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/dist/index.d.ts
CHANGED
|
@@ -34,7 +34,7 @@ interface paths {
|
|
|
34
34
|
put?: never;
|
|
35
35
|
/**
|
|
36
36
|
* listDiagramTypes
|
|
37
|
-
* @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.
|
|
37
|
+
* @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.
|
|
38
38
|
*/
|
|
39
39
|
post: operations["listDiagramTypes"];
|
|
40
40
|
delete?: never;
|
|
@@ -54,7 +54,7 @@ interface paths {
|
|
|
54
54
|
put?: never;
|
|
55
55
|
/**
|
|
56
56
|
* getDiagramTypeGuide
|
|
57
|
-
* @description Get DSL writing instructions for a diagram type. Call before writing diagramCode.
|
|
57
|
+
* @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.
|
|
58
58
|
*/
|
|
59
59
|
post: operations["getDiagramTypeGuide"];
|
|
60
60
|
delete?: never;
|
|
@@ -74,7 +74,7 @@ interface paths {
|
|
|
74
74
|
put?: never;
|
|
75
75
|
/**
|
|
76
76
|
* listArchitectureIcons
|
|
77
|
-
* @description
|
|
77
|
+
* @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.
|
|
78
78
|
*/
|
|
79
79
|
post: operations["listArchitectureIcons"];
|
|
80
80
|
delete?: never;
|
|
@@ -694,7 +694,7 @@ interface paths {
|
|
|
694
694
|
put?: never;
|
|
695
695
|
/**
|
|
696
696
|
* designDeckInWhiteboard
|
|
697
|
-
* @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
|
|
697
|
+
* @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.
|
|
698
698
|
*/
|
|
699
699
|
post: operations["designDeckInWhiteboard"];
|
|
700
700
|
delete?: never;
|
|
@@ -714,7 +714,7 @@ interface paths {
|
|
|
714
714
|
put?: never;
|
|
715
715
|
/**
|
|
716
716
|
* designIllustrationInWhiteboard
|
|
717
|
-
* @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
|
|
717
|
+
* @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.
|
|
718
718
|
*/
|
|
719
719
|
post: operations["designIllustrationInWhiteboard"];
|
|
720
720
|
delete?: never;
|
|
@@ -1094,7 +1094,7 @@ interface paths {
|
|
|
1094
1094
|
put?: never;
|
|
1095
1095
|
/**
|
|
1096
1096
|
* renderDiagram
|
|
1097
|
-
* @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.
|
|
1097
|
+
* @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.
|
|
1098
1098
|
*/
|
|
1099
1099
|
post: operations["renderDiagram"];
|
|
1100
1100
|
delete?: never;
|
|
@@ -2260,6 +2260,8 @@ interface paths {
|
|
|
2260
2260
|
* kg_search
|
|
2261
2261
|
* @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.
|
|
2262
2262
|
*
|
|
2263
|
+
* 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".
|
|
2264
|
+
*
|
|
2263
2265
|
* PICK THE MODE THAT FITS THE QUERY:
|
|
2264
2266
|
*
|
|
2265
2267
|
* • 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.
|
|
@@ -2320,7 +2322,7 @@ interface paths {
|
|
|
2320
2322
|
put?: never;
|
|
2321
2323
|
/**
|
|
2322
2324
|
* kg_get_entity
|
|
2323
|
-
* @description Fetch a KG entity by id or name, with 1-hop neighbours.
|
|
2325
|
+
* @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.
|
|
2324
2326
|
*/
|
|
2325
2327
|
post: operations["kg_get_entity"];
|
|
2326
2328
|
delete?: never;
|
|
@@ -4072,12 +4074,12 @@ interface operations {
|
|
|
4072
4074
|
requestBody?: {
|
|
4073
4075
|
content: {
|
|
4074
4076
|
"application/json": {
|
|
4075
|
-
/** @description Keyword or intent, e.g. 'circuit', 'wiring harness', 'timing'. Semantic-backed: matches descriptions, not just names. */
|
|
4077
|
+
/** @description Keyword or intent, e.g. 'circuit', 'wiring harness', 'timing', 'BPMN process'. Semantic-backed: matches descriptions and diagram family names, not just type names. */
|
|
4076
4078
|
query?: string;
|
|
4077
4079
|
enabledOnly?: boolean;
|
|
4078
4080
|
limit?: number;
|
|
4079
4081
|
offset?: number;
|
|
4080
|
-
/** @description Field projection. Valid fields: type, label, description, whenToUse, dslLanguage, dslInstructions, exampleDsl, enabled, availableOnFree, sortOrder, updatedAt. */
|
|
4082
|
+
/** @description Field projection. Valid fields: type, label, description, whenToUse, dslLanguage, dslInstructions, exampleDsl, enabled, availableOnFree, sortOrder, updatedAt, supportedDiagrams. */
|
|
4081
4083
|
fields?: string[];
|
|
4082
4084
|
};
|
|
4083
4085
|
};
|
|
@@ -4160,6 +4162,7 @@ interface operations {
|
|
|
4160
4162
|
requestBody?: {
|
|
4161
4163
|
content: {
|
|
4162
4164
|
"application/json": {
|
|
4165
|
+
/** @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. */
|
|
4163
4166
|
type: string;
|
|
4164
4167
|
/** @description Field projection. Valid fields: type, label, description, whenToUse, dslLanguage, dslInstructions, exampleDsl, enabled, sortOrder, updatedAt. */
|
|
4165
4168
|
fields?: string[];
|
|
@@ -4244,13 +4247,13 @@ interface operations {
|
|
|
4244
4247
|
requestBody?: {
|
|
4245
4248
|
content: {
|
|
4246
4249
|
"application/json": {
|
|
4247
|
-
/** @description Search by name, category, vendor, or
|
|
4250
|
+
/** @description Search by icon name, exact iconKey, category, vendor, description or aliases. */
|
|
4248
4251
|
query?: string;
|
|
4249
|
-
/** @description Filter by category
|
|
4252
|
+
/** @description Filter by category, e.g. AWS, Azure, GCP, Technology, Oracle Cloud, Kubernetes, Networking, General. */
|
|
4250
4253
|
category?: string;
|
|
4251
4254
|
limit?: number;
|
|
4252
4255
|
offset?: number;
|
|
4253
|
-
/** @description Field projection. Valid fields: id, iconPath, iconName, category, subcategory, vendor, description, searchTerms, tags, useCases, aliases, isFeatured, displayOrder. */
|
|
4256
|
+
/** @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. */
|
|
4254
4257
|
fields?: string[];
|
|
4255
4258
|
};
|
|
4256
4259
|
};
|
|
@@ -6351,9 +6354,9 @@ interface operations {
|
|
|
6351
6354
|
documentId: string;
|
|
6352
6355
|
/** @description Optimistic-lock token: the document's versionTimestamp from getDocument() or any mutating tool's response. (Alias accepted: versionTimestamp.) */
|
|
6353
6356
|
documentVersionTimestamp?: number;
|
|
6354
|
-
/** @description Diagram type (e.g. mermaid, plantuml, bpmn, d2). Call listDiagramTypes for all types. */
|
|
6357
|
+
/** @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. */
|
|
6355
6358
|
type: string;
|
|
6356
|
-
/** @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. */
|
|
6359
|
+
/** @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. */
|
|
6357
6360
|
diagramCode: string;
|
|
6358
6361
|
/** @description Short description of what the diagram shows (1-2 sentences). */
|
|
6359
6362
|
prompt: string;
|
|
@@ -6476,7 +6479,7 @@ interface operations {
|
|
|
6476
6479
|
"application/json": {
|
|
6477
6480
|
/** @description Diagram ID from DIAGRAM_OMITTED markers. */
|
|
6478
6481
|
diagramId: string;
|
|
6479
|
-
/** @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>`). */
|
|
6482
|
+
/** @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>`). */
|
|
6480
6483
|
diagramCode?: string;
|
|
6481
6484
|
/** @description New short description (metadata only — does NOT change the rendered diagram). */
|
|
6482
6485
|
prompt?: string;
|
|
@@ -7054,7 +7057,7 @@ interface operations {
|
|
|
7054
7057
|
maskBase64: string;
|
|
7055
7058
|
/** @description What to put in the masked area, in plain language (e.g. 'replace the car with a red bicycle'). */
|
|
7056
7059
|
prompt: string;
|
|
7057
|
-
/** @description Optional 0..1
|
|
7060
|
+
/** @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. */
|
|
7058
7061
|
strength?: number;
|
|
7059
7062
|
};
|
|
7060
7063
|
};
|
|
@@ -7154,7 +7157,7 @@ interface operations {
|
|
|
7154
7157
|
title?: string;
|
|
7155
7158
|
/** @description Optional brand kit id (from listBrandKits) to theme the deck. If omitted, the organisation's effective brand is used. */
|
|
7156
7159
|
brandKitId?: string;
|
|
7157
|
-
/** @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').
|
|
7160
|
+
/** @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). */
|
|
7158
7161
|
slideCount?: number;
|
|
7159
7162
|
/** @description Deprecated and ignored. Still accepted so existing callers do not break; passing it changes nothing. */
|
|
7160
7163
|
imageCount?: number;
|
|
@@ -8182,8 +8185,8 @@ interface operations {
|
|
|
8182
8185
|
/** @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. */
|
|
8183
8186
|
projectId?: string;
|
|
8184
8187
|
documentId: string;
|
|
8185
|
-
/** @description Optional
|
|
8186
|
-
|
|
8188
|
+
/** @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. */
|
|
8189
|
+
rerouteConnectors?: boolean;
|
|
8187
8190
|
/** @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). */
|
|
8188
8191
|
shapes: ({
|
|
8189
8192
|
/**
|
|
@@ -8563,9 +8566,9 @@ interface operations {
|
|
|
8563
8566
|
"application/json": {
|
|
8564
8567
|
/** @description The whiteboard's documentId. */
|
|
8565
8568
|
documentId: string;
|
|
8566
|
-
/** @description Diagram language, e.g. 'bpmn', 'mermaid', 'd2', 'plantuml', 'graphviz'.
|
|
8569
|
+
/** @description Diagram language, e.g. 'default', 'bpmn', 'mermaid', 'd2', 'plantuml', 'graphviz'. For a diagram family, use its defaultRenderer from listDiagramTypes. */
|
|
8567
8570
|
diagramType: string;
|
|
8568
|
-
/** @description The diagram DSL / code. For
|
|
8571
|
+
/** @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). */
|
|
8569
8572
|
source: string;
|
|
8570
8573
|
/** @description Optional caption shown beneath the diagram. */
|
|
8571
8574
|
caption?: string;
|
|
@@ -9155,12 +9158,12 @@ interface operations {
|
|
|
9155
9158
|
requestBody?: {
|
|
9156
9159
|
content: {
|
|
9157
9160
|
"application/json": {
|
|
9158
|
-
/** @description Diagram language, e.g. 'mermaid', 'd2', 'plantuml', 'graphviz', 'bpmn', 'vegalite'.
|
|
9161
|
+
/** @description Diagram language, e.g. 'default', 'mermaid', 'd2', 'plantuml', 'graphviz', 'bpmn', 'vegalite'. For a diagram family, use its defaultRenderer from listDiagramTypes. */
|
|
9159
9162
|
diagramType: string;
|
|
9160
|
-
/** @description The diagram DSL / code to render. For
|
|
9163
|
+
/** @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). */
|
|
9161
9164
|
source: string;
|
|
9162
9165
|
/**
|
|
9163
|
-
* @description png (default) or jpeg = raster; svg
|
|
9166
|
+
* @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.
|
|
9164
9167
|
* @enum {string}
|
|
9165
9168
|
*/
|
|
9166
9169
|
format?: "png" | "jpeg" | "svg";
|
|
@@ -9261,7 +9264,7 @@ interface operations {
|
|
|
9261
9264
|
/** @description The diagram's id (from getDocument markers / getDiagramInDocument). */
|
|
9262
9265
|
diagramId: string;
|
|
9263
9266
|
/**
|
|
9264
|
-
* @description png (default) or jpeg = raster; svg
|
|
9267
|
+
* @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.
|
|
9265
9268
|
* @enum {string}
|
|
9266
9269
|
*/
|
|
9267
9270
|
format?: "png" | "jpeg" | "svg";
|
|
@@ -10739,8 +10742,11 @@ interface operations {
|
|
|
10739
10742
|
type?: string;
|
|
10740
10743
|
/** @description Priority. Default: medium. */
|
|
10741
10744
|
priority?: string;
|
|
10742
|
-
/**
|
|
10743
|
-
|
|
10745
|
+
/**
|
|
10746
|
+
* @description Initial status. Default: captured.
|
|
10747
|
+
* @enum {string}
|
|
10748
|
+
*/
|
|
10749
|
+
status?: "captured" | "triaging" | "shaped" | "approved" | "ready_for_agent" | "in_progress" | "ready_for_review" | "in_review" | "blocked" | "done" | "rejected" | "deferred";
|
|
10744
10750
|
/** @description Source (e.g. human_manual, agent_review). */
|
|
10745
10751
|
source?: string;
|
|
10746
10752
|
/** @description e.g. this_week, this_month, this_quarter. */
|
|
@@ -10918,7 +10924,8 @@ interface operations {
|
|
|
10918
10924
|
versionTimestamp: number;
|
|
10919
10925
|
title?: string;
|
|
10920
10926
|
type?: string;
|
|
10921
|
-
|
|
10927
|
+
/** @enum {string} */
|
|
10928
|
+
status?: "captured" | "triaging" | "shaped" | "approved" | "ready_for_agent" | "in_progress" | "ready_for_review" | "in_review" | "blocked" | "done" | "rejected" | "deferred";
|
|
10922
10929
|
priority?: string;
|
|
10923
10930
|
urgency?: string;
|
|
10924
10931
|
/** @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. */
|
|
@@ -13352,8 +13359,11 @@ interface operations {
|
|
|
13352
13359
|
description?: string;
|
|
13353
13360
|
/** @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. */
|
|
13354
13361
|
type?: string;
|
|
13355
|
-
/**
|
|
13356
|
-
|
|
13362
|
+
/**
|
|
13363
|
+
* @description Initial status. Default: captured.
|
|
13364
|
+
* @enum {string}
|
|
13365
|
+
*/
|
|
13366
|
+
status?: "captured" | "triaging" | "shaped" | "approved" | "ready_for_agent" | "in_progress" | "ready_for_review" | "in_review" | "blocked" | "done" | "rejected" | "deferred";
|
|
13357
13367
|
/** @description Priority. Default: medium. */
|
|
13358
13368
|
priority?: string;
|
|
13359
13369
|
/** @description e.g. this_week, this_month, this_quarter. */
|
|
@@ -13713,7 +13723,8 @@ interface operations {
|
|
|
13713
13723
|
versionTimestamp: number;
|
|
13714
13724
|
title?: string;
|
|
13715
13725
|
type?: string;
|
|
13716
|
-
|
|
13726
|
+
/** @enum {string} */
|
|
13727
|
+
status?: "captured" | "triaging" | "shaped" | "approved" | "ready_for_agent" | "in_progress" | "ready_for_review" | "in_review" | "blocked" | "done" | "rejected" | "deferred";
|
|
13717
13728
|
priority?: string;
|
|
13718
13729
|
urgency?: string;
|
|
13719
13730
|
/** @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. */
|
|
@@ -14778,6 +14789,12 @@ interface operations {
|
|
|
14778
14789
|
depth?: number;
|
|
14779
14790
|
/** @default 20 */
|
|
14780
14791
|
limit?: number;
|
|
14792
|
+
/** @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. */
|
|
14793
|
+
asOf?: string;
|
|
14794
|
+
/** @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". */
|
|
14795
|
+
history?: boolean;
|
|
14796
|
+
/** @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. */
|
|
14797
|
+
timeZone?: string;
|
|
14781
14798
|
};
|
|
14782
14799
|
};
|
|
14783
14800
|
};
|
|
@@ -14946,6 +14963,12 @@ interface operations {
|
|
|
14946
14963
|
name?: string;
|
|
14947
14964
|
/** @description Scope the lookup to one project. Recommended when resolving by `name`, since the same entity name can exist in several projects. */
|
|
14948
14965
|
projectId?: string;
|
|
14966
|
+
/** @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. */
|
|
14967
|
+
asOf?: string;
|
|
14968
|
+
/** @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". */
|
|
14969
|
+
history?: boolean;
|
|
14970
|
+
/** @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. */
|
|
14971
|
+
timeZone?: string;
|
|
14949
14972
|
};
|
|
14950
14973
|
};
|
|
14951
14974
|
};
|