@stablebaseline/sdk 0.10.0 → 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 +144 -14
- package/dist/index.d.ts +144 -14
- package/openapi.json +292 -14
- package/package.json +1 -1
- package/src/types.generated.ts +144 -14
package/dist/index.d.cts
CHANGED
|
@@ -774,7 +774,7 @@ interface paths {
|
|
|
774
774
|
put?: never;
|
|
775
775
|
/**
|
|
776
776
|
* startMeetingScribe
|
|
777
|
-
* @description Invite the Stable Baseline Meeting Scribe bot to a LIVE meeting (Zoom, Google Meet, Microsoft Teams, or Webex) so it paints a live, editable whiteboard of the conversation as it happens: sticky notes and topic clusters, an agenda that ticks itself off, and decisions and actions pinned to rails, on a real board the team keeps working in afterwards. The bot transcribes only and stores no recording. WHITEBOARD IS REQUIRED: the scribe always paints an existing whiteboard, so documentId (the whiteboard's id) is required. If you do not have a whiteboard id, ASK THE USER which whiteboard to use; do not create one automatically. COST + APPROVAL: it bills 7 credits for every 5 minutes while it runs (a 60-minute meeting is about 84 credits; hard cap 180 minutes), and it needs the user's explicit approval. Call FIRST without confirm to get the exact quote plus the workspace balance, show that to the user, and only call again with confirm:true once they agree. Available on the Plus, Pro and Enterprise plans. It returns immediately with a sessionId; poll getMeetingScribeStatus to watch it join and paint, and stopMeetingScribe to end it. The user can also just remove the bot from the meeting to stop it.
|
|
777
|
+
* @description Invite the Stable Baseline Meeting Scribe bot to a LIVE meeting (Zoom, Google Meet, Microsoft Teams, or Webex) so it paints a live, editable whiteboard of the conversation as it happens: sticky notes and topic clusters, an agenda that ticks itself off, and decisions and actions pinned to rails, on a real board the team keeps working in afterwards. The bot transcribes only and stores no recording. WHITEBOARD IS REQUIRED: the scribe always paints an existing whiteboard, so documentId (the whiteboard's id) is required. If you do not have a whiteboard id, ASK THE USER which whiteboard to use; do not create one automatically. COST + APPROVAL: it bills 7 credits for every 5 minutes while it runs (a 60-minute meeting is about 84 credits; hard cap 180 minutes), and it needs the user's explicit approval. Call FIRST without confirm to get the exact quote plus the workspace balance, show that to the user, and only call again with confirm:true once they agree. Available on the Plus, Pro and Enterprise plans. It returns immediately with a sessionId; poll getMeetingScribeStatus to watch it join and paint, and stopMeetingScribe to end it. The user can also just remove the bot from the meeting to stop it. GUIDED MEETINGS (where the organisation has them): meetingType 'guided' with a guided part adds private guidance beside the live board: an assistant listens and suggests what to ask or say next from material the user chose, shown only to the people they choose and never to guests. A guided meeting has one price, the bot included: its first hour is charged when it starts, then each 5 minutes after it (the quote says how many credits); getMeetingScribeStatus then reports the guidance's status.
|
|
778
778
|
*/
|
|
779
779
|
post: operations["startMeetingScribe"];
|
|
780
780
|
delete?: never;
|
|
@@ -794,7 +794,7 @@ interface paths {
|
|
|
794
794
|
put?: never;
|
|
795
795
|
/**
|
|
796
796
|
* getMeetingScribeStatus
|
|
797
|
-
* @description Get a meeting scribe's status after startMeetingScribe: the session state (joining, in the waiting room, live in the call, paused, ending, ended, or failed), the live activity feed of what the scribe has painted, and the board it is painting. Give it the sessionId returned by startMeetingScribe. Poll every 15 to 30 seconds while the meeting runs. When the meeting ends the board holds the finished 'meeting map' (topics, decisions, actions, and a summary).
|
|
797
|
+
* @description Get a meeting scribe's status after startMeetingScribe: the session state (joining, in the waiting room, live in the call, paused, ending, ended, or failed), the live activity feed of what the scribe has painted, and the board it is painting. Give it the sessionId returned by startMeetingScribe. Poll every 15 to 30 seconds while the meeting runs. When the meeting ends the board holds the finished 'meeting map' (topics, decisions, actions, and a summary). For a guided meeting, a person chosen to see the guidance also gets `guidance`: its status (preparing, active, paused, out_of_credits, stopped or failed), its template, who it is shown to, and whether its first hour and how many 5 minute blocks after it were billed, never what it suggested.
|
|
798
798
|
*/
|
|
799
799
|
post: operations["getMeetingScribeStatus"];
|
|
800
800
|
delete?: never;
|
|
@@ -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;
|
|
@@ -1738,7 +1738,7 @@ interface paths {
|
|
|
1738
1738
|
put?: never;
|
|
1739
1739
|
/**
|
|
1740
1740
|
* getPlan
|
|
1741
|
-
* @description Get full plan details including phases, items, and activity. Every level carries its own optimistic-lock token, so one call supplies them all: the top-level versionTimestamp is the plan's (for updatePlan), phases[].versionTimestamp each phase's (for updatePlanPhase) and items[].versionTimestamp each task's or improvement's (for updateTask / updateImprovement, including their bulk `items` form). Items include percent_complete for progress tracking. Each item carries owner_name (the owner's display name) beside owner_id, and start_date, end_date and target_date: its due date is its end_date, or its target_date when it has no end date.
|
|
1741
|
+
* @description Get full plan details including phases, items, and activity. Every level carries its own optimistic-lock token, so one call supplies them all: the top-level versionTimestamp is the plan's (for updatePlan), phases[].versionTimestamp each phase's (for updatePlanPhase) and items[].versionTimestamp each task's or improvement's (for updateTask / updateImprovement, including their bulk `items` form). Items include percent_complete for progress tracking. Each item carries owner_name (the owner's display name) beside owner_id, owner_team_name (the owning team's name) beside owner_team_id, and start_date, end_date and target_date: its due date is its end_date, or its target_date when it has no end date.
|
|
1742
1742
|
*/
|
|
1743
1743
|
post: operations["getPlan"];
|
|
1744
1744
|
delete?: never;
|
|
@@ -1998,7 +1998,7 @@ interface paths {
|
|
|
1998
1998
|
put?: never;
|
|
1999
1999
|
/**
|
|
2000
2000
|
* createTask
|
|
2001
|
-
* @description Create a task in a plan. Requires planId and title. Accepts every field updateTask accepts, so a task can be created complete in ONE call: no create-then-update, and no window in which other actors read a half-written record. Pass parentItemId to create it under its story, requirement or feature in the work hierarchy (which may be in another plan, or in none), and linkedRecords to link database rows to it. Pass `fields` (for example ["id", "friendlyId", "versionTimestamp"]) for a short answer instead of the whole task.
|
|
2001
|
+
* @description Create a task in a plan. Requires planId and title. Accepts every field updateTask accepts, so a task can be created complete in ONE call: no create-then-update, and no window in which other actors read a half-written record. Pass parentItemId to create it under its story, requirement or feature in the work hierarchy (which may be in another plan, or in none), and linkedRecords to link database rows to it. Pass `fields` (for example ["id", "friendlyId", "versionTimestamp"]) for a short answer instead of the whole task. The task in the answer carries owner_name (the owner's display name) beside owner_id and owner_team_name (the owning team's name) beside owner_team_id, as getTask's does.
|
|
2002
2002
|
*/
|
|
2003
2003
|
post: operations["createTask"];
|
|
2004
2004
|
delete?: never;
|
|
@@ -2018,7 +2018,7 @@ interface paths {
|
|
|
2018
2018
|
put?: never;
|
|
2019
2019
|
/**
|
|
2020
2020
|
* listTasks
|
|
2021
|
-
* @description List AND grep tasks in a plan. `query` searches the title, friendlyId and description, not just the title (substring by default; set isRegex:true for a regular expression, caseSensitive:true for exact case). Supports filtering by status, priority, phaseId and parentItemId (a story's tasks in the work hierarchy, say). Each task carries owner_name (the owner's display name) beside owner_id, and start_date, end_date and target_date: its due date is its end_date, or its target_date when it has no end date. Every task carries its versionTimestamp, ready for updateTask, so one call here supplies the tokens for a whole batch of updates, its parent_item_id and parentItem (the item it belongs to in the work hierarchy, or null), and linkedRecords, the database rows it links (as getTask describes them); filter by them with hasLinkedRecords, linkedRecordIds and linkedTableIds.
|
|
2021
|
+
* @description List AND grep tasks in a plan. `query` searches the title, friendlyId and description, not just the title (substring by default; set isRegex:true for a regular expression, caseSensitive:true for exact case). Supports filtering by status, priority, phaseId and parentItemId (a story's tasks in the work hierarchy, say). Each task carries owner_name (the owner's display name) beside owner_id, owner_team_name (the owning team's name) beside owner_team_id, and start_date, end_date and target_date: its due date is its end_date, or its target_date when it has no end date. Every task carries its versionTimestamp, ready for updateTask, so one call here supplies the tokens for a whole batch of updates, its parent_item_id and parentItem (the item it belongs to in the work hierarchy, or null), and linkedRecords, the database rows it links (as getTask describes them); filter by them with hasLinkedRecords, linkedRecordIds and linkedTableIds.
|
|
2022
2022
|
*/
|
|
2023
2023
|
post: operations["listTasks"];
|
|
2024
2024
|
delete?: never;
|
|
@@ -2038,7 +2038,7 @@ interface paths {
|
|
|
2038
2038
|
put?: never;
|
|
2039
2039
|
/**
|
|
2040
2040
|
* getTask
|
|
2041
|
-
* @description Get a task by ID with full details, evidence, activity, and the `checklist` array (each item: id, text, due_date, completed_at, plus server-stamped attribution). Returns versionTimestamp; pass it to updateTask to modify. Includes percent_complete for progress tracking. The task carries owner_name (the owner's display name) beside owner_id, and start_date, end_date and target_date: its due date is its end_date, or its target_date when it has no end date. Also returns the work hierarchy: parentItem (the item this one belongs to, such as its epic or story: { id, friendlyId, title, type, status, isTask }, or null), children (the items that belong to it, in status order then by id, at most 200: each with ownerId, ownerTeamId and percentComplete) and childProgress { total, done, closed } over every child (closed counts done, rejected and deferred). Set a parent with parentItemId on updateImprovement or updateTask. Also returns linkedRecords: the database rows it links, each { linkId, databaseId, tableId, rowId, state, label, title, autoId, tableName, databaseName, href } read for you. state ok gives the row's title and a link to it; no_access means you cannot read that row, so no title is given; removed means the row, its table or its database was deleted. Change them with linkedRecords on updateImprovement or updateTask.
|
|
2041
|
+
* @description Get a task by ID with full details, evidence, activity, and the `checklist` array (each item: id, text, due_date, completed_at, plus server-stamped attribution). Returns versionTimestamp; pass it to updateTask to modify. Includes percent_complete for progress tracking. The task carries owner_name (the owner's display name) beside owner_id, owner_team_name (the owning team's name) beside owner_team_id, and start_date, end_date and target_date: its due date is its end_date, or its target_date when it has no end date. Also returns the work hierarchy: parentItem (the item this one belongs to, such as its epic or story: { id, friendlyId, title, type, status, isTask }, or null), children (the items that belong to it, in status order then by id, at most 200: each with ownerId, ownerTeamId and percentComplete) and childProgress { total, done, closed } over every child (closed counts done, rejected and deferred). Set a parent with parentItemId on updateImprovement or updateTask. Also returns linkedRecords: the database rows it links, each { linkId, databaseId, tableId, rowId, state, label, title, autoId, tableName, databaseName, href } read for you. state ok gives the row's title and a link to it; no_access means you cannot read that row, so no title is given; removed means the row, its table or its database was deleted. Change them with linkedRecords on updateImprovement or updateTask.
|
|
2042
2042
|
*/
|
|
2043
2043
|
post: operations["getTask"];
|
|
2044
2044
|
delete?: never;
|
|
@@ -2058,7 +2058,7 @@ interface paths {
|
|
|
2058
2058
|
put?: never;
|
|
2059
2059
|
/**
|
|
2060
2060
|
* updateTask
|
|
2061
|
-
* @description Update a task, or many tasks in one call. A task is the same kind of record as an improvement (one with `is_task=true`), so this is a thin alias over updateImprovement: every field on updateImprovement is supported, including `checklist`, `acceptance_criteria`, dates, owner, percent_complete, parentItemId (the story or requirement it belongs to in the work hierarchy), linkedRecords (the database rows it links: a list replaces them, { add, remove } changes some), etc. versionTimestamp (optimistic locking) is the task's updated_at in epoch milliseconds, and you rarely need a getTask call for it: listTasks and getPlan (items[].versionTimestamp) return it for every task in a plan at once, and every write returns the task's new one. Pass `fields` (for example ["id", "versionTimestamp"]) for a short answer instead of the whole task. To change many tasks (a plan-wide re-date, say), send `items`: up to 200 entries of { taskId, versionTimestamp, ...changes } per call (more than 200: split them into several calls of up to 200), each checked and written on its own and answered with one row per entry plus a summary. Statuses are captured / in_progress / blocked / done / rejected / deferred, and FOUR of those are CLOSED: blocked, done, rejected, deferred. Entering one needs its comment (blocked_comment / rejection_comment / completion_comment); leaving one for an open status needs reopened_comment, including blocked -> in_progress, which surprises people because `blocked` does not sound terminal. `metadata` MERGES into what is stored (null on a key deletes it); pass metadata_replace:true to overwrite the object wholesale. To edit checklist items: call getTask, modify the `checklist` array (preserving each row's `id` to keep its attribution stamps), and pass the full array back here; array order is the sort order. Assignment: pass `owner_id=<uuid>` to assign to a user, `owner_team_id=<uuid>` to assign to a team (mutually exclusive: a task has one owner, a user or a team, never both). To unassign, pass `owner_id=null` AND `owner_team_id=null`. To switch owner kind, send the new value AND null the old one in the SAME call.
|
|
2061
|
+
* @description Update a task, or many tasks in one call. A task is the same kind of record as an improvement (one with `is_task=true`), so this is a thin alias over updateImprovement: every field on updateImprovement is supported, including `checklist`, `acceptance_criteria`, dates, owner, percent_complete, parentItemId (the story or requirement it belongs to in the work hierarchy), linkedRecords (the database rows it links: a list replaces them, { add, remove } changes some), etc. versionTimestamp (optimistic locking) is the task's updated_at in epoch milliseconds, and you rarely need a getTask call for it: listTasks and getPlan (items[].versionTimestamp) return it for every task in a plan at once, and every write returns the task's new one. Pass `fields` (for example ["id", "versionTimestamp"]) for a short answer instead of the whole task. To change many tasks (a plan-wide re-date, say), send `items`: up to 200 entries of { taskId, versionTimestamp, ...changes } per call (more than 200: split them into several calls of up to 200), each checked and written on its own and answered with one row per entry plus a summary. Statuses are captured / in_progress / blocked / done / rejected / deferred, and FOUR of those are CLOSED: blocked, done, rejected, deferred. Entering one needs its comment (blocked_comment / rejection_comment / completion_comment); leaving one for an open status needs reopened_comment, including blocked -> in_progress, which surprises people because `blocked` does not sound terminal. `metadata` MERGES into what is stored (null on a key deletes it); pass metadata_replace:true to overwrite the object wholesale. To edit checklist items: call getTask, modify the `checklist` array (preserving each row's `id` to keep its attribution stamps), and pass the full array back here; array order is the sort order. Assignment: pass `owner_id=<uuid>` to assign to a user, `owner_team_id=<uuid>` to assign to a team (mutually exclusive: a task has one owner, a user or a team, never both). To unassign, pass `owner_id=null` AND `owner_team_id=null`. To switch owner kind, send the new value AND null the old one in the SAME call. The task in the answer carries owner_name (the owner's display name) beside owner_id and owner_team_name (the owning team's name) beside owner_team_id, as getTask's does.
|
|
2062
2062
|
*/
|
|
2063
2063
|
post: operations["updateTask"];
|
|
2064
2064
|
delete?: never;
|
|
@@ -2078,7 +2078,7 @@ interface paths {
|
|
|
2078
2078
|
put?: never;
|
|
2079
2079
|
/**
|
|
2080
2080
|
* getPlanHierarchy
|
|
2081
|
-
* @description Get the complete plan hierarchy (phases, tasks, improvements) in one call. Recommended first call for plan navigation. Each item carries owner_name (the owner's display name) beside owner_id, and start_date, end_date and target_date: its due date is its end_date, or its target_date when it has no end date.
|
|
2081
|
+
* @description Get the complete plan hierarchy (phases, tasks, improvements) in one call. Recommended first call for plan navigation. Each item carries owner_name (the owner's display name) beside owner_id, owner_team_name (the owning team's name) beside owner_team_id, and start_date, end_date and target_date: its due date is its end_date, or its target_date when it has no end date.
|
|
2082
2082
|
*/
|
|
2083
2083
|
post: operations["getPlanHierarchy"];
|
|
2084
2084
|
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, 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;
|
|
@@ -9867,6 +9867,92 @@ interface operations {
|
|
|
9867
9867
|
"application/json": {
|
|
9868
9868
|
/** @description The whiteboard the scribe paints into. REQUIRED: a meeting scribe always paints an existing board. If you do not have a whiteboard id, ask the user which whiteboard to use; never create one automatically. */
|
|
9869
9869
|
documentId: string;
|
|
9870
|
+
/**
|
|
9871
|
+
* @description Optional. 'standard' (the default): the live board only. 'guided': the live board plus private guidance, which needs the guided part.
|
|
9872
|
+
* @enum {string}
|
|
9873
|
+
*/
|
|
9874
|
+
meetingType?: "standard" | "guided";
|
|
9875
|
+
/** @description The guided part, only with meetingType 'guided': what the guidance guides from and who sees it. Checked on the server: the template must be available to the board's organisation, every item of the material must be one the user can open now in that organisation, and the notice must be ticked for an interview. */
|
|
9876
|
+
guided?: {
|
|
9877
|
+
/** @description The guidance template: 'custom' (the user's own instructions) or one the organisation has, such as 'guided_interview' or 'guided_sales'. */
|
|
9878
|
+
templateKey: string;
|
|
9879
|
+
/** @description What the meeting is for, in the user's own words (at most 4,000 characters). The only instructions the guidance follows. */
|
|
9880
|
+
instructions?: string;
|
|
9881
|
+
/** @description What the guidance reads (at most 50): documents, folders, whole projects, database tables or plans the user can open. */
|
|
9882
|
+
material?: {
|
|
9883
|
+
/**
|
|
9884
|
+
* @description What it is (always give it; the server refuses an item without one).
|
|
9885
|
+
* @enum {string}
|
|
9886
|
+
*/
|
|
9887
|
+
kind?: "document" | "folder" | "project" | "database_table" | "plan";
|
|
9888
|
+
/** @description Its id. */
|
|
9889
|
+
id: string;
|
|
9890
|
+
/** @description Its name (at most 200 characters), shown as the source of a suggestion. */
|
|
9891
|
+
label: string;
|
|
9892
|
+
/** @description Optional, for a table only: which rows, as the databases' own question filter. */
|
|
9893
|
+
filter?: {
|
|
9894
|
+
[key: string]: unknown;
|
|
9895
|
+
};
|
|
9896
|
+
}[];
|
|
9897
|
+
/** @description Who sees the guidance (never guests, never the live link or the bot's camera): only the user, chosen people and teams of the organisation, or everyone in the organisation who can open the board. */
|
|
9898
|
+
visibility?: {
|
|
9899
|
+
/**
|
|
9900
|
+
* @description Who sees it. Default only_me.
|
|
9901
|
+
* @enum {string}
|
|
9902
|
+
*/
|
|
9903
|
+
mode?: "only_me" | "people" | "everyone_on_board";
|
|
9904
|
+
/** @description With mode 'people': the people's ids. Each must be able to open the material, or the start is refused naming them. */
|
|
9905
|
+
userIds?: string[];
|
|
9906
|
+
/** @description With mode 'people': the teams' ids. */
|
|
9907
|
+
teamIds?: string[];
|
|
9908
|
+
};
|
|
9909
|
+
/** @description What it listens to besides the words. */
|
|
9910
|
+
listening?: {
|
|
9911
|
+
/** @description Laughter and applause, only where the template allows it. Default false. */
|
|
9912
|
+
roomSound?: boolean;
|
|
9913
|
+
};
|
|
9914
|
+
/** @description What the guidance may use. */
|
|
9915
|
+
tools?: {
|
|
9916
|
+
/** @description Public web search, only where the template allows it. Default false. */
|
|
9917
|
+
webSearch?: boolean;
|
|
9918
|
+
/** @description Save what it hears to the tables in writeTargets. Default false. */
|
|
9919
|
+
write?: boolean;
|
|
9920
|
+
};
|
|
9921
|
+
/**
|
|
9922
|
+
* @description How often it speaks up unprompted. Default balanced.
|
|
9923
|
+
* @enum {string}
|
|
9924
|
+
*/
|
|
9925
|
+
frequency?: "quiet" | "balanced" | "often";
|
|
9926
|
+
/** @description The template's details, by its step's field ids (for an interview: the interview and candidate rows as {table_id, row_id}, the questions to aim for, the length). */
|
|
9927
|
+
templateInputs?: {
|
|
9928
|
+
[key: string]: unknown;
|
|
9929
|
+
};
|
|
9930
|
+
/** @description Where it may save, by the template's role: {"answers": {"database_id": "...", "table_id": "..."}}. Only tables the user may write. */
|
|
9931
|
+
writeTargets?: {
|
|
9932
|
+
[key: string]: unknown;
|
|
9933
|
+
};
|
|
9934
|
+
/** @description Suggest a score after a person has scored, only where the template allows it and only for organisations known to be outside the EU, the EEA and the UK. People always decide. Default false. */
|
|
9935
|
+
evaluate?: boolean;
|
|
9936
|
+
/** @description The notice the user gave the other people in the meeting (required for an interview, and whenever room sound is on). */
|
|
9937
|
+
consent?: {
|
|
9938
|
+
/** @description True once the user has told them that an assistant listens and takes notes. */
|
|
9939
|
+
given?: boolean;
|
|
9940
|
+
/** @description Which notice words were shown. */
|
|
9941
|
+
textVersion?: string;
|
|
9942
|
+
};
|
|
9943
|
+
/** @description Optional. Who is who in the meeting, so the guidance can tell the user's side from the others (the customer, the candidate). The guidance reads the names and the words as information about the meeting, never as instructions. */
|
|
9944
|
+
participants?: {
|
|
9945
|
+
/** @description The people on the user's side, each once (at most 50). Only active members of the board's organisation are kept. */
|
|
9946
|
+
ours?: {
|
|
9947
|
+
/** @description The person's user id. */
|
|
9948
|
+
userId: string;
|
|
9949
|
+
/** @description The name the meeting shows for them (at most 120 characters). */
|
|
9950
|
+
name: string;
|
|
9951
|
+
}[];
|
|
9952
|
+
/** @description The user's own words about everyone else, such as who the customer is and who runs what (at most 1,000 characters). */
|
|
9953
|
+
text?: string;
|
|
9954
|
+
};
|
|
9955
|
+
};
|
|
9870
9956
|
/** @description The meeting link to join: a Zoom, Google Meet, Microsoft Teams, or Webex URL (https only). Any other host is rejected. */
|
|
9871
9957
|
meetingUrl: string;
|
|
9872
9958
|
/** @description Optional agenda pre-drawn on the board as a left rail; each item gets a status sticker (pending, active, done) as the conversation reaches it. Omit to let the rail build itself from the topics that emerge. */
|
|
@@ -10829,6 +10915,21 @@ interface operations {
|
|
|
10829
10915
|
documentId: string;
|
|
10830
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. */
|
|
10831
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
|
+
};
|
|
10832
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). */
|
|
10833
10934
|
shapes: ({
|
|
10834
10935
|
/**
|
|
@@ -31450,6 +31551,30 @@ interface operations {
|
|
|
31450
31551
|
compliance?: boolean;
|
|
31451
31552
|
/** @description The live meeting capture bot. */
|
|
31452
31553
|
meeting_scribe?: boolean;
|
|
31554
|
+
/** @description Guided meetings: guidance beside the live board, from the person's own material. Needs meeting_scribe on. */
|
|
31555
|
+
guided_meetings?: boolean;
|
|
31556
|
+
/** @description The Audit and review template of guided meetings. Needs guided_meetings on. */
|
|
31557
|
+
guided_audit?: boolean;
|
|
31558
|
+
/** @description The Client advice meeting template of guided meetings. Needs guided_meetings on. */
|
|
31559
|
+
guided_client_advice?: boolean;
|
|
31560
|
+
/** @description The 1:1 and coaching template of guided meetings. Needs guided_meetings on. */
|
|
31561
|
+
guided_coaching?: boolean;
|
|
31562
|
+
/** @description The Comedy set template of guided meetings. Needs guided_meetings on. */
|
|
31563
|
+
guided_comedy?: boolean;
|
|
31564
|
+
/** @description The Customer discovery template of guided meetings. Needs guided_meetings on. */
|
|
31565
|
+
guided_discovery?: boolean;
|
|
31566
|
+
/** @description The Interview template of guided meetings. Needs guided_meetings on. */
|
|
31567
|
+
guided_interview?: boolean;
|
|
31568
|
+
/** @description The Plan check-in template of guided meetings. Needs guided_meetings on. */
|
|
31569
|
+
guided_plan_checkin?: boolean;
|
|
31570
|
+
/** @description The Requirements workshop template of guided meetings. Needs guided_meetings on. */
|
|
31571
|
+
guided_requirements?: boolean;
|
|
31572
|
+
/** @description The Sales call template of guided meetings. Needs guided_meetings on. */
|
|
31573
|
+
guided_sales?: boolean;
|
|
31574
|
+
/** @description The Speaking coach template of guided meetings. Needs guided_meetings on. */
|
|
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;
|
|
31453
31578
|
/** @description Agents, with their duties and their connectors. */
|
|
31454
31579
|
agents?: boolean;
|
|
31455
31580
|
/** @description Time tracking: timers and time entries on tasks, improvements and tables. Needs databases on. */
|
|
@@ -33490,7 +33615,7 @@ interface operations {
|
|
|
33490
33615
|
databaseId: string;
|
|
33491
33616
|
/** @description The table's id or name. */
|
|
33492
33617
|
table: string;
|
|
33493
|
-
/** @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. */
|
|
33494
33619
|
where?: {
|
|
33495
33620
|
field?: string;
|
|
33496
33621
|
via?: string[];
|
|
@@ -33528,6 +33653,11 @@ interface operations {
|
|
|
33528
33653
|
does_not_link_to?: (number | string)[] | string | number;
|
|
33529
33654
|
has_any_link?: boolean;
|
|
33530
33655
|
has_no_link?: boolean;
|
|
33656
|
+
linked_from?: {
|
|
33657
|
+
table?: string;
|
|
33658
|
+
row?: string;
|
|
33659
|
+
link?: string;
|
|
33660
|
+
};
|
|
33531
33661
|
and?: {
|
|
33532
33662
|
[key: string]: unknown;
|
|
33533
33663
|
}[];
|
|
@@ -34585,7 +34715,7 @@ interface operations {
|
|
|
34585
34715
|
databaseId: string;
|
|
34586
34716
|
/** @description The table's id or name. */
|
|
34587
34717
|
table: string;
|
|
34588
|
-
/** @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. */
|
|
34589
34719
|
rows?: {
|
|
34590
34720
|
/** @description The row to change. Leave out to add a row (or, with matchOn, to add or change one). */
|
|
34591
34721
|
id?: string;
|