@stablebaseline/sdk 0.10.0 → 0.10.1
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 +117 -9
- package/dist/index.d.ts +117 -9
- package/openapi.json +236 -9
- package/package.json +1 -1
- package/src/types.generated.ts +117 -9
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;
|
|
@@ -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;
|
|
@@ -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, 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;
|
|
@@ -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. */
|
|
@@ -31450,6 +31536,28 @@ interface operations {
|
|
|
31450
31536
|
compliance?: boolean;
|
|
31451
31537
|
/** @description The live meeting capture bot. */
|
|
31452
31538
|
meeting_scribe?: boolean;
|
|
31539
|
+
/** @description Guided meetings: guidance beside the live board, from the person's own material. Needs meeting_scribe on. */
|
|
31540
|
+
guided_meetings?: boolean;
|
|
31541
|
+
/** @description The Audit and review template of guided meetings. Needs guided_meetings on. */
|
|
31542
|
+
guided_audit?: boolean;
|
|
31543
|
+
/** @description The Client advice meeting template of guided meetings. Needs guided_meetings on. */
|
|
31544
|
+
guided_client_advice?: boolean;
|
|
31545
|
+
/** @description The 1:1 and coaching template of guided meetings. Needs guided_meetings on. */
|
|
31546
|
+
guided_coaching?: boolean;
|
|
31547
|
+
/** @description The Comedy set template of guided meetings. Needs guided_meetings on. */
|
|
31548
|
+
guided_comedy?: boolean;
|
|
31549
|
+
/** @description The Customer discovery template of guided meetings. Needs guided_meetings on. */
|
|
31550
|
+
guided_discovery?: boolean;
|
|
31551
|
+
/** @description The Interview template of guided meetings. Needs guided_meetings on. */
|
|
31552
|
+
guided_interview?: boolean;
|
|
31553
|
+
/** @description The Plan check-in template of guided meetings. Needs guided_meetings on. */
|
|
31554
|
+
guided_plan_checkin?: boolean;
|
|
31555
|
+
/** @description The Requirements workshop template of guided meetings. Needs guided_meetings on. */
|
|
31556
|
+
guided_requirements?: boolean;
|
|
31557
|
+
/** @description The Sales call template of guided meetings. Needs guided_meetings on. */
|
|
31558
|
+
guided_sales?: boolean;
|
|
31559
|
+
/** @description The Speaking coach template of guided meetings. Needs guided_meetings on. */
|
|
31560
|
+
guided_speaking?: boolean;
|
|
31453
31561
|
/** @description Agents, with their duties and their connectors. */
|
|
31454
31562
|
agents?: boolean;
|
|
31455
31563
|
/** @description Time tracking: timers and time entries on tasks, improvements and tables. Needs databases on. */
|
package/dist/index.d.ts
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;
|
|
@@ -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;
|
|
@@ -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, 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;
|
|
@@ -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. */
|
|
@@ -31450,6 +31536,28 @@ interface operations {
|
|
|
31450
31536
|
compliance?: boolean;
|
|
31451
31537
|
/** @description The live meeting capture bot. */
|
|
31452
31538
|
meeting_scribe?: boolean;
|
|
31539
|
+
/** @description Guided meetings: guidance beside the live board, from the person's own material. Needs meeting_scribe on. */
|
|
31540
|
+
guided_meetings?: boolean;
|
|
31541
|
+
/** @description The Audit and review template of guided meetings. Needs guided_meetings on. */
|
|
31542
|
+
guided_audit?: boolean;
|
|
31543
|
+
/** @description The Client advice meeting template of guided meetings. Needs guided_meetings on. */
|
|
31544
|
+
guided_client_advice?: boolean;
|
|
31545
|
+
/** @description The 1:1 and coaching template of guided meetings. Needs guided_meetings on. */
|
|
31546
|
+
guided_coaching?: boolean;
|
|
31547
|
+
/** @description The Comedy set template of guided meetings. Needs guided_meetings on. */
|
|
31548
|
+
guided_comedy?: boolean;
|
|
31549
|
+
/** @description The Customer discovery template of guided meetings. Needs guided_meetings on. */
|
|
31550
|
+
guided_discovery?: boolean;
|
|
31551
|
+
/** @description The Interview template of guided meetings. Needs guided_meetings on. */
|
|
31552
|
+
guided_interview?: boolean;
|
|
31553
|
+
/** @description The Plan check-in template of guided meetings. Needs guided_meetings on. */
|
|
31554
|
+
guided_plan_checkin?: boolean;
|
|
31555
|
+
/** @description The Requirements workshop template of guided meetings. Needs guided_meetings on. */
|
|
31556
|
+
guided_requirements?: boolean;
|
|
31557
|
+
/** @description The Sales call template of guided meetings. Needs guided_meetings on. */
|
|
31558
|
+
guided_sales?: boolean;
|
|
31559
|
+
/** @description The Speaking coach template of guided meetings. Needs guided_meetings on. */
|
|
31560
|
+
guided_speaking?: boolean;
|
|
31453
31561
|
/** @description Agents, with their duties and their connectors. */
|
|
31454
31562
|
agents?: boolean;
|
|
31455
31563
|
/** @description Time tracking: timers and time entries on tasks, improvements and tables. Needs databases on. */
|
package/openapi.json
CHANGED
|
@@ -8213,7 +8213,7 @@
|
|
|
8213
8213
|
"/tools/startMeetingScribe": {
|
|
8214
8214
|
"post": {
|
|
8215
8215
|
"summary": "startMeetingScribe",
|
|
8216
|
-
"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.",
|
|
8216
|
+
"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.",
|
|
8217
8217
|
"operationId": "startMeetingScribe",
|
|
8218
8218
|
"tags": [
|
|
8219
8219
|
"whiteboards"
|
|
@@ -8242,6 +8242,189 @@
|
|
|
8242
8242
|
"type": "string",
|
|
8243
8243
|
"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."
|
|
8244
8244
|
},
|
|
8245
|
+
"meetingType": {
|
|
8246
|
+
"type": "string",
|
|
8247
|
+
"enum": [
|
|
8248
|
+
"standard",
|
|
8249
|
+
"guided"
|
|
8250
|
+
],
|
|
8251
|
+
"description": "Optional. 'standard' (the default): the live board only. 'guided': the live board plus private guidance, which needs the guided part."
|
|
8252
|
+
},
|
|
8253
|
+
"guided": {
|
|
8254
|
+
"type": "object",
|
|
8255
|
+
"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.",
|
|
8256
|
+
"properties": {
|
|
8257
|
+
"templateKey": {
|
|
8258
|
+
"type": "string",
|
|
8259
|
+
"description": "The guidance template: 'custom' (the user's own instructions) or one the organisation has, such as 'guided_interview' or 'guided_sales'."
|
|
8260
|
+
},
|
|
8261
|
+
"instructions": {
|
|
8262
|
+
"type": "string",
|
|
8263
|
+
"description": "What the meeting is for, in the user's own words (at most 4,000 characters). The only instructions the guidance follows."
|
|
8264
|
+
},
|
|
8265
|
+
"material": {
|
|
8266
|
+
"type": "array",
|
|
8267
|
+
"description": "What the guidance reads (at most 50): documents, folders, whole projects, database tables or plans the user can open.",
|
|
8268
|
+
"items": {
|
|
8269
|
+
"type": "object",
|
|
8270
|
+
"properties": {
|
|
8271
|
+
"kind": {
|
|
8272
|
+
"type": "string",
|
|
8273
|
+
"enum": [
|
|
8274
|
+
"document",
|
|
8275
|
+
"folder",
|
|
8276
|
+
"project",
|
|
8277
|
+
"database_table",
|
|
8278
|
+
"plan"
|
|
8279
|
+
],
|
|
8280
|
+
"description": "What it is (always give it; the server refuses an item without one)."
|
|
8281
|
+
},
|
|
8282
|
+
"id": {
|
|
8283
|
+
"type": "string",
|
|
8284
|
+
"description": "Its id."
|
|
8285
|
+
},
|
|
8286
|
+
"label": {
|
|
8287
|
+
"type": "string",
|
|
8288
|
+
"description": "Its name (at most 200 characters), shown as the source of a suggestion."
|
|
8289
|
+
},
|
|
8290
|
+
"filter": {
|
|
8291
|
+
"type": "object",
|
|
8292
|
+
"description": "Optional, for a table only: which rows, as the databases' own question filter.",
|
|
8293
|
+
"additionalProperties": true
|
|
8294
|
+
}
|
|
8295
|
+
},
|
|
8296
|
+
"required": [
|
|
8297
|
+
"id",
|
|
8298
|
+
"label"
|
|
8299
|
+
]
|
|
8300
|
+
}
|
|
8301
|
+
},
|
|
8302
|
+
"visibility": {
|
|
8303
|
+
"type": "object",
|
|
8304
|
+
"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.",
|
|
8305
|
+
"properties": {
|
|
8306
|
+
"mode": {
|
|
8307
|
+
"type": "string",
|
|
8308
|
+
"enum": [
|
|
8309
|
+
"only_me",
|
|
8310
|
+
"people",
|
|
8311
|
+
"everyone_on_board"
|
|
8312
|
+
],
|
|
8313
|
+
"description": "Who sees it. Default only_me."
|
|
8314
|
+
},
|
|
8315
|
+
"userIds": {
|
|
8316
|
+
"type": "array",
|
|
8317
|
+
"items": {
|
|
8318
|
+
"type": "string"
|
|
8319
|
+
},
|
|
8320
|
+
"description": "With mode 'people': the people's ids. Each must be able to open the material, or the start is refused naming them."
|
|
8321
|
+
},
|
|
8322
|
+
"teamIds": {
|
|
8323
|
+
"type": "array",
|
|
8324
|
+
"items": {
|
|
8325
|
+
"type": "string"
|
|
8326
|
+
},
|
|
8327
|
+
"description": "With mode 'people': the teams' ids."
|
|
8328
|
+
}
|
|
8329
|
+
}
|
|
8330
|
+
},
|
|
8331
|
+
"listening": {
|
|
8332
|
+
"type": "object",
|
|
8333
|
+
"description": "What it listens to besides the words.",
|
|
8334
|
+
"properties": {
|
|
8335
|
+
"roomSound": {
|
|
8336
|
+
"type": "boolean",
|
|
8337
|
+
"description": "Laughter and applause, only where the template allows it. Default false."
|
|
8338
|
+
}
|
|
8339
|
+
}
|
|
8340
|
+
},
|
|
8341
|
+
"tools": {
|
|
8342
|
+
"type": "object",
|
|
8343
|
+
"description": "What the guidance may use.",
|
|
8344
|
+
"properties": {
|
|
8345
|
+
"webSearch": {
|
|
8346
|
+
"type": "boolean",
|
|
8347
|
+
"description": "Public web search, only where the template allows it. Default false."
|
|
8348
|
+
},
|
|
8349
|
+
"write": {
|
|
8350
|
+
"type": "boolean",
|
|
8351
|
+
"description": "Save what it hears to the tables in writeTargets. Default false."
|
|
8352
|
+
}
|
|
8353
|
+
}
|
|
8354
|
+
},
|
|
8355
|
+
"frequency": {
|
|
8356
|
+
"type": "string",
|
|
8357
|
+
"enum": [
|
|
8358
|
+
"quiet",
|
|
8359
|
+
"balanced",
|
|
8360
|
+
"often"
|
|
8361
|
+
],
|
|
8362
|
+
"description": "How often it speaks up unprompted. Default balanced."
|
|
8363
|
+
},
|
|
8364
|
+
"templateInputs": {
|
|
8365
|
+
"type": "object",
|
|
8366
|
+
"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).",
|
|
8367
|
+
"additionalProperties": true
|
|
8368
|
+
},
|
|
8369
|
+
"writeTargets": {
|
|
8370
|
+
"type": "object",
|
|
8371
|
+
"description": "Where it may save, by the template's role: {\"answers\": {\"database_id\": \"...\", \"table_id\": \"...\"}}. Only tables the user may write.",
|
|
8372
|
+
"additionalProperties": true
|
|
8373
|
+
},
|
|
8374
|
+
"evaluate": {
|
|
8375
|
+
"type": "boolean",
|
|
8376
|
+
"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."
|
|
8377
|
+
},
|
|
8378
|
+
"consent": {
|
|
8379
|
+
"type": "object",
|
|
8380
|
+
"description": "The notice the user gave the other people in the meeting (required for an interview, and whenever room sound is on).",
|
|
8381
|
+
"properties": {
|
|
8382
|
+
"given": {
|
|
8383
|
+
"type": "boolean",
|
|
8384
|
+
"description": "True once the user has told them that an assistant listens and takes notes."
|
|
8385
|
+
},
|
|
8386
|
+
"textVersion": {
|
|
8387
|
+
"type": "string",
|
|
8388
|
+
"description": "Which notice words were shown."
|
|
8389
|
+
}
|
|
8390
|
+
}
|
|
8391
|
+
},
|
|
8392
|
+
"participants": {
|
|
8393
|
+
"type": "object",
|
|
8394
|
+
"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.",
|
|
8395
|
+
"properties": {
|
|
8396
|
+
"ours": {
|
|
8397
|
+
"type": "array",
|
|
8398
|
+
"description": "The people on the user's side, each once (at most 50). Only active members of the board's organisation are kept.",
|
|
8399
|
+
"items": {
|
|
8400
|
+
"type": "object",
|
|
8401
|
+
"properties": {
|
|
8402
|
+
"userId": {
|
|
8403
|
+
"type": "string",
|
|
8404
|
+
"description": "The person's user id."
|
|
8405
|
+
},
|
|
8406
|
+
"name": {
|
|
8407
|
+
"type": "string",
|
|
8408
|
+
"description": "The name the meeting shows for them (at most 120 characters)."
|
|
8409
|
+
}
|
|
8410
|
+
},
|
|
8411
|
+
"required": [
|
|
8412
|
+
"userId",
|
|
8413
|
+
"name"
|
|
8414
|
+
]
|
|
8415
|
+
}
|
|
8416
|
+
},
|
|
8417
|
+
"text": {
|
|
8418
|
+
"type": "string",
|
|
8419
|
+
"description": "The user's own words about everyone else, such as who the customer is and who runs what (at most 1,000 characters)."
|
|
8420
|
+
}
|
|
8421
|
+
}
|
|
8422
|
+
}
|
|
8423
|
+
},
|
|
8424
|
+
"required": [
|
|
8425
|
+
"templateKey"
|
|
8426
|
+
]
|
|
8427
|
+
},
|
|
8245
8428
|
"meetingUrl": {
|
|
8246
8429
|
"type": "string",
|
|
8247
8430
|
"description": "The meeting link to join: a Zoom, Google Meet, Microsoft Teams, or Webex URL (https only). Any other host is rejected."
|
|
@@ -8446,7 +8629,7 @@
|
|
|
8446
8629
|
"/tools/getMeetingScribeStatus": {
|
|
8447
8630
|
"post": {
|
|
8448
8631
|
"summary": "getMeetingScribeStatus",
|
|
8449
|
-
"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).",
|
|
8632
|
+
"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.",
|
|
8450
8633
|
"operationId": "getMeetingScribeStatus",
|
|
8451
8634
|
"tags": [
|
|
8452
8635
|
"whiteboards"
|
|
@@ -20349,7 +20532,7 @@
|
|
|
20349
20532
|
"/tools/getPlan": {
|
|
20350
20533
|
"post": {
|
|
20351
20534
|
"summary": "getPlan",
|
|
20352
|
-
"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.",
|
|
20535
|
+
"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.",
|
|
20353
20536
|
"operationId": "getPlan",
|
|
20354
20537
|
"tags": [
|
|
20355
20538
|
"plans"
|
|
@@ -23149,7 +23332,7 @@
|
|
|
23149
23332
|
"/tools/createTask": {
|
|
23150
23333
|
"post": {
|
|
23151
23334
|
"summary": "createTask",
|
|
23152
|
-
"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.",
|
|
23335
|
+
"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.",
|
|
23153
23336
|
"operationId": "createTask",
|
|
23154
23337
|
"tags": [
|
|
23155
23338
|
"plans"
|
|
@@ -23714,7 +23897,7 @@
|
|
|
23714
23897
|
"/tools/listTasks": {
|
|
23715
23898
|
"post": {
|
|
23716
23899
|
"summary": "listTasks",
|
|
23717
|
-
"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.",
|
|
23900
|
+
"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.",
|
|
23718
23901
|
"operationId": "listTasks",
|
|
23719
23902
|
"tags": [
|
|
23720
23903
|
"plans"
|
|
@@ -23951,7 +24134,7 @@
|
|
|
23951
24134
|
"/tools/getTask": {
|
|
23952
24135
|
"post": {
|
|
23953
24136
|
"summary": "getTask",
|
|
23954
|
-
"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.",
|
|
24137
|
+
"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.",
|
|
23955
24138
|
"operationId": "getTask",
|
|
23956
24139
|
"tags": [
|
|
23957
24140
|
"plans"
|
|
@@ -24112,7 +24295,7 @@
|
|
|
24112
24295
|
"/tools/updateTask": {
|
|
24113
24296
|
"post": {
|
|
24114
24297
|
"summary": "updateTask",
|
|
24115
|
-
"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.",
|
|
24298
|
+
"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.",
|
|
24116
24299
|
"operationId": "updateTask",
|
|
24117
24300
|
"tags": [
|
|
24118
24301
|
"plans"
|
|
@@ -25213,7 +25396,7 @@
|
|
|
25213
25396
|
"/tools/getPlanHierarchy": {
|
|
25214
25397
|
"post": {
|
|
25215
25398
|
"summary": "getPlanHierarchy",
|
|
25216
|
-
"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.",
|
|
25399
|
+
"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.",
|
|
25217
25400
|
"operationId": "getPlanHierarchy",
|
|
25218
25401
|
"tags": [
|
|
25219
25402
|
"plans"
|
|
@@ -42120,7 +42303,7 @@
|
|
|
42120
42303
|
"/tools/updateOrgFeatureFlags": {
|
|
42121
42304
|
"post": {
|
|
42122
42305
|
"summary": "updateOrgFeatureFlags",
|
|
42123
|
-
"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.",
|
|
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.",
|
|
42124
42307
|
"operationId": "updateOrgFeatureFlags",
|
|
42125
42308
|
"tags": [
|
|
42126
42309
|
"settings"
|
|
@@ -42172,6 +42355,50 @@
|
|
|
42172
42355
|
"type": "boolean",
|
|
42173
42356
|
"description": "The live meeting capture bot."
|
|
42174
42357
|
},
|
|
42358
|
+
"guided_meetings": {
|
|
42359
|
+
"type": "boolean",
|
|
42360
|
+
"description": "Guided meetings: guidance beside the live board, from the person's own material. Needs meeting_scribe on."
|
|
42361
|
+
},
|
|
42362
|
+
"guided_audit": {
|
|
42363
|
+
"type": "boolean",
|
|
42364
|
+
"description": "The Audit and review template of guided meetings. Needs guided_meetings on."
|
|
42365
|
+
},
|
|
42366
|
+
"guided_client_advice": {
|
|
42367
|
+
"type": "boolean",
|
|
42368
|
+
"description": "The Client advice meeting template of guided meetings. Needs guided_meetings on."
|
|
42369
|
+
},
|
|
42370
|
+
"guided_coaching": {
|
|
42371
|
+
"type": "boolean",
|
|
42372
|
+
"description": "The 1:1 and coaching template of guided meetings. Needs guided_meetings on."
|
|
42373
|
+
},
|
|
42374
|
+
"guided_comedy": {
|
|
42375
|
+
"type": "boolean",
|
|
42376
|
+
"description": "The Comedy set template of guided meetings. Needs guided_meetings on."
|
|
42377
|
+
},
|
|
42378
|
+
"guided_discovery": {
|
|
42379
|
+
"type": "boolean",
|
|
42380
|
+
"description": "The Customer discovery template of guided meetings. Needs guided_meetings on."
|
|
42381
|
+
},
|
|
42382
|
+
"guided_interview": {
|
|
42383
|
+
"type": "boolean",
|
|
42384
|
+
"description": "The Interview template of guided meetings. Needs guided_meetings on."
|
|
42385
|
+
},
|
|
42386
|
+
"guided_plan_checkin": {
|
|
42387
|
+
"type": "boolean",
|
|
42388
|
+
"description": "The Plan check-in template of guided meetings. Needs guided_meetings on."
|
|
42389
|
+
},
|
|
42390
|
+
"guided_requirements": {
|
|
42391
|
+
"type": "boolean",
|
|
42392
|
+
"description": "The Requirements workshop template of guided meetings. Needs guided_meetings on."
|
|
42393
|
+
},
|
|
42394
|
+
"guided_sales": {
|
|
42395
|
+
"type": "boolean",
|
|
42396
|
+
"description": "The Sales call template of guided meetings. Needs guided_meetings on."
|
|
42397
|
+
},
|
|
42398
|
+
"guided_speaking": {
|
|
42399
|
+
"type": "boolean",
|
|
42400
|
+
"description": "The Speaking coach template of guided meetings. Needs guided_meetings on."
|
|
42401
|
+
},
|
|
42175
42402
|
"agents": {
|
|
42176
42403
|
"type": "boolean",
|
|
42177
42404
|
"description": "Agents, with their duties and their connectors."
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stablebaseline/sdk",
|
|
3
|
-
"version": "0.10.
|
|
3
|
+
"version": "0.10.1",
|
|
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
|
@@ -775,7 +775,7 @@ export interface paths {
|
|
|
775
775
|
put?: never;
|
|
776
776
|
/**
|
|
777
777
|
* startMeetingScribe
|
|
778
|
-
* @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.
|
|
778
|
+
* @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.
|
|
779
779
|
*/
|
|
780
780
|
post: operations["startMeetingScribe"];
|
|
781
781
|
delete?: never;
|
|
@@ -795,7 +795,7 @@ export interface paths {
|
|
|
795
795
|
put?: never;
|
|
796
796
|
/**
|
|
797
797
|
* getMeetingScribeStatus
|
|
798
|
-
* @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).
|
|
798
|
+
* @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.
|
|
799
799
|
*/
|
|
800
800
|
post: operations["getMeetingScribeStatus"];
|
|
801
801
|
delete?: never;
|
|
@@ -1739,7 +1739,7 @@ export interface paths {
|
|
|
1739
1739
|
put?: never;
|
|
1740
1740
|
/**
|
|
1741
1741
|
* getPlan
|
|
1742
|
-
* @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.
|
|
1742
|
+
* @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.
|
|
1743
1743
|
*/
|
|
1744
1744
|
post: operations["getPlan"];
|
|
1745
1745
|
delete?: never;
|
|
@@ -1999,7 +1999,7 @@ export interface paths {
|
|
|
1999
1999
|
put?: never;
|
|
2000
2000
|
/**
|
|
2001
2001
|
* createTask
|
|
2002
|
-
* @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.
|
|
2002
|
+
* @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.
|
|
2003
2003
|
*/
|
|
2004
2004
|
post: operations["createTask"];
|
|
2005
2005
|
delete?: never;
|
|
@@ -2019,7 +2019,7 @@ export interface paths {
|
|
|
2019
2019
|
put?: never;
|
|
2020
2020
|
/**
|
|
2021
2021
|
* listTasks
|
|
2022
|
-
* @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.
|
|
2022
|
+
* @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.
|
|
2023
2023
|
*/
|
|
2024
2024
|
post: operations["listTasks"];
|
|
2025
2025
|
delete?: never;
|
|
@@ -2039,7 +2039,7 @@ export interface paths {
|
|
|
2039
2039
|
put?: never;
|
|
2040
2040
|
/**
|
|
2041
2041
|
* getTask
|
|
2042
|
-
* @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.
|
|
2042
|
+
* @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.
|
|
2043
2043
|
*/
|
|
2044
2044
|
post: operations["getTask"];
|
|
2045
2045
|
delete?: never;
|
|
@@ -2059,7 +2059,7 @@ export interface paths {
|
|
|
2059
2059
|
put?: never;
|
|
2060
2060
|
/**
|
|
2061
2061
|
* updateTask
|
|
2062
|
-
* @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.
|
|
2062
|
+
* @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.
|
|
2063
2063
|
*/
|
|
2064
2064
|
post: operations["updateTask"];
|
|
2065
2065
|
delete?: never;
|
|
@@ -2079,7 +2079,7 @@ export interface paths {
|
|
|
2079
2079
|
put?: never;
|
|
2080
2080
|
/**
|
|
2081
2081
|
* getPlanHierarchy
|
|
2082
|
-
* @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.
|
|
2082
|
+
* @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.
|
|
2083
2083
|
*/
|
|
2084
2084
|
post: operations["getPlanHierarchy"];
|
|
2085
2085
|
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, 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, 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;
|
|
@@ -9868,6 +9868,92 @@ export interface operations {
|
|
|
9868
9868
|
"application/json": {
|
|
9869
9869
|
/** @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. */
|
|
9870
9870
|
documentId: string;
|
|
9871
|
+
/**
|
|
9872
|
+
* @description Optional. 'standard' (the default): the live board only. 'guided': the live board plus private guidance, which needs the guided part.
|
|
9873
|
+
* @enum {string}
|
|
9874
|
+
*/
|
|
9875
|
+
meetingType?: "standard" | "guided";
|
|
9876
|
+
/** @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. */
|
|
9877
|
+
guided?: {
|
|
9878
|
+
/** @description The guidance template: 'custom' (the user's own instructions) or one the organisation has, such as 'guided_interview' or 'guided_sales'. */
|
|
9879
|
+
templateKey: string;
|
|
9880
|
+
/** @description What the meeting is for, in the user's own words (at most 4,000 characters). The only instructions the guidance follows. */
|
|
9881
|
+
instructions?: string;
|
|
9882
|
+
/** @description What the guidance reads (at most 50): documents, folders, whole projects, database tables or plans the user can open. */
|
|
9883
|
+
material?: {
|
|
9884
|
+
/**
|
|
9885
|
+
* @description What it is (always give it; the server refuses an item without one).
|
|
9886
|
+
* @enum {string}
|
|
9887
|
+
*/
|
|
9888
|
+
kind?: "document" | "folder" | "project" | "database_table" | "plan";
|
|
9889
|
+
/** @description Its id. */
|
|
9890
|
+
id: string;
|
|
9891
|
+
/** @description Its name (at most 200 characters), shown as the source of a suggestion. */
|
|
9892
|
+
label: string;
|
|
9893
|
+
/** @description Optional, for a table only: which rows, as the databases' own question filter. */
|
|
9894
|
+
filter?: {
|
|
9895
|
+
[key: string]: unknown;
|
|
9896
|
+
};
|
|
9897
|
+
}[];
|
|
9898
|
+
/** @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. */
|
|
9899
|
+
visibility?: {
|
|
9900
|
+
/**
|
|
9901
|
+
* @description Who sees it. Default only_me.
|
|
9902
|
+
* @enum {string}
|
|
9903
|
+
*/
|
|
9904
|
+
mode?: "only_me" | "people" | "everyone_on_board";
|
|
9905
|
+
/** @description With mode 'people': the people's ids. Each must be able to open the material, or the start is refused naming them. */
|
|
9906
|
+
userIds?: string[];
|
|
9907
|
+
/** @description With mode 'people': the teams' ids. */
|
|
9908
|
+
teamIds?: string[];
|
|
9909
|
+
};
|
|
9910
|
+
/** @description What it listens to besides the words. */
|
|
9911
|
+
listening?: {
|
|
9912
|
+
/** @description Laughter and applause, only where the template allows it. Default false. */
|
|
9913
|
+
roomSound?: boolean;
|
|
9914
|
+
};
|
|
9915
|
+
/** @description What the guidance may use. */
|
|
9916
|
+
tools?: {
|
|
9917
|
+
/** @description Public web search, only where the template allows it. Default false. */
|
|
9918
|
+
webSearch?: boolean;
|
|
9919
|
+
/** @description Save what it hears to the tables in writeTargets. Default false. */
|
|
9920
|
+
write?: boolean;
|
|
9921
|
+
};
|
|
9922
|
+
/**
|
|
9923
|
+
* @description How often it speaks up unprompted. Default balanced.
|
|
9924
|
+
* @enum {string}
|
|
9925
|
+
*/
|
|
9926
|
+
frequency?: "quiet" | "balanced" | "often";
|
|
9927
|
+
/** @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). */
|
|
9928
|
+
templateInputs?: {
|
|
9929
|
+
[key: string]: unknown;
|
|
9930
|
+
};
|
|
9931
|
+
/** @description Where it may save, by the template's role: {"answers": {"database_id": "...", "table_id": "..."}}. Only tables the user may write. */
|
|
9932
|
+
writeTargets?: {
|
|
9933
|
+
[key: string]: unknown;
|
|
9934
|
+
};
|
|
9935
|
+
/** @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. */
|
|
9936
|
+
evaluate?: boolean;
|
|
9937
|
+
/** @description The notice the user gave the other people in the meeting (required for an interview, and whenever room sound is on). */
|
|
9938
|
+
consent?: {
|
|
9939
|
+
/** @description True once the user has told them that an assistant listens and takes notes. */
|
|
9940
|
+
given?: boolean;
|
|
9941
|
+
/** @description Which notice words were shown. */
|
|
9942
|
+
textVersion?: string;
|
|
9943
|
+
};
|
|
9944
|
+
/** @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. */
|
|
9945
|
+
participants?: {
|
|
9946
|
+
/** @description The people on the user's side, each once (at most 50). Only active members of the board's organisation are kept. */
|
|
9947
|
+
ours?: {
|
|
9948
|
+
/** @description The person's user id. */
|
|
9949
|
+
userId: string;
|
|
9950
|
+
/** @description The name the meeting shows for them (at most 120 characters). */
|
|
9951
|
+
name: string;
|
|
9952
|
+
}[];
|
|
9953
|
+
/** @description The user's own words about everyone else, such as who the customer is and who runs what (at most 1,000 characters). */
|
|
9954
|
+
text?: string;
|
|
9955
|
+
};
|
|
9956
|
+
};
|
|
9871
9957
|
/** @description The meeting link to join: a Zoom, Google Meet, Microsoft Teams, or Webex URL (https only). Any other host is rejected. */
|
|
9872
9958
|
meetingUrl: string;
|
|
9873
9959
|
/** @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. */
|
|
@@ -31451,6 +31537,28 @@ export interface operations {
|
|
|
31451
31537
|
compliance?: boolean;
|
|
31452
31538
|
/** @description The live meeting capture bot. */
|
|
31453
31539
|
meeting_scribe?: boolean;
|
|
31540
|
+
/** @description Guided meetings: guidance beside the live board, from the person's own material. Needs meeting_scribe on. */
|
|
31541
|
+
guided_meetings?: boolean;
|
|
31542
|
+
/** @description The Audit and review template of guided meetings. Needs guided_meetings on. */
|
|
31543
|
+
guided_audit?: boolean;
|
|
31544
|
+
/** @description The Client advice meeting template of guided meetings. Needs guided_meetings on. */
|
|
31545
|
+
guided_client_advice?: boolean;
|
|
31546
|
+
/** @description The 1:1 and coaching template of guided meetings. Needs guided_meetings on. */
|
|
31547
|
+
guided_coaching?: boolean;
|
|
31548
|
+
/** @description The Comedy set template of guided meetings. Needs guided_meetings on. */
|
|
31549
|
+
guided_comedy?: boolean;
|
|
31550
|
+
/** @description The Customer discovery template of guided meetings. Needs guided_meetings on. */
|
|
31551
|
+
guided_discovery?: boolean;
|
|
31552
|
+
/** @description The Interview template of guided meetings. Needs guided_meetings on. */
|
|
31553
|
+
guided_interview?: boolean;
|
|
31554
|
+
/** @description The Plan check-in template of guided meetings. Needs guided_meetings on. */
|
|
31555
|
+
guided_plan_checkin?: boolean;
|
|
31556
|
+
/** @description The Requirements workshop template of guided meetings. Needs guided_meetings on. */
|
|
31557
|
+
guided_requirements?: boolean;
|
|
31558
|
+
/** @description The Sales call template of guided meetings. Needs guided_meetings on. */
|
|
31559
|
+
guided_sales?: boolean;
|
|
31560
|
+
/** @description The Speaking coach template of guided meetings. Needs guided_meetings on. */
|
|
31561
|
+
guided_speaking?: boolean;
|
|
31454
31562
|
/** @description Agents, with their duties and their connectors. */
|
|
31455
31563
|
agents?: boolean;
|
|
31456
31564
|
/** @description Time tracking: timers and time entries on tasks, improvements and tables. Needs databases on. */
|