@stablebaseline/sdk 0.10.1 → 0.10.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 +28 -6
- package/dist/index.d.ts +28 -6
- package/openapi.json +57 -6
- package/package.json +1 -1
- package/src/types.generated.ts +28 -6
package/dist/index.d.cts
CHANGED
|
@@ -914,7 +914,7 @@ interface paths {
|
|
|
914
914
|
put?: never;
|
|
915
915
|
/**
|
|
916
916
|
* addWhiteboardElements
|
|
917
|
-
* @description Author shapes onto a whiteboard from high-level specs (you do NOT need the full Excalidraw element schema). Appends to the canvas. PLACEMENT ON AN EXISTING BOARD (critical): NEVER guess x/y onto a board that already has content — guessed coordinates land ON TOP of existing shapes and create an unreadable pile. Either (a) OMIT x/y entirely and the server auto-places the new elements together in clear space BELOW the current content, or (b) FIRST call getWhiteboard({ includeElements:true }) to see where existing shapes already are and choose a genuinely EMPTY region. Pass explicit x/y only for a deliberate layout in space you have confirmed is empty. PREFER THE RICHEST FORM THAT FITS, not plain rectangles: for a sticky/post-it note use { type:'sticky', text, backgroundColor } (a first-class note with an auto-fitting bound label — there is NO sticky-note stencil; OMIT x/y and it is auto-placed in clear space below existing content, so it doesn't land on top of the current drawing); for kanban/scrum/story boards, flowcharts, UML/ER, BPMN, org charts, wireframes/mockups, charts or people use a LIBRARY STENCIL in ONE call — { type:'stencil', stencil:'<name e.g. decision>', x, y } fuzzy-matches by name with no prior listWhiteboardStencils call (pass width/height to SCALE the whole stencil and text to fill its single label); for cloud/software-architecture use ICONS — { type:'image', iconPath:'dev/docker.svg', x, y } (paths from listArchitectureIcons); reserve raw rectangles/ellipses for when no standard form fits. Expressive enough to reproduce hand-drawn style templates (sticky-note brainstorm grids, sketchy mind maps, flowcharts). Each spec: { type: 'rectangle'|'ellipse'|'diamond'|'sticky'|'text'|'arrow'|'line'|'freedraw'|'frame'|'image'|'stencil', id?, x, y, width, height, text? (STRONGLY PREFER setting a shape's label via its own `text` — it becomes a centred, auto-WRAPPED bound label fitted to the shape; do NOT drop a separate type:'text' element on top of a shape as its label. Standalone type:'text' is for free-floating titles/notes and now also wraps to its width; Yes/No label on an arrow — emojis are fine, e.g. a warning sign in a 'Risks' label), fontSize?, fontFamily? (1=hand-drawn default, 2=normal, 3=code), textAlign?, backgroundColor? (name 'blue'/'green'/'yellow'/'pink'/'violet'/'orange'/'teal'/… or hex), strokeColor?, fillStyle? ('solid'|'hachure'|'cross-hatch'), strokeStyle? ('solid'|'dashed'|'dotted' — use 'dashed' for grid/category borders), strokeWidth? (1 thin/2 bold/4 extra), roughness? (0 clean, 1 default, 2 very sketchy/hand-drawn — use 2 for organic mind maps), roundness? (number type or null for sharp), opacity?, name? (frame title), frameId? (put a shape inside a frame), start?:{id}, end?:{id} (connect arrows/lines to shapes by id — connectors AUTO-CLIP to the shape edges, never overrun to the centre, AUTO-ROUTE around any shapes in between so a decision's No/loop-back branch never cuts straight through the boxes between source and target, and bound text auto-wraps + centres), routing? ('straight' default | 'elbow' for clean right-angle flowchart/org-chart connectors | 'curved'), startArrowhead?/endArrowhead? (arrowheads are SOLID filled triangles by default — just OMIT them. Pass null for a plain mind-map spoke with no head. Do NOT pass 'arrow': that is the open 'V' head and is auto-upgraded to a solid triangle anyway), points? ([[0,0],[dx,dy]] relative, only for manual geometry — almost never needed; binding by id is better), props? (escape hatch: any other Excalidraw field) }. ARCHITECTURE ICONS: to place a software-architecture icon (AWS/Azure/GCP/Docker/Kubernetes/databases/etc.), first call listArchitectureIcons to find one, then add a spec { type:'image', iconPath:'<relative_url e.g. dev/docker.svg>', x, y, width:96, height:96, text?:'<caption shown below>' } — the icon is stored as a URL reference (never base64). Use imageUrl instead of iconPath for any other public image. Combine icons with labelled boxes + elbow arrows for clean architecture diagrams. LIBRARY STENCILS: for hand-drawn, on-brand elements (scrum/kanban columns, flowchart symbols, UML/ER, BPMN, org-chart nodes, wireframe widgets, stick figures), FIRST call listWhiteboardStencils to find one, then add { type:'stencil', stencilKey:'<key from listWhiteboardStencils>', x, y } (or { type:'stencil', stencil:'<name e.g. decision>', pack?:'<pack>', x, y } to fuzzy-match by name). A stencil is a mini-whiteboard (a collection of elements) of kind 'symbol' or 'template' (listWhiteboardStencils returns the kind + its embedded `labels`). For a SYMBOL (one atomic labelled node — flowchart box, BPMN task, org node), pass id + text + width/height: the label auto-fits its single slot and arrows bind to it via start/end {id}. For a TEMPLATE (a multi-component layout — Alerts, Forms, Tables, Charts), place it WHOLE (no single text); the result returns its `children` (id + text + colour + position) so you retext, recolour, or DELETE specific parts by id via updateWhiteboardScene (cluster children by y to act on a whole row/variant). STRONGLY prefer stencils over plain rectangles for wireframes/mockups, kanban/scrum boards, UML/BPMN, org charts; for dense flowcharts, plain shapes with bound text + elbow arrows are equally reliable. (For a plain sticky/post-it note use type:'sticky', NOT a stencil — there is no sticky-note stencil.) FRAMES: a frame is a NON-DESTRUCTIVE, ANY-SIZE container. To enclose shapes that ALREADY exist, add ONE type:'frame' sized to cover them (a frame automatically captures the elements inside its bounds) or set those shapes' frameId — never recreate or delete-and-redraw content just to frame it. If a frame doesn't fully cover its content, just RESIZE the frame (patch its width/height). Deleting a frame (deleteIds:[frameId]) leaves all its contents intact on the canvas — it only removes the frame border + title. PRESENTATION/SLIDES: when the user wants a presentation or slide deck, create type:'frame' slides sized width:1280,height:720 (16:9), laid out LEFT-TO-RIGHT at the same y (x: 0, then 1440, 2880, 4320, …), each with a `name` (the slide title). Put every slide's shapes/text/images INSIDE its frame by setting their frameId to that frame's id (give the frame an id and reference it). Slides play in order (left-to-right, then top-to-bottom) in the board's Present mode and export to PPTX, so one frame = one slide. FLOWCHART recipe: rectangles (roundness null for sharp process boxes), diamonds for decisions, arrows with routing:'elbow' and Yes/No as the arrow's text. Use type 'sticky' for sticky/post-it notes (a solid-fill note with an auto-fitting bound label — set text + backgroundColor); type 'line' with no arrowheads + roughness:2 for sketchy mind-map spokes. FREEHAND DOODLES: to actually draw/doodle/sketch freehand, use { type:'freedraw', points } where points is a RELATIVE [[x,y],…] path of the stroke (e.g. a squiggle, circling or annotating something, a hand-drawn star/heart/smiley/arrow, an organic blob) — it renders as one smooth freehand stroke. x/y is the origin; omit x/y to auto-place. Chain several freedraw specs for a multi-stroke doodle. NOTE: freehand is always SOLID (strokeStyle is ignored on freedraw) — colour, strokeWidth and opacity DO apply; a freedraw with strokeStyle:'dashed' or 'dotted' is automatically rendered as a smooth dashed/dotted line so the dashes actually show. Give shapes ids and reference them from connectors. Connectors may also bind to shapes ALREADY on the board by their id (get them via getWhiteboard includeElements:true) — you do NOT need to resend existing shapes; the server reads the live scene to bind the arrow and route it around the other boxes. Great for brainstorms, mind maps, flowcharts, org charts, SWOT, retros. PROCESS: for any non-trivial board call getWhiteboardGuide FIRST to plan it; then after adding, ALWAYS call getWhiteboardImage to SEE the result and check layout, labels, spacing, overlaps and how shapes connect — if anything looks off, fix it with updateWhiteboardScene (patch by id) and render again, iterating until it looks right. RESULT: returns `added` (count), `placement` (bounding box {x,y,width,height} of what you just added) and `autoPlaced` (true when you omitted x/y so it was placed in clear space below existing content) — use placement/autoPlaced to tell the user WHERE the new elements landed, never invent a location.
|
|
917
|
+
* @description Author shapes onto a whiteboard from high-level specs (you do NOT need the full Excalidraw element schema). Appends to the canvas. PLACEMENT ON AN EXISTING BOARD (critical): NEVER guess x/y onto a board that already has content — guessed coordinates land ON TOP of existing shapes and create an unreadable pile. Either (a) OMIT x/y entirely and the server auto-places the new elements together in clear space BELOW the current content, or (b) FIRST call getWhiteboard({ includeElements:true }) to see where existing shapes already are and choose a genuinely EMPTY region. Pass explicit x/y only for a deliberate layout in space you have confirmed is empty. For a CONNECTED drawing (flowchart, org chart, process, decision tree, relationships), omit x/y, connect with elbow arrows and pass arrange:{} (direction DOWN by default): the server lays it out and routes every arrow. PREFER THE RICHEST FORM THAT FITS, not plain rectangles: for a sticky/post-it note use { type:'sticky', text, backgroundColor } (a first-class note with an auto-fitting bound label — there is NO sticky-note stencil; OMIT x/y and it is auto-placed in clear space below existing content, so it doesn't land on top of the current drawing); for kanban/scrum/story boards, flowcharts, UML/ER, BPMN, org charts, wireframes/mockups, charts or people use a LIBRARY STENCIL in ONE call — { type:'stencil', stencil:'<name e.g. decision>', x, y } fuzzy-matches by name with no prior listWhiteboardStencils call (pass width/height to SCALE the whole stencil and text to fill its single label); for cloud/software-architecture use ICONS — { type:'image', iconPath:'dev/docker.svg', x, y } (paths from listArchitectureIcons); reserve raw rectangles/ellipses for when no standard form fits. Expressive enough to reproduce hand-drawn style templates (sticky-note brainstorm grids, sketchy mind maps, flowcharts). Each spec: { type: 'rectangle'|'ellipse'|'diamond'|'sticky'|'text'|'arrow'|'line'|'freedraw'|'frame'|'image'|'stencil', id?, x, y, width, height, text? (STRONGLY PREFER setting a shape's label via its own `text` — it becomes a centred, auto-WRAPPED bound label fitted to the shape; do NOT drop a separate type:'text' element on top of a shape as its label. Standalone type:'text' is for free-floating titles/notes and now also wraps to its width; Yes/No label on an arrow — emojis are fine, e.g. a warning sign in a 'Risks' label), fontSize?, fontFamily? (1=hand-drawn default, 2=normal, 3=code), textAlign?, backgroundColor? (name 'blue'/'green'/'yellow'/'pink'/'violet'/'orange'/'teal'/… or hex), strokeColor?, fillStyle? ('solid'|'hachure'|'cross-hatch'), strokeStyle? ('solid'|'dashed'|'dotted' — use 'dashed' for grid/category borders), strokeWidth? (1 thin/2 bold/4 extra), roughness? (0 clean, 1 default, 2 very sketchy/hand-drawn — use 2 for organic mind maps), roundness? (number type or null for sharp), opacity?, name? (frame title), frameId? (put a shape inside a frame), start?:{id}, end?:{id} (connect arrows/lines to shapes by id — connectors AUTO-CLIP to the shape edges, never overrun to the centre, AUTO-ROUTE around any shapes in between so a decision's No/loop-back branch never cuts straight through the boxes between source and target, and bound text auto-wraps + centres), routing? ('straight' default | 'elbow' for clean right-angle flowchart/org-chart connectors | 'curved'), startArrowhead?/endArrowhead? (arrowheads are SOLID filled triangles by default — just OMIT them. Pass null for a plain mind-map spoke with no head. Do NOT pass 'arrow': that is the open 'V' head and is auto-upgraded to a solid triangle anyway), points? ([[0,0],[dx,dy]] relative, only for manual geometry — almost never needed; binding by id is better), props? (escape hatch: any other Excalidraw field) }. ARCHITECTURE ICONS: to place a software-architecture icon (AWS/Azure/GCP/Docker/Kubernetes/databases/etc.), first call listArchitectureIcons to find one, then add a spec { type:'image', iconPath:'<relative_url e.g. dev/docker.svg>', x, y, width:96, height:96, text?:'<caption shown below>' } — the icon is stored as a URL reference (never base64). Use imageUrl instead of iconPath for any other public image. Combine icons with labelled boxes + elbow arrows for clean architecture diagrams. LIBRARY STENCILS: for hand-drawn, on-brand elements (scrum/kanban columns, flowchart symbols, UML/ER, BPMN, org-chart nodes, wireframe widgets, stick figures), FIRST call listWhiteboardStencils to find one, then add { type:'stencil', stencilKey:'<key from listWhiteboardStencils>', x, y } (or { type:'stencil', stencil:'<name e.g. decision>', pack?:'<pack>', x, y } to fuzzy-match by name). A stencil is a mini-whiteboard (a collection of elements) of kind 'symbol' or 'template' (listWhiteboardStencils returns the kind + its embedded `labels`). For a SYMBOL (one atomic labelled node — flowchart box, BPMN task, org node), pass id + text + width/height: the label auto-fits its single slot and arrows bind to it via start/end {id}. For a TEMPLATE (a multi-component layout — Alerts, Forms, Tables, Charts), place it WHOLE (no single text); the result returns its `children` (id + text + colour + position) so you retext, recolour, or DELETE specific parts by id via updateWhiteboardScene (cluster children by y to act on a whole row/variant). STRONGLY prefer stencils over plain rectangles for wireframes/mockups, kanban/scrum boards, UML/BPMN, org charts; for dense flowcharts, plain shapes with bound text + elbow arrows are equally reliable. (For a plain sticky/post-it note use type:'sticky', NOT a stencil — there is no sticky-note stencil.) FRAMES: a frame is a NON-DESTRUCTIVE, ANY-SIZE container. To enclose shapes that ALREADY exist, add ONE type:'frame' sized to cover them (a frame automatically captures the elements inside its bounds) or set those shapes' frameId — never recreate or delete-and-redraw content just to frame it. If a frame doesn't fully cover its content, just RESIZE the frame (patch its width/height). Deleting a frame (deleteIds:[frameId]) leaves all its contents intact on the canvas — it only removes the frame border + title. PRESENTATION/SLIDES: when the user wants a presentation or slide deck, create type:'frame' slides sized width:1280,height:720 (16:9), laid out LEFT-TO-RIGHT at the same y (x: 0, then 1440, 2880, 4320, …), each with a `name` (the slide title). Put every slide's shapes/text/images INSIDE its frame by setting their frameId to that frame's id (give the frame an id and reference it). Slides play in order (left-to-right, then top-to-bottom) in the board's Present mode and export to PPTX, so one frame = one slide. FLOWCHART recipe: rectangles (roundness null for sharp process boxes), diamonds for decisions, arrows with routing:'elbow' and Yes/No as the arrow's text. Use type 'sticky' for sticky/post-it notes (a solid-fill note with an auto-fitting bound label — set text + backgroundColor); type 'line' with no arrowheads + roughness:2 for sketchy mind-map spokes. FREEHAND DOODLES: to actually draw/doodle/sketch freehand, use { type:'freedraw', points } where points is a RELATIVE [[x,y],…] path of the stroke (e.g. a squiggle, circling or annotating something, a hand-drawn star/heart/smiley/arrow, an organic blob) — it renders as one smooth freehand stroke. x/y is the origin; omit x/y to auto-place. Chain several freedraw specs for a multi-stroke doodle. NOTE: freehand is always SOLID (strokeStyle is ignored on freedraw) — colour, strokeWidth and opacity DO apply; a freedraw with strokeStyle:'dashed' or 'dotted' is automatically rendered as a smooth dashed/dotted line so the dashes actually show. Give shapes ids and reference them from connectors. Connectors may also bind to shapes ALREADY on the board by their id (get them via getWhiteboard includeElements:true) — you do NOT need to resend existing shapes; the server reads the live scene to bind the arrow and route it around the other boxes. Great for brainstorms, mind maps, flowcharts, org charts, SWOT, retros. PROCESS: for any non-trivial board call getWhiteboardGuide FIRST to plan it; then after adding, ALWAYS call getWhiteboardImage to SEE the result and check layout, labels, spacing, overlaps and how shapes connect — if anything looks off, fix it with updateWhiteboardScene (patch by id) and render again, iterating until it looks right. RESULT: returns `added` (count), `placement` (bounding box {x,y,width,height} of what you just added) and `autoPlaced` (true when you omitted x/y so it was placed in clear space below existing content) — use placement/autoPlaced to tell the user WHERE the new elements landed, never invent a location.
|
|
918
918
|
*/
|
|
919
919
|
post: operations["addWhiteboardElements"];
|
|
920
920
|
delete?: never;
|
|
@@ -2624,7 +2624,7 @@ interface paths {
|
|
|
2624
2624
|
put?: never;
|
|
2625
2625
|
/**
|
|
2626
2626
|
* listInvoices
|
|
2627
|
-
* @description List invoices for an organisation, newest first.
|
|
2627
|
+
* @description List invoices for an organisation, newest first: paid, open and refunded ones only (refunded is a paid invoice whose payment was refunded, wholly or partly; amount_refunded says how much). Each carries its invoice number, hosted Stripe invoice URL and PDF link. Stripe IDs are stripped.
|
|
2628
2628
|
*/
|
|
2629
2629
|
post: operations["listInvoices"];
|
|
2630
2630
|
delete?: never;
|
|
@@ -3904,7 +3904,7 @@ interface paths {
|
|
|
3904
3904
|
put?: never;
|
|
3905
3905
|
/**
|
|
3906
3906
|
* updateOrgFeatureFlags
|
|
3907
|
-
* @description Switch organisation modules on or off, one true or false a module: documents, plans, improvements, knowledge_graph, compliance, meeting_scribe, guided_meetings, guided_audit, guided_client_advice, guided_coaching, guided_comedy, guided_discovery, guided_interview, guided_plan_checkin, guided_requirements, guided_sales, guided_speaking, agents, time_tracking, time_approvals, databases, database_public_forms, customer_managed_keys, own_ai. getOrgSettings returns each module's current state. A module can be switched ON only when it is available to the organisation: its plan includes it (for example meeting_scribe needs Plus, Pro or Enterprise), or Stable Baseline made it available. Switching OFF is always allowed (customer_managed_keys excepted while the key is in use). A module that is off is off everywhere: its app pages are hidden, its tools are not offered, its actions are refused, and its background work pauses until it is on again. Nothing is deleted. database_public_forms needs databases on to take effect. Auth: can_admin_org + org owner or admin. Rate limit 30/min.
|
|
3907
|
+
* @description Switch organisation modules on or off, one true or false a module: documents, plans, improvements, knowledge_graph, compliance, meeting_scribe, guided_meetings, guided_audit, guided_client_advice, guided_coaching, guided_comedy, guided_discovery, guided_interview, guided_plan_checkin, guided_requirements, guided_sales, guided_speaking, guided_custom, agents, time_tracking, time_approvals, databases, database_public_forms, customer_managed_keys, own_ai. getOrgSettings returns each module's current state. A module can be switched ON only when it is available to the organisation: its plan includes it (for example meeting_scribe needs Plus, Pro or Enterprise), or Stable Baseline made it available. Switching OFF is always allowed (customer_managed_keys excepted while the key is in use). A module that is off is off everywhere: its app pages are hidden, its tools are not offered, its actions are refused, and its background work pauses until it is on again. Nothing is deleted. database_public_forms needs databases on to take effect. Auth: can_admin_org + org owner or admin. Rate limit 30/min.
|
|
3908
3908
|
*/
|
|
3909
3909
|
post: operations["updateOrgFeatureFlags"];
|
|
3910
3910
|
delete?: never;
|
|
@@ -4284,7 +4284,7 @@ interface paths {
|
|
|
4284
4284
|
put?: never;
|
|
4285
4285
|
/**
|
|
4286
4286
|
* writeDatabaseRows
|
|
4287
|
-
* @description Add rows to a table or change rows, in one of two ways that never mix. Call getDatabase with table first: it gives each field's exact name and choices, how each kind of value is written and which fields are never written. rows (up to 500): written at once, with no mode, changeId or maxRows. A row without id is added; a row with id is changed, touching only the fields you send, so other people's changes to other fields stay (send strict: true with the version you read to refuse a change when the row has changed since). With matchOn (a field marked unique, such as Email), a row without id changes the row holding the same value, or is added when there is none. The rows changed and the rows added are each all or nothing. Values as getDatabase says: choices by name, people by id or "me", files this job holds as {"fileId": "<id>"}, relations by the linked rows' ids, or {"add": [ids], "remove": [ids]} to change some links and keep the rest (a link field holds up to 10,000 links in one row by default). Or every row that matches, without rows: where (or view) picks them; set gives each field a value or a formula for each row; match reads a row of another table; copyFrom adds another table's rows. It previews (the count, the first rows before and after, a changeId); mode "apply" does it in the same call. One call is enough: never one row at a time. undo puts it back. getDatabaseGuide topic bulk_changes (also joins, copying, formulas).
|
|
4287
|
+
* @description Add rows to a table or change rows, in one of two ways that never mix. Call getDatabase with table first: it gives each field's exact name and choices, how each kind of value is written and which fields are never written. rows (up to 500): written at once, with no mode, changeId or maxRows. Each row is {"fields": {"<field name>": value}}, such as {"fields": {"Title": "Q3 report", "Score": 4}}. A row without id is added; a row with id is changed, touching only the fields you send, so other people's changes to other fields stay (send strict: true with the version you read to refuse a change when the row has changed since). With matchOn (a field marked unique, such as Email), a row without id changes the row holding the same value, or is added when there is none. The rows changed and the rows added are each all or nothing. Values as getDatabase says: choices by name, people by id or "me", files this job holds as {"fileId": "<id>"}, relations by the linked rows' ids, or {"add": [ids], "remove": [ids]} to change some links and keep the rest (a link field holds up to 10,000 links in one row by default). Or every row that matches, without rows: where (or view) picks them; set gives each field a value or a formula for each row; match reads a row of another table; copyFrom adds another table's rows. It previews (the count, the first rows before and after, a changeId); mode "apply" does it in the same call. One call is enough: never one row at a time. undo puts it back. getDatabaseGuide topic bulk_changes (also joins, copying, formulas).
|
|
4288
4288
|
*/
|
|
4289
4289
|
post: operations["writeDatabaseRows"];
|
|
4290
4290
|
delete?: never;
|
|
@@ -10915,6 +10915,21 @@ interface operations {
|
|
|
10915
10915
|
documentId: string;
|
|
10916
10916
|
/** @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. */
|
|
10917
10917
|
rerouteConnectors?: boolean;
|
|
10918
|
+
/** @description Optional. Lay out what this call adds the way the board's Arrange does, so you never work out x/y for a connected drawing (a flowchart, an org chart, a process, a decision tree, a web of relationships): the shapes are set out along the way their arrows flow, as a tidy tree when the arrows make one, and every elbow arrow is routed round the shapes, hopping where it crosses another. Pass {} for the defaults. Omit x/y on the shapes you add and give the connectors routing:'elbow' (a straight arrow stays straight between its shapes). What is already on the board stays where it is, apart from what sits beside or below the new shapes, which moves just enough to make room. The result's `arranged` says what happened. */
|
|
10919
|
+
arrange?: {
|
|
10920
|
+
/**
|
|
10921
|
+
* @description The way the arrows flow: DOWN (the default) top to bottom, RIGHT left to right, UP bottom to top, LEFT right to left.
|
|
10922
|
+
* @enum {string}
|
|
10923
|
+
*/
|
|
10924
|
+
direction?: "RIGHT" | "DOWN" | "LEFT" | "UP";
|
|
10925
|
+
/**
|
|
10926
|
+
* @description Optional. network: shapes joined with no flow (peers, relationships), each near the ones it joins, with no direction; tree or flow to insist on one. Left out, shapes whose arrows make a tree are laid out as a tree and the rest flow.
|
|
10927
|
+
* @enum {string}
|
|
10928
|
+
*/
|
|
10929
|
+
arrangement?: "flow" | "tree" | "network";
|
|
10930
|
+
/** @description true: arrange the whole board, not only what this call adds (everything on it may move). */
|
|
10931
|
+
whole?: boolean;
|
|
10932
|
+
};
|
|
10918
10933
|
/** @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). */
|
|
10919
10934
|
shapes: ({
|
|
10920
10935
|
/**
|
|
@@ -31558,6 +31573,8 @@ interface operations {
|
|
|
31558
31573
|
guided_sales?: boolean;
|
|
31559
31574
|
/** @description The Speaking coach template of guided meetings. Needs guided_meetings on. */
|
|
31560
31575
|
guided_speaking?: boolean;
|
|
31576
|
+
/** @description Your own instructions in guided meetings: the person's own words instead of a template. Needs guided_meetings on. */
|
|
31577
|
+
guided_custom?: boolean;
|
|
31561
31578
|
/** @description Agents, with their duties and their connectors. */
|
|
31562
31579
|
agents?: boolean;
|
|
31563
31580
|
/** @description Time tracking: timers and time entries on tasks, improvements and tables. Needs databases on. */
|
|
@@ -33598,7 +33615,7 @@ interface operations {
|
|
|
33598
33615
|
databaseId: string;
|
|
33599
33616
|
/** @description The table's id or name. */
|
|
33600
33617
|
table: string;
|
|
33601
|
-
/** @description A filter. A condition is { "field": <the field's name>, "<operator>": <value> } with exactly one operator, such as { "field": "Status", "is": "Done" }; a group is { "and": [...] } or { "or": [...] } holding 1 to 25 conditions or groups, nested 3 levels deep at most, 25 conditions in all. Operators by field type: text, link, email and phone: is, is_not, is_any_of, is_none_of (a list of 1 to 100 values), contains, does_not_contain, starts_with, is_empty, is_not_empty. Long text: contains, does_not_contain, is_empty, is_not_empty. Numbers (number, currency, percent, rating, duration, automatic number): is, is_not, is_any_of, is_none_of, greater_than, less_than, at_least, at_most, between [low, high], is_empty, is_not_empty. Dates and times: is, before, after, between, in_the_last and in_the_next (a number of days), in_period, is_empty, is_not_empty; a date value is YYYY-MM-DD, an ISO date and time, "today", "yesterday", "tomorrow" or days from today such as "today-30". in_period takes a calendar period by name, such as "this_month" or "year_to_date", or { "period": "month", "offset": -1 } (offset: whole periods from the current one; to_date: only up to today; years_back: that many years earlier). Single choice and status: is, is_not, is_any_of, is_none_of with a choice's name, is_empty, is_not_empty. Multiple choice, person and team: contains_any_of, contains_all_of, contains_none_of (people by id or "me"), is_empty, is_not_empty. Checkbox: is_ticked, is_not_ticked. Relation: links_to, does_not_link_to (row ids), has_any_link, has_no_link. A field of a linked table: name the relation in via, as { "via": ["Account"], "field": "Industry", "is": "Retail" } (rows linked to a row that matches; with a not operator such as is_not, rows linked to none); one relation away, never in a saved view's filter. is_empty, is_not_empty, is_ticked, is_not_ticked, has_any_link and has_no_link take true. Text matching ignores case. */
|
|
33618
|
+
/** @description A filter. A condition is { "field": <the field's name>, "<operator>": <value> } with exactly one operator, such as { "field": "Status", "is": "Done" }; a group is { "and": [...] } or { "or": [...] } holding 1 to 25 conditions or groups, nested 3 levels deep at most, 25 conditions in all. Operators by field type: text, link, email and phone: is, is_not, is_any_of, is_none_of (a list of 1 to 100 values), contains, does_not_contain, starts_with, is_empty, is_not_empty. Long text: contains, does_not_contain, is_empty, is_not_empty. Numbers (number, currency, percent, rating, duration, automatic number): is, is_not, is_any_of, is_none_of, greater_than, less_than, at_least, at_most, between [low, high], is_empty, is_not_empty. Dates and times: is, before, after, between, in_the_last and in_the_next (a number of days), in_period, is_empty, is_not_empty; a date value is YYYY-MM-DD, an ISO date and time, "today", "yesterday", "tomorrow" or days from today such as "today-30". in_period takes a calendar period by name, such as "this_month" or "year_to_date", or { "period": "month", "offset": -1 } (offset: whole periods from the current one; to_date: only up to today; years_back: that many years earlier). Single choice and status: is, is_not, is_any_of, is_none_of with a choice's name, is_empty, is_not_empty. Multiple choice, person and team: contains_any_of, contains_all_of, contains_none_of (people by id or "me"), is_empty, is_not_empty. Checkbox: is_ticked, is_not_ticked. Relation: links_to, does_not_link_to (row ids), has_any_link, has_no_link. A field of a linked table: name the relation in via, as { "via": ["Account"], "field": "Industry", "is": "Retail" } (rows linked to a row that matches; with a not operator such as is_not, rows linked to none); one relation away, never in a saved view's filter. One row's links: { "linked_from": { "table": "Accounts", "row": "<row id>", "link": "Deals" } } keeps the rows that row links to through its link field (a table in another database by its id); never in a saved filter. is_empty, is_not_empty, is_ticked, is_not_ticked, has_any_link and has_no_link take true. Text matching ignores case. */
|
|
33602
33619
|
where?: {
|
|
33603
33620
|
field?: string;
|
|
33604
33621
|
via?: string[];
|
|
@@ -33636,6 +33653,11 @@ interface operations {
|
|
|
33636
33653
|
does_not_link_to?: (number | string)[] | string | number;
|
|
33637
33654
|
has_any_link?: boolean;
|
|
33638
33655
|
has_no_link?: boolean;
|
|
33656
|
+
linked_from?: {
|
|
33657
|
+
table?: string;
|
|
33658
|
+
row?: string;
|
|
33659
|
+
link?: string;
|
|
33660
|
+
};
|
|
33639
33661
|
and?: {
|
|
33640
33662
|
[key: string]: unknown;
|
|
33641
33663
|
}[];
|
|
@@ -34693,7 +34715,7 @@ interface operations {
|
|
|
34693
34715
|
databaseId: string;
|
|
34694
34716
|
/** @description The table's id or name. */
|
|
34695
34717
|
table: string;
|
|
34696
|
-
/** @description
|
|
34718
|
+
/** @description Each row is {"fields": {"<field name>": value}}, with id to change that row: [{"fields": {"Title": "Q3 report", "Score": 4}}]. Rows are written at once, never with mode or changeId. Leave out to change every row that matches. */
|
|
34697
34719
|
rows?: {
|
|
34698
34720
|
/** @description The row to change. Leave out to add a row (or, with matchOn, to add or change one). */
|
|
34699
34721
|
id?: string;
|
package/dist/index.d.ts
CHANGED
|
@@ -914,7 +914,7 @@ interface paths {
|
|
|
914
914
|
put?: never;
|
|
915
915
|
/**
|
|
916
916
|
* addWhiteboardElements
|
|
917
|
-
* @description Author shapes onto a whiteboard from high-level specs (you do NOT need the full Excalidraw element schema). Appends to the canvas. PLACEMENT ON AN EXISTING BOARD (critical): NEVER guess x/y onto a board that already has content — guessed coordinates land ON TOP of existing shapes and create an unreadable pile. Either (a) OMIT x/y entirely and the server auto-places the new elements together in clear space BELOW the current content, or (b) FIRST call getWhiteboard({ includeElements:true }) to see where existing shapes already are and choose a genuinely EMPTY region. Pass explicit x/y only for a deliberate layout in space you have confirmed is empty. PREFER THE RICHEST FORM THAT FITS, not plain rectangles: for a sticky/post-it note use { type:'sticky', text, backgroundColor } (a first-class note with an auto-fitting bound label — there is NO sticky-note stencil; OMIT x/y and it is auto-placed in clear space below existing content, so it doesn't land on top of the current drawing); for kanban/scrum/story boards, flowcharts, UML/ER, BPMN, org charts, wireframes/mockups, charts or people use a LIBRARY STENCIL in ONE call — { type:'stencil', stencil:'<name e.g. decision>', x, y } fuzzy-matches by name with no prior listWhiteboardStencils call (pass width/height to SCALE the whole stencil and text to fill its single label); for cloud/software-architecture use ICONS — { type:'image', iconPath:'dev/docker.svg', x, y } (paths from listArchitectureIcons); reserve raw rectangles/ellipses for when no standard form fits. Expressive enough to reproduce hand-drawn style templates (sticky-note brainstorm grids, sketchy mind maps, flowcharts). Each spec: { type: 'rectangle'|'ellipse'|'diamond'|'sticky'|'text'|'arrow'|'line'|'freedraw'|'frame'|'image'|'stencil', id?, x, y, width, height, text? (STRONGLY PREFER setting a shape's label via its own `text` — it becomes a centred, auto-WRAPPED bound label fitted to the shape; do NOT drop a separate type:'text' element on top of a shape as its label. Standalone type:'text' is for free-floating titles/notes and now also wraps to its width; Yes/No label on an arrow — emojis are fine, e.g. a warning sign in a 'Risks' label), fontSize?, fontFamily? (1=hand-drawn default, 2=normal, 3=code), textAlign?, backgroundColor? (name 'blue'/'green'/'yellow'/'pink'/'violet'/'orange'/'teal'/… or hex), strokeColor?, fillStyle? ('solid'|'hachure'|'cross-hatch'), strokeStyle? ('solid'|'dashed'|'dotted' — use 'dashed' for grid/category borders), strokeWidth? (1 thin/2 bold/4 extra), roughness? (0 clean, 1 default, 2 very sketchy/hand-drawn — use 2 for organic mind maps), roundness? (number type or null for sharp), opacity?, name? (frame title), frameId? (put a shape inside a frame), start?:{id}, end?:{id} (connect arrows/lines to shapes by id — connectors AUTO-CLIP to the shape edges, never overrun to the centre, AUTO-ROUTE around any shapes in between so a decision's No/loop-back branch never cuts straight through the boxes between source and target, and bound text auto-wraps + centres), routing? ('straight' default | 'elbow' for clean right-angle flowchart/org-chart connectors | 'curved'), startArrowhead?/endArrowhead? (arrowheads are SOLID filled triangles by default — just OMIT them. Pass null for a plain mind-map spoke with no head. Do NOT pass 'arrow': that is the open 'V' head and is auto-upgraded to a solid triangle anyway), points? ([[0,0],[dx,dy]] relative, only for manual geometry — almost never needed; binding by id is better), props? (escape hatch: any other Excalidraw field) }. ARCHITECTURE ICONS: to place a software-architecture icon (AWS/Azure/GCP/Docker/Kubernetes/databases/etc.), first call listArchitectureIcons to find one, then add a spec { type:'image', iconPath:'<relative_url e.g. dev/docker.svg>', x, y, width:96, height:96, text?:'<caption shown below>' } — the icon is stored as a URL reference (never base64). Use imageUrl instead of iconPath for any other public image. Combine icons with labelled boxes + elbow arrows for clean architecture diagrams. LIBRARY STENCILS: for hand-drawn, on-brand elements (scrum/kanban columns, flowchart symbols, UML/ER, BPMN, org-chart nodes, wireframe widgets, stick figures), FIRST call listWhiteboardStencils to find one, then add { type:'stencil', stencilKey:'<key from listWhiteboardStencils>', x, y } (or { type:'stencil', stencil:'<name e.g. decision>', pack?:'<pack>', x, y } to fuzzy-match by name). A stencil is a mini-whiteboard (a collection of elements) of kind 'symbol' or 'template' (listWhiteboardStencils returns the kind + its embedded `labels`). For a SYMBOL (one atomic labelled node — flowchart box, BPMN task, org node), pass id + text + width/height: the label auto-fits its single slot and arrows bind to it via start/end {id}. For a TEMPLATE (a multi-component layout — Alerts, Forms, Tables, Charts), place it WHOLE (no single text); the result returns its `children` (id + text + colour + position) so you retext, recolour, or DELETE specific parts by id via updateWhiteboardScene (cluster children by y to act on a whole row/variant). STRONGLY prefer stencils over plain rectangles for wireframes/mockups, kanban/scrum boards, UML/BPMN, org charts; for dense flowcharts, plain shapes with bound text + elbow arrows are equally reliable. (For a plain sticky/post-it note use type:'sticky', NOT a stencil — there is no sticky-note stencil.) FRAMES: a frame is a NON-DESTRUCTIVE, ANY-SIZE container. To enclose shapes that ALREADY exist, add ONE type:'frame' sized to cover them (a frame automatically captures the elements inside its bounds) or set those shapes' frameId — never recreate or delete-and-redraw content just to frame it. If a frame doesn't fully cover its content, just RESIZE the frame (patch its width/height). Deleting a frame (deleteIds:[frameId]) leaves all its contents intact on the canvas — it only removes the frame border + title. PRESENTATION/SLIDES: when the user wants a presentation or slide deck, create type:'frame' slides sized width:1280,height:720 (16:9), laid out LEFT-TO-RIGHT at the same y (x: 0, then 1440, 2880, 4320, …), each with a `name` (the slide title). Put every slide's shapes/text/images INSIDE its frame by setting their frameId to that frame's id (give the frame an id and reference it). Slides play in order (left-to-right, then top-to-bottom) in the board's Present mode and export to PPTX, so one frame = one slide. FLOWCHART recipe: rectangles (roundness null for sharp process boxes), diamonds for decisions, arrows with routing:'elbow' and Yes/No as the arrow's text. Use type 'sticky' for sticky/post-it notes (a solid-fill note with an auto-fitting bound label — set text + backgroundColor); type 'line' with no arrowheads + roughness:2 for sketchy mind-map spokes. FREEHAND DOODLES: to actually draw/doodle/sketch freehand, use { type:'freedraw', points } where points is a RELATIVE [[x,y],…] path of the stroke (e.g. a squiggle, circling or annotating something, a hand-drawn star/heart/smiley/arrow, an organic blob) — it renders as one smooth freehand stroke. x/y is the origin; omit x/y to auto-place. Chain several freedraw specs for a multi-stroke doodle. NOTE: freehand is always SOLID (strokeStyle is ignored on freedraw) — colour, strokeWidth and opacity DO apply; a freedraw with strokeStyle:'dashed' or 'dotted' is automatically rendered as a smooth dashed/dotted line so the dashes actually show. Give shapes ids and reference them from connectors. Connectors may also bind to shapes ALREADY on the board by their id (get them via getWhiteboard includeElements:true) — you do NOT need to resend existing shapes; the server reads the live scene to bind the arrow and route it around the other boxes. Great for brainstorms, mind maps, flowcharts, org charts, SWOT, retros. PROCESS: for any non-trivial board call getWhiteboardGuide FIRST to plan it; then after adding, ALWAYS call getWhiteboardImage to SEE the result and check layout, labels, spacing, overlaps and how shapes connect — if anything looks off, fix it with updateWhiteboardScene (patch by id) and render again, iterating until it looks right. RESULT: returns `added` (count), `placement` (bounding box {x,y,width,height} of what you just added) and `autoPlaced` (true when you omitted x/y so it was placed in clear space below existing content) — use placement/autoPlaced to tell the user WHERE the new elements landed, never invent a location.
|
|
917
|
+
* @description Author shapes onto a whiteboard from high-level specs (you do NOT need the full Excalidraw element schema). Appends to the canvas. PLACEMENT ON AN EXISTING BOARD (critical): NEVER guess x/y onto a board that already has content — guessed coordinates land ON TOP of existing shapes and create an unreadable pile. Either (a) OMIT x/y entirely and the server auto-places the new elements together in clear space BELOW the current content, or (b) FIRST call getWhiteboard({ includeElements:true }) to see where existing shapes already are and choose a genuinely EMPTY region. Pass explicit x/y only for a deliberate layout in space you have confirmed is empty. For a CONNECTED drawing (flowchart, org chart, process, decision tree, relationships), omit x/y, connect with elbow arrows and pass arrange:{} (direction DOWN by default): the server lays it out and routes every arrow. PREFER THE RICHEST FORM THAT FITS, not plain rectangles: for a sticky/post-it note use { type:'sticky', text, backgroundColor } (a first-class note with an auto-fitting bound label — there is NO sticky-note stencil; OMIT x/y and it is auto-placed in clear space below existing content, so it doesn't land on top of the current drawing); for kanban/scrum/story boards, flowcharts, UML/ER, BPMN, org charts, wireframes/mockups, charts or people use a LIBRARY STENCIL in ONE call — { type:'stencil', stencil:'<name e.g. decision>', x, y } fuzzy-matches by name with no prior listWhiteboardStencils call (pass width/height to SCALE the whole stencil and text to fill its single label); for cloud/software-architecture use ICONS — { type:'image', iconPath:'dev/docker.svg', x, y } (paths from listArchitectureIcons); reserve raw rectangles/ellipses for when no standard form fits. Expressive enough to reproduce hand-drawn style templates (sticky-note brainstorm grids, sketchy mind maps, flowcharts). Each spec: { type: 'rectangle'|'ellipse'|'diamond'|'sticky'|'text'|'arrow'|'line'|'freedraw'|'frame'|'image'|'stencil', id?, x, y, width, height, text? (STRONGLY PREFER setting a shape's label via its own `text` — it becomes a centred, auto-WRAPPED bound label fitted to the shape; do NOT drop a separate type:'text' element on top of a shape as its label. Standalone type:'text' is for free-floating titles/notes and now also wraps to its width; Yes/No label on an arrow — emojis are fine, e.g. a warning sign in a 'Risks' label), fontSize?, fontFamily? (1=hand-drawn default, 2=normal, 3=code), textAlign?, backgroundColor? (name 'blue'/'green'/'yellow'/'pink'/'violet'/'orange'/'teal'/… or hex), strokeColor?, fillStyle? ('solid'|'hachure'|'cross-hatch'), strokeStyle? ('solid'|'dashed'|'dotted' — use 'dashed' for grid/category borders), strokeWidth? (1 thin/2 bold/4 extra), roughness? (0 clean, 1 default, 2 very sketchy/hand-drawn — use 2 for organic mind maps), roundness? (number type or null for sharp), opacity?, name? (frame title), frameId? (put a shape inside a frame), start?:{id}, end?:{id} (connect arrows/lines to shapes by id — connectors AUTO-CLIP to the shape edges, never overrun to the centre, AUTO-ROUTE around any shapes in between so a decision's No/loop-back branch never cuts straight through the boxes between source and target, and bound text auto-wraps + centres), routing? ('straight' default | 'elbow' for clean right-angle flowchart/org-chart connectors | 'curved'), startArrowhead?/endArrowhead? (arrowheads are SOLID filled triangles by default — just OMIT them. Pass null for a plain mind-map spoke with no head. Do NOT pass 'arrow': that is the open 'V' head and is auto-upgraded to a solid triangle anyway), points? ([[0,0],[dx,dy]] relative, only for manual geometry — almost never needed; binding by id is better), props? (escape hatch: any other Excalidraw field) }. ARCHITECTURE ICONS: to place a software-architecture icon (AWS/Azure/GCP/Docker/Kubernetes/databases/etc.), first call listArchitectureIcons to find one, then add a spec { type:'image', iconPath:'<relative_url e.g. dev/docker.svg>', x, y, width:96, height:96, text?:'<caption shown below>' } — the icon is stored as a URL reference (never base64). Use imageUrl instead of iconPath for any other public image. Combine icons with labelled boxes + elbow arrows for clean architecture diagrams. LIBRARY STENCILS: for hand-drawn, on-brand elements (scrum/kanban columns, flowchart symbols, UML/ER, BPMN, org-chart nodes, wireframe widgets, stick figures), FIRST call listWhiteboardStencils to find one, then add { type:'stencil', stencilKey:'<key from listWhiteboardStencils>', x, y } (or { type:'stencil', stencil:'<name e.g. decision>', pack?:'<pack>', x, y } to fuzzy-match by name). A stencil is a mini-whiteboard (a collection of elements) of kind 'symbol' or 'template' (listWhiteboardStencils returns the kind + its embedded `labels`). For a SYMBOL (one atomic labelled node — flowchart box, BPMN task, org node), pass id + text + width/height: the label auto-fits its single slot and arrows bind to it via start/end {id}. For a TEMPLATE (a multi-component layout — Alerts, Forms, Tables, Charts), place it WHOLE (no single text); the result returns its `children` (id + text + colour + position) so you retext, recolour, or DELETE specific parts by id via updateWhiteboardScene (cluster children by y to act on a whole row/variant). STRONGLY prefer stencils over plain rectangles for wireframes/mockups, kanban/scrum boards, UML/BPMN, org charts; for dense flowcharts, plain shapes with bound text + elbow arrows are equally reliable. (For a plain sticky/post-it note use type:'sticky', NOT a stencil — there is no sticky-note stencil.) FRAMES: a frame is a NON-DESTRUCTIVE, ANY-SIZE container. To enclose shapes that ALREADY exist, add ONE type:'frame' sized to cover them (a frame automatically captures the elements inside its bounds) or set those shapes' frameId — never recreate or delete-and-redraw content just to frame it. If a frame doesn't fully cover its content, just RESIZE the frame (patch its width/height). Deleting a frame (deleteIds:[frameId]) leaves all its contents intact on the canvas — it only removes the frame border + title. PRESENTATION/SLIDES: when the user wants a presentation or slide deck, create type:'frame' slides sized width:1280,height:720 (16:9), laid out LEFT-TO-RIGHT at the same y (x: 0, then 1440, 2880, 4320, …), each with a `name` (the slide title). Put every slide's shapes/text/images INSIDE its frame by setting their frameId to that frame's id (give the frame an id and reference it). Slides play in order (left-to-right, then top-to-bottom) in the board's Present mode and export to PPTX, so one frame = one slide. FLOWCHART recipe: rectangles (roundness null for sharp process boxes), diamonds for decisions, arrows with routing:'elbow' and Yes/No as the arrow's text. Use type 'sticky' for sticky/post-it notes (a solid-fill note with an auto-fitting bound label — set text + backgroundColor); type 'line' with no arrowheads + roughness:2 for sketchy mind-map spokes. FREEHAND DOODLES: to actually draw/doodle/sketch freehand, use { type:'freedraw', points } where points is a RELATIVE [[x,y],…] path of the stroke (e.g. a squiggle, circling or annotating something, a hand-drawn star/heart/smiley/arrow, an organic blob) — it renders as one smooth freehand stroke. x/y is the origin; omit x/y to auto-place. Chain several freedraw specs for a multi-stroke doodle. NOTE: freehand is always SOLID (strokeStyle is ignored on freedraw) — colour, strokeWidth and opacity DO apply; a freedraw with strokeStyle:'dashed' or 'dotted' is automatically rendered as a smooth dashed/dotted line so the dashes actually show. Give shapes ids and reference them from connectors. Connectors may also bind to shapes ALREADY on the board by their id (get them via getWhiteboard includeElements:true) — you do NOT need to resend existing shapes; the server reads the live scene to bind the arrow and route it around the other boxes. Great for brainstorms, mind maps, flowcharts, org charts, SWOT, retros. PROCESS: for any non-trivial board call getWhiteboardGuide FIRST to plan it; then after adding, ALWAYS call getWhiteboardImage to SEE the result and check layout, labels, spacing, overlaps and how shapes connect — if anything looks off, fix it with updateWhiteboardScene (patch by id) and render again, iterating until it looks right. RESULT: returns `added` (count), `placement` (bounding box {x,y,width,height} of what you just added) and `autoPlaced` (true when you omitted x/y so it was placed in clear space below existing content) — use placement/autoPlaced to tell the user WHERE the new elements landed, never invent a location.
|
|
918
918
|
*/
|
|
919
919
|
post: operations["addWhiteboardElements"];
|
|
920
920
|
delete?: never;
|
|
@@ -2624,7 +2624,7 @@ interface paths {
|
|
|
2624
2624
|
put?: never;
|
|
2625
2625
|
/**
|
|
2626
2626
|
* listInvoices
|
|
2627
|
-
* @description List invoices for an organisation, newest first.
|
|
2627
|
+
* @description List invoices for an organisation, newest first: paid, open and refunded ones only (refunded is a paid invoice whose payment was refunded, wholly or partly; amount_refunded says how much). Each carries its invoice number, hosted Stripe invoice URL and PDF link. Stripe IDs are stripped.
|
|
2628
2628
|
*/
|
|
2629
2629
|
post: operations["listInvoices"];
|
|
2630
2630
|
delete?: never;
|
|
@@ -3904,7 +3904,7 @@ interface paths {
|
|
|
3904
3904
|
put?: never;
|
|
3905
3905
|
/**
|
|
3906
3906
|
* updateOrgFeatureFlags
|
|
3907
|
-
* @description Switch organisation modules on or off, one true or false a module: documents, plans, improvements, knowledge_graph, compliance, meeting_scribe, guided_meetings, guided_audit, guided_client_advice, guided_coaching, guided_comedy, guided_discovery, guided_interview, guided_plan_checkin, guided_requirements, guided_sales, guided_speaking, agents, time_tracking, time_approvals, databases, database_public_forms, customer_managed_keys, own_ai. getOrgSettings returns each module's current state. A module can be switched ON only when it is available to the organisation: its plan includes it (for example meeting_scribe needs Plus, Pro or Enterprise), or Stable Baseline made it available. Switching OFF is always allowed (customer_managed_keys excepted while the key is in use). A module that is off is off everywhere: its app pages are hidden, its tools are not offered, its actions are refused, and its background work pauses until it is on again. Nothing is deleted. database_public_forms needs databases on to take effect. Auth: can_admin_org + org owner or admin. Rate limit 30/min.
|
|
3907
|
+
* @description Switch organisation modules on or off, one true or false a module: documents, plans, improvements, knowledge_graph, compliance, meeting_scribe, guided_meetings, guided_audit, guided_client_advice, guided_coaching, guided_comedy, guided_discovery, guided_interview, guided_plan_checkin, guided_requirements, guided_sales, guided_speaking, guided_custom, agents, time_tracking, time_approvals, databases, database_public_forms, customer_managed_keys, own_ai. getOrgSettings returns each module's current state. A module can be switched ON only when it is available to the organisation: its plan includes it (for example meeting_scribe needs Plus, Pro or Enterprise), or Stable Baseline made it available. Switching OFF is always allowed (customer_managed_keys excepted while the key is in use). A module that is off is off everywhere: its app pages are hidden, its tools are not offered, its actions are refused, and its background work pauses until it is on again. Nothing is deleted. database_public_forms needs databases on to take effect. Auth: can_admin_org + org owner or admin. Rate limit 30/min.
|
|
3908
3908
|
*/
|
|
3909
3909
|
post: operations["updateOrgFeatureFlags"];
|
|
3910
3910
|
delete?: never;
|
|
@@ -4284,7 +4284,7 @@ interface paths {
|
|
|
4284
4284
|
put?: never;
|
|
4285
4285
|
/**
|
|
4286
4286
|
* writeDatabaseRows
|
|
4287
|
-
* @description Add rows to a table or change rows, in one of two ways that never mix. Call getDatabase with table first: it gives each field's exact name and choices, how each kind of value is written and which fields are never written. rows (up to 500): written at once, with no mode, changeId or maxRows. A row without id is added; a row with id is changed, touching only the fields you send, so other people's changes to other fields stay (send strict: true with the version you read to refuse a change when the row has changed since). With matchOn (a field marked unique, such as Email), a row without id changes the row holding the same value, or is added when there is none. The rows changed and the rows added are each all or nothing. Values as getDatabase says: choices by name, people by id or "me", files this job holds as {"fileId": "<id>"}, relations by the linked rows' ids, or {"add": [ids], "remove": [ids]} to change some links and keep the rest (a link field holds up to 10,000 links in one row by default). Or every row that matches, without rows: where (or view) picks them; set gives each field a value or a formula for each row; match reads a row of another table; copyFrom adds another table's rows. It previews (the count, the first rows before and after, a changeId); mode "apply" does it in the same call. One call is enough: never one row at a time. undo puts it back. getDatabaseGuide topic bulk_changes (also joins, copying, formulas).
|
|
4287
|
+
* @description Add rows to a table or change rows, in one of two ways that never mix. Call getDatabase with table first: it gives each field's exact name and choices, how each kind of value is written and which fields are never written. rows (up to 500): written at once, with no mode, changeId or maxRows. Each row is {"fields": {"<field name>": value}}, such as {"fields": {"Title": "Q3 report", "Score": 4}}. A row without id is added; a row with id is changed, touching only the fields you send, so other people's changes to other fields stay (send strict: true with the version you read to refuse a change when the row has changed since). With matchOn (a field marked unique, such as Email), a row without id changes the row holding the same value, or is added when there is none. The rows changed and the rows added are each all or nothing. Values as getDatabase says: choices by name, people by id or "me", files this job holds as {"fileId": "<id>"}, relations by the linked rows' ids, or {"add": [ids], "remove": [ids]} to change some links and keep the rest (a link field holds up to 10,000 links in one row by default). Or every row that matches, without rows: where (or view) picks them; set gives each field a value or a formula for each row; match reads a row of another table; copyFrom adds another table's rows. It previews (the count, the first rows before and after, a changeId); mode "apply" does it in the same call. One call is enough: never one row at a time. undo puts it back. getDatabaseGuide topic bulk_changes (also joins, copying, formulas).
|
|
4288
4288
|
*/
|
|
4289
4289
|
post: operations["writeDatabaseRows"];
|
|
4290
4290
|
delete?: never;
|
|
@@ -10915,6 +10915,21 @@ interface operations {
|
|
|
10915
10915
|
documentId: string;
|
|
10916
10916
|
/** @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. */
|
|
10917
10917
|
rerouteConnectors?: boolean;
|
|
10918
|
+
/** @description Optional. Lay out what this call adds the way the board's Arrange does, so you never work out x/y for a connected drawing (a flowchart, an org chart, a process, a decision tree, a web of relationships): the shapes are set out along the way their arrows flow, as a tidy tree when the arrows make one, and every elbow arrow is routed round the shapes, hopping where it crosses another. Pass {} for the defaults. Omit x/y on the shapes you add and give the connectors routing:'elbow' (a straight arrow stays straight between its shapes). What is already on the board stays where it is, apart from what sits beside or below the new shapes, which moves just enough to make room. The result's `arranged` says what happened. */
|
|
10919
|
+
arrange?: {
|
|
10920
|
+
/**
|
|
10921
|
+
* @description The way the arrows flow: DOWN (the default) top to bottom, RIGHT left to right, UP bottom to top, LEFT right to left.
|
|
10922
|
+
* @enum {string}
|
|
10923
|
+
*/
|
|
10924
|
+
direction?: "RIGHT" | "DOWN" | "LEFT" | "UP";
|
|
10925
|
+
/**
|
|
10926
|
+
* @description Optional. network: shapes joined with no flow (peers, relationships), each near the ones it joins, with no direction; tree or flow to insist on one. Left out, shapes whose arrows make a tree are laid out as a tree and the rest flow.
|
|
10927
|
+
* @enum {string}
|
|
10928
|
+
*/
|
|
10929
|
+
arrangement?: "flow" | "tree" | "network";
|
|
10930
|
+
/** @description true: arrange the whole board, not only what this call adds (everything on it may move). */
|
|
10931
|
+
whole?: boolean;
|
|
10932
|
+
};
|
|
10918
10933
|
/** @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). */
|
|
10919
10934
|
shapes: ({
|
|
10920
10935
|
/**
|
|
@@ -31558,6 +31573,8 @@ interface operations {
|
|
|
31558
31573
|
guided_sales?: boolean;
|
|
31559
31574
|
/** @description The Speaking coach template of guided meetings. Needs guided_meetings on. */
|
|
31560
31575
|
guided_speaking?: boolean;
|
|
31576
|
+
/** @description Your own instructions in guided meetings: the person's own words instead of a template. Needs guided_meetings on. */
|
|
31577
|
+
guided_custom?: boolean;
|
|
31561
31578
|
/** @description Agents, with their duties and their connectors. */
|
|
31562
31579
|
agents?: boolean;
|
|
31563
31580
|
/** @description Time tracking: timers and time entries on tasks, improvements and tables. Needs databases on. */
|
|
@@ -33598,7 +33615,7 @@ interface operations {
|
|
|
33598
33615
|
databaseId: string;
|
|
33599
33616
|
/** @description The table's id or name. */
|
|
33600
33617
|
table: string;
|
|
33601
|
-
/** @description A filter. A condition is { "field": <the field's name>, "<operator>": <value> } with exactly one operator, such as { "field": "Status", "is": "Done" }; a group is { "and": [...] } or { "or": [...] } holding 1 to 25 conditions or groups, nested 3 levels deep at most, 25 conditions in all. Operators by field type: text, link, email and phone: is, is_not, is_any_of, is_none_of (a list of 1 to 100 values), contains, does_not_contain, starts_with, is_empty, is_not_empty. Long text: contains, does_not_contain, is_empty, is_not_empty. Numbers (number, currency, percent, rating, duration, automatic number): is, is_not, is_any_of, is_none_of, greater_than, less_than, at_least, at_most, between [low, high], is_empty, is_not_empty. Dates and times: is, before, after, between, in_the_last and in_the_next (a number of days), in_period, is_empty, is_not_empty; a date value is YYYY-MM-DD, an ISO date and time, "today", "yesterday", "tomorrow" or days from today such as "today-30". in_period takes a calendar period by name, such as "this_month" or "year_to_date", or { "period": "month", "offset": -1 } (offset: whole periods from the current one; to_date: only up to today; years_back: that many years earlier). Single choice and status: is, is_not, is_any_of, is_none_of with a choice's name, is_empty, is_not_empty. Multiple choice, person and team: contains_any_of, contains_all_of, contains_none_of (people by id or "me"), is_empty, is_not_empty. Checkbox: is_ticked, is_not_ticked. Relation: links_to, does_not_link_to (row ids), has_any_link, has_no_link. A field of a linked table: name the relation in via, as { "via": ["Account"], "field": "Industry", "is": "Retail" } (rows linked to a row that matches; with a not operator such as is_not, rows linked to none); one relation away, never in a saved view's filter. is_empty, is_not_empty, is_ticked, is_not_ticked, has_any_link and has_no_link take true. Text matching ignores case. */
|
|
33618
|
+
/** @description A filter. A condition is { "field": <the field's name>, "<operator>": <value> } with exactly one operator, such as { "field": "Status", "is": "Done" }; a group is { "and": [...] } or { "or": [...] } holding 1 to 25 conditions or groups, nested 3 levels deep at most, 25 conditions in all. Operators by field type: text, link, email and phone: is, is_not, is_any_of, is_none_of (a list of 1 to 100 values), contains, does_not_contain, starts_with, is_empty, is_not_empty. Long text: contains, does_not_contain, is_empty, is_not_empty. Numbers (number, currency, percent, rating, duration, automatic number): is, is_not, is_any_of, is_none_of, greater_than, less_than, at_least, at_most, between [low, high], is_empty, is_not_empty. Dates and times: is, before, after, between, in_the_last and in_the_next (a number of days), in_period, is_empty, is_not_empty; a date value is YYYY-MM-DD, an ISO date and time, "today", "yesterday", "tomorrow" or days from today such as "today-30". in_period takes a calendar period by name, such as "this_month" or "year_to_date", or { "period": "month", "offset": -1 } (offset: whole periods from the current one; to_date: only up to today; years_back: that many years earlier). Single choice and status: is, is_not, is_any_of, is_none_of with a choice's name, is_empty, is_not_empty. Multiple choice, person and team: contains_any_of, contains_all_of, contains_none_of (people by id or "me"), is_empty, is_not_empty. Checkbox: is_ticked, is_not_ticked. Relation: links_to, does_not_link_to (row ids), has_any_link, has_no_link. A field of a linked table: name the relation in via, as { "via": ["Account"], "field": "Industry", "is": "Retail" } (rows linked to a row that matches; with a not operator such as is_not, rows linked to none); one relation away, never in a saved view's filter. One row's links: { "linked_from": { "table": "Accounts", "row": "<row id>", "link": "Deals" } } keeps the rows that row links to through its link field (a table in another database by its id); never in a saved filter. is_empty, is_not_empty, is_ticked, is_not_ticked, has_any_link and has_no_link take true. Text matching ignores case. */
|
|
33602
33619
|
where?: {
|
|
33603
33620
|
field?: string;
|
|
33604
33621
|
via?: string[];
|
|
@@ -33636,6 +33653,11 @@ interface operations {
|
|
|
33636
33653
|
does_not_link_to?: (number | string)[] | string | number;
|
|
33637
33654
|
has_any_link?: boolean;
|
|
33638
33655
|
has_no_link?: boolean;
|
|
33656
|
+
linked_from?: {
|
|
33657
|
+
table?: string;
|
|
33658
|
+
row?: string;
|
|
33659
|
+
link?: string;
|
|
33660
|
+
};
|
|
33639
33661
|
and?: {
|
|
33640
33662
|
[key: string]: unknown;
|
|
33641
33663
|
}[];
|
|
@@ -34693,7 +34715,7 @@ interface operations {
|
|
|
34693
34715
|
databaseId: string;
|
|
34694
34716
|
/** @description The table's id or name. */
|
|
34695
34717
|
table: string;
|
|
34696
|
-
/** @description
|
|
34718
|
+
/** @description Each row is {"fields": {"<field name>": value}}, with id to change that row: [{"fields": {"Title": "Q3 report", "Score": 4}}]. Rows are written at once, never with mode or changeId. Leave out to change every row that matches. */
|
|
34697
34719
|
rows?: {
|
|
34698
34720
|
/** @description The row to change. Leave out to add a row (or, with matchOn, to add or change one). */
|
|
34699
34721
|
id?: string;
|
package/openapi.json
CHANGED
|
@@ -9805,7 +9805,7 @@
|
|
|
9805
9805
|
"/tools/addWhiteboardElements": {
|
|
9806
9806
|
"post": {
|
|
9807
9807
|
"summary": "addWhiteboardElements",
|
|
9808
|
-
"description": "Author shapes onto a whiteboard from high-level specs (you do NOT need the full Excalidraw element schema). Appends to the canvas. PLACEMENT ON AN EXISTING BOARD (critical): NEVER guess x/y onto a board that already has content — guessed coordinates land ON TOP of existing shapes and create an unreadable pile. Either (a) OMIT x/y entirely and the server auto-places the new elements together in clear space BELOW the current content, or (b) FIRST call getWhiteboard({ includeElements:true }) to see where existing shapes already are and choose a genuinely EMPTY region. Pass explicit x/y only for a deliberate layout in space you have confirmed is empty. PREFER THE RICHEST FORM THAT FITS, not plain rectangles: for a sticky/post-it note use { type:'sticky', text, backgroundColor } (a first-class note with an auto-fitting bound label — there is NO sticky-note stencil; OMIT x/y and it is auto-placed in clear space below existing content, so it doesn't land on top of the current drawing); for kanban/scrum/story boards, flowcharts, UML/ER, BPMN, org charts, wireframes/mockups, charts or people use a LIBRARY STENCIL in ONE call — { type:'stencil', stencil:'<name e.g. decision>', x, y } fuzzy-matches by name with no prior listWhiteboardStencils call (pass width/height to SCALE the whole stencil and text to fill its single label); for cloud/software-architecture use ICONS — { type:'image', iconPath:'dev/docker.svg', x, y } (paths from listArchitectureIcons); reserve raw rectangles/ellipses for when no standard form fits. Expressive enough to reproduce hand-drawn style templates (sticky-note brainstorm grids, sketchy mind maps, flowcharts). Each spec: { type: 'rectangle'|'ellipse'|'diamond'|'sticky'|'text'|'arrow'|'line'|'freedraw'|'frame'|'image'|'stencil', id?, x, y, width, height, text? (STRONGLY PREFER setting a shape's label via its own `text` — it becomes a centred, auto-WRAPPED bound label fitted to the shape; do NOT drop a separate type:'text' element on top of a shape as its label. Standalone type:'text' is for free-floating titles/notes and now also wraps to its width; Yes/No label on an arrow — emojis are fine, e.g. a warning sign in a 'Risks' label), fontSize?, fontFamily? (1=hand-drawn default, 2=normal, 3=code), textAlign?, backgroundColor? (name 'blue'/'green'/'yellow'/'pink'/'violet'/'orange'/'teal'/… or hex), strokeColor?, fillStyle? ('solid'|'hachure'|'cross-hatch'), strokeStyle? ('solid'|'dashed'|'dotted' — use 'dashed' for grid/category borders), strokeWidth? (1 thin/2 bold/4 extra), roughness? (0 clean, 1 default, 2 very sketchy/hand-drawn — use 2 for organic mind maps), roundness? (number type or null for sharp), opacity?, name? (frame title), frameId? (put a shape inside a frame), start?:{id}, end?:{id} (connect arrows/lines to shapes by id — connectors AUTO-CLIP to the shape edges, never overrun to the centre, AUTO-ROUTE around any shapes in between so a decision's No/loop-back branch never cuts straight through the boxes between source and target, and bound text auto-wraps + centres), routing? ('straight' default | 'elbow' for clean right-angle flowchart/org-chart connectors | 'curved'), startArrowhead?/endArrowhead? (arrowheads are SOLID filled triangles by default — just OMIT them. Pass null for a plain mind-map spoke with no head. Do NOT pass 'arrow': that is the open 'V' head and is auto-upgraded to a solid triangle anyway), points? ([[0,0],[dx,dy]] relative, only for manual geometry — almost never needed; binding by id is better), props? (escape hatch: any other Excalidraw field) }. ARCHITECTURE ICONS: to place a software-architecture icon (AWS/Azure/GCP/Docker/Kubernetes/databases/etc.), first call listArchitectureIcons to find one, then add a spec { type:'image', iconPath:'<relative_url e.g. dev/docker.svg>', x, y, width:96, height:96, text?:'<caption shown below>' } — the icon is stored as a URL reference (never base64). Use imageUrl instead of iconPath for any other public image. Combine icons with labelled boxes + elbow arrows for clean architecture diagrams. LIBRARY STENCILS: for hand-drawn, on-brand elements (scrum/kanban columns, flowchart symbols, UML/ER, BPMN, org-chart nodes, wireframe widgets, stick figures), FIRST call listWhiteboardStencils to find one, then add { type:'stencil', stencilKey:'<key from listWhiteboardStencils>', x, y } (or { type:'stencil', stencil:'<name e.g. decision>', pack?:'<pack>', x, y } to fuzzy-match by name). A stencil is a mini-whiteboard (a collection of elements) of kind 'symbol' or 'template' (listWhiteboardStencils returns the kind + its embedded `labels`). For a SYMBOL (one atomic labelled node — flowchart box, BPMN task, org node), pass id + text + width/height: the label auto-fits its single slot and arrows bind to it via start/end {id}. For a TEMPLATE (a multi-component layout — Alerts, Forms, Tables, Charts), place it WHOLE (no single text); the result returns its `children` (id + text + colour + position) so you retext, recolour, or DELETE specific parts by id via updateWhiteboardScene (cluster children by y to act on a whole row/variant). STRONGLY prefer stencils over plain rectangles for wireframes/mockups, kanban/scrum boards, UML/BPMN, org charts; for dense flowcharts, plain shapes with bound text + elbow arrows are equally reliable. (For a plain sticky/post-it note use type:'sticky', NOT a stencil — there is no sticky-note stencil.) FRAMES: a frame is a NON-DESTRUCTIVE, ANY-SIZE container. To enclose shapes that ALREADY exist, add ONE type:'frame' sized to cover them (a frame automatically captures the elements inside its bounds) or set those shapes' frameId — never recreate or delete-and-redraw content just to frame it. If a frame doesn't fully cover its content, just RESIZE the frame (patch its width/height). Deleting a frame (deleteIds:[frameId]) leaves all its contents intact on the canvas — it only removes the frame border + title. PRESENTATION/SLIDES: when the user wants a presentation or slide deck, create type:'frame' slides sized width:1280,height:720 (16:9), laid out LEFT-TO-RIGHT at the same y (x: 0, then 1440, 2880, 4320, …), each with a `name` (the slide title). Put every slide's shapes/text/images INSIDE its frame by setting their frameId to that frame's id (give the frame an id and reference it). Slides play in order (left-to-right, then top-to-bottom) in the board's Present mode and export to PPTX, so one frame = one slide. FLOWCHART recipe: rectangles (roundness null for sharp process boxes), diamonds for decisions, arrows with routing:'elbow' and Yes/No as the arrow's text. Use type 'sticky' for sticky/post-it notes (a solid-fill note with an auto-fitting bound label — set text + backgroundColor); type 'line' with no arrowheads + roughness:2 for sketchy mind-map spokes. FREEHAND DOODLES: to actually draw/doodle/sketch freehand, use { type:'freedraw', points } where points is a RELATIVE [[x,y],…] path of the stroke (e.g. a squiggle, circling or annotating something, a hand-drawn star/heart/smiley/arrow, an organic blob) — it renders as one smooth freehand stroke. x/y is the origin; omit x/y to auto-place. Chain several freedraw specs for a multi-stroke doodle. NOTE: freehand is always SOLID (strokeStyle is ignored on freedraw) — colour, strokeWidth and opacity DO apply; a freedraw with strokeStyle:'dashed' or 'dotted' is automatically rendered as a smooth dashed/dotted line so the dashes actually show. Give shapes ids and reference them from connectors. Connectors may also bind to shapes ALREADY on the board by their id (get them via getWhiteboard includeElements:true) — you do NOT need to resend existing shapes; the server reads the live scene to bind the arrow and route it around the other boxes. Great for brainstorms, mind maps, flowcharts, org charts, SWOT, retros. PROCESS: for any non-trivial board call getWhiteboardGuide FIRST to plan it; then after adding, ALWAYS call getWhiteboardImage to SEE the result and check layout, labels, spacing, overlaps and how shapes connect — if anything looks off, fix it with updateWhiteboardScene (patch by id) and render again, iterating until it looks right. RESULT: returns `added` (count), `placement` (bounding box {x,y,width,height} of what you just added) and `autoPlaced` (true when you omitted x/y so it was placed in clear space below existing content) — use placement/autoPlaced to tell the user WHERE the new elements landed, never invent a location.",
|
|
9808
|
+
"description": "Author shapes onto a whiteboard from high-level specs (you do NOT need the full Excalidraw element schema). Appends to the canvas. PLACEMENT ON AN EXISTING BOARD (critical): NEVER guess x/y onto a board that already has content — guessed coordinates land ON TOP of existing shapes and create an unreadable pile. Either (a) OMIT x/y entirely and the server auto-places the new elements together in clear space BELOW the current content, or (b) FIRST call getWhiteboard({ includeElements:true }) to see where existing shapes already are and choose a genuinely EMPTY region. Pass explicit x/y only for a deliberate layout in space you have confirmed is empty. For a CONNECTED drawing (flowchart, org chart, process, decision tree, relationships), omit x/y, connect with elbow arrows and pass arrange:{} (direction DOWN by default): the server lays it out and routes every arrow. PREFER THE RICHEST FORM THAT FITS, not plain rectangles: for a sticky/post-it note use { type:'sticky', text, backgroundColor } (a first-class note with an auto-fitting bound label — there is NO sticky-note stencil; OMIT x/y and it is auto-placed in clear space below existing content, so it doesn't land on top of the current drawing); for kanban/scrum/story boards, flowcharts, UML/ER, BPMN, org charts, wireframes/mockups, charts or people use a LIBRARY STENCIL in ONE call — { type:'stencil', stencil:'<name e.g. decision>', x, y } fuzzy-matches by name with no prior listWhiteboardStencils call (pass width/height to SCALE the whole stencil and text to fill its single label); for cloud/software-architecture use ICONS — { type:'image', iconPath:'dev/docker.svg', x, y } (paths from listArchitectureIcons); reserve raw rectangles/ellipses for when no standard form fits. Expressive enough to reproduce hand-drawn style templates (sticky-note brainstorm grids, sketchy mind maps, flowcharts). Each spec: { type: 'rectangle'|'ellipse'|'diamond'|'sticky'|'text'|'arrow'|'line'|'freedraw'|'frame'|'image'|'stencil', id?, x, y, width, height, text? (STRONGLY PREFER setting a shape's label via its own `text` — it becomes a centred, auto-WRAPPED bound label fitted to the shape; do NOT drop a separate type:'text' element on top of a shape as its label. Standalone type:'text' is for free-floating titles/notes and now also wraps to its width; Yes/No label on an arrow — emojis are fine, e.g. a warning sign in a 'Risks' label), fontSize?, fontFamily? (1=hand-drawn default, 2=normal, 3=code), textAlign?, backgroundColor? (name 'blue'/'green'/'yellow'/'pink'/'violet'/'orange'/'teal'/… or hex), strokeColor?, fillStyle? ('solid'|'hachure'|'cross-hatch'), strokeStyle? ('solid'|'dashed'|'dotted' — use 'dashed' for grid/category borders), strokeWidth? (1 thin/2 bold/4 extra), roughness? (0 clean, 1 default, 2 very sketchy/hand-drawn — use 2 for organic mind maps), roundness? (number type or null for sharp), opacity?, name? (frame title), frameId? (put a shape inside a frame), start?:{id}, end?:{id} (connect arrows/lines to shapes by id — connectors AUTO-CLIP to the shape edges, never overrun to the centre, AUTO-ROUTE around any shapes in between so a decision's No/loop-back branch never cuts straight through the boxes between source and target, and bound text auto-wraps + centres), routing? ('straight' default | 'elbow' for clean right-angle flowchart/org-chart connectors | 'curved'), startArrowhead?/endArrowhead? (arrowheads are SOLID filled triangles by default — just OMIT them. Pass null for a plain mind-map spoke with no head. Do NOT pass 'arrow': that is the open 'V' head and is auto-upgraded to a solid triangle anyway), points? ([[0,0],[dx,dy]] relative, only for manual geometry — almost never needed; binding by id is better), props? (escape hatch: any other Excalidraw field) }. ARCHITECTURE ICONS: to place a software-architecture icon (AWS/Azure/GCP/Docker/Kubernetes/databases/etc.), first call listArchitectureIcons to find one, then add a spec { type:'image', iconPath:'<relative_url e.g. dev/docker.svg>', x, y, width:96, height:96, text?:'<caption shown below>' } — the icon is stored as a URL reference (never base64). Use imageUrl instead of iconPath for any other public image. Combine icons with labelled boxes + elbow arrows for clean architecture diagrams. LIBRARY STENCILS: for hand-drawn, on-brand elements (scrum/kanban columns, flowchart symbols, UML/ER, BPMN, org-chart nodes, wireframe widgets, stick figures), FIRST call listWhiteboardStencils to find one, then add { type:'stencil', stencilKey:'<key from listWhiteboardStencils>', x, y } (or { type:'stencil', stencil:'<name e.g. decision>', pack?:'<pack>', x, y } to fuzzy-match by name). A stencil is a mini-whiteboard (a collection of elements) of kind 'symbol' or 'template' (listWhiteboardStencils returns the kind + its embedded `labels`). For a SYMBOL (one atomic labelled node — flowchart box, BPMN task, org node), pass id + text + width/height: the label auto-fits its single slot and arrows bind to it via start/end {id}. For a TEMPLATE (a multi-component layout — Alerts, Forms, Tables, Charts), place it WHOLE (no single text); the result returns its `children` (id + text + colour + position) so you retext, recolour, or DELETE specific parts by id via updateWhiteboardScene (cluster children by y to act on a whole row/variant). STRONGLY prefer stencils over plain rectangles for wireframes/mockups, kanban/scrum boards, UML/BPMN, org charts; for dense flowcharts, plain shapes with bound text + elbow arrows are equally reliable. (For a plain sticky/post-it note use type:'sticky', NOT a stencil — there is no sticky-note stencil.) FRAMES: a frame is a NON-DESTRUCTIVE, ANY-SIZE container. To enclose shapes that ALREADY exist, add ONE type:'frame' sized to cover them (a frame automatically captures the elements inside its bounds) or set those shapes' frameId — never recreate or delete-and-redraw content just to frame it. If a frame doesn't fully cover its content, just RESIZE the frame (patch its width/height). Deleting a frame (deleteIds:[frameId]) leaves all its contents intact on the canvas — it only removes the frame border + title. PRESENTATION/SLIDES: when the user wants a presentation or slide deck, create type:'frame' slides sized width:1280,height:720 (16:9), laid out LEFT-TO-RIGHT at the same y (x: 0, then 1440, 2880, 4320, …), each with a `name` (the slide title). Put every slide's shapes/text/images INSIDE its frame by setting their frameId to that frame's id (give the frame an id and reference it). Slides play in order (left-to-right, then top-to-bottom) in the board's Present mode and export to PPTX, so one frame = one slide. FLOWCHART recipe: rectangles (roundness null for sharp process boxes), diamonds for decisions, arrows with routing:'elbow' and Yes/No as the arrow's text. Use type 'sticky' for sticky/post-it notes (a solid-fill note with an auto-fitting bound label — set text + backgroundColor); type 'line' with no arrowheads + roughness:2 for sketchy mind-map spokes. FREEHAND DOODLES: to actually draw/doodle/sketch freehand, use { type:'freedraw', points } where points is a RELATIVE [[x,y],…] path of the stroke (e.g. a squiggle, circling or annotating something, a hand-drawn star/heart/smiley/arrow, an organic blob) — it renders as one smooth freehand stroke. x/y is the origin; omit x/y to auto-place. Chain several freedraw specs for a multi-stroke doodle. NOTE: freehand is always SOLID (strokeStyle is ignored on freedraw) — colour, strokeWidth and opacity DO apply; a freedraw with strokeStyle:'dashed' or 'dotted' is automatically rendered as a smooth dashed/dotted line so the dashes actually show. Give shapes ids and reference them from connectors. Connectors may also bind to shapes ALREADY on the board by their id (get them via getWhiteboard includeElements:true) — you do NOT need to resend existing shapes; the server reads the live scene to bind the arrow and route it around the other boxes. Great for brainstorms, mind maps, flowcharts, org charts, SWOT, retros. PROCESS: for any non-trivial board call getWhiteboardGuide FIRST to plan it; then after adding, ALWAYS call getWhiteboardImage to SEE the result and check layout, labels, spacing, overlaps and how shapes connect — if anything looks off, fix it with updateWhiteboardScene (patch by id) and render again, iterating until it looks right. RESULT: returns `added` (count), `placement` (bounding box {x,y,width,height} of what you just added) and `autoPlaced` (true when you omitted x/y so it was placed in clear space below existing content) — use placement/autoPlaced to tell the user WHERE the new elements landed, never invent a location.",
|
|
9809
9809
|
"operationId": "addWhiteboardElements",
|
|
9810
9810
|
"tags": [
|
|
9811
9811
|
"whiteboards"
|
|
@@ -9841,6 +9841,36 @@
|
|
|
9841
9841
|
"type": "boolean",
|
|
9842
9842
|
"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."
|
|
9843
9843
|
},
|
|
9844
|
+
"arrange": {
|
|
9845
|
+
"type": "object",
|
|
9846
|
+
"description": "Optional. Lay out what this call adds the way the board's Arrange does, so you never work out x/y for a connected drawing (a flowchart, an org chart, a process, a decision tree, a web of relationships): the shapes are set out along the way their arrows flow, as a tidy tree when the arrows make one, and every elbow arrow is routed round the shapes, hopping where it crosses another. Pass {} for the defaults. Omit x/y on the shapes you add and give the connectors routing:'elbow' (a straight arrow stays straight between its shapes). What is already on the board stays where it is, apart from what sits beside or below the new shapes, which moves just enough to make room. The result's `arranged` says what happened.",
|
|
9847
|
+
"properties": {
|
|
9848
|
+
"direction": {
|
|
9849
|
+
"type": "string",
|
|
9850
|
+
"enum": [
|
|
9851
|
+
"RIGHT",
|
|
9852
|
+
"DOWN",
|
|
9853
|
+
"LEFT",
|
|
9854
|
+
"UP"
|
|
9855
|
+
],
|
|
9856
|
+
"description": "The way the arrows flow: DOWN (the default) top to bottom, RIGHT left to right, UP bottom to top, LEFT right to left."
|
|
9857
|
+
},
|
|
9858
|
+
"arrangement": {
|
|
9859
|
+
"type": "string",
|
|
9860
|
+
"enum": [
|
|
9861
|
+
"flow",
|
|
9862
|
+
"tree",
|
|
9863
|
+
"network"
|
|
9864
|
+
],
|
|
9865
|
+
"description": "Optional. network: shapes joined with no flow (peers, relationships), each near the ones it joins, with no direction; tree or flow to insist on one. Left out, shapes whose arrows make a tree are laid out as a tree and the rest flow."
|
|
9866
|
+
},
|
|
9867
|
+
"whole": {
|
|
9868
|
+
"type": "boolean",
|
|
9869
|
+
"description": "true: arrange the whole board, not only what this call adds (everything on it may move)."
|
|
9870
|
+
}
|
|
9871
|
+
},
|
|
9872
|
+
"additionalProperties": false
|
|
9873
|
+
},
|
|
9844
9874
|
"shapes": {
|
|
9845
9875
|
"type": "array",
|
|
9846
9876
|
"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).",
|
|
@@ -29923,7 +29953,7 @@
|
|
|
29923
29953
|
"/tools/listInvoices": {
|
|
29924
29954
|
"post": {
|
|
29925
29955
|
"summary": "listInvoices",
|
|
29926
|
-
"description": "List invoices for an organisation, newest first.
|
|
29956
|
+
"description": "List invoices for an organisation, newest first: paid, open and refunded ones only (refunded is a paid invoice whose payment was refunded, wholly or partly; amount_refunded says how much). Each carries its invoice number, hosted Stripe invoice URL and PDF link. Stripe IDs are stripped.",
|
|
29927
29957
|
"operationId": "listInvoices",
|
|
29928
29958
|
"tags": [
|
|
29929
29959
|
"billing"
|
|
@@ -42303,7 +42333,7 @@
|
|
|
42303
42333
|
"/tools/updateOrgFeatureFlags": {
|
|
42304
42334
|
"post": {
|
|
42305
42335
|
"summary": "updateOrgFeatureFlags",
|
|
42306
|
-
"description": "Switch organisation modules on or off, one true or false a module: documents, plans, improvements, knowledge_graph, compliance, meeting_scribe, guided_meetings, guided_audit, guided_client_advice, guided_coaching, guided_comedy, guided_discovery, guided_interview, guided_plan_checkin, guided_requirements, guided_sales, guided_speaking, agents, time_tracking, time_approvals, databases, database_public_forms, customer_managed_keys, own_ai. getOrgSettings returns each module's current state. A module can be switched ON only when it is available to the organisation: its plan includes it (for example meeting_scribe needs Plus, Pro or Enterprise), or Stable Baseline made it available. Switching OFF is always allowed (customer_managed_keys excepted while the key is in use). A module that is off is off everywhere: its app pages are hidden, its tools are not offered, its actions are refused, and its background work pauses until it is on again. Nothing is deleted. database_public_forms needs databases on to take effect. Auth: can_admin_org + org owner or admin. Rate limit 30/min.",
|
|
42336
|
+
"description": "Switch organisation modules on or off, one true or false a module: documents, plans, improvements, knowledge_graph, compliance, meeting_scribe, guided_meetings, guided_audit, guided_client_advice, guided_coaching, guided_comedy, guided_discovery, guided_interview, guided_plan_checkin, guided_requirements, guided_sales, guided_speaking, guided_custom, agents, time_tracking, time_approvals, databases, database_public_forms, customer_managed_keys, own_ai. getOrgSettings returns each module's current state. A module can be switched ON only when it is available to the organisation: its plan includes it (for example meeting_scribe needs Plus, Pro or Enterprise), or Stable Baseline made it available. Switching OFF is always allowed (customer_managed_keys excepted while the key is in use). A module that is off is off everywhere: its app pages are hidden, its tools are not offered, its actions are refused, and its background work pauses until it is on again. Nothing is deleted. database_public_forms needs databases on to take effect. Auth: can_admin_org + org owner or admin. Rate limit 30/min.",
|
|
42307
42337
|
"operationId": "updateOrgFeatureFlags",
|
|
42308
42338
|
"tags": [
|
|
42309
42339
|
"settings"
|
|
@@ -42399,6 +42429,10 @@
|
|
|
42399
42429
|
"type": "boolean",
|
|
42400
42430
|
"description": "The Speaking coach template of guided meetings. Needs guided_meetings on."
|
|
42401
42431
|
},
|
|
42432
|
+
"guided_custom": {
|
|
42433
|
+
"type": "boolean",
|
|
42434
|
+
"description": "Your own instructions in guided meetings: the person's own words instead of a template. Needs guided_meetings on."
|
|
42435
|
+
},
|
|
42402
42436
|
"agents": {
|
|
42403
42437
|
"type": "boolean",
|
|
42404
42438
|
"description": "Agents, with their duties and their connectors."
|
|
@@ -45797,6 +45831,23 @@
|
|
|
45797
45831
|
"has_no_link": {
|
|
45798
45832
|
"type": "boolean"
|
|
45799
45833
|
},
|
|
45834
|
+
"linked_from": {
|
|
45835
|
+
"type": "object",
|
|
45836
|
+
"properties": {
|
|
45837
|
+
"table": {
|
|
45838
|
+
"type": "string",
|
|
45839
|
+
"maxLength": 200
|
|
45840
|
+
},
|
|
45841
|
+
"row": {
|
|
45842
|
+
"type": "string",
|
|
45843
|
+
"maxLength": 64
|
|
45844
|
+
},
|
|
45845
|
+
"link": {
|
|
45846
|
+
"type": "string",
|
|
45847
|
+
"maxLength": 100
|
|
45848
|
+
}
|
|
45849
|
+
}
|
|
45850
|
+
},
|
|
45800
45851
|
"and": {
|
|
45801
45852
|
"type": "array",
|
|
45802
45853
|
"minItems": 1,
|
|
@@ -45818,7 +45869,7 @@
|
|
|
45818
45869
|
}
|
|
45819
45870
|
}
|
|
45820
45871
|
},
|
|
45821
|
-
"description": "A filter. A condition is { \"field\": <the field's name>, \"<operator>\": <value> } with exactly one operator, such as { \"field\": \"Status\", \"is\": \"Done\" }; a group is { \"and\": [...] } or { \"or\": [...] } holding 1 to 25 conditions or groups, nested 3 levels deep at most, 25 conditions in all. Operators by field type: text, link, email and phone: is, is_not, is_any_of, is_none_of (a list of 1 to 100 values), contains, does_not_contain, starts_with, is_empty, is_not_empty. Long text: contains, does_not_contain, is_empty, is_not_empty. Numbers (number, currency, percent, rating, duration, automatic number): is, is_not, is_any_of, is_none_of, greater_than, less_than, at_least, at_most, between [low, high], is_empty, is_not_empty. Dates and times: is, before, after, between, in_the_last and in_the_next (a number of days), in_period, is_empty, is_not_empty; a date value is YYYY-MM-DD, an ISO date and time, \"today\", \"yesterday\", \"tomorrow\" or days from today such as \"today-30\". in_period takes a calendar period by name, such as \"this_month\" or \"year_to_date\", or { \"period\": \"month\", \"offset\": -1 } (offset: whole periods from the current one; to_date: only up to today; years_back: that many years earlier). Single choice and status: is, is_not, is_any_of, is_none_of with a choice's name, is_empty, is_not_empty. Multiple choice, person and team: contains_any_of, contains_all_of, contains_none_of (people by id or \"me\"), is_empty, is_not_empty. Checkbox: is_ticked, is_not_ticked. Relation: links_to, does_not_link_to (row ids), has_any_link, has_no_link. A field of a linked table: name the relation in via, as { \"via\": [\"Account\"], \"field\": \"Industry\", \"is\": \"Retail\" } (rows linked to a row that matches; with a not operator such as is_not, rows linked to none); one relation away, never in a saved view's filter. is_empty, is_not_empty, is_ticked, is_not_ticked, has_any_link and has_no_link take true. Text matching ignores case."
|
|
45872
|
+
"description": "A filter. A condition is { \"field\": <the field's name>, \"<operator>\": <value> } with exactly one operator, such as { \"field\": \"Status\", \"is\": \"Done\" }; a group is { \"and\": [...] } or { \"or\": [...] } holding 1 to 25 conditions or groups, nested 3 levels deep at most, 25 conditions in all. Operators by field type: text, link, email and phone: is, is_not, is_any_of, is_none_of (a list of 1 to 100 values), contains, does_not_contain, starts_with, is_empty, is_not_empty. Long text: contains, does_not_contain, is_empty, is_not_empty. Numbers (number, currency, percent, rating, duration, automatic number): is, is_not, is_any_of, is_none_of, greater_than, less_than, at_least, at_most, between [low, high], is_empty, is_not_empty. Dates and times: is, before, after, between, in_the_last and in_the_next (a number of days), in_period, is_empty, is_not_empty; a date value is YYYY-MM-DD, an ISO date and time, \"today\", \"yesterday\", \"tomorrow\" or days from today such as \"today-30\". in_period takes a calendar period by name, such as \"this_month\" or \"year_to_date\", or { \"period\": \"month\", \"offset\": -1 } (offset: whole periods from the current one; to_date: only up to today; years_back: that many years earlier). Single choice and status: is, is_not, is_any_of, is_none_of with a choice's name, is_empty, is_not_empty. Multiple choice, person and team: contains_any_of, contains_all_of, contains_none_of (people by id or \"me\"), is_empty, is_not_empty. Checkbox: is_ticked, is_not_ticked. Relation: links_to, does_not_link_to (row ids), has_any_link, has_no_link. A field of a linked table: name the relation in via, as { \"via\": [\"Account\"], \"field\": \"Industry\", \"is\": \"Retail\" } (rows linked to a row that matches; with a not operator such as is_not, rows linked to none); one relation away, never in a saved view's filter. One row's links: { \"linked_from\": { \"table\": \"Accounts\", \"row\": \"<row id>\", \"link\": \"Deals\" } } keeps the rows that row links to through its link field (a table in another database by its id); never in a saved filter. is_empty, is_not_empty, is_ticked, is_not_ticked, has_any_link and has_no_link take true. Text matching ignores case."
|
|
45822
45873
|
},
|
|
45823
45874
|
"query": {
|
|
45824
45875
|
"type": "string",
|
|
@@ -48193,7 +48244,7 @@
|
|
|
48193
48244
|
"/tools/writeDatabaseRows": {
|
|
48194
48245
|
"post": {
|
|
48195
48246
|
"summary": "writeDatabaseRows",
|
|
48196
|
-
"description": "Add rows to a table or change rows, in one of two ways that never mix. Call getDatabase with table first: it gives each field's exact name and choices, how each kind of value is written and which fields are never written. rows (up to 500): written at once, with no mode, changeId or maxRows. A row without id is added; a row with id is changed, touching only the fields you send, so other people's changes to other fields stay (send strict: true with the version you read to refuse a change when the row has changed since). With matchOn (a field marked unique, such as Email), a row without id changes the row holding the same value, or is added when there is none. The rows changed and the rows added are each all or nothing. Values as getDatabase says: choices by name, people by id or \"me\", files this job holds as {\"fileId\": \"<id>\"}, relations by the linked rows' ids, or {\"add\": [ids], \"remove\": [ids]} to change some links and keep the rest (a link field holds up to 10,000 links in one row by default). Or every row that matches, without rows: where (or view) picks them; set gives each field a value or a formula for each row; match reads a row of another table; copyFrom adds another table's rows. It previews (the count, the first rows before and after, a changeId); mode \"apply\" does it in the same call. One call is enough: never one row at a time. undo puts it back. getDatabaseGuide topic bulk_changes (also joins, copying, formulas).",
|
|
48247
|
+
"description": "Add rows to a table or change rows, in one of two ways that never mix. Call getDatabase with table first: it gives each field's exact name and choices, how each kind of value is written and which fields are never written. rows (up to 500): written at once, with no mode, changeId or maxRows. Each row is {\"fields\": {\"<field name>\": value}}, such as {\"fields\": {\"Title\": \"Q3 report\", \"Score\": 4}}. A row without id is added; a row with id is changed, touching only the fields you send, so other people's changes to other fields stay (send strict: true with the version you read to refuse a change when the row has changed since). With matchOn (a field marked unique, such as Email), a row without id changes the row holding the same value, or is added when there is none. The rows changed and the rows added are each all or nothing. Values as getDatabase says: choices by name, people by id or \"me\", files this job holds as {\"fileId\": \"<id>\"}, relations by the linked rows' ids, or {\"add\": [ids], \"remove\": [ids]} to change some links and keep the rest (a link field holds up to 10,000 links in one row by default). Or every row that matches, without rows: where (or view) picks them; set gives each field a value or a formula for each row; match reads a row of another table; copyFrom adds another table's rows. It previews (the count, the first rows before and after, a changeId); mode \"apply\" does it in the same call. One call is enough: never one row at a time. undo puts it back. getDatabaseGuide topic bulk_changes (also joins, copying, formulas).",
|
|
48197
48248
|
"operationId": "writeDatabaseRows",
|
|
48198
48249
|
"tags": [
|
|
48199
48250
|
"databases"
|
|
@@ -48257,7 +48308,7 @@
|
|
|
48257
48308
|
}
|
|
48258
48309
|
}
|
|
48259
48310
|
},
|
|
48260
|
-
"description": "
|
|
48311
|
+
"description": "Each row is {\"fields\": {\"<field name>\": value}}, with id to change that row: [{\"fields\": {\"Title\": \"Q3 report\", \"Score\": 4}}]. Rows are written at once, never with mode or changeId. Leave out to change every row that matches."
|
|
48261
48312
|
},
|
|
48262
48313
|
"matchOn": {
|
|
48263
48314
|
"type": "string",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stablebaseline/sdk",
|
|
3
|
-
"version": "0.10.
|
|
3
|
+
"version": "0.10.2",
|
|
4
4
|
"description": "TypeScript SDK for the Stable Baseline REST API. End-to-end agent-managed company brain: docs, diagrams, plans, databases, agents and a self-learning Knowledge Graph. 222 tools across 20 categories.",
|
|
5
5
|
"homepage": "https://stablebaseline.io",
|
|
6
6
|
"repository": {
|
package/src/types.generated.ts
CHANGED
|
@@ -915,7 +915,7 @@ export interface paths {
|
|
|
915
915
|
put?: never;
|
|
916
916
|
/**
|
|
917
917
|
* addWhiteboardElements
|
|
918
|
-
* @description Author shapes onto a whiteboard from high-level specs (you do NOT need the full Excalidraw element schema). Appends to the canvas. PLACEMENT ON AN EXISTING BOARD (critical): NEVER guess x/y onto a board that already has content — guessed coordinates land ON TOP of existing shapes and create an unreadable pile. Either (a) OMIT x/y entirely and the server auto-places the new elements together in clear space BELOW the current content, or (b) FIRST call getWhiteboard({ includeElements:true }) to see where existing shapes already are and choose a genuinely EMPTY region. Pass explicit x/y only for a deliberate layout in space you have confirmed is empty. PREFER THE RICHEST FORM THAT FITS, not plain rectangles: for a sticky/post-it note use { type:'sticky', text, backgroundColor } (a first-class note with an auto-fitting bound label — there is NO sticky-note stencil; OMIT x/y and it is auto-placed in clear space below existing content, so it doesn't land on top of the current drawing); for kanban/scrum/story boards, flowcharts, UML/ER, BPMN, org charts, wireframes/mockups, charts or people use a LIBRARY STENCIL in ONE call — { type:'stencil', stencil:'<name e.g. decision>', x, y } fuzzy-matches by name with no prior listWhiteboardStencils call (pass width/height to SCALE the whole stencil and text to fill its single label); for cloud/software-architecture use ICONS — { type:'image', iconPath:'dev/docker.svg', x, y } (paths from listArchitectureIcons); reserve raw rectangles/ellipses for when no standard form fits. Expressive enough to reproduce hand-drawn style templates (sticky-note brainstorm grids, sketchy mind maps, flowcharts). Each spec: { type: 'rectangle'|'ellipse'|'diamond'|'sticky'|'text'|'arrow'|'line'|'freedraw'|'frame'|'image'|'stencil', id?, x, y, width, height, text? (STRONGLY PREFER setting a shape's label via its own `text` — it becomes a centred, auto-WRAPPED bound label fitted to the shape; do NOT drop a separate type:'text' element on top of a shape as its label. Standalone type:'text' is for free-floating titles/notes and now also wraps to its width; Yes/No label on an arrow — emojis are fine, e.g. a warning sign in a 'Risks' label), fontSize?, fontFamily? (1=hand-drawn default, 2=normal, 3=code), textAlign?, backgroundColor? (name 'blue'/'green'/'yellow'/'pink'/'violet'/'orange'/'teal'/… or hex), strokeColor?, fillStyle? ('solid'|'hachure'|'cross-hatch'), strokeStyle? ('solid'|'dashed'|'dotted' — use 'dashed' for grid/category borders), strokeWidth? (1 thin/2 bold/4 extra), roughness? (0 clean, 1 default, 2 very sketchy/hand-drawn — use 2 for organic mind maps), roundness? (number type or null for sharp), opacity?, name? (frame title), frameId? (put a shape inside a frame), start?:{id}, end?:{id} (connect arrows/lines to shapes by id — connectors AUTO-CLIP to the shape edges, never overrun to the centre, AUTO-ROUTE around any shapes in between so a decision's No/loop-back branch never cuts straight through the boxes between source and target, and bound text auto-wraps + centres), routing? ('straight' default | 'elbow' for clean right-angle flowchart/org-chart connectors | 'curved'), startArrowhead?/endArrowhead? (arrowheads are SOLID filled triangles by default — just OMIT them. Pass null for a plain mind-map spoke with no head. Do NOT pass 'arrow': that is the open 'V' head and is auto-upgraded to a solid triangle anyway), points? ([[0,0],[dx,dy]] relative, only for manual geometry — almost never needed; binding by id is better), props? (escape hatch: any other Excalidraw field) }. ARCHITECTURE ICONS: to place a software-architecture icon (AWS/Azure/GCP/Docker/Kubernetes/databases/etc.), first call listArchitectureIcons to find one, then add a spec { type:'image', iconPath:'<relative_url e.g. dev/docker.svg>', x, y, width:96, height:96, text?:'<caption shown below>' } — the icon is stored as a URL reference (never base64). Use imageUrl instead of iconPath for any other public image. Combine icons with labelled boxes + elbow arrows for clean architecture diagrams. LIBRARY STENCILS: for hand-drawn, on-brand elements (scrum/kanban columns, flowchart symbols, UML/ER, BPMN, org-chart nodes, wireframe widgets, stick figures), FIRST call listWhiteboardStencils to find one, then add { type:'stencil', stencilKey:'<key from listWhiteboardStencils>', x, y } (or { type:'stencil', stencil:'<name e.g. decision>', pack?:'<pack>', x, y } to fuzzy-match by name). A stencil is a mini-whiteboard (a collection of elements) of kind 'symbol' or 'template' (listWhiteboardStencils returns the kind + its embedded `labels`). For a SYMBOL (one atomic labelled node — flowchart box, BPMN task, org node), pass id + text + width/height: the label auto-fits its single slot and arrows bind to it via start/end {id}. For a TEMPLATE (a multi-component layout — Alerts, Forms, Tables, Charts), place it WHOLE (no single text); the result returns its `children` (id + text + colour + position) so you retext, recolour, or DELETE specific parts by id via updateWhiteboardScene (cluster children by y to act on a whole row/variant). STRONGLY prefer stencils over plain rectangles for wireframes/mockups, kanban/scrum boards, UML/BPMN, org charts; for dense flowcharts, plain shapes with bound text + elbow arrows are equally reliable. (For a plain sticky/post-it note use type:'sticky', NOT a stencil — there is no sticky-note stencil.) FRAMES: a frame is a NON-DESTRUCTIVE, ANY-SIZE container. To enclose shapes that ALREADY exist, add ONE type:'frame' sized to cover them (a frame automatically captures the elements inside its bounds) or set those shapes' frameId — never recreate or delete-and-redraw content just to frame it. If a frame doesn't fully cover its content, just RESIZE the frame (patch its width/height). Deleting a frame (deleteIds:[frameId]) leaves all its contents intact on the canvas — it only removes the frame border + title. PRESENTATION/SLIDES: when the user wants a presentation or slide deck, create type:'frame' slides sized width:1280,height:720 (16:9), laid out LEFT-TO-RIGHT at the same y (x: 0, then 1440, 2880, 4320, …), each with a `name` (the slide title). Put every slide's shapes/text/images INSIDE its frame by setting their frameId to that frame's id (give the frame an id and reference it). Slides play in order (left-to-right, then top-to-bottom) in the board's Present mode and export to PPTX, so one frame = one slide. FLOWCHART recipe: rectangles (roundness null for sharp process boxes), diamonds for decisions, arrows with routing:'elbow' and Yes/No as the arrow's text. Use type 'sticky' for sticky/post-it notes (a solid-fill note with an auto-fitting bound label — set text + backgroundColor); type 'line' with no arrowheads + roughness:2 for sketchy mind-map spokes. FREEHAND DOODLES: to actually draw/doodle/sketch freehand, use { type:'freedraw', points } where points is a RELATIVE [[x,y],…] path of the stroke (e.g. a squiggle, circling or annotating something, a hand-drawn star/heart/smiley/arrow, an organic blob) — it renders as one smooth freehand stroke. x/y is the origin; omit x/y to auto-place. Chain several freedraw specs for a multi-stroke doodle. NOTE: freehand is always SOLID (strokeStyle is ignored on freedraw) — colour, strokeWidth and opacity DO apply; a freedraw with strokeStyle:'dashed' or 'dotted' is automatically rendered as a smooth dashed/dotted line so the dashes actually show. Give shapes ids and reference them from connectors. Connectors may also bind to shapes ALREADY on the board by their id (get them via getWhiteboard includeElements:true) — you do NOT need to resend existing shapes; the server reads the live scene to bind the arrow and route it around the other boxes. Great for brainstorms, mind maps, flowcharts, org charts, SWOT, retros. PROCESS: for any non-trivial board call getWhiteboardGuide FIRST to plan it; then after adding, ALWAYS call getWhiteboardImage to SEE the result and check layout, labels, spacing, overlaps and how shapes connect — if anything looks off, fix it with updateWhiteboardScene (patch by id) and render again, iterating until it looks right. RESULT: returns `added` (count), `placement` (bounding box {x,y,width,height} of what you just added) and `autoPlaced` (true when you omitted x/y so it was placed in clear space below existing content) — use placement/autoPlaced to tell the user WHERE the new elements landed, never invent a location.
|
|
918
|
+
* @description Author shapes onto a whiteboard from high-level specs (you do NOT need the full Excalidraw element schema). Appends to the canvas. PLACEMENT ON AN EXISTING BOARD (critical): NEVER guess x/y onto a board that already has content — guessed coordinates land ON TOP of existing shapes and create an unreadable pile. Either (a) OMIT x/y entirely and the server auto-places the new elements together in clear space BELOW the current content, or (b) FIRST call getWhiteboard({ includeElements:true }) to see where existing shapes already are and choose a genuinely EMPTY region. Pass explicit x/y only for a deliberate layout in space you have confirmed is empty. For a CONNECTED drawing (flowchart, org chart, process, decision tree, relationships), omit x/y, connect with elbow arrows and pass arrange:{} (direction DOWN by default): the server lays it out and routes every arrow. PREFER THE RICHEST FORM THAT FITS, not plain rectangles: for a sticky/post-it note use { type:'sticky', text, backgroundColor } (a first-class note with an auto-fitting bound label — there is NO sticky-note stencil; OMIT x/y and it is auto-placed in clear space below existing content, so it doesn't land on top of the current drawing); for kanban/scrum/story boards, flowcharts, UML/ER, BPMN, org charts, wireframes/mockups, charts or people use a LIBRARY STENCIL in ONE call — { type:'stencil', stencil:'<name e.g. decision>', x, y } fuzzy-matches by name with no prior listWhiteboardStencils call (pass width/height to SCALE the whole stencil and text to fill its single label); for cloud/software-architecture use ICONS — { type:'image', iconPath:'dev/docker.svg', x, y } (paths from listArchitectureIcons); reserve raw rectangles/ellipses for when no standard form fits. Expressive enough to reproduce hand-drawn style templates (sticky-note brainstorm grids, sketchy mind maps, flowcharts). Each spec: { type: 'rectangle'|'ellipse'|'diamond'|'sticky'|'text'|'arrow'|'line'|'freedraw'|'frame'|'image'|'stencil', id?, x, y, width, height, text? (STRONGLY PREFER setting a shape's label via its own `text` — it becomes a centred, auto-WRAPPED bound label fitted to the shape; do NOT drop a separate type:'text' element on top of a shape as its label. Standalone type:'text' is for free-floating titles/notes and now also wraps to its width; Yes/No label on an arrow — emojis are fine, e.g. a warning sign in a 'Risks' label), fontSize?, fontFamily? (1=hand-drawn default, 2=normal, 3=code), textAlign?, backgroundColor? (name 'blue'/'green'/'yellow'/'pink'/'violet'/'orange'/'teal'/… or hex), strokeColor?, fillStyle? ('solid'|'hachure'|'cross-hatch'), strokeStyle? ('solid'|'dashed'|'dotted' — use 'dashed' for grid/category borders), strokeWidth? (1 thin/2 bold/4 extra), roughness? (0 clean, 1 default, 2 very sketchy/hand-drawn — use 2 for organic mind maps), roundness? (number type or null for sharp), opacity?, name? (frame title), frameId? (put a shape inside a frame), start?:{id}, end?:{id} (connect arrows/lines to shapes by id — connectors AUTO-CLIP to the shape edges, never overrun to the centre, AUTO-ROUTE around any shapes in between so a decision's No/loop-back branch never cuts straight through the boxes between source and target, and bound text auto-wraps + centres), routing? ('straight' default | 'elbow' for clean right-angle flowchart/org-chart connectors | 'curved'), startArrowhead?/endArrowhead? (arrowheads are SOLID filled triangles by default — just OMIT them. Pass null for a plain mind-map spoke with no head. Do NOT pass 'arrow': that is the open 'V' head and is auto-upgraded to a solid triangle anyway), points? ([[0,0],[dx,dy]] relative, only for manual geometry — almost never needed; binding by id is better), props? (escape hatch: any other Excalidraw field) }. ARCHITECTURE ICONS: to place a software-architecture icon (AWS/Azure/GCP/Docker/Kubernetes/databases/etc.), first call listArchitectureIcons to find one, then add a spec { type:'image', iconPath:'<relative_url e.g. dev/docker.svg>', x, y, width:96, height:96, text?:'<caption shown below>' } — the icon is stored as a URL reference (never base64). Use imageUrl instead of iconPath for any other public image. Combine icons with labelled boxes + elbow arrows for clean architecture diagrams. LIBRARY STENCILS: for hand-drawn, on-brand elements (scrum/kanban columns, flowchart symbols, UML/ER, BPMN, org-chart nodes, wireframe widgets, stick figures), FIRST call listWhiteboardStencils to find one, then add { type:'stencil', stencilKey:'<key from listWhiteboardStencils>', x, y } (or { type:'stencil', stencil:'<name e.g. decision>', pack?:'<pack>', x, y } to fuzzy-match by name). A stencil is a mini-whiteboard (a collection of elements) of kind 'symbol' or 'template' (listWhiteboardStencils returns the kind + its embedded `labels`). For a SYMBOL (one atomic labelled node — flowchart box, BPMN task, org node), pass id + text + width/height: the label auto-fits its single slot and arrows bind to it via start/end {id}. For a TEMPLATE (a multi-component layout — Alerts, Forms, Tables, Charts), place it WHOLE (no single text); the result returns its `children` (id + text + colour + position) so you retext, recolour, or DELETE specific parts by id via updateWhiteboardScene (cluster children by y to act on a whole row/variant). STRONGLY prefer stencils over plain rectangles for wireframes/mockups, kanban/scrum boards, UML/BPMN, org charts; for dense flowcharts, plain shapes with bound text + elbow arrows are equally reliable. (For a plain sticky/post-it note use type:'sticky', NOT a stencil — there is no sticky-note stencil.) FRAMES: a frame is a NON-DESTRUCTIVE, ANY-SIZE container. To enclose shapes that ALREADY exist, add ONE type:'frame' sized to cover them (a frame automatically captures the elements inside its bounds) or set those shapes' frameId — never recreate or delete-and-redraw content just to frame it. If a frame doesn't fully cover its content, just RESIZE the frame (patch its width/height). Deleting a frame (deleteIds:[frameId]) leaves all its contents intact on the canvas — it only removes the frame border + title. PRESENTATION/SLIDES: when the user wants a presentation or slide deck, create type:'frame' slides sized width:1280,height:720 (16:9), laid out LEFT-TO-RIGHT at the same y (x: 0, then 1440, 2880, 4320, …), each with a `name` (the slide title). Put every slide's shapes/text/images INSIDE its frame by setting their frameId to that frame's id (give the frame an id and reference it). Slides play in order (left-to-right, then top-to-bottom) in the board's Present mode and export to PPTX, so one frame = one slide. FLOWCHART recipe: rectangles (roundness null for sharp process boxes), diamonds for decisions, arrows with routing:'elbow' and Yes/No as the arrow's text. Use type 'sticky' for sticky/post-it notes (a solid-fill note with an auto-fitting bound label — set text + backgroundColor); type 'line' with no arrowheads + roughness:2 for sketchy mind-map spokes. FREEHAND DOODLES: to actually draw/doodle/sketch freehand, use { type:'freedraw', points } where points is a RELATIVE [[x,y],…] path of the stroke (e.g. a squiggle, circling or annotating something, a hand-drawn star/heart/smiley/arrow, an organic blob) — it renders as one smooth freehand stroke. x/y is the origin; omit x/y to auto-place. Chain several freedraw specs for a multi-stroke doodle. NOTE: freehand is always SOLID (strokeStyle is ignored on freedraw) — colour, strokeWidth and opacity DO apply; a freedraw with strokeStyle:'dashed' or 'dotted' is automatically rendered as a smooth dashed/dotted line so the dashes actually show. Give shapes ids and reference them from connectors. Connectors may also bind to shapes ALREADY on the board by their id (get them via getWhiteboard includeElements:true) — you do NOT need to resend existing shapes; the server reads the live scene to bind the arrow and route it around the other boxes. Great for brainstorms, mind maps, flowcharts, org charts, SWOT, retros. PROCESS: for any non-trivial board call getWhiteboardGuide FIRST to plan it; then after adding, ALWAYS call getWhiteboardImage to SEE the result and check layout, labels, spacing, overlaps and how shapes connect — if anything looks off, fix it with updateWhiteboardScene (patch by id) and render again, iterating until it looks right. RESULT: returns `added` (count), `placement` (bounding box {x,y,width,height} of what you just added) and `autoPlaced` (true when you omitted x/y so it was placed in clear space below existing content) — use placement/autoPlaced to tell the user WHERE the new elements landed, never invent a location.
|
|
919
919
|
*/
|
|
920
920
|
post: operations["addWhiteboardElements"];
|
|
921
921
|
delete?: never;
|
|
@@ -2625,7 +2625,7 @@ export interface paths {
|
|
|
2625
2625
|
put?: never;
|
|
2626
2626
|
/**
|
|
2627
2627
|
* listInvoices
|
|
2628
|
-
* @description List invoices for an organisation, newest first.
|
|
2628
|
+
* @description List invoices for an organisation, newest first: paid, open and refunded ones only (refunded is a paid invoice whose payment was refunded, wholly or partly; amount_refunded says how much). Each carries its invoice number, hosted Stripe invoice URL and PDF link. Stripe IDs are stripped.
|
|
2629
2629
|
*/
|
|
2630
2630
|
post: operations["listInvoices"];
|
|
2631
2631
|
delete?: never;
|
|
@@ -3905,7 +3905,7 @@ export interface paths {
|
|
|
3905
3905
|
put?: never;
|
|
3906
3906
|
/**
|
|
3907
3907
|
* updateOrgFeatureFlags
|
|
3908
|
-
* @description Switch organisation modules on or off, one true or false a module: documents, plans, improvements, knowledge_graph, compliance, meeting_scribe, guided_meetings, guided_audit, guided_client_advice, guided_coaching, guided_comedy, guided_discovery, guided_interview, guided_plan_checkin, guided_requirements, guided_sales, guided_speaking, agents, time_tracking, time_approvals, databases, database_public_forms, customer_managed_keys, own_ai. getOrgSettings returns each module's current state. A module can be switched ON only when it is available to the organisation: its plan includes it (for example meeting_scribe needs Plus, Pro or Enterprise), or Stable Baseline made it available. Switching OFF is always allowed (customer_managed_keys excepted while the key is in use). A module that is off is off everywhere: its app pages are hidden, its tools are not offered, its actions are refused, and its background work pauses until it is on again. Nothing is deleted. database_public_forms needs databases on to take effect. Auth: can_admin_org + org owner or admin. Rate limit 30/min.
|
|
3908
|
+
* @description Switch organisation modules on or off, one true or false a module: documents, plans, improvements, knowledge_graph, compliance, meeting_scribe, guided_meetings, guided_audit, guided_client_advice, guided_coaching, guided_comedy, guided_discovery, guided_interview, guided_plan_checkin, guided_requirements, guided_sales, guided_speaking, guided_custom, agents, time_tracking, time_approvals, databases, database_public_forms, customer_managed_keys, own_ai. getOrgSettings returns each module's current state. A module can be switched ON only when it is available to the organisation: its plan includes it (for example meeting_scribe needs Plus, Pro or Enterprise), or Stable Baseline made it available. Switching OFF is always allowed (customer_managed_keys excepted while the key is in use). A module that is off is off everywhere: its app pages are hidden, its tools are not offered, its actions are refused, and its background work pauses until it is on again. Nothing is deleted. database_public_forms needs databases on to take effect. Auth: can_admin_org + org owner or admin. Rate limit 30/min.
|
|
3909
3909
|
*/
|
|
3910
3910
|
post: operations["updateOrgFeatureFlags"];
|
|
3911
3911
|
delete?: never;
|
|
@@ -4285,7 +4285,7 @@ export interface paths {
|
|
|
4285
4285
|
put?: never;
|
|
4286
4286
|
/**
|
|
4287
4287
|
* writeDatabaseRows
|
|
4288
|
-
* @description Add rows to a table or change rows, in one of two ways that never mix. Call getDatabase with table first: it gives each field's exact name and choices, how each kind of value is written and which fields are never written. rows (up to 500): written at once, with no mode, changeId or maxRows. A row without id is added; a row with id is changed, touching only the fields you send, so other people's changes to other fields stay (send strict: true with the version you read to refuse a change when the row has changed since). With matchOn (a field marked unique, such as Email), a row without id changes the row holding the same value, or is added when there is none. The rows changed and the rows added are each all or nothing. Values as getDatabase says: choices by name, people by id or "me", files this job holds as {"fileId": "<id>"}, relations by the linked rows' ids, or {"add": [ids], "remove": [ids]} to change some links and keep the rest (a link field holds up to 10,000 links in one row by default). Or every row that matches, without rows: where (or view) picks them; set gives each field a value or a formula for each row; match reads a row of another table; copyFrom adds another table's rows. It previews (the count, the first rows before and after, a changeId); mode "apply" does it in the same call. One call is enough: never one row at a time. undo puts it back. getDatabaseGuide topic bulk_changes (also joins, copying, formulas).
|
|
4288
|
+
* @description Add rows to a table or change rows, in one of two ways that never mix. Call getDatabase with table first: it gives each field's exact name and choices, how each kind of value is written and which fields are never written. rows (up to 500): written at once, with no mode, changeId or maxRows. Each row is {"fields": {"<field name>": value}}, such as {"fields": {"Title": "Q3 report", "Score": 4}}. A row without id is added; a row with id is changed, touching only the fields you send, so other people's changes to other fields stay (send strict: true with the version you read to refuse a change when the row has changed since). With matchOn (a field marked unique, such as Email), a row without id changes the row holding the same value, or is added when there is none. The rows changed and the rows added are each all or nothing. Values as getDatabase says: choices by name, people by id or "me", files this job holds as {"fileId": "<id>"}, relations by the linked rows' ids, or {"add": [ids], "remove": [ids]} to change some links and keep the rest (a link field holds up to 10,000 links in one row by default). Or every row that matches, without rows: where (or view) picks them; set gives each field a value or a formula for each row; match reads a row of another table; copyFrom adds another table's rows. It previews (the count, the first rows before and after, a changeId); mode "apply" does it in the same call. One call is enough: never one row at a time. undo puts it back. getDatabaseGuide topic bulk_changes (also joins, copying, formulas).
|
|
4289
4289
|
*/
|
|
4290
4290
|
post: operations["writeDatabaseRows"];
|
|
4291
4291
|
delete?: never;
|
|
@@ -10916,6 +10916,21 @@ export interface operations {
|
|
|
10916
10916
|
documentId: string;
|
|
10917
10917
|
/** @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. */
|
|
10918
10918
|
rerouteConnectors?: boolean;
|
|
10919
|
+
/** @description Optional. Lay out what this call adds the way the board's Arrange does, so you never work out x/y for a connected drawing (a flowchart, an org chart, a process, a decision tree, a web of relationships): the shapes are set out along the way their arrows flow, as a tidy tree when the arrows make one, and every elbow arrow is routed round the shapes, hopping where it crosses another. Pass {} for the defaults. Omit x/y on the shapes you add and give the connectors routing:'elbow' (a straight arrow stays straight between its shapes). What is already on the board stays where it is, apart from what sits beside or below the new shapes, which moves just enough to make room. The result's `arranged` says what happened. */
|
|
10920
|
+
arrange?: {
|
|
10921
|
+
/**
|
|
10922
|
+
* @description The way the arrows flow: DOWN (the default) top to bottom, RIGHT left to right, UP bottom to top, LEFT right to left.
|
|
10923
|
+
* @enum {string}
|
|
10924
|
+
*/
|
|
10925
|
+
direction?: "RIGHT" | "DOWN" | "LEFT" | "UP";
|
|
10926
|
+
/**
|
|
10927
|
+
* @description Optional. network: shapes joined with no flow (peers, relationships), each near the ones it joins, with no direction; tree or flow to insist on one. Left out, shapes whose arrows make a tree are laid out as a tree and the rest flow.
|
|
10928
|
+
* @enum {string}
|
|
10929
|
+
*/
|
|
10930
|
+
arrangement?: "flow" | "tree" | "network";
|
|
10931
|
+
/** @description true: arrange the whole board, not only what this call adds (everything on it may move). */
|
|
10932
|
+
whole?: boolean;
|
|
10933
|
+
};
|
|
10919
10934
|
/** @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). */
|
|
10920
10935
|
shapes: ({
|
|
10921
10936
|
/**
|
|
@@ -31559,6 +31574,8 @@ export interface operations {
|
|
|
31559
31574
|
guided_sales?: boolean;
|
|
31560
31575
|
/** @description The Speaking coach template of guided meetings. Needs guided_meetings on. */
|
|
31561
31576
|
guided_speaking?: boolean;
|
|
31577
|
+
/** @description Your own instructions in guided meetings: the person's own words instead of a template. Needs guided_meetings on. */
|
|
31578
|
+
guided_custom?: boolean;
|
|
31562
31579
|
/** @description Agents, with their duties and their connectors. */
|
|
31563
31580
|
agents?: boolean;
|
|
31564
31581
|
/** @description Time tracking: timers and time entries on tasks, improvements and tables. Needs databases on. */
|
|
@@ -33599,7 +33616,7 @@ export interface operations {
|
|
|
33599
33616
|
databaseId: string;
|
|
33600
33617
|
/** @description The table's id or name. */
|
|
33601
33618
|
table: string;
|
|
33602
|
-
/** @description A filter. A condition is { "field": <the field's name>, "<operator>": <value> } with exactly one operator, such as { "field": "Status", "is": "Done" }; a group is { "and": [...] } or { "or": [...] } holding 1 to 25 conditions or groups, nested 3 levels deep at most, 25 conditions in all. Operators by field type: text, link, email and phone: is, is_not, is_any_of, is_none_of (a list of 1 to 100 values), contains, does_not_contain, starts_with, is_empty, is_not_empty. Long text: contains, does_not_contain, is_empty, is_not_empty. Numbers (number, currency, percent, rating, duration, automatic number): is, is_not, is_any_of, is_none_of, greater_than, less_than, at_least, at_most, between [low, high], is_empty, is_not_empty. Dates and times: is, before, after, between, in_the_last and in_the_next (a number of days), in_period, is_empty, is_not_empty; a date value is YYYY-MM-DD, an ISO date and time, "today", "yesterday", "tomorrow" or days from today such as "today-30". in_period takes a calendar period by name, such as "this_month" or "year_to_date", or { "period": "month", "offset": -1 } (offset: whole periods from the current one; to_date: only up to today; years_back: that many years earlier). Single choice and status: is, is_not, is_any_of, is_none_of with a choice's name, is_empty, is_not_empty. Multiple choice, person and team: contains_any_of, contains_all_of, contains_none_of (people by id or "me"), is_empty, is_not_empty. Checkbox: is_ticked, is_not_ticked. Relation: links_to, does_not_link_to (row ids), has_any_link, has_no_link. A field of a linked table: name the relation in via, as { "via": ["Account"], "field": "Industry", "is": "Retail" } (rows linked to a row that matches; with a not operator such as is_not, rows linked to none); one relation away, never in a saved view's filter. is_empty, is_not_empty, is_ticked, is_not_ticked, has_any_link and has_no_link take true. Text matching ignores case. */
|
|
33619
|
+
/** @description A filter. A condition is { "field": <the field's name>, "<operator>": <value> } with exactly one operator, such as { "field": "Status", "is": "Done" }; a group is { "and": [...] } or { "or": [...] } holding 1 to 25 conditions or groups, nested 3 levels deep at most, 25 conditions in all. Operators by field type: text, link, email and phone: is, is_not, is_any_of, is_none_of (a list of 1 to 100 values), contains, does_not_contain, starts_with, is_empty, is_not_empty. Long text: contains, does_not_contain, is_empty, is_not_empty. Numbers (number, currency, percent, rating, duration, automatic number): is, is_not, is_any_of, is_none_of, greater_than, less_than, at_least, at_most, between [low, high], is_empty, is_not_empty. Dates and times: is, before, after, between, in_the_last and in_the_next (a number of days), in_period, is_empty, is_not_empty; a date value is YYYY-MM-DD, an ISO date and time, "today", "yesterday", "tomorrow" or days from today such as "today-30". in_period takes a calendar period by name, such as "this_month" or "year_to_date", or { "period": "month", "offset": -1 } (offset: whole periods from the current one; to_date: only up to today; years_back: that many years earlier). Single choice and status: is, is_not, is_any_of, is_none_of with a choice's name, is_empty, is_not_empty. Multiple choice, person and team: contains_any_of, contains_all_of, contains_none_of (people by id or "me"), is_empty, is_not_empty. Checkbox: is_ticked, is_not_ticked. Relation: links_to, does_not_link_to (row ids), has_any_link, has_no_link. A field of a linked table: name the relation in via, as { "via": ["Account"], "field": "Industry", "is": "Retail" } (rows linked to a row that matches; with a not operator such as is_not, rows linked to none); one relation away, never in a saved view's filter. One row's links: { "linked_from": { "table": "Accounts", "row": "<row id>", "link": "Deals" } } keeps the rows that row links to through its link field (a table in another database by its id); never in a saved filter. is_empty, is_not_empty, is_ticked, is_not_ticked, has_any_link and has_no_link take true. Text matching ignores case. */
|
|
33603
33620
|
where?: {
|
|
33604
33621
|
field?: string;
|
|
33605
33622
|
via?: string[];
|
|
@@ -33637,6 +33654,11 @@ export interface operations {
|
|
|
33637
33654
|
does_not_link_to?: (number | string)[] | string | number;
|
|
33638
33655
|
has_any_link?: boolean;
|
|
33639
33656
|
has_no_link?: boolean;
|
|
33657
|
+
linked_from?: {
|
|
33658
|
+
table?: string;
|
|
33659
|
+
row?: string;
|
|
33660
|
+
link?: string;
|
|
33661
|
+
};
|
|
33640
33662
|
and?: {
|
|
33641
33663
|
[key: string]: unknown;
|
|
33642
33664
|
}[];
|
|
@@ -34694,7 +34716,7 @@ export interface operations {
|
|
|
34694
34716
|
databaseId: string;
|
|
34695
34717
|
/** @description The table's id or name. */
|
|
34696
34718
|
table: string;
|
|
34697
|
-
/** @description
|
|
34719
|
+
/** @description Each row is {"fields": {"<field name>": value}}, with id to change that row: [{"fields": {"Title": "Q3 report", "Score": 4}}]. Rows are written at once, never with mode or changeId. Leave out to change every row that matches. */
|
|
34698
34720
|
rows?: {
|
|
34699
34721
|
/** @description The row to change. Leave out to add a row (or, with matchOn, to add or change one). */
|
|
34700
34722
|
id?: string;
|