@stablebaseline/sdk 0.8.0 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.cts +478 -75
- package/dist/index.d.ts +478 -75
- package/openapi.json +1066 -84
- package/package.json +1 -1
- package/src/types.generated.ts +478 -75
package/dist/index.d.cts
CHANGED
|
@@ -374,7 +374,7 @@ interface paths {
|
|
|
374
374
|
put?: never;
|
|
375
375
|
/**
|
|
376
376
|
* listDocuments
|
|
377
|
-
* @description List AND grep documents in a project, workspace, or folder. `query` does a full-content search across each document's body (not just the title) and returns the matching lines — like grep across your docs. Each returned document includes `contentMatches: [{line, text, context?}]` and `matchCount`; the `text` is anchor-ready (paste it straight into editDocument's oldText). Use isRegex:true for regular-expression search (e.g. "TODO\(.*\)", "ACME-\d+"), caseSensitive for exact case, and contextLines for surrounding lines (grep -C). versionTimestamp is returned per document so you can edit straight from the results without a getDocument round-trip. Also supports date filtering. SCOPE HONESTY — read this before concluding something is absent: only documents that actually matched are returned (a document is never listed with matchCount 0 just because it was in scope), and the `grep` block reports `scannedDocuments` against `totalDocumentsInScope`. When `truncated` is true the search covered only part of the scope, so an absence is NOT proof; repeat with `scanOffset` set to the returned `nextScanOffset` until that field is gone, and union the results. A document too large to read is returned with `contentSearchSkipped: true` and NO matchCount, because its body was never searched.
|
|
377
|
+
* @description List AND grep documents in a project, workspace, or folder. `query` does a full-content search across each document's body (not just the title) and returns the matching lines — like grep across your docs. Each returned document includes `contentMatches: [{line, text, context?}]` and `matchCount`; the `text` is anchor-ready (paste it straight into editDocument's oldText). Use isRegex:true for regular-expression search (e.g. "TODO\(.*\)", "ACME-\d+"), caseSensitive for exact case, and contextLines for surrounding lines (grep -C). versionTimestamp is returned per document so you can edit straight from the results without a getDocument round-trip. Also supports date filtering. SCOPE HONESTY — read this before concluding something is absent: only documents that actually matched are returned (a document is never listed with matchCount 0 just because it was in scope), and the `grep` block reports `scannedDocuments` against `totalDocumentsInScope`. When `truncated` is true the search covered only part of the scope, so an absence is NOT proof; repeat with `scanOffset` set to the returned `nextScanOffset` until that field is gone, and union the results. A document too large to read is returned with `contentSearchSkipped: true` and NO matchCount, because its body was never searched. WHAT CHANGED: give changedSince (a period such as this_week, or a date) to list only the documents added or edited in that time, newest change first, each with change: added or edited, when (in words, in the person's time zone), by whom (a person's name, and the agent's key when one did it) and the versions saved meanwhile. With no projectId, workspaceId or folderId it covers your whole organisation. Only documents the caller may open are listed. For how one changed, call listDocumentVersions with the same changedSince and compare:true. Not with query.
|
|
378
378
|
*/
|
|
379
379
|
post: operations["listDocuments"];
|
|
380
380
|
delete?: never;
|
|
@@ -854,7 +854,7 @@ interface paths {
|
|
|
854
854
|
put?: never;
|
|
855
855
|
/**
|
|
856
856
|
* listWhiteboards
|
|
857
|
-
* @description List AND grep the whiteboards in a project (hidden whiteboard-kind documents). `query` searches the title and friendlyId (substring by default; set isRegex:true for a regular expression, caseSensitive:true for exact case). This is the tool to find a board by name — listDocuments deliberately excludes whiteboards. Returns documentId, diagramId, title and timestamps for each.
|
|
857
|
+
* @description List AND grep the whiteboards in a project (hidden whiteboard-kind documents). `query` searches the title and friendlyId (substring by default; set isRegex:true for a regular expression, caseSensitive:true for exact case). This is the tool to find a board by name — listDocuments deliberately excludes whiteboards. Returns documentId, diagramId, title and timestamps for each. projectId is required unless changedSince is given. WHAT CHANGED: give changedSince (a period such as this_week, or a date) to list only the boards added or changed in that time, newest change first, each with change: what happened, when (in words, in the person's time zone), by whom (a person's name, and the agent's key when one did it). With no project named it covers a workspace (workspaceId) or your whole organisation. Only what the caller may open is listed.
|
|
858
858
|
*/
|
|
859
859
|
post: operations["listWhiteboards"];
|
|
860
860
|
delete?: never;
|
|
@@ -1174,7 +1174,7 @@ interface paths {
|
|
|
1174
1174
|
put?: never;
|
|
1175
1175
|
/**
|
|
1176
1176
|
* listDocumentVersions
|
|
1177
|
-
* @description List version history for a document. Returns timestamps, creator, change summary, and content.
|
|
1177
|
+
* @description List version history for a document. Returns timestamps, creator, change summary, and content. HOW IT CHANGED: give changedSince (a period such as this_week, or a date) for the versions saved in that time, each with who saved it by name and when in words; add compare:true for the difference, worked out from the text: the lines added and removed between the document as it stood before that time and now, each with the heading it sits under. compare:true without changedSince sets a version (versionNumber, else the newest) against the one before it.
|
|
1178
1178
|
*/
|
|
1179
1179
|
post: operations["listDocumentVersions"];
|
|
1180
1180
|
delete?: never;
|
|
@@ -1414,7 +1414,7 @@ interface paths {
|
|
|
1414
1414
|
put?: never;
|
|
1415
1415
|
/**
|
|
1416
1416
|
* listImprovements
|
|
1417
|
-
* @description List AND grep improvements in a project. `query` searches the title, friendlyId and problem statement, not just the title (substring by default; set isRegex:true for a regular expression, caseSensitive:true for exact case). Supports filtering by status, type, priority, and by parentItemId for an item's children in the work hierarchy (an epic's stories, say). For ranked semantic + text search use searchImprovements. Every item carries its versionTimestamp, ready for updateImprovement, so one call here supplies the tokens for a whole batch of updates (fields ["id", "friendlyId", "versionTimestamp"] returns just those), and its parentItem: the item it belongs to in the work hierarchy ({ id, friendlyId, title, type, status, isTask }, or null). Each item also carries linkedRecords, the database rows it links (as getImprovement describes them); filter by them with hasLinkedRecords, linkedRecordIds and linkedTableIds.
|
|
1417
|
+
* @description List AND grep improvements in a project. `query` searches the title, friendlyId and problem statement, not just the title (substring by default; set isRegex:true for a regular expression, caseSensitive:true for exact case). Supports filtering by status, type, priority, and by parentItemId for an item's children in the work hierarchy (an epic's stories, say). For ranked semantic + text search use searchImprovements. Every item carries its versionTimestamp, ready for updateImprovement, so one call here supplies the tokens for a whole batch of updates (fields ["id", "friendlyId", "versionTimestamp"] returns just those), and its parentItem: the item it belongs to in the work hierarchy ({ id, friendlyId, title, type, status, isTask }, or null). Each item also carries linkedRecords, the database rows it links (as getImprovement describes them); filter by them with hasLinkedRecords, linkedRecordIds and linkedTableIds. projectId is required unless changedSince is given. WHAT CHANGED: give changedSince (a period such as this_week, or a date) to list only the improvements and tasks added or changed in that time, newest change first, each with change: what happened, when (in words, in the person's time zone), by whom (a person's name, and the agent's key when one did it), and what happened to each in that time in words (status and field changes, comments, evidence). With no project named it covers a workspace (workspaceId) or your whole organisation. Only what the caller may open is listed. With changedSince the filters are status, type, priority, source, categoryId and query.
|
|
1418
1418
|
*/
|
|
1419
1419
|
post: operations["listImprovements"];
|
|
1420
1420
|
delete?: never;
|
|
@@ -1718,7 +1718,7 @@ interface paths {
|
|
|
1718
1718
|
put?: never;
|
|
1719
1719
|
/**
|
|
1720
1720
|
* listPlans
|
|
1721
|
-
* @description List AND grep plans in a project. `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 and priority.
|
|
1721
|
+
* @description List AND grep plans in a project. `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 and priority. projectId is required unless changedSince is given. WHAT CHANGED: give changedSince (a period such as this_week, or a date) to list only the plans added or changed in that time, newest change first, each with change: what happened, when (in words, in the person's time zone), by whom (a person's name, and the agent's key when one did it), and what happened to each in that time in words (status and field changes, comments). With no project named it covers a workspace (workspaceId) or your whole organisation. Only what the caller may open is listed. A plan's tasks are work items: listImprovements with the same changedSince lists them.
|
|
1722
1722
|
*/
|
|
1723
1723
|
post: operations["listPlans"];
|
|
1724
1724
|
delete?: never;
|
|
@@ -6734,6 +6734,12 @@ interface operations {
|
|
|
6734
6734
|
projectId?: string;
|
|
6735
6735
|
workspaceId?: string;
|
|
6736
6736
|
folderId?: string;
|
|
6737
|
+
/** @description What changed: only what was added or edited from this point, newest change first, each with who changed it and when. A period: today, yesterday, this_week, last_week, this_month, last_month, last_7_days or last_30_days (worked out in timeZone; weeks start on Monday), or a date (YYYY-MM-DD, from its start) or a date and time. */
|
|
6738
|
+
changedSince?: string;
|
|
6739
|
+
/** @description With changedSince given as a date: only what changed before this date (YYYY-MM-DD) or date and time. */
|
|
6740
|
+
changedBefore?: string;
|
|
6741
|
+
/** @description The IANA time zone the window and its times are in, such as Australia/Sydney. Default: the person's own (the zone their browser last saved), else UTC. */
|
|
6742
|
+
timeZone?: string;
|
|
6737
6743
|
/** @description Search text. Matched against title, friendlyId AND full document content. Returns the matching lines per document (grep). Case-insensitive unless caseSensitive:true; treated as a regex if isRegex:true. */
|
|
6738
6744
|
query?: string;
|
|
6739
6745
|
/** @description Treat `query` as a JavaScript regular expression (grep -E). Default false (literal substring). Regex search requires a project/workspace/folder scope and scans a bounded window of documents. */
|
|
@@ -7872,11 +7878,55 @@ interface operations {
|
|
|
7872
7878
|
/** @description The table's id or name. */
|
|
7873
7879
|
table: string;
|
|
7874
7880
|
/** @description The same as queryDatabaseRows' summaries. */
|
|
7875
|
-
summaries?:
|
|
7881
|
+
summaries?: ({
|
|
7882
|
+
/** @enum {string} */
|
|
7883
|
+
fn?: "count" | "count_values" | "count_distinct" | "sum" | "average" | "min" | "max" | "median" | "percentile";
|
|
7884
|
+
/** @description The field's name, for every fn but count. */
|
|
7885
|
+
field?: string;
|
|
7886
|
+
/** @description Optional label for this total: letters, digits and _ (anything else becomes _). */
|
|
7887
|
+
as?: string;
|
|
7888
|
+
/** @description Such as [50, 90]. */
|
|
7889
|
+
percentiles?: number[];
|
|
7890
|
+
/** @enum {string} */
|
|
7891
|
+
show?: "running_total" | "moving_average" | "share" | "share_of_parent" | "previous" | "change" | "change_percent" | "rank";
|
|
7892
|
+
window?: number;
|
|
7893
|
+
/** @enum {string} */
|
|
7894
|
+
by?: "period" | "year" | "line";
|
|
7895
|
+
/** @description Only groups matching, such as { "at_least": 10 }. */
|
|
7896
|
+
keep?: {
|
|
7897
|
+
greater_than?: number;
|
|
7898
|
+
less_than?: number;
|
|
7899
|
+
at_least?: number;
|
|
7900
|
+
at_most?: number;
|
|
7901
|
+
};
|
|
7902
|
+
/**
|
|
7903
|
+
* @description No groupBy: also the period before.
|
|
7904
|
+
* @enum {string}
|
|
7905
|
+
*/
|
|
7906
|
+
compare?: "previous_period" | "year_before";
|
|
7907
|
+
} & {
|
|
7908
|
+
[key: string]: unknown;
|
|
7909
|
+
})[];
|
|
7876
7910
|
/** @description The same as queryDatabaseRows' groupBy. */
|
|
7877
|
-
groupBy?: (string |
|
|
7911
|
+
groupBy?: (string | {
|
|
7912
|
+
field?: string;
|
|
7913
|
+
/** @enum {string} */
|
|
7914
|
+
bucket?: "day" | "week" | "month" | "quarter" | "year" | "day_of_week" | "month_of_year" | "hour_of_day";
|
|
7915
|
+
/** @description Ranges of this size. */
|
|
7916
|
+
binSize?: number;
|
|
7917
|
+
/** @description Or N equal ranges. */
|
|
7918
|
+
bins?: number;
|
|
7919
|
+
/** @description Empty buckets too. */
|
|
7920
|
+
fill?: boolean;
|
|
7921
|
+
/** @description The N largest by the first summary (second field: per first), the rest as Other. */
|
|
7922
|
+
top?: number;
|
|
7923
|
+
/** @description Pivot columns. */
|
|
7924
|
+
across?: boolean;
|
|
7925
|
+
})[];
|
|
7878
7926
|
/** @description A filter, the same shape as queryDatabaseRows' where. */
|
|
7879
|
-
where?:
|
|
7927
|
+
where?: {
|
|
7928
|
+
[key: string]: unknown;
|
|
7929
|
+
};
|
|
7880
7930
|
/** @description Keep rows whose title or fast-search text fields contain this. */
|
|
7881
7931
|
query?: string;
|
|
7882
7932
|
/** @description Rows only: the fields to chart. Default: up to 12 short fields. */
|
|
@@ -8045,11 +8095,55 @@ interface operations {
|
|
|
8045
8095
|
/** @description The table's id or name. */
|
|
8046
8096
|
table: string;
|
|
8047
8097
|
/** @description The same as queryDatabaseRows' summaries. */
|
|
8048
|
-
summaries?:
|
|
8098
|
+
summaries?: ({
|
|
8099
|
+
/** @enum {string} */
|
|
8100
|
+
fn?: "count" | "count_values" | "count_distinct" | "sum" | "average" | "min" | "max" | "median" | "percentile";
|
|
8101
|
+
/** @description The field's name, for every fn but count. */
|
|
8102
|
+
field?: string;
|
|
8103
|
+
/** @description Optional label for this total: letters, digits and _ (anything else becomes _). */
|
|
8104
|
+
as?: string;
|
|
8105
|
+
/** @description Such as [50, 90]. */
|
|
8106
|
+
percentiles?: number[];
|
|
8107
|
+
/** @enum {string} */
|
|
8108
|
+
show?: "running_total" | "moving_average" | "share" | "share_of_parent" | "previous" | "change" | "change_percent" | "rank";
|
|
8109
|
+
window?: number;
|
|
8110
|
+
/** @enum {string} */
|
|
8111
|
+
by?: "period" | "year" | "line";
|
|
8112
|
+
/** @description Only groups matching, such as { "at_least": 10 }. */
|
|
8113
|
+
keep?: {
|
|
8114
|
+
greater_than?: number;
|
|
8115
|
+
less_than?: number;
|
|
8116
|
+
at_least?: number;
|
|
8117
|
+
at_most?: number;
|
|
8118
|
+
};
|
|
8119
|
+
/**
|
|
8120
|
+
* @description No groupBy: also the period before.
|
|
8121
|
+
* @enum {string}
|
|
8122
|
+
*/
|
|
8123
|
+
compare?: "previous_period" | "year_before";
|
|
8124
|
+
} & {
|
|
8125
|
+
[key: string]: unknown;
|
|
8126
|
+
})[];
|
|
8049
8127
|
/** @description The same as queryDatabaseRows' groupBy. */
|
|
8050
|
-
groupBy?: (string |
|
|
8128
|
+
groupBy?: (string | {
|
|
8129
|
+
field?: string;
|
|
8130
|
+
/** @enum {string} */
|
|
8131
|
+
bucket?: "day" | "week" | "month" | "quarter" | "year" | "day_of_week" | "month_of_year" | "hour_of_day";
|
|
8132
|
+
/** @description Ranges of this size. */
|
|
8133
|
+
binSize?: number;
|
|
8134
|
+
/** @description Or N equal ranges. */
|
|
8135
|
+
bins?: number;
|
|
8136
|
+
/** @description Empty buckets too. */
|
|
8137
|
+
fill?: boolean;
|
|
8138
|
+
/** @description The N largest by the first summary (second field: per first), the rest as Other. */
|
|
8139
|
+
top?: number;
|
|
8140
|
+
/** @description Pivot columns. */
|
|
8141
|
+
across?: boolean;
|
|
8142
|
+
})[];
|
|
8051
8143
|
/** @description A filter, the same shape as queryDatabaseRows' where. */
|
|
8052
|
-
where?:
|
|
8144
|
+
where?: {
|
|
8145
|
+
[key: string]: unknown;
|
|
8146
|
+
};
|
|
8053
8147
|
/** @description Keep rows whose title or fast-search text fields contain this. */
|
|
8054
8148
|
query?: string;
|
|
8055
8149
|
/** @description Rows only: the fields to chart. Default: up to 12 short fields. */
|
|
@@ -10059,13 +10153,25 @@ interface operations {
|
|
|
10059
10153
|
requestBody?: {
|
|
10060
10154
|
content: {
|
|
10061
10155
|
"application/json": {
|
|
10062
|
-
projectId
|
|
10156
|
+
projectId?: string;
|
|
10157
|
+
/** @description With changedSince and no projectId: only what changed in this workspace. Neither: your whole organisation. */
|
|
10158
|
+
workspaceId?: string;
|
|
10063
10159
|
/** @description Grep across title and friendlyId. Substring by default; a regular expression when isRegex is true. */
|
|
10064
10160
|
query?: string;
|
|
10065
10161
|
/** @description Treat `query` as a regular expression. */
|
|
10066
10162
|
isRegex?: boolean;
|
|
10067
10163
|
/** @description Match case exactly. Default false. */
|
|
10068
10164
|
caseSensitive?: boolean;
|
|
10165
|
+
/** @description What changed: only what was added or edited from this point, newest change first, each with who changed it and when. A period: today, yesterday, this_week, last_week, this_month, last_month, last_7_days or last_30_days (worked out in timeZone; weeks start on Monday), or a date (YYYY-MM-DD, from its start) or a date and time. */
|
|
10166
|
+
changedSince?: string;
|
|
10167
|
+
/** @description With changedSince given as a date: only what changed before this date (YYYY-MM-DD) or date and time. */
|
|
10168
|
+
changedBefore?: string;
|
|
10169
|
+
/** @description The IANA time zone the window and its times are in, such as Australia/Sydney. Default: the person's own (the zone their browser last saved), else UTC. */
|
|
10170
|
+
timeZone?: string;
|
|
10171
|
+
/** @description With changedSince: boards per answer (default 30, at most 100). */
|
|
10172
|
+
limit?: number;
|
|
10173
|
+
/** @description With changedSince: how many to skip (nextOffset from the last answer). */
|
|
10174
|
+
offset?: number;
|
|
10069
10175
|
};
|
|
10070
10176
|
};
|
|
10071
10177
|
};
|
|
@@ -10314,7 +10420,16 @@ interface operations {
|
|
|
10314
10420
|
projectId?: string;
|
|
10315
10421
|
documentId: string;
|
|
10316
10422
|
/** @description Elements to write. For mode 'patch', each may be a partial { id, ...changedFields } merged into the matching element by id; full Excalidraw elements for 'replace'/'append' (or new ids in 'patch'). */
|
|
10317
|
-
elements?:
|
|
10423
|
+
elements?: ({
|
|
10424
|
+
id?: string;
|
|
10425
|
+
type?: string;
|
|
10426
|
+
x?: number;
|
|
10427
|
+
y?: number;
|
|
10428
|
+
width?: number;
|
|
10429
|
+
height?: number;
|
|
10430
|
+
} & {
|
|
10431
|
+
[key: string]: unknown;
|
|
10432
|
+
})[];
|
|
10318
10433
|
/**
|
|
10319
10434
|
* @description How to apply your `elements`. patch (DEFAULT — use this for ANY partial edit): merges each item into the element with the same id and leaves everything else untouched, like find-and-replace by id; new ids are added. append: only adds your items, changes nothing else. replace: OVERWRITES THE WHOLE CANVAS — every existing element you don't resend is DELETED — so use it ONLY to set an entire board at once. To change or rebuild just a SECTION, use patch (+ deleteIds to remove specific ids), NEVER replace. A replace that would drop any existing element is rejected unless confirmReplace:true.
|
|
10320
10435
|
* @enum {string}
|
|
@@ -10323,9 +10438,22 @@ interface operations {
|
|
|
10323
10438
|
/** @description Element ids to remove from the scene. */
|
|
10324
10439
|
deleteIds?: string[];
|
|
10325
10440
|
/** @description Optional Excalidraw appState fields to merge (e.g. viewBackgroundColor). */
|
|
10326
|
-
appState?:
|
|
10441
|
+
appState?: {
|
|
10442
|
+
viewBackgroundColor?: string;
|
|
10443
|
+
} & {
|
|
10444
|
+
[key: string]: unknown;
|
|
10445
|
+
};
|
|
10327
10446
|
/** @description Optional Excalidraw BinaryFiles map (for embedded images), merged in. */
|
|
10328
|
-
files?:
|
|
10447
|
+
files?: {
|
|
10448
|
+
[key: string]: {
|
|
10449
|
+
id?: string;
|
|
10450
|
+
mimeType?: string;
|
|
10451
|
+
dataURL?: string;
|
|
10452
|
+
created?: number;
|
|
10453
|
+
} & {
|
|
10454
|
+
[key: string]: unknown;
|
|
10455
|
+
};
|
|
10456
|
+
};
|
|
10329
10457
|
/** @description Optional optimistic-locking token from getWhiteboard. Only used for mode 'replace': if the board changed since you read it, the replace is rejected so you don't overwrite a collaborator's newer edits — re-read with getWhiteboard and retry. Not needed for patch/append, which automatically merge onto the latest scene. */
|
|
10330
10458
|
versionTimestamp?: number;
|
|
10331
10459
|
/** @description Safety acknowledgement for mode 'replace' ONLY. A replace that would DELETE ANY existing element not present in your `elements` is rejected unless this is true. Leave it unset and use mode:'patch' to edit part of a board (it merges by id and keeps the rest); set true only when you truly intend to overwrite the WHOLE scene. */
|
|
@@ -10510,9 +10638,17 @@ interface operations {
|
|
|
10510
10638
|
/** @description Fill colour: a name ('blue'/'green'/'yellow'/'pink'/'violet'/'orange'/'teal'/…) or a hex value. */
|
|
10511
10639
|
backgroundColor?: string;
|
|
10512
10640
|
/** @description For arrows/lines: { id } of the source shape (auto-clips to the edge + auto-routes around shapes in between). */
|
|
10513
|
-
start?:
|
|
10641
|
+
start?: {
|
|
10642
|
+
id?: string;
|
|
10643
|
+
} & {
|
|
10644
|
+
[key: string]: unknown;
|
|
10645
|
+
};
|
|
10514
10646
|
/** @description For arrows/lines: { id } of the target shape. */
|
|
10515
|
-
end?:
|
|
10647
|
+
end?: {
|
|
10648
|
+
id?: string;
|
|
10649
|
+
} & {
|
|
10650
|
+
[key: string]: unknown;
|
|
10651
|
+
};
|
|
10516
10652
|
/** @description For type:'chart' — the chart's title, drawn at the top of the chart. */
|
|
10517
10653
|
title?: string;
|
|
10518
10654
|
/**
|
|
@@ -10531,7 +10667,14 @@ interface operations {
|
|
|
10531
10667
|
[key: string]: unknown;
|
|
10532
10668
|
};
|
|
10533
10669
|
/** @description For type:'table' — column headers: string[] (e.g. ['Task','Owner','Status']) or [{ header:string, width?:number, align?:'left'|'center'|'right' }]. */
|
|
10534
|
-
columns?: (string |
|
|
10670
|
+
columns?: (string | ({
|
|
10671
|
+
header?: string;
|
|
10672
|
+
width?: number;
|
|
10673
|
+
/** @enum {string} */
|
|
10674
|
+
align?: "left" | "center" | "right";
|
|
10675
|
+
} & {
|
|
10676
|
+
[key: string]: unknown;
|
|
10677
|
+
}))[];
|
|
10535
10678
|
/** @description For type:'table' — data rows; each row is an array of cell values (string|number) aligned to columns, e.g. [['T-1','Sam','Done'],['T-2','Lee','WIP']]. */
|
|
10536
10679
|
rows?: (string | number)[][];
|
|
10537
10680
|
/** @description Arbitrary Excalidraw customData stored on the element (e.g. a slide frame's { deckId } so a board frame resolves back to its source deck). Merged with any builder-set customData. */
|
|
@@ -11245,7 +11388,9 @@ interface operations {
|
|
|
11245
11388
|
/** @description Rows as arrays of cell strings. If headers is omitted, the first row is treated as the header row. */
|
|
11246
11389
|
rows?: string[][];
|
|
11247
11390
|
/** @description Alternative to rows: an array of objects; columns come from headers, or the first object's keys. */
|
|
11248
|
-
data?:
|
|
11391
|
+
data?: {
|
|
11392
|
+
[key: string]: unknown;
|
|
11393
|
+
}[];
|
|
11249
11394
|
/** @description Optional column headers (rendered as a styled header row). For data, also selects and orders the columns. */
|
|
11250
11395
|
headers?: string[];
|
|
11251
11396
|
/** @description Cell width in px, 60-400 (default 160). */
|
|
@@ -11796,11 +11941,55 @@ interface operations {
|
|
|
11796
11941
|
/** @description The table's id or name. */
|
|
11797
11942
|
table: string;
|
|
11798
11943
|
/** @description The same as queryDatabaseRows' summaries. */
|
|
11799
|
-
summaries?:
|
|
11944
|
+
summaries?: ({
|
|
11945
|
+
/** @enum {string} */
|
|
11946
|
+
fn?: "count" | "count_values" | "count_distinct" | "sum" | "average" | "min" | "max" | "median" | "percentile";
|
|
11947
|
+
/** @description The field's name, for every fn but count. */
|
|
11948
|
+
field?: string;
|
|
11949
|
+
/** @description Optional label for this total: letters, digits and _ (anything else becomes _). */
|
|
11950
|
+
as?: string;
|
|
11951
|
+
/** @description Such as [50, 90]. */
|
|
11952
|
+
percentiles?: number[];
|
|
11953
|
+
/** @enum {string} */
|
|
11954
|
+
show?: "running_total" | "moving_average" | "share" | "share_of_parent" | "previous" | "change" | "change_percent" | "rank";
|
|
11955
|
+
window?: number;
|
|
11956
|
+
/** @enum {string} */
|
|
11957
|
+
by?: "period" | "year" | "line";
|
|
11958
|
+
/** @description Only groups matching, such as { "at_least": 10 }. */
|
|
11959
|
+
keep?: {
|
|
11960
|
+
greater_than?: number;
|
|
11961
|
+
less_than?: number;
|
|
11962
|
+
at_least?: number;
|
|
11963
|
+
at_most?: number;
|
|
11964
|
+
};
|
|
11965
|
+
/**
|
|
11966
|
+
* @description No groupBy: also the period before.
|
|
11967
|
+
* @enum {string}
|
|
11968
|
+
*/
|
|
11969
|
+
compare?: "previous_period" | "year_before";
|
|
11970
|
+
} & {
|
|
11971
|
+
[key: string]: unknown;
|
|
11972
|
+
})[];
|
|
11800
11973
|
/** @description The same as queryDatabaseRows' groupBy. */
|
|
11801
|
-
groupBy?: (string |
|
|
11974
|
+
groupBy?: (string | {
|
|
11975
|
+
field?: string;
|
|
11976
|
+
/** @enum {string} */
|
|
11977
|
+
bucket?: "day" | "week" | "month" | "quarter" | "year" | "day_of_week" | "month_of_year" | "hour_of_day";
|
|
11978
|
+
/** @description Ranges of this size. */
|
|
11979
|
+
binSize?: number;
|
|
11980
|
+
/** @description Or N equal ranges. */
|
|
11981
|
+
bins?: number;
|
|
11982
|
+
/** @description Empty buckets too. */
|
|
11983
|
+
fill?: boolean;
|
|
11984
|
+
/** @description The N largest by the first summary (second field: per first), the rest as Other. */
|
|
11985
|
+
top?: number;
|
|
11986
|
+
/** @description Pivot columns. */
|
|
11987
|
+
across?: boolean;
|
|
11988
|
+
})[];
|
|
11802
11989
|
/** @description A filter, the same shape as queryDatabaseRows' where. */
|
|
11803
|
-
where?:
|
|
11990
|
+
where?: {
|
|
11991
|
+
[key: string]: unknown;
|
|
11992
|
+
};
|
|
11804
11993
|
/** @description Keep rows whose title or fast-search text fields contain this. */
|
|
11805
11994
|
query?: string;
|
|
11806
11995
|
/** @description Rows only: the fields to chart. Default: up to 12 short fields. */
|
|
@@ -12328,6 +12517,14 @@ interface operations {
|
|
|
12328
12517
|
requestBody?: {
|
|
12329
12518
|
content: {
|
|
12330
12519
|
"application/json": {
|
|
12520
|
+
/** @description What changed: only what was added or edited from this point, newest change first, each with who changed it and when. A period: today, yesterday, this_week, last_week, this_month, last_month, last_7_days or last_30_days (worked out in timeZone; weeks start on Monday), or a date (YYYY-MM-DD, from its start) or a date and time. */
|
|
12521
|
+
changedSince?: string;
|
|
12522
|
+
/** @description With changedSince given as a date: only what changed before this date (YYYY-MM-DD) or date and time. */
|
|
12523
|
+
changedBefore?: string;
|
|
12524
|
+
/** @description The IANA time zone the window and its times are in, such as Australia/Sydney. Default: the person's own (the zone their browser last saved), else UTC. */
|
|
12525
|
+
timeZone?: string;
|
|
12526
|
+
/** @description Also return the difference: the lines added and removed, each with the heading it sits under. */
|
|
12527
|
+
compare?: boolean;
|
|
12331
12528
|
/** @description Optional. Narrows a friendly-id lookup to one project. Only needed when a friendly id is ambiguous — TAS-/IMP-/PLN- ids are numbered per PROJECT, so the same id can exist in several. Ignored when the id is a UUID. */
|
|
12332
12529
|
projectId?: string;
|
|
12333
12530
|
/** @description Accepts either the UUID or the friendly id (e.g. DOC-815); friendly ids are resolved within your organisation. */
|
|
@@ -13885,7 +14082,15 @@ interface operations {
|
|
|
13885
14082
|
requestBody?: {
|
|
13886
14083
|
content: {
|
|
13887
14084
|
"application/json": {
|
|
13888
|
-
projectId
|
|
14085
|
+
projectId?: string;
|
|
14086
|
+
/** @description With changedSince and no projectId: only what changed in this workspace. Neither: your whole organisation. */
|
|
14087
|
+
workspaceId?: string;
|
|
14088
|
+
/** @description What changed: only what was added or edited from this point, newest change first, each with who changed it and when. A period: today, yesterday, this_week, last_week, this_month, last_month, last_7_days or last_30_days (worked out in timeZone; weeks start on Monday), or a date (YYYY-MM-DD, from its start) or a date and time. */
|
|
14089
|
+
changedSince?: string;
|
|
14090
|
+
/** @description With changedSince given as a date: only what changed before this date (YYYY-MM-DD) or date and time. */
|
|
14091
|
+
changedBefore?: string;
|
|
14092
|
+
/** @description The IANA time zone the window and its times are in, such as Australia/Sydney. Default: the person's own (the zone their browser last saved), else UTC. */
|
|
14093
|
+
timeZone?: string;
|
|
13889
14094
|
/** @description Only the children of this item in the work hierarchy (its UUID or friendly id, such as IMP-12), whatever plan or phase they are in. "none" lists only the items with no parent. The work hierarchy is not the plan outline nesting (setPlanItemParent). */
|
|
13890
14095
|
parentItemId?: string;
|
|
13891
14096
|
/** @description true: only items that link at least one database record; false: only items that link none. */
|
|
@@ -13926,7 +14131,7 @@ interface operations {
|
|
|
13926
14131
|
limit?: number;
|
|
13927
14132
|
/** @description Pagination offset. */
|
|
13928
14133
|
offset?: number;
|
|
13929
|
-
/** @description Field projection. Valid fields: id, friendly_id, friendlyId, title, type, status, priority, source, category_id, categoryId, parent_item_id, parentItemId, parentItem, linkedRecords, created_at, createdAt, updated_at, updatedAt, versionTimestamp, href. */
|
|
14134
|
+
/** @description Field projection. Valid fields: id, friendly_id, friendlyId, title, type, status, priority, source, category_id, categoryId, parent_item_id, parentItemId, parentItem, linkedRecords, created_at, createdAt, updated_at, updatedAt, versionTimestamp, href. With changedSince: id, friendlyId, title, type, status, priority, isTask, projectId, project, createdAt, updatedAt, versionTimestamp, href, change. */
|
|
13930
14135
|
fields?: string[];
|
|
13931
14136
|
};
|
|
13932
14137
|
};
|
|
@@ -14298,11 +14503,21 @@ interface operations {
|
|
|
14298
14503
|
constraints?: string[];
|
|
14299
14504
|
non_goals?: string[];
|
|
14300
14505
|
/** @description Array of {id, title}. */
|
|
14301
|
-
impacted_documents?:
|
|
14506
|
+
impacted_documents?: ({
|
|
14507
|
+
id?: string;
|
|
14508
|
+
title?: string;
|
|
14509
|
+
} & {
|
|
14510
|
+
[key: string]: unknown;
|
|
14511
|
+
})[];
|
|
14302
14512
|
/** @description Document IDs to link. Titles resolved automatically. */
|
|
14303
14513
|
linked_document_ids?: string[];
|
|
14304
14514
|
/** @description Array of {id, name}. */
|
|
14305
|
-
impacted_diagrams?:
|
|
14515
|
+
impacted_diagrams?: ({
|
|
14516
|
+
id?: string;
|
|
14517
|
+
name?: string;
|
|
14518
|
+
} & {
|
|
14519
|
+
[key: string]: unknown;
|
|
14520
|
+
})[];
|
|
14306
14521
|
impacted_components?: string[];
|
|
14307
14522
|
agent_ready?: boolean;
|
|
14308
14523
|
agent_missing_info?: string[];
|
|
@@ -14336,9 +14551,19 @@ interface operations {
|
|
|
14336
14551
|
source_channel?: string;
|
|
14337
14552
|
impacted_repositories?: string[];
|
|
14338
14553
|
/** @description Free-form JSON for logical links: blocks, blocked_by, duplicates, supersedes, relates_to (arrays of item IDs). */
|
|
14339
|
-
relationships?:
|
|
14554
|
+
relationships?: {
|
|
14555
|
+
blocks?: string[];
|
|
14556
|
+
blocked_by?: string[];
|
|
14557
|
+
duplicates?: string[];
|
|
14558
|
+
supersedes?: string[];
|
|
14559
|
+
relates_to?: string[];
|
|
14560
|
+
} & {
|
|
14561
|
+
[key: string]: unknown;
|
|
14562
|
+
};
|
|
14340
14563
|
/** @description Free-form JSON stored alongside the item. On updateImprovement this MERGES rather than replaces. */
|
|
14341
|
-
metadata?:
|
|
14564
|
+
metadata?: {
|
|
14565
|
+
[key: string]: unknown;
|
|
14566
|
+
};
|
|
14342
14567
|
/** @description Optional. Answer with only these fields instead of the whole improvement, for example ["id", "versionTimestamp"]. Any of the improvement's own fields (snake_case or camelCase) or of the keys around it in the full answer (versionTimestamp, href and, where present, url, title, trackingId, message). The id is always returned, and so is any notice that needs your attention (a note, such as a phase's dates following its tasks or an item's id changing with its type, and a date change's cascadePreview). Unknown names are ignored. */
|
|
14343
14568
|
fields?: string[];
|
|
14344
14569
|
};
|
|
@@ -14611,10 +14836,20 @@ interface operations {
|
|
|
14611
14836
|
}[];
|
|
14612
14837
|
constraints?: string[];
|
|
14613
14838
|
non_goals?: string[];
|
|
14614
|
-
impacted_documents?:
|
|
14839
|
+
impacted_documents?: ({
|
|
14840
|
+
id?: string;
|
|
14841
|
+
title?: string;
|
|
14842
|
+
} & {
|
|
14843
|
+
[key: string]: unknown;
|
|
14844
|
+
})[];
|
|
14615
14845
|
/** @description Document IDs to link. */
|
|
14616
14846
|
linked_document_ids?: string[];
|
|
14617
|
-
impacted_diagrams?:
|
|
14847
|
+
impacted_diagrams?: ({
|
|
14848
|
+
id?: string;
|
|
14849
|
+
name?: string;
|
|
14850
|
+
} & {
|
|
14851
|
+
[key: string]: unknown;
|
|
14852
|
+
})[];
|
|
14618
14853
|
impacted_components?: string[];
|
|
14619
14854
|
impacted_repositories?: string[];
|
|
14620
14855
|
agent_ready?: boolean;
|
|
@@ -14636,9 +14871,19 @@ interface operations {
|
|
|
14636
14871
|
/** @description Required when moving OUT of a closed status. The closed set is blocked, done, rejected and deferred — note that `blocked` counts as closed, so blocked -> in_progress needs this comment. */
|
|
14637
14872
|
reopened_comment?: string;
|
|
14638
14873
|
/** @description Free-form JSON for logical links: blocks, blocked_by, duplicates, supersedes, relates_to (arrays of item IDs). REPLACES the stored object wholesale — read it first and send the complete set. */
|
|
14639
|
-
relationships?:
|
|
14874
|
+
relationships?: {
|
|
14875
|
+
blocks?: string[];
|
|
14876
|
+
blocked_by?: string[];
|
|
14877
|
+
duplicates?: string[];
|
|
14878
|
+
supersedes?: string[];
|
|
14879
|
+
relates_to?: string[];
|
|
14880
|
+
} & {
|
|
14881
|
+
[key: string]: unknown;
|
|
14882
|
+
};
|
|
14640
14883
|
/** @description Free-form JSON. MERGES into the stored object key by key: keys you don't send are left alone, and sending a key with value null deletes it. Send metadata_replace:true to overwrite the whole object instead. (Merging is the default so a partial write can never destroy a sibling key written by another actor.) */
|
|
14641
|
-
metadata?:
|
|
14884
|
+
metadata?: {
|
|
14885
|
+
[key: string]: unknown;
|
|
14886
|
+
};
|
|
14642
14887
|
/** @description Opt out of the metadata merge: true means the object you send REPLACES everything stored, deleting any key you omit. Default false. */
|
|
14643
14888
|
metadata_replace?: boolean;
|
|
14644
14889
|
/** @description Link to plan. Null to unlink. */
|
|
@@ -14739,9 +14984,19 @@ interface operations {
|
|
|
14739
14984
|
}[];
|
|
14740
14985
|
constraints?: string[];
|
|
14741
14986
|
non_goals?: string[];
|
|
14742
|
-
impacted_documents?:
|
|
14987
|
+
impacted_documents?: ({
|
|
14988
|
+
id?: string;
|
|
14989
|
+
title?: string;
|
|
14990
|
+
} & {
|
|
14991
|
+
[key: string]: unknown;
|
|
14992
|
+
})[];
|
|
14743
14993
|
linked_document_ids?: string[];
|
|
14744
|
-
impacted_diagrams?:
|
|
14994
|
+
impacted_diagrams?: ({
|
|
14995
|
+
id?: string;
|
|
14996
|
+
name?: string;
|
|
14997
|
+
} & {
|
|
14998
|
+
[key: string]: unknown;
|
|
14999
|
+
})[];
|
|
14745
15000
|
impacted_components?: string[];
|
|
14746
15001
|
impacted_repositories?: string[];
|
|
14747
15002
|
agent_ready?: boolean;
|
|
@@ -14758,8 +15013,18 @@ interface operations {
|
|
|
14758
15013
|
rejection_comment?: string;
|
|
14759
15014
|
completion_comment?: string;
|
|
14760
15015
|
reopened_comment?: string;
|
|
14761
|
-
relationships?:
|
|
14762
|
-
|
|
15016
|
+
relationships?: {
|
|
15017
|
+
blocks?: string[];
|
|
15018
|
+
blocked_by?: string[];
|
|
15019
|
+
duplicates?: string[];
|
|
15020
|
+
supersedes?: string[];
|
|
15021
|
+
relates_to?: string[];
|
|
15022
|
+
} & {
|
|
15023
|
+
[key: string]: unknown;
|
|
15024
|
+
};
|
|
15025
|
+
metadata?: {
|
|
15026
|
+
[key: string]: unknown;
|
|
15027
|
+
};
|
|
14763
15028
|
metadata_replace?: boolean;
|
|
14764
15029
|
plan_id?: string;
|
|
14765
15030
|
phase_id?: string;
|
|
@@ -15779,7 +16044,9 @@ interface operations {
|
|
|
15779
16044
|
/** @description For field_change: new value. */
|
|
15780
16045
|
newValue?: string;
|
|
15781
16046
|
/** @description Additional context. */
|
|
15782
|
-
metadata?:
|
|
16047
|
+
metadata?: {
|
|
16048
|
+
[key: string]: unknown;
|
|
16049
|
+
};
|
|
15783
16050
|
};
|
|
15784
16051
|
};
|
|
15785
16052
|
};
|
|
@@ -16274,7 +16541,15 @@ interface operations {
|
|
|
16274
16541
|
requestBody?: {
|
|
16275
16542
|
content: {
|
|
16276
16543
|
"application/json": {
|
|
16277
|
-
projectId
|
|
16544
|
+
projectId?: string;
|
|
16545
|
+
/** @description With changedSince and no projectId: only what changed in this workspace. Neither: your whole organisation. */
|
|
16546
|
+
workspaceId?: string;
|
|
16547
|
+
/** @description What changed: only what was added or edited from this point, newest change first, each with who changed it and when. A period: today, yesterday, this_week, last_week, this_month, last_month, last_7_days or last_30_days (worked out in timeZone; weeks start on Monday), or a date (YYYY-MM-DD, from its start) or a date and time. */
|
|
16548
|
+
changedSince?: string;
|
|
16549
|
+
/** @description With changedSince given as a date: only what changed before this date (YYYY-MM-DD) or date and time. */
|
|
16550
|
+
changedBefore?: string;
|
|
16551
|
+
/** @description The IANA time zone the window and its times are in, such as Australia/Sydney. Default: the person's own (the zone their browser last saved), else UTC. */
|
|
16552
|
+
timeZone?: string;
|
|
16278
16553
|
/** @description Filter: draft, planning, active, on_hold, completed, cancelled. */
|
|
16279
16554
|
status?: string;
|
|
16280
16555
|
/** @description Filter: low, medium, high, critical. */
|
|
@@ -16293,7 +16568,7 @@ interface operations {
|
|
|
16293
16568
|
limit?: number;
|
|
16294
16569
|
/** @description Pagination offset. */
|
|
16295
16570
|
offset?: number;
|
|
16296
|
-
/** @description Field projection. Valid fields: id, friendly_id, friendlyId, title, description, status, priority, icon, color, start_date, startDate, end_date, endDate, created_at, createdAt, updated_at, updatedAt, versionTimestamp, href. */
|
|
16571
|
+
/** @description Field projection. Valid fields: id, friendly_id, friendlyId, title, description, status, priority, icon, color, start_date, startDate, end_date, endDate, created_at, createdAt, updated_at, updatedAt, versionTimestamp, href. With changedSince: id, friendlyId, title, status, priority, startDate, endDate, projectId, project, createdAt, updatedAt, versionTimestamp, href, change. */
|
|
16297
16572
|
fields?: string[];
|
|
16298
16573
|
};
|
|
16299
16574
|
};
|
|
@@ -16556,7 +16831,14 @@ interface operations {
|
|
|
16556
16831
|
/** @description YYYY-MM-DD. */
|
|
16557
16832
|
end_date?: string;
|
|
16558
16833
|
/** @description Array of {id, title}. */
|
|
16559
|
-
linked_documents?:
|
|
16834
|
+
linked_documents?: ({
|
|
16835
|
+
/** @description The document's id. */
|
|
16836
|
+
id: string;
|
|
16837
|
+
/** @description Not needed: the title is read from the document. */
|
|
16838
|
+
title?: string;
|
|
16839
|
+
} & {
|
|
16840
|
+
[key: string]: unknown;
|
|
16841
|
+
})[];
|
|
16560
16842
|
/** @description Document IDs to link. */
|
|
16561
16843
|
linked_document_ids?: string[];
|
|
16562
16844
|
/** @description Optional. Answer with only these fields instead of the whole plan, for example ["id", "versionTimestamp"]. Any of the plan's own fields (snake_case or camelCase) or of the keys around it in the full answer (versionTimestamp, href and, where present, url, title, trackingId, message). The id is always returned, and so is any notice that needs your attention (a note, such as a phase's dates following its tasks or an item's id changing with its type, and a date change's cascadePreview). Unknown names are ignored. */
|
|
@@ -16697,10 +16979,19 @@ interface operations {
|
|
|
16697
16979
|
start_date?: string;
|
|
16698
16980
|
/** @description YYYY-MM-DD. */
|
|
16699
16981
|
end_date?: string;
|
|
16700
|
-
linked_documents?:
|
|
16982
|
+
linked_documents?: ({
|
|
16983
|
+
/** @description The document's id. */
|
|
16984
|
+
id: string;
|
|
16985
|
+
/** @description Not needed: the title is read from the document. */
|
|
16986
|
+
title?: string;
|
|
16987
|
+
} & {
|
|
16988
|
+
[key: string]: unknown;
|
|
16989
|
+
})[];
|
|
16701
16990
|
/** @description Document IDs to link. */
|
|
16702
16991
|
linked_document_ids?: string[];
|
|
16703
|
-
metadata?:
|
|
16992
|
+
metadata?: {
|
|
16993
|
+
[key: string]: unknown;
|
|
16994
|
+
};
|
|
16704
16995
|
/** @description Optional. Answer with only these fields instead of the whole plan, for example ["id", "versionTimestamp"]. Any of the plan's own fields (snake_case or camelCase) or of the keys around it in the full answer (versionTimestamp, href and, where present, url, title, trackingId, message). The id is always returned, and so is any notice that needs your attention (a note, such as a phase's dates following its tasks or an item's id changing with its type, and a date change's cascadePreview). Unknown names are ignored. */
|
|
16705
16996
|
fields?: string[];
|
|
16706
16997
|
};
|
|
@@ -17765,7 +18056,9 @@ interface operations {
|
|
|
17765
18056
|
/** @description For field_change: new value. */
|
|
17766
18057
|
newValue?: string;
|
|
17767
18058
|
/** @description Additional context. */
|
|
17768
|
-
metadata?:
|
|
18059
|
+
metadata?: {
|
|
18060
|
+
[key: string]: unknown;
|
|
18061
|
+
};
|
|
17769
18062
|
};
|
|
17770
18063
|
};
|
|
17771
18064
|
};
|
|
@@ -18208,11 +18501,21 @@ interface operations {
|
|
|
18208
18501
|
constraints?: string[];
|
|
18209
18502
|
non_goals?: string[];
|
|
18210
18503
|
/** @description Array of {id, title}. */
|
|
18211
|
-
impacted_documents?:
|
|
18504
|
+
impacted_documents?: ({
|
|
18505
|
+
id?: string;
|
|
18506
|
+
title?: string;
|
|
18507
|
+
} & {
|
|
18508
|
+
[key: string]: unknown;
|
|
18509
|
+
})[];
|
|
18212
18510
|
/** @description Document IDs to link. Titles resolved automatically. */
|
|
18213
18511
|
linked_document_ids?: string[];
|
|
18214
18512
|
/** @description Array of {id, name}. */
|
|
18215
|
-
impacted_diagrams?:
|
|
18513
|
+
impacted_diagrams?: ({
|
|
18514
|
+
id?: string;
|
|
18515
|
+
name?: string;
|
|
18516
|
+
} & {
|
|
18517
|
+
[key: string]: unknown;
|
|
18518
|
+
})[];
|
|
18216
18519
|
impacted_components?: string[];
|
|
18217
18520
|
impacted_repositories?: string[];
|
|
18218
18521
|
agent_ready?: boolean;
|
|
@@ -18238,9 +18541,19 @@ interface operations {
|
|
|
18238
18541
|
/** @description Progress percentage (0-100). Null means not tracked. */
|
|
18239
18542
|
percent_complete?: number;
|
|
18240
18543
|
/** @description Free-form JSON for logical links: blocks, blocked_by, duplicates, supersedes, relates_to (arrays of item IDs). */
|
|
18241
|
-
relationships?:
|
|
18544
|
+
relationships?: {
|
|
18545
|
+
blocks?: string[];
|
|
18546
|
+
blocked_by?: string[];
|
|
18547
|
+
duplicates?: string[];
|
|
18548
|
+
supersedes?: string[];
|
|
18549
|
+
relates_to?: string[];
|
|
18550
|
+
} & {
|
|
18551
|
+
[key: string]: unknown;
|
|
18552
|
+
};
|
|
18242
18553
|
/** @description Free-form JSON stored alongside the task. On updateTask this MERGES rather than replaces. */
|
|
18243
|
-
metadata?:
|
|
18554
|
+
metadata?: {
|
|
18555
|
+
[key: string]: unknown;
|
|
18556
|
+
};
|
|
18244
18557
|
/** @description Optional. Answer with only these fields instead of the whole task, for example ["id", "versionTimestamp"]. Any of the task's own fields (snake_case or camelCase) or of the keys around it in the full answer (versionTimestamp, href and, where present, url, title, trackingId, message). The id is always returned, and so is any notice that needs your attention (a note, such as a phase's dates following its tasks or an item's id changing with its type, and a date change's cascadePreview). Unknown names are ignored. */
|
|
18245
18558
|
fields?: string[];
|
|
18246
18559
|
};
|
|
@@ -18732,10 +19045,20 @@ interface operations {
|
|
|
18732
19045
|
}[];
|
|
18733
19046
|
constraints?: string[];
|
|
18734
19047
|
non_goals?: string[];
|
|
18735
|
-
impacted_documents?:
|
|
19048
|
+
impacted_documents?: ({
|
|
19049
|
+
id?: string;
|
|
19050
|
+
title?: string;
|
|
19051
|
+
} & {
|
|
19052
|
+
[key: string]: unknown;
|
|
19053
|
+
})[];
|
|
18736
19054
|
/** @description Document IDs to link. */
|
|
18737
19055
|
linked_document_ids?: string[];
|
|
18738
|
-
impacted_diagrams?:
|
|
19056
|
+
impacted_diagrams?: ({
|
|
19057
|
+
id?: string;
|
|
19058
|
+
name?: string;
|
|
19059
|
+
} & {
|
|
19060
|
+
[key: string]: unknown;
|
|
19061
|
+
})[];
|
|
18739
19062
|
impacted_components?: string[];
|
|
18740
19063
|
impacted_repositories?: string[];
|
|
18741
19064
|
agent_ready?: boolean;
|
|
@@ -18757,9 +19080,19 @@ interface operations {
|
|
|
18757
19080
|
/** @description Required when moving OUT of a closed status. The closed set is blocked, done, rejected and deferred — note that `blocked` counts as closed, so blocked -> in_progress needs this comment. */
|
|
18758
19081
|
reopened_comment?: string;
|
|
18759
19082
|
/** @description Free-form JSON for logical links: blocks, blocked_by, duplicates, supersedes, relates_to (arrays of item IDs). REPLACES the stored object wholesale — read it first and send the complete set. */
|
|
18760
|
-
relationships?:
|
|
19083
|
+
relationships?: {
|
|
19084
|
+
blocks?: string[];
|
|
19085
|
+
blocked_by?: string[];
|
|
19086
|
+
duplicates?: string[];
|
|
19087
|
+
supersedes?: string[];
|
|
19088
|
+
relates_to?: string[];
|
|
19089
|
+
} & {
|
|
19090
|
+
[key: string]: unknown;
|
|
19091
|
+
};
|
|
18761
19092
|
/** @description Free-form JSON. MERGES into the stored object key by key: keys you don't send are left alone, and sending a key with value null deletes it. Send metadata_replace:true to overwrite the whole object instead. (Merging is the default so a partial write can never destroy a sibling key written by another actor.) */
|
|
18762
|
-
metadata?:
|
|
19093
|
+
metadata?: {
|
|
19094
|
+
[key: string]: unknown;
|
|
19095
|
+
};
|
|
18763
19096
|
/** @description Opt out of the metadata merge: true means the object you send REPLACES everything stored, deleting any key you omit. Default false. */
|
|
18764
19097
|
metadata_replace?: boolean;
|
|
18765
19098
|
/** @description Link to plan. Null to unlink. */
|
|
@@ -18829,9 +19162,19 @@ interface operations {
|
|
|
18829
19162
|
}[];
|
|
18830
19163
|
constraints?: string[];
|
|
18831
19164
|
non_goals?: string[];
|
|
18832
|
-
impacted_documents?:
|
|
19165
|
+
impacted_documents?: ({
|
|
19166
|
+
id?: string;
|
|
19167
|
+
title?: string;
|
|
19168
|
+
} & {
|
|
19169
|
+
[key: string]: unknown;
|
|
19170
|
+
})[];
|
|
18833
19171
|
linked_document_ids?: string[];
|
|
18834
|
-
impacted_diagrams?:
|
|
19172
|
+
impacted_diagrams?: ({
|
|
19173
|
+
id?: string;
|
|
19174
|
+
name?: string;
|
|
19175
|
+
} & {
|
|
19176
|
+
[key: string]: unknown;
|
|
19177
|
+
})[];
|
|
18835
19178
|
impacted_components?: string[];
|
|
18836
19179
|
impacted_repositories?: string[];
|
|
18837
19180
|
agent_ready?: boolean;
|
|
@@ -18848,8 +19191,18 @@ interface operations {
|
|
|
18848
19191
|
rejection_comment?: string;
|
|
18849
19192
|
completion_comment?: string;
|
|
18850
19193
|
reopened_comment?: string;
|
|
18851
|
-
relationships?:
|
|
18852
|
-
|
|
19194
|
+
relationships?: {
|
|
19195
|
+
blocks?: string[];
|
|
19196
|
+
blocked_by?: string[];
|
|
19197
|
+
duplicates?: string[];
|
|
19198
|
+
supersedes?: string[];
|
|
19199
|
+
relates_to?: string[];
|
|
19200
|
+
} & {
|
|
19201
|
+
[key: string]: unknown;
|
|
19202
|
+
};
|
|
19203
|
+
metadata?: {
|
|
19204
|
+
[key: string]: unknown;
|
|
19205
|
+
};
|
|
18853
19206
|
metadata_replace?: boolean;
|
|
18854
19207
|
plan_id?: string;
|
|
18855
19208
|
phase_id?: string;
|
|
@@ -30266,15 +30619,44 @@ interface operations {
|
|
|
30266
30619
|
view_name?: string;
|
|
30267
30620
|
is_default?: boolean;
|
|
30268
30621
|
/** @description Visible column ids (string[]) when an array. */
|
|
30269
|
-
visible_columns?:
|
|
30622
|
+
visible_columns?: {
|
|
30623
|
+
[key: string]: unknown;
|
|
30624
|
+
} | string[] | null;
|
|
30270
30625
|
/** @description Column widths — a { colId: px } map, or a number[] when an array. */
|
|
30271
|
-
column_widths?:
|
|
30626
|
+
column_widths?: {
|
|
30627
|
+
[key: string]: number;
|
|
30628
|
+
} | number[] | null;
|
|
30272
30629
|
/** @description Ordered column ids (string[]) when an array. */
|
|
30273
|
-
column_order?:
|
|
30630
|
+
column_order?: {
|
|
30631
|
+
[key: string]: unknown;
|
|
30632
|
+
} | string[] | null;
|
|
30274
30633
|
/** @description Sort rules — array of { id, desc } when an array. */
|
|
30275
|
-
sort_config?:
|
|
30634
|
+
sort_config?: {
|
|
30635
|
+
[key: string]: unknown;
|
|
30636
|
+
} | ({
|
|
30637
|
+
id?: string;
|
|
30638
|
+
desc?: boolean;
|
|
30639
|
+
} & {
|
|
30640
|
+
[key: string]: unknown;
|
|
30641
|
+
})[] | null;
|
|
30276
30642
|
/** @description Filter state — usually a { pageSize, tab, filters } object. */
|
|
30277
|
-
filter_config?:
|
|
30643
|
+
filter_config?: ({
|
|
30644
|
+
pageSize?: number;
|
|
30645
|
+
tab?: string;
|
|
30646
|
+
filters?: ({
|
|
30647
|
+
id?: string;
|
|
30648
|
+
value?: string;
|
|
30649
|
+
} & {
|
|
30650
|
+
[key: string]: unknown;
|
|
30651
|
+
})[];
|
|
30652
|
+
} & {
|
|
30653
|
+
[key: string]: unknown;
|
|
30654
|
+
}) | ({
|
|
30655
|
+
id?: string;
|
|
30656
|
+
value?: string;
|
|
30657
|
+
} & {
|
|
30658
|
+
[key: string]: unknown;
|
|
30659
|
+
})[] | null;
|
|
30278
30660
|
}[];
|
|
30279
30661
|
};
|
|
30280
30662
|
};
|
|
@@ -31617,8 +31999,12 @@ interface operations {
|
|
|
31617
31999
|
does_not_link_to?: (number | string)[] | string | number;
|
|
31618
32000
|
has_any_link?: boolean;
|
|
31619
32001
|
has_no_link?: boolean;
|
|
31620
|
-
and?:
|
|
31621
|
-
|
|
32002
|
+
and?: {
|
|
32003
|
+
[key: string]: unknown;
|
|
32004
|
+
}[];
|
|
32005
|
+
or?: {
|
|
32006
|
+
[key: string]: unknown;
|
|
32007
|
+
}[];
|
|
31622
32008
|
};
|
|
31623
32009
|
/** @description Find rows by text: matches the title field and the text fields with fast search on (on a small table, every short text field). Ignores case. */
|
|
31624
32010
|
query?: string;
|
|
@@ -31640,7 +32026,7 @@ interface operations {
|
|
|
31640
32026
|
/** @description Totals worked out in the database instead of rows: count (rows), count_values (filled cells of a field), count_distinct (different values), sum, average, min, max (numbers; min and max also dates). With groupBy, one line per group plus the totals. Rows you cannot see are never counted. */
|
|
31641
32027
|
summaries?: {
|
|
31642
32028
|
/** @enum {string} */
|
|
31643
|
-
fn
|
|
32029
|
+
fn?: "count" | "count_values" | "count_distinct" | "sum" | "average" | "min" | "max" | "median" | "percentile";
|
|
31644
32030
|
/** @description The field's name, for every fn but count. */
|
|
31645
32031
|
field?: string;
|
|
31646
32032
|
/** @description Optional label for this total: letters, digits and _ (anything else becomes _). */
|
|
@@ -31969,7 +32355,7 @@ interface operations {
|
|
|
31969
32355
|
fields?: {
|
|
31970
32356
|
name: string;
|
|
31971
32357
|
/** @enum {string} */
|
|
31972
|
-
type
|
|
32358
|
+
type?: "text" | "long_text" | "url" | "email" | "phone" | "number" | "currency" | "percent" | "rating" | "auto_number" | "single_choice" | "multiple_choice" | "status" | "checkbox" | "date" | "datetime" | "duration" | "person" | "team" | "relation" | "lookup" | "rollup" | "artefact_link" | "attachment" | "formula";
|
|
31973
32359
|
description?: string;
|
|
31974
32360
|
/** @description Each row's value must differ (text, link, email, phone, number, currency). */
|
|
31975
32361
|
unique?: boolean;
|
|
@@ -32005,7 +32391,7 @@ interface operations {
|
|
|
32005
32391
|
/** @description Who sees and edits which rows. open: everyone with access, every row. edit_own: everyone sees every row; people edit the rows that name them in field (a Person field). see_own: people see and edit only the rows that name them or their team in field (a Person or Team field). private: each row is seen by its creator and admins only. */
|
|
32006
32392
|
rowRule?: {
|
|
32007
32393
|
/** @enum {string} */
|
|
32008
|
-
rule
|
|
32394
|
+
rule?: "open" | "edit_own" | "see_own" | "private";
|
|
32009
32395
|
field?: string;
|
|
32010
32396
|
};
|
|
32011
32397
|
}[];
|
|
@@ -32158,7 +32544,7 @@ interface operations {
|
|
|
32158
32544
|
/** @description Who sees and edits which rows. open: everyone with access, every row. edit_own: everyone sees every row; people edit the rows that name them in field (a Person field). see_own: people see and edit only the rows that name them or their team in field (a Person or Team field). private: each row is seen by its creator and admins only. */
|
|
32159
32545
|
rowRule?: {
|
|
32160
32546
|
/** @enum {string} */
|
|
32161
|
-
rule
|
|
32547
|
+
rule?: "open" | "edit_own" | "see_own" | "private";
|
|
32162
32548
|
field?: string;
|
|
32163
32549
|
};
|
|
32164
32550
|
/** @description Number rows with this prefix (1 to 10 capital letters or digits, such as CUS gives CUS-1). null stops numbering. */
|
|
@@ -32168,7 +32554,7 @@ interface operations {
|
|
|
32168
32554
|
addFields?: {
|
|
32169
32555
|
name: string;
|
|
32170
32556
|
/** @enum {string} */
|
|
32171
|
-
type
|
|
32557
|
+
type?: "text" | "long_text" | "url" | "email" | "phone" | "number" | "currency" | "percent" | "rating" | "auto_number" | "single_choice" | "multiple_choice" | "status" | "checkbox" | "date" | "datetime" | "duration" | "person" | "team" | "relation" | "lookup" | "rollup" | "artefact_link" | "attachment" | "formula";
|
|
32172
32558
|
description?: string;
|
|
32173
32559
|
/** @description Each row's value must differ (text, link, email, phone, number, currency). */
|
|
32174
32560
|
unique?: boolean;
|
|
@@ -32256,8 +32642,10 @@ interface operations {
|
|
|
32256
32642
|
* @enum {string}
|
|
32257
32643
|
*/
|
|
32258
32644
|
viewType?: "grid" | "board" | "list" | "calendar" | "gallery";
|
|
32259
|
-
/** @description The view's saved filter
|
|
32260
|
-
filter?:
|
|
32645
|
+
/** @description The view's saved filter: queryDatabaseRows' where, never across a relation (no via). null clears it. */
|
|
32646
|
+
filter?: {
|
|
32647
|
+
[key: string]: unknown;
|
|
32648
|
+
} | null;
|
|
32261
32649
|
/** @description Up to 3 sort keys, first wins. Default: the order rows were added. */
|
|
32262
32650
|
sort?: {
|
|
32263
32651
|
/** @description The field's name. */
|
|
@@ -32284,8 +32672,10 @@ interface operations {
|
|
|
32284
32672
|
name?: string;
|
|
32285
32673
|
/** @enum {string} */
|
|
32286
32674
|
viewType?: "grid" | "board" | "list" | "calendar" | "gallery";
|
|
32287
|
-
/** @description The view's saved filter
|
|
32288
|
-
filter?:
|
|
32675
|
+
/** @description The view's saved filter: queryDatabaseRows' where, never across a relation (no via). null clears it. */
|
|
32676
|
+
filter?: {
|
|
32677
|
+
[key: string]: unknown;
|
|
32678
|
+
} | null;
|
|
32289
32679
|
/** @description Up to 3 sort keys, first wins. Default: the order rows were added. */
|
|
32290
32680
|
sort?: {
|
|
32291
32681
|
/** @description The field's name. */
|
|
@@ -32658,7 +33048,9 @@ interface operations {
|
|
|
32658
33048
|
/** @description A unique field, by name: rows without id (or copied rows) change the row with the same value, or are added. */
|
|
32659
33049
|
matchOn?: string;
|
|
32660
33050
|
/** @description Every row that matches: queryDatabaseRows' where. */
|
|
32661
|
-
where?:
|
|
33051
|
+
where?: {
|
|
33052
|
+
[key: string]: unknown;
|
|
33053
|
+
};
|
|
32662
33054
|
/** @description A saved view: its filter picks the rows too. */
|
|
32663
33055
|
view?: string;
|
|
32664
33056
|
/** @description Field name -> a value as in rows, or {"formula": "..."} for each row, such as {"Discount": {"formula": "{Discount} * 100"}}. */
|
|
@@ -32969,11 +33361,20 @@ interface operations {
|
|
|
32969
33361
|
*/
|
|
32970
33362
|
format?: "csv" | "xlsx";
|
|
32971
33363
|
/** @description Every row that matches: queryDatabaseRows' where. */
|
|
32972
|
-
where?:
|
|
33364
|
+
where?: {
|
|
33365
|
+
[key: string]: unknown;
|
|
33366
|
+
};
|
|
32973
33367
|
/** @description A saved view: its filter, sort and fields. */
|
|
32974
33368
|
view?: string;
|
|
32975
33369
|
/** @description queryDatabaseRows' sort. */
|
|
32976
|
-
sort?:
|
|
33370
|
+
sort?: ({
|
|
33371
|
+
/** @description The field's name. */
|
|
33372
|
+
field: string;
|
|
33373
|
+
/** @enum {string} */
|
|
33374
|
+
direction?: "ascending" | "descending";
|
|
33375
|
+
} & {
|
|
33376
|
+
[key: string]: unknown;
|
|
33377
|
+
})[];
|
|
32977
33378
|
/** @description Fields in order, by name. Default: every field, or the view's. */
|
|
32978
33379
|
select?: string[];
|
|
32979
33380
|
/** @description For dates, such as Australia/Sydney. Default UTC. */
|
|
@@ -33106,7 +33507,9 @@ interface operations {
|
|
|
33106
33507
|
/** @description The rows' ids. Leave out to delete every row that matches. */
|
|
33107
33508
|
rowIds?: string[];
|
|
33108
33509
|
/** @description Every row that matches: queryDatabaseRows' where. */
|
|
33109
|
-
where?:
|
|
33510
|
+
where?: {
|
|
33511
|
+
[key: string]: unknown;
|
|
33512
|
+
};
|
|
33110
33513
|
/** @description A saved view: its filter picks the rows too. */
|
|
33111
33514
|
view?: string;
|
|
33112
33515
|
/**
|