@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/src/types.generated.ts
CHANGED
|
@@ -375,7 +375,7 @@ export interface paths {
|
|
|
375
375
|
put?: never;
|
|
376
376
|
/**
|
|
377
377
|
* listDocuments
|
|
378
|
-
* @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.
|
|
378
|
+
* @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.
|
|
379
379
|
*/
|
|
380
380
|
post: operations["listDocuments"];
|
|
381
381
|
delete?: never;
|
|
@@ -855,7 +855,7 @@ export interface paths {
|
|
|
855
855
|
put?: never;
|
|
856
856
|
/**
|
|
857
857
|
* listWhiteboards
|
|
858
|
-
* @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.
|
|
858
|
+
* @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.
|
|
859
859
|
*/
|
|
860
860
|
post: operations["listWhiteboards"];
|
|
861
861
|
delete?: never;
|
|
@@ -1175,7 +1175,7 @@ export interface paths {
|
|
|
1175
1175
|
put?: never;
|
|
1176
1176
|
/**
|
|
1177
1177
|
* listDocumentVersions
|
|
1178
|
-
* @description List version history for a document. Returns timestamps, creator, change summary, and content.
|
|
1178
|
+
* @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.
|
|
1179
1179
|
*/
|
|
1180
1180
|
post: operations["listDocumentVersions"];
|
|
1181
1181
|
delete?: never;
|
|
@@ -1415,7 +1415,7 @@ export interface paths {
|
|
|
1415
1415
|
put?: never;
|
|
1416
1416
|
/**
|
|
1417
1417
|
* listImprovements
|
|
1418
|
-
* @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.
|
|
1418
|
+
* @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.
|
|
1419
1419
|
*/
|
|
1420
1420
|
post: operations["listImprovements"];
|
|
1421
1421
|
delete?: never;
|
|
@@ -1719,7 +1719,7 @@ export interface paths {
|
|
|
1719
1719
|
put?: never;
|
|
1720
1720
|
/**
|
|
1721
1721
|
* listPlans
|
|
1722
|
-
* @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.
|
|
1722
|
+
* @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.
|
|
1723
1723
|
*/
|
|
1724
1724
|
post: operations["listPlans"];
|
|
1725
1725
|
delete?: never;
|
|
@@ -6735,6 +6735,12 @@ export interface operations {
|
|
|
6735
6735
|
projectId?: string;
|
|
6736
6736
|
workspaceId?: string;
|
|
6737
6737
|
folderId?: string;
|
|
6738
|
+
/** @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. */
|
|
6739
|
+
changedSince?: string;
|
|
6740
|
+
/** @description With changedSince given as a date: only what changed before this date (YYYY-MM-DD) or date and time. */
|
|
6741
|
+
changedBefore?: string;
|
|
6742
|
+
/** @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. */
|
|
6743
|
+
timeZone?: string;
|
|
6738
6744
|
/** @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. */
|
|
6739
6745
|
query?: string;
|
|
6740
6746
|
/** @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. */
|
|
@@ -7873,11 +7879,55 @@ export interface operations {
|
|
|
7873
7879
|
/** @description The table's id or name. */
|
|
7874
7880
|
table: string;
|
|
7875
7881
|
/** @description The same as queryDatabaseRows' summaries. */
|
|
7876
|
-
summaries?:
|
|
7882
|
+
summaries?: ({
|
|
7883
|
+
/** @enum {string} */
|
|
7884
|
+
fn?: "count" | "count_values" | "count_distinct" | "sum" | "average" | "min" | "max" | "median" | "percentile";
|
|
7885
|
+
/** @description The field's name, for every fn but count. */
|
|
7886
|
+
field?: string;
|
|
7887
|
+
/** @description Optional label for this total: letters, digits and _ (anything else becomes _). */
|
|
7888
|
+
as?: string;
|
|
7889
|
+
/** @description Such as [50, 90]. */
|
|
7890
|
+
percentiles?: number[];
|
|
7891
|
+
/** @enum {string} */
|
|
7892
|
+
show?: "running_total" | "moving_average" | "share" | "share_of_parent" | "previous" | "change" | "change_percent" | "rank";
|
|
7893
|
+
window?: number;
|
|
7894
|
+
/** @enum {string} */
|
|
7895
|
+
by?: "period" | "year" | "line";
|
|
7896
|
+
/** @description Only groups matching, such as { "at_least": 10 }. */
|
|
7897
|
+
keep?: {
|
|
7898
|
+
greater_than?: number;
|
|
7899
|
+
less_than?: number;
|
|
7900
|
+
at_least?: number;
|
|
7901
|
+
at_most?: number;
|
|
7902
|
+
};
|
|
7903
|
+
/**
|
|
7904
|
+
* @description No groupBy: also the period before.
|
|
7905
|
+
* @enum {string}
|
|
7906
|
+
*/
|
|
7907
|
+
compare?: "previous_period" | "year_before";
|
|
7908
|
+
} & {
|
|
7909
|
+
[key: string]: unknown;
|
|
7910
|
+
})[];
|
|
7877
7911
|
/** @description The same as queryDatabaseRows' groupBy. */
|
|
7878
|
-
groupBy?: (string |
|
|
7912
|
+
groupBy?: (string | {
|
|
7913
|
+
field?: string;
|
|
7914
|
+
/** @enum {string} */
|
|
7915
|
+
bucket?: "day" | "week" | "month" | "quarter" | "year" | "day_of_week" | "month_of_year" | "hour_of_day";
|
|
7916
|
+
/** @description Ranges of this size. */
|
|
7917
|
+
binSize?: number;
|
|
7918
|
+
/** @description Or N equal ranges. */
|
|
7919
|
+
bins?: number;
|
|
7920
|
+
/** @description Empty buckets too. */
|
|
7921
|
+
fill?: boolean;
|
|
7922
|
+
/** @description The N largest by the first summary (second field: per first), the rest as Other. */
|
|
7923
|
+
top?: number;
|
|
7924
|
+
/** @description Pivot columns. */
|
|
7925
|
+
across?: boolean;
|
|
7926
|
+
})[];
|
|
7879
7927
|
/** @description A filter, the same shape as queryDatabaseRows' where. */
|
|
7880
|
-
where?:
|
|
7928
|
+
where?: {
|
|
7929
|
+
[key: string]: unknown;
|
|
7930
|
+
};
|
|
7881
7931
|
/** @description Keep rows whose title or fast-search text fields contain this. */
|
|
7882
7932
|
query?: string;
|
|
7883
7933
|
/** @description Rows only: the fields to chart. Default: up to 12 short fields. */
|
|
@@ -8046,11 +8096,55 @@ export interface operations {
|
|
|
8046
8096
|
/** @description The table's id or name. */
|
|
8047
8097
|
table: string;
|
|
8048
8098
|
/** @description The same as queryDatabaseRows' summaries. */
|
|
8049
|
-
summaries?:
|
|
8099
|
+
summaries?: ({
|
|
8100
|
+
/** @enum {string} */
|
|
8101
|
+
fn?: "count" | "count_values" | "count_distinct" | "sum" | "average" | "min" | "max" | "median" | "percentile";
|
|
8102
|
+
/** @description The field's name, for every fn but count. */
|
|
8103
|
+
field?: string;
|
|
8104
|
+
/** @description Optional label for this total: letters, digits and _ (anything else becomes _). */
|
|
8105
|
+
as?: string;
|
|
8106
|
+
/** @description Such as [50, 90]. */
|
|
8107
|
+
percentiles?: number[];
|
|
8108
|
+
/** @enum {string} */
|
|
8109
|
+
show?: "running_total" | "moving_average" | "share" | "share_of_parent" | "previous" | "change" | "change_percent" | "rank";
|
|
8110
|
+
window?: number;
|
|
8111
|
+
/** @enum {string} */
|
|
8112
|
+
by?: "period" | "year" | "line";
|
|
8113
|
+
/** @description Only groups matching, such as { "at_least": 10 }. */
|
|
8114
|
+
keep?: {
|
|
8115
|
+
greater_than?: number;
|
|
8116
|
+
less_than?: number;
|
|
8117
|
+
at_least?: number;
|
|
8118
|
+
at_most?: number;
|
|
8119
|
+
};
|
|
8120
|
+
/**
|
|
8121
|
+
* @description No groupBy: also the period before.
|
|
8122
|
+
* @enum {string}
|
|
8123
|
+
*/
|
|
8124
|
+
compare?: "previous_period" | "year_before";
|
|
8125
|
+
} & {
|
|
8126
|
+
[key: string]: unknown;
|
|
8127
|
+
})[];
|
|
8050
8128
|
/** @description The same as queryDatabaseRows' groupBy. */
|
|
8051
|
-
groupBy?: (string |
|
|
8129
|
+
groupBy?: (string | {
|
|
8130
|
+
field?: string;
|
|
8131
|
+
/** @enum {string} */
|
|
8132
|
+
bucket?: "day" | "week" | "month" | "quarter" | "year" | "day_of_week" | "month_of_year" | "hour_of_day";
|
|
8133
|
+
/** @description Ranges of this size. */
|
|
8134
|
+
binSize?: number;
|
|
8135
|
+
/** @description Or N equal ranges. */
|
|
8136
|
+
bins?: number;
|
|
8137
|
+
/** @description Empty buckets too. */
|
|
8138
|
+
fill?: boolean;
|
|
8139
|
+
/** @description The N largest by the first summary (second field: per first), the rest as Other. */
|
|
8140
|
+
top?: number;
|
|
8141
|
+
/** @description Pivot columns. */
|
|
8142
|
+
across?: boolean;
|
|
8143
|
+
})[];
|
|
8052
8144
|
/** @description A filter, the same shape as queryDatabaseRows' where. */
|
|
8053
|
-
where?:
|
|
8145
|
+
where?: {
|
|
8146
|
+
[key: string]: unknown;
|
|
8147
|
+
};
|
|
8054
8148
|
/** @description Keep rows whose title or fast-search text fields contain this. */
|
|
8055
8149
|
query?: string;
|
|
8056
8150
|
/** @description Rows only: the fields to chart. Default: up to 12 short fields. */
|
|
@@ -10060,13 +10154,25 @@ export interface operations {
|
|
|
10060
10154
|
requestBody?: {
|
|
10061
10155
|
content: {
|
|
10062
10156
|
"application/json": {
|
|
10063
|
-
projectId
|
|
10157
|
+
projectId?: string;
|
|
10158
|
+
/** @description With changedSince and no projectId: only what changed in this workspace. Neither: your whole organisation. */
|
|
10159
|
+
workspaceId?: string;
|
|
10064
10160
|
/** @description Grep across title and friendlyId. Substring by default; a regular expression when isRegex is true. */
|
|
10065
10161
|
query?: string;
|
|
10066
10162
|
/** @description Treat `query` as a regular expression. */
|
|
10067
10163
|
isRegex?: boolean;
|
|
10068
10164
|
/** @description Match case exactly. Default false. */
|
|
10069
10165
|
caseSensitive?: boolean;
|
|
10166
|
+
/** @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. */
|
|
10167
|
+
changedSince?: string;
|
|
10168
|
+
/** @description With changedSince given as a date: only what changed before this date (YYYY-MM-DD) or date and time. */
|
|
10169
|
+
changedBefore?: string;
|
|
10170
|
+
/** @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. */
|
|
10171
|
+
timeZone?: string;
|
|
10172
|
+
/** @description With changedSince: boards per answer (default 30, at most 100). */
|
|
10173
|
+
limit?: number;
|
|
10174
|
+
/** @description With changedSince: how many to skip (nextOffset from the last answer). */
|
|
10175
|
+
offset?: number;
|
|
10070
10176
|
};
|
|
10071
10177
|
};
|
|
10072
10178
|
};
|
|
@@ -10315,7 +10421,16 @@ export interface operations {
|
|
|
10315
10421
|
projectId?: string;
|
|
10316
10422
|
documentId: string;
|
|
10317
10423
|
/** @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'). */
|
|
10318
|
-
elements?:
|
|
10424
|
+
elements?: ({
|
|
10425
|
+
id?: string;
|
|
10426
|
+
type?: string;
|
|
10427
|
+
x?: number;
|
|
10428
|
+
y?: number;
|
|
10429
|
+
width?: number;
|
|
10430
|
+
height?: number;
|
|
10431
|
+
} & {
|
|
10432
|
+
[key: string]: unknown;
|
|
10433
|
+
})[];
|
|
10319
10434
|
/**
|
|
10320
10435
|
* @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.
|
|
10321
10436
|
* @enum {string}
|
|
@@ -10324,9 +10439,22 @@ export interface operations {
|
|
|
10324
10439
|
/** @description Element ids to remove from the scene. */
|
|
10325
10440
|
deleteIds?: string[];
|
|
10326
10441
|
/** @description Optional Excalidraw appState fields to merge (e.g. viewBackgroundColor). */
|
|
10327
|
-
appState?:
|
|
10442
|
+
appState?: {
|
|
10443
|
+
viewBackgroundColor?: string;
|
|
10444
|
+
} & {
|
|
10445
|
+
[key: string]: unknown;
|
|
10446
|
+
};
|
|
10328
10447
|
/** @description Optional Excalidraw BinaryFiles map (for embedded images), merged in. */
|
|
10329
|
-
files?:
|
|
10448
|
+
files?: {
|
|
10449
|
+
[key: string]: {
|
|
10450
|
+
id?: string;
|
|
10451
|
+
mimeType?: string;
|
|
10452
|
+
dataURL?: string;
|
|
10453
|
+
created?: number;
|
|
10454
|
+
} & {
|
|
10455
|
+
[key: string]: unknown;
|
|
10456
|
+
};
|
|
10457
|
+
};
|
|
10330
10458
|
/** @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. */
|
|
10331
10459
|
versionTimestamp?: number;
|
|
10332
10460
|
/** @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. */
|
|
@@ -10511,9 +10639,17 @@ export interface operations {
|
|
|
10511
10639
|
/** @description Fill colour: a name ('blue'/'green'/'yellow'/'pink'/'violet'/'orange'/'teal'/…) or a hex value. */
|
|
10512
10640
|
backgroundColor?: string;
|
|
10513
10641
|
/** @description For arrows/lines: { id } of the source shape (auto-clips to the edge + auto-routes around shapes in between). */
|
|
10514
|
-
start?:
|
|
10642
|
+
start?: {
|
|
10643
|
+
id?: string;
|
|
10644
|
+
} & {
|
|
10645
|
+
[key: string]: unknown;
|
|
10646
|
+
};
|
|
10515
10647
|
/** @description For arrows/lines: { id } of the target shape. */
|
|
10516
|
-
end?:
|
|
10648
|
+
end?: {
|
|
10649
|
+
id?: string;
|
|
10650
|
+
} & {
|
|
10651
|
+
[key: string]: unknown;
|
|
10652
|
+
};
|
|
10517
10653
|
/** @description For type:'chart' — the chart's title, drawn at the top of the chart. */
|
|
10518
10654
|
title?: string;
|
|
10519
10655
|
/**
|
|
@@ -10532,7 +10668,14 @@ export interface operations {
|
|
|
10532
10668
|
[key: string]: unknown;
|
|
10533
10669
|
};
|
|
10534
10670
|
/** @description For type:'table' — column headers: string[] (e.g. ['Task','Owner','Status']) or [{ header:string, width?:number, align?:'left'|'center'|'right' }]. */
|
|
10535
|
-
columns?: (string |
|
|
10671
|
+
columns?: (string | ({
|
|
10672
|
+
header?: string;
|
|
10673
|
+
width?: number;
|
|
10674
|
+
/** @enum {string} */
|
|
10675
|
+
align?: "left" | "center" | "right";
|
|
10676
|
+
} & {
|
|
10677
|
+
[key: string]: unknown;
|
|
10678
|
+
}))[];
|
|
10536
10679
|
/** @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']]. */
|
|
10537
10680
|
rows?: (string | number)[][];
|
|
10538
10681
|
/** @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. */
|
|
@@ -11246,7 +11389,9 @@ export interface operations {
|
|
|
11246
11389
|
/** @description Rows as arrays of cell strings. If headers is omitted, the first row is treated as the header row. */
|
|
11247
11390
|
rows?: string[][];
|
|
11248
11391
|
/** @description Alternative to rows: an array of objects; columns come from headers, or the first object's keys. */
|
|
11249
|
-
data?:
|
|
11392
|
+
data?: {
|
|
11393
|
+
[key: string]: unknown;
|
|
11394
|
+
}[];
|
|
11250
11395
|
/** @description Optional column headers (rendered as a styled header row). For data, also selects and orders the columns. */
|
|
11251
11396
|
headers?: string[];
|
|
11252
11397
|
/** @description Cell width in px, 60-400 (default 160). */
|
|
@@ -11797,11 +11942,55 @@ export interface operations {
|
|
|
11797
11942
|
/** @description The table's id or name. */
|
|
11798
11943
|
table: string;
|
|
11799
11944
|
/** @description The same as queryDatabaseRows' summaries. */
|
|
11800
|
-
summaries?:
|
|
11945
|
+
summaries?: ({
|
|
11946
|
+
/** @enum {string} */
|
|
11947
|
+
fn?: "count" | "count_values" | "count_distinct" | "sum" | "average" | "min" | "max" | "median" | "percentile";
|
|
11948
|
+
/** @description The field's name, for every fn but count. */
|
|
11949
|
+
field?: string;
|
|
11950
|
+
/** @description Optional label for this total: letters, digits and _ (anything else becomes _). */
|
|
11951
|
+
as?: string;
|
|
11952
|
+
/** @description Such as [50, 90]. */
|
|
11953
|
+
percentiles?: number[];
|
|
11954
|
+
/** @enum {string} */
|
|
11955
|
+
show?: "running_total" | "moving_average" | "share" | "share_of_parent" | "previous" | "change" | "change_percent" | "rank";
|
|
11956
|
+
window?: number;
|
|
11957
|
+
/** @enum {string} */
|
|
11958
|
+
by?: "period" | "year" | "line";
|
|
11959
|
+
/** @description Only groups matching, such as { "at_least": 10 }. */
|
|
11960
|
+
keep?: {
|
|
11961
|
+
greater_than?: number;
|
|
11962
|
+
less_than?: number;
|
|
11963
|
+
at_least?: number;
|
|
11964
|
+
at_most?: number;
|
|
11965
|
+
};
|
|
11966
|
+
/**
|
|
11967
|
+
* @description No groupBy: also the period before.
|
|
11968
|
+
* @enum {string}
|
|
11969
|
+
*/
|
|
11970
|
+
compare?: "previous_period" | "year_before";
|
|
11971
|
+
} & {
|
|
11972
|
+
[key: string]: unknown;
|
|
11973
|
+
})[];
|
|
11801
11974
|
/** @description The same as queryDatabaseRows' groupBy. */
|
|
11802
|
-
groupBy?: (string |
|
|
11975
|
+
groupBy?: (string | {
|
|
11976
|
+
field?: string;
|
|
11977
|
+
/** @enum {string} */
|
|
11978
|
+
bucket?: "day" | "week" | "month" | "quarter" | "year" | "day_of_week" | "month_of_year" | "hour_of_day";
|
|
11979
|
+
/** @description Ranges of this size. */
|
|
11980
|
+
binSize?: number;
|
|
11981
|
+
/** @description Or N equal ranges. */
|
|
11982
|
+
bins?: number;
|
|
11983
|
+
/** @description Empty buckets too. */
|
|
11984
|
+
fill?: boolean;
|
|
11985
|
+
/** @description The N largest by the first summary (second field: per first), the rest as Other. */
|
|
11986
|
+
top?: number;
|
|
11987
|
+
/** @description Pivot columns. */
|
|
11988
|
+
across?: boolean;
|
|
11989
|
+
})[];
|
|
11803
11990
|
/** @description A filter, the same shape as queryDatabaseRows' where. */
|
|
11804
|
-
where?:
|
|
11991
|
+
where?: {
|
|
11992
|
+
[key: string]: unknown;
|
|
11993
|
+
};
|
|
11805
11994
|
/** @description Keep rows whose title or fast-search text fields contain this. */
|
|
11806
11995
|
query?: string;
|
|
11807
11996
|
/** @description Rows only: the fields to chart. Default: up to 12 short fields. */
|
|
@@ -12329,6 +12518,14 @@ export interface operations {
|
|
|
12329
12518
|
requestBody?: {
|
|
12330
12519
|
content: {
|
|
12331
12520
|
"application/json": {
|
|
12521
|
+
/** @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. */
|
|
12522
|
+
changedSince?: string;
|
|
12523
|
+
/** @description With changedSince given as a date: only what changed before this date (YYYY-MM-DD) or date and time. */
|
|
12524
|
+
changedBefore?: string;
|
|
12525
|
+
/** @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. */
|
|
12526
|
+
timeZone?: string;
|
|
12527
|
+
/** @description Also return the difference: the lines added and removed, each with the heading it sits under. */
|
|
12528
|
+
compare?: boolean;
|
|
12332
12529
|
/** @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. */
|
|
12333
12530
|
projectId?: string;
|
|
12334
12531
|
/** @description Accepts either the UUID or the friendly id (e.g. DOC-815); friendly ids are resolved within your organisation. */
|
|
@@ -13886,7 +14083,15 @@ export interface operations {
|
|
|
13886
14083
|
requestBody?: {
|
|
13887
14084
|
content: {
|
|
13888
14085
|
"application/json": {
|
|
13889
|
-
projectId
|
|
14086
|
+
projectId?: string;
|
|
14087
|
+
/** @description With changedSince and no projectId: only what changed in this workspace. Neither: your whole organisation. */
|
|
14088
|
+
workspaceId?: string;
|
|
14089
|
+
/** @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. */
|
|
14090
|
+
changedSince?: string;
|
|
14091
|
+
/** @description With changedSince given as a date: only what changed before this date (YYYY-MM-DD) or date and time. */
|
|
14092
|
+
changedBefore?: string;
|
|
14093
|
+
/** @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. */
|
|
14094
|
+
timeZone?: string;
|
|
13890
14095
|
/** @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). */
|
|
13891
14096
|
parentItemId?: string;
|
|
13892
14097
|
/** @description true: only items that link at least one database record; false: only items that link none. */
|
|
@@ -13927,7 +14132,7 @@ export interface operations {
|
|
|
13927
14132
|
limit?: number;
|
|
13928
14133
|
/** @description Pagination offset. */
|
|
13929
14134
|
offset?: number;
|
|
13930
|
-
/** @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. */
|
|
14135
|
+
/** @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. */
|
|
13931
14136
|
fields?: string[];
|
|
13932
14137
|
};
|
|
13933
14138
|
};
|
|
@@ -14299,11 +14504,21 @@ export interface operations {
|
|
|
14299
14504
|
constraints?: string[];
|
|
14300
14505
|
non_goals?: string[];
|
|
14301
14506
|
/** @description Array of {id, title}. */
|
|
14302
|
-
impacted_documents?:
|
|
14507
|
+
impacted_documents?: ({
|
|
14508
|
+
id?: string;
|
|
14509
|
+
title?: string;
|
|
14510
|
+
} & {
|
|
14511
|
+
[key: string]: unknown;
|
|
14512
|
+
})[];
|
|
14303
14513
|
/** @description Document IDs to link. Titles resolved automatically. */
|
|
14304
14514
|
linked_document_ids?: string[];
|
|
14305
14515
|
/** @description Array of {id, name}. */
|
|
14306
|
-
impacted_diagrams?:
|
|
14516
|
+
impacted_diagrams?: ({
|
|
14517
|
+
id?: string;
|
|
14518
|
+
name?: string;
|
|
14519
|
+
} & {
|
|
14520
|
+
[key: string]: unknown;
|
|
14521
|
+
})[];
|
|
14307
14522
|
impacted_components?: string[];
|
|
14308
14523
|
agent_ready?: boolean;
|
|
14309
14524
|
agent_missing_info?: string[];
|
|
@@ -14337,9 +14552,19 @@ export interface operations {
|
|
|
14337
14552
|
source_channel?: string;
|
|
14338
14553
|
impacted_repositories?: string[];
|
|
14339
14554
|
/** @description Free-form JSON for logical links: blocks, blocked_by, duplicates, supersedes, relates_to (arrays of item IDs). */
|
|
14340
|
-
relationships?:
|
|
14555
|
+
relationships?: {
|
|
14556
|
+
blocks?: string[];
|
|
14557
|
+
blocked_by?: string[];
|
|
14558
|
+
duplicates?: string[];
|
|
14559
|
+
supersedes?: string[];
|
|
14560
|
+
relates_to?: string[];
|
|
14561
|
+
} & {
|
|
14562
|
+
[key: string]: unknown;
|
|
14563
|
+
};
|
|
14341
14564
|
/** @description Free-form JSON stored alongside the item. On updateImprovement this MERGES rather than replaces. */
|
|
14342
|
-
metadata?:
|
|
14565
|
+
metadata?: {
|
|
14566
|
+
[key: string]: unknown;
|
|
14567
|
+
};
|
|
14343
14568
|
/** @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. */
|
|
14344
14569
|
fields?: string[];
|
|
14345
14570
|
};
|
|
@@ -14612,10 +14837,20 @@ export interface operations {
|
|
|
14612
14837
|
}[];
|
|
14613
14838
|
constraints?: string[];
|
|
14614
14839
|
non_goals?: string[];
|
|
14615
|
-
impacted_documents?:
|
|
14840
|
+
impacted_documents?: ({
|
|
14841
|
+
id?: string;
|
|
14842
|
+
title?: string;
|
|
14843
|
+
} & {
|
|
14844
|
+
[key: string]: unknown;
|
|
14845
|
+
})[];
|
|
14616
14846
|
/** @description Document IDs to link. */
|
|
14617
14847
|
linked_document_ids?: string[];
|
|
14618
|
-
impacted_diagrams?:
|
|
14848
|
+
impacted_diagrams?: ({
|
|
14849
|
+
id?: string;
|
|
14850
|
+
name?: string;
|
|
14851
|
+
} & {
|
|
14852
|
+
[key: string]: unknown;
|
|
14853
|
+
})[];
|
|
14619
14854
|
impacted_components?: string[];
|
|
14620
14855
|
impacted_repositories?: string[];
|
|
14621
14856
|
agent_ready?: boolean;
|
|
@@ -14637,9 +14872,19 @@ export interface operations {
|
|
|
14637
14872
|
/** @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. */
|
|
14638
14873
|
reopened_comment?: string;
|
|
14639
14874
|
/** @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. */
|
|
14640
|
-
relationships?:
|
|
14875
|
+
relationships?: {
|
|
14876
|
+
blocks?: string[];
|
|
14877
|
+
blocked_by?: string[];
|
|
14878
|
+
duplicates?: string[];
|
|
14879
|
+
supersedes?: string[];
|
|
14880
|
+
relates_to?: string[];
|
|
14881
|
+
} & {
|
|
14882
|
+
[key: string]: unknown;
|
|
14883
|
+
};
|
|
14641
14884
|
/** @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.) */
|
|
14642
|
-
metadata?:
|
|
14885
|
+
metadata?: {
|
|
14886
|
+
[key: string]: unknown;
|
|
14887
|
+
};
|
|
14643
14888
|
/** @description Opt out of the metadata merge: true means the object you send REPLACES everything stored, deleting any key you omit. Default false. */
|
|
14644
14889
|
metadata_replace?: boolean;
|
|
14645
14890
|
/** @description Link to plan. Null to unlink. */
|
|
@@ -14740,9 +14985,19 @@ export interface operations {
|
|
|
14740
14985
|
}[];
|
|
14741
14986
|
constraints?: string[];
|
|
14742
14987
|
non_goals?: string[];
|
|
14743
|
-
impacted_documents?:
|
|
14988
|
+
impacted_documents?: ({
|
|
14989
|
+
id?: string;
|
|
14990
|
+
title?: string;
|
|
14991
|
+
} & {
|
|
14992
|
+
[key: string]: unknown;
|
|
14993
|
+
})[];
|
|
14744
14994
|
linked_document_ids?: string[];
|
|
14745
|
-
impacted_diagrams?:
|
|
14995
|
+
impacted_diagrams?: ({
|
|
14996
|
+
id?: string;
|
|
14997
|
+
name?: string;
|
|
14998
|
+
} & {
|
|
14999
|
+
[key: string]: unknown;
|
|
15000
|
+
})[];
|
|
14746
15001
|
impacted_components?: string[];
|
|
14747
15002
|
impacted_repositories?: string[];
|
|
14748
15003
|
agent_ready?: boolean;
|
|
@@ -14759,8 +15014,18 @@ export interface operations {
|
|
|
14759
15014
|
rejection_comment?: string;
|
|
14760
15015
|
completion_comment?: string;
|
|
14761
15016
|
reopened_comment?: string;
|
|
14762
|
-
relationships?:
|
|
14763
|
-
|
|
15017
|
+
relationships?: {
|
|
15018
|
+
blocks?: string[];
|
|
15019
|
+
blocked_by?: string[];
|
|
15020
|
+
duplicates?: string[];
|
|
15021
|
+
supersedes?: string[];
|
|
15022
|
+
relates_to?: string[];
|
|
15023
|
+
} & {
|
|
15024
|
+
[key: string]: unknown;
|
|
15025
|
+
};
|
|
15026
|
+
metadata?: {
|
|
15027
|
+
[key: string]: unknown;
|
|
15028
|
+
};
|
|
14764
15029
|
metadata_replace?: boolean;
|
|
14765
15030
|
plan_id?: string;
|
|
14766
15031
|
phase_id?: string;
|
|
@@ -15780,7 +16045,9 @@ export interface operations {
|
|
|
15780
16045
|
/** @description For field_change: new value. */
|
|
15781
16046
|
newValue?: string;
|
|
15782
16047
|
/** @description Additional context. */
|
|
15783
|
-
metadata?:
|
|
16048
|
+
metadata?: {
|
|
16049
|
+
[key: string]: unknown;
|
|
16050
|
+
};
|
|
15784
16051
|
};
|
|
15785
16052
|
};
|
|
15786
16053
|
};
|
|
@@ -16275,7 +16542,15 @@ export interface operations {
|
|
|
16275
16542
|
requestBody?: {
|
|
16276
16543
|
content: {
|
|
16277
16544
|
"application/json": {
|
|
16278
|
-
projectId
|
|
16545
|
+
projectId?: string;
|
|
16546
|
+
/** @description With changedSince and no projectId: only what changed in this workspace. Neither: your whole organisation. */
|
|
16547
|
+
workspaceId?: string;
|
|
16548
|
+
/** @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. */
|
|
16549
|
+
changedSince?: string;
|
|
16550
|
+
/** @description With changedSince given as a date: only what changed before this date (YYYY-MM-DD) or date and time. */
|
|
16551
|
+
changedBefore?: string;
|
|
16552
|
+
/** @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. */
|
|
16553
|
+
timeZone?: string;
|
|
16279
16554
|
/** @description Filter: draft, planning, active, on_hold, completed, cancelled. */
|
|
16280
16555
|
status?: string;
|
|
16281
16556
|
/** @description Filter: low, medium, high, critical. */
|
|
@@ -16294,7 +16569,7 @@ export interface operations {
|
|
|
16294
16569
|
limit?: number;
|
|
16295
16570
|
/** @description Pagination offset. */
|
|
16296
16571
|
offset?: number;
|
|
16297
|
-
/** @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. */
|
|
16572
|
+
/** @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. */
|
|
16298
16573
|
fields?: string[];
|
|
16299
16574
|
};
|
|
16300
16575
|
};
|
|
@@ -16557,7 +16832,14 @@ export interface operations {
|
|
|
16557
16832
|
/** @description YYYY-MM-DD. */
|
|
16558
16833
|
end_date?: string;
|
|
16559
16834
|
/** @description Array of {id, title}. */
|
|
16560
|
-
linked_documents?:
|
|
16835
|
+
linked_documents?: ({
|
|
16836
|
+
/** @description The document's id. */
|
|
16837
|
+
id: string;
|
|
16838
|
+
/** @description Not needed: the title is read from the document. */
|
|
16839
|
+
title?: string;
|
|
16840
|
+
} & {
|
|
16841
|
+
[key: string]: unknown;
|
|
16842
|
+
})[];
|
|
16561
16843
|
/** @description Document IDs to link. */
|
|
16562
16844
|
linked_document_ids?: string[];
|
|
16563
16845
|
/** @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. */
|
|
@@ -16698,10 +16980,19 @@ export interface operations {
|
|
|
16698
16980
|
start_date?: string;
|
|
16699
16981
|
/** @description YYYY-MM-DD. */
|
|
16700
16982
|
end_date?: string;
|
|
16701
|
-
linked_documents?:
|
|
16983
|
+
linked_documents?: ({
|
|
16984
|
+
/** @description The document's id. */
|
|
16985
|
+
id: string;
|
|
16986
|
+
/** @description Not needed: the title is read from the document. */
|
|
16987
|
+
title?: string;
|
|
16988
|
+
} & {
|
|
16989
|
+
[key: string]: unknown;
|
|
16990
|
+
})[];
|
|
16702
16991
|
/** @description Document IDs to link. */
|
|
16703
16992
|
linked_document_ids?: string[];
|
|
16704
|
-
metadata?:
|
|
16993
|
+
metadata?: {
|
|
16994
|
+
[key: string]: unknown;
|
|
16995
|
+
};
|
|
16705
16996
|
/** @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. */
|
|
16706
16997
|
fields?: string[];
|
|
16707
16998
|
};
|
|
@@ -17766,7 +18057,9 @@ export interface operations {
|
|
|
17766
18057
|
/** @description For field_change: new value. */
|
|
17767
18058
|
newValue?: string;
|
|
17768
18059
|
/** @description Additional context. */
|
|
17769
|
-
metadata?:
|
|
18060
|
+
metadata?: {
|
|
18061
|
+
[key: string]: unknown;
|
|
18062
|
+
};
|
|
17770
18063
|
};
|
|
17771
18064
|
};
|
|
17772
18065
|
};
|
|
@@ -18209,11 +18502,21 @@ export interface operations {
|
|
|
18209
18502
|
constraints?: string[];
|
|
18210
18503
|
non_goals?: string[];
|
|
18211
18504
|
/** @description Array of {id, title}. */
|
|
18212
|
-
impacted_documents?:
|
|
18505
|
+
impacted_documents?: ({
|
|
18506
|
+
id?: string;
|
|
18507
|
+
title?: string;
|
|
18508
|
+
} & {
|
|
18509
|
+
[key: string]: unknown;
|
|
18510
|
+
})[];
|
|
18213
18511
|
/** @description Document IDs to link. Titles resolved automatically. */
|
|
18214
18512
|
linked_document_ids?: string[];
|
|
18215
18513
|
/** @description Array of {id, name}. */
|
|
18216
|
-
impacted_diagrams?:
|
|
18514
|
+
impacted_diagrams?: ({
|
|
18515
|
+
id?: string;
|
|
18516
|
+
name?: string;
|
|
18517
|
+
} & {
|
|
18518
|
+
[key: string]: unknown;
|
|
18519
|
+
})[];
|
|
18217
18520
|
impacted_components?: string[];
|
|
18218
18521
|
impacted_repositories?: string[];
|
|
18219
18522
|
agent_ready?: boolean;
|
|
@@ -18239,9 +18542,19 @@ export interface operations {
|
|
|
18239
18542
|
/** @description Progress percentage (0-100). Null means not tracked. */
|
|
18240
18543
|
percent_complete?: number;
|
|
18241
18544
|
/** @description Free-form JSON for logical links: blocks, blocked_by, duplicates, supersedes, relates_to (arrays of item IDs). */
|
|
18242
|
-
relationships?:
|
|
18545
|
+
relationships?: {
|
|
18546
|
+
blocks?: string[];
|
|
18547
|
+
blocked_by?: string[];
|
|
18548
|
+
duplicates?: string[];
|
|
18549
|
+
supersedes?: string[];
|
|
18550
|
+
relates_to?: string[];
|
|
18551
|
+
} & {
|
|
18552
|
+
[key: string]: unknown;
|
|
18553
|
+
};
|
|
18243
18554
|
/** @description Free-form JSON stored alongside the task. On updateTask this MERGES rather than replaces. */
|
|
18244
|
-
metadata?:
|
|
18555
|
+
metadata?: {
|
|
18556
|
+
[key: string]: unknown;
|
|
18557
|
+
};
|
|
18245
18558
|
/** @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. */
|
|
18246
18559
|
fields?: string[];
|
|
18247
18560
|
};
|
|
@@ -18733,10 +19046,20 @@ export interface operations {
|
|
|
18733
19046
|
}[];
|
|
18734
19047
|
constraints?: string[];
|
|
18735
19048
|
non_goals?: string[];
|
|
18736
|
-
impacted_documents?:
|
|
19049
|
+
impacted_documents?: ({
|
|
19050
|
+
id?: string;
|
|
19051
|
+
title?: string;
|
|
19052
|
+
} & {
|
|
19053
|
+
[key: string]: unknown;
|
|
19054
|
+
})[];
|
|
18737
19055
|
/** @description Document IDs to link. */
|
|
18738
19056
|
linked_document_ids?: string[];
|
|
18739
|
-
impacted_diagrams?:
|
|
19057
|
+
impacted_diagrams?: ({
|
|
19058
|
+
id?: string;
|
|
19059
|
+
name?: string;
|
|
19060
|
+
} & {
|
|
19061
|
+
[key: string]: unknown;
|
|
19062
|
+
})[];
|
|
18740
19063
|
impacted_components?: string[];
|
|
18741
19064
|
impacted_repositories?: string[];
|
|
18742
19065
|
agent_ready?: boolean;
|
|
@@ -18758,9 +19081,19 @@ export interface operations {
|
|
|
18758
19081
|
/** @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. */
|
|
18759
19082
|
reopened_comment?: string;
|
|
18760
19083
|
/** @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. */
|
|
18761
|
-
relationships?:
|
|
19084
|
+
relationships?: {
|
|
19085
|
+
blocks?: string[];
|
|
19086
|
+
blocked_by?: string[];
|
|
19087
|
+
duplicates?: string[];
|
|
19088
|
+
supersedes?: string[];
|
|
19089
|
+
relates_to?: string[];
|
|
19090
|
+
} & {
|
|
19091
|
+
[key: string]: unknown;
|
|
19092
|
+
};
|
|
18762
19093
|
/** @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.) */
|
|
18763
|
-
metadata?:
|
|
19094
|
+
metadata?: {
|
|
19095
|
+
[key: string]: unknown;
|
|
19096
|
+
};
|
|
18764
19097
|
/** @description Opt out of the metadata merge: true means the object you send REPLACES everything stored, deleting any key you omit. Default false. */
|
|
18765
19098
|
metadata_replace?: boolean;
|
|
18766
19099
|
/** @description Link to plan. Null to unlink. */
|
|
@@ -18830,9 +19163,19 @@ export interface operations {
|
|
|
18830
19163
|
}[];
|
|
18831
19164
|
constraints?: string[];
|
|
18832
19165
|
non_goals?: string[];
|
|
18833
|
-
impacted_documents?:
|
|
19166
|
+
impacted_documents?: ({
|
|
19167
|
+
id?: string;
|
|
19168
|
+
title?: string;
|
|
19169
|
+
} & {
|
|
19170
|
+
[key: string]: unknown;
|
|
19171
|
+
})[];
|
|
18834
19172
|
linked_document_ids?: string[];
|
|
18835
|
-
impacted_diagrams?:
|
|
19173
|
+
impacted_diagrams?: ({
|
|
19174
|
+
id?: string;
|
|
19175
|
+
name?: string;
|
|
19176
|
+
} & {
|
|
19177
|
+
[key: string]: unknown;
|
|
19178
|
+
})[];
|
|
18836
19179
|
impacted_components?: string[];
|
|
18837
19180
|
impacted_repositories?: string[];
|
|
18838
19181
|
agent_ready?: boolean;
|
|
@@ -18849,8 +19192,18 @@ export interface operations {
|
|
|
18849
19192
|
rejection_comment?: string;
|
|
18850
19193
|
completion_comment?: string;
|
|
18851
19194
|
reopened_comment?: string;
|
|
18852
|
-
relationships?:
|
|
18853
|
-
|
|
19195
|
+
relationships?: {
|
|
19196
|
+
blocks?: string[];
|
|
19197
|
+
blocked_by?: string[];
|
|
19198
|
+
duplicates?: string[];
|
|
19199
|
+
supersedes?: string[];
|
|
19200
|
+
relates_to?: string[];
|
|
19201
|
+
} & {
|
|
19202
|
+
[key: string]: unknown;
|
|
19203
|
+
};
|
|
19204
|
+
metadata?: {
|
|
19205
|
+
[key: string]: unknown;
|
|
19206
|
+
};
|
|
18854
19207
|
metadata_replace?: boolean;
|
|
18855
19208
|
plan_id?: string;
|
|
18856
19209
|
phase_id?: string;
|
|
@@ -30267,15 +30620,44 @@ export interface operations {
|
|
|
30267
30620
|
view_name?: string;
|
|
30268
30621
|
is_default?: boolean;
|
|
30269
30622
|
/** @description Visible column ids (string[]) when an array. */
|
|
30270
|
-
visible_columns?:
|
|
30623
|
+
visible_columns?: {
|
|
30624
|
+
[key: string]: unknown;
|
|
30625
|
+
} | string[] | null;
|
|
30271
30626
|
/** @description Column widths — a { colId: px } map, or a number[] when an array. */
|
|
30272
|
-
column_widths?:
|
|
30627
|
+
column_widths?: {
|
|
30628
|
+
[key: string]: number;
|
|
30629
|
+
} | number[] | null;
|
|
30273
30630
|
/** @description Ordered column ids (string[]) when an array. */
|
|
30274
|
-
column_order?:
|
|
30631
|
+
column_order?: {
|
|
30632
|
+
[key: string]: unknown;
|
|
30633
|
+
} | string[] | null;
|
|
30275
30634
|
/** @description Sort rules — array of { id, desc } when an array. */
|
|
30276
|
-
sort_config?:
|
|
30635
|
+
sort_config?: {
|
|
30636
|
+
[key: string]: unknown;
|
|
30637
|
+
} | ({
|
|
30638
|
+
id?: string;
|
|
30639
|
+
desc?: boolean;
|
|
30640
|
+
} & {
|
|
30641
|
+
[key: string]: unknown;
|
|
30642
|
+
})[] | null;
|
|
30277
30643
|
/** @description Filter state — usually a { pageSize, tab, filters } object. */
|
|
30278
|
-
filter_config?:
|
|
30644
|
+
filter_config?: ({
|
|
30645
|
+
pageSize?: number;
|
|
30646
|
+
tab?: string;
|
|
30647
|
+
filters?: ({
|
|
30648
|
+
id?: string;
|
|
30649
|
+
value?: string;
|
|
30650
|
+
} & {
|
|
30651
|
+
[key: string]: unknown;
|
|
30652
|
+
})[];
|
|
30653
|
+
} & {
|
|
30654
|
+
[key: string]: unknown;
|
|
30655
|
+
}) | ({
|
|
30656
|
+
id?: string;
|
|
30657
|
+
value?: string;
|
|
30658
|
+
} & {
|
|
30659
|
+
[key: string]: unknown;
|
|
30660
|
+
})[] | null;
|
|
30279
30661
|
}[];
|
|
30280
30662
|
};
|
|
30281
30663
|
};
|
|
@@ -31618,8 +32000,12 @@ export interface operations {
|
|
|
31618
32000
|
does_not_link_to?: (number | string)[] | string | number;
|
|
31619
32001
|
has_any_link?: boolean;
|
|
31620
32002
|
has_no_link?: boolean;
|
|
31621
|
-
and?:
|
|
31622
|
-
|
|
32003
|
+
and?: {
|
|
32004
|
+
[key: string]: unknown;
|
|
32005
|
+
}[];
|
|
32006
|
+
or?: {
|
|
32007
|
+
[key: string]: unknown;
|
|
32008
|
+
}[];
|
|
31623
32009
|
};
|
|
31624
32010
|
/** @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. */
|
|
31625
32011
|
query?: string;
|
|
@@ -31641,7 +32027,7 @@ export interface operations {
|
|
|
31641
32027
|
/** @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. */
|
|
31642
32028
|
summaries?: {
|
|
31643
32029
|
/** @enum {string} */
|
|
31644
|
-
fn
|
|
32030
|
+
fn?: "count" | "count_values" | "count_distinct" | "sum" | "average" | "min" | "max" | "median" | "percentile";
|
|
31645
32031
|
/** @description The field's name, for every fn but count. */
|
|
31646
32032
|
field?: string;
|
|
31647
32033
|
/** @description Optional label for this total: letters, digits and _ (anything else becomes _). */
|
|
@@ -31970,7 +32356,7 @@ export interface operations {
|
|
|
31970
32356
|
fields?: {
|
|
31971
32357
|
name: string;
|
|
31972
32358
|
/** @enum {string} */
|
|
31973
|
-
type
|
|
32359
|
+
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";
|
|
31974
32360
|
description?: string;
|
|
31975
32361
|
/** @description Each row's value must differ (text, link, email, phone, number, currency). */
|
|
31976
32362
|
unique?: boolean;
|
|
@@ -32006,7 +32392,7 @@ export interface operations {
|
|
|
32006
32392
|
/** @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. */
|
|
32007
32393
|
rowRule?: {
|
|
32008
32394
|
/** @enum {string} */
|
|
32009
|
-
rule
|
|
32395
|
+
rule?: "open" | "edit_own" | "see_own" | "private";
|
|
32010
32396
|
field?: string;
|
|
32011
32397
|
};
|
|
32012
32398
|
}[];
|
|
@@ -32159,7 +32545,7 @@ export interface operations {
|
|
|
32159
32545
|
/** @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. */
|
|
32160
32546
|
rowRule?: {
|
|
32161
32547
|
/** @enum {string} */
|
|
32162
|
-
rule
|
|
32548
|
+
rule?: "open" | "edit_own" | "see_own" | "private";
|
|
32163
32549
|
field?: string;
|
|
32164
32550
|
};
|
|
32165
32551
|
/** @description Number rows with this prefix (1 to 10 capital letters or digits, such as CUS gives CUS-1). null stops numbering. */
|
|
@@ -32169,7 +32555,7 @@ export interface operations {
|
|
|
32169
32555
|
addFields?: {
|
|
32170
32556
|
name: string;
|
|
32171
32557
|
/** @enum {string} */
|
|
32172
|
-
type
|
|
32558
|
+
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";
|
|
32173
32559
|
description?: string;
|
|
32174
32560
|
/** @description Each row's value must differ (text, link, email, phone, number, currency). */
|
|
32175
32561
|
unique?: boolean;
|
|
@@ -32257,8 +32643,10 @@ export interface operations {
|
|
|
32257
32643
|
* @enum {string}
|
|
32258
32644
|
*/
|
|
32259
32645
|
viewType?: "grid" | "board" | "list" | "calendar" | "gallery";
|
|
32260
|
-
/** @description The view's saved filter
|
|
32261
|
-
filter?:
|
|
32646
|
+
/** @description The view's saved filter: queryDatabaseRows' where, never across a relation (no via). null clears it. */
|
|
32647
|
+
filter?: {
|
|
32648
|
+
[key: string]: unknown;
|
|
32649
|
+
} | null;
|
|
32262
32650
|
/** @description Up to 3 sort keys, first wins. Default: the order rows were added. */
|
|
32263
32651
|
sort?: {
|
|
32264
32652
|
/** @description The field's name. */
|
|
@@ -32285,8 +32673,10 @@ export interface operations {
|
|
|
32285
32673
|
name?: string;
|
|
32286
32674
|
/** @enum {string} */
|
|
32287
32675
|
viewType?: "grid" | "board" | "list" | "calendar" | "gallery";
|
|
32288
|
-
/** @description The view's saved filter
|
|
32289
|
-
filter?:
|
|
32676
|
+
/** @description The view's saved filter: queryDatabaseRows' where, never across a relation (no via). null clears it. */
|
|
32677
|
+
filter?: {
|
|
32678
|
+
[key: string]: unknown;
|
|
32679
|
+
} | null;
|
|
32290
32680
|
/** @description Up to 3 sort keys, first wins. Default: the order rows were added. */
|
|
32291
32681
|
sort?: {
|
|
32292
32682
|
/** @description The field's name. */
|
|
@@ -32659,7 +33049,9 @@ export interface operations {
|
|
|
32659
33049
|
/** @description A unique field, by name: rows without id (or copied rows) change the row with the same value, or are added. */
|
|
32660
33050
|
matchOn?: string;
|
|
32661
33051
|
/** @description Every row that matches: queryDatabaseRows' where. */
|
|
32662
|
-
where?:
|
|
33052
|
+
where?: {
|
|
33053
|
+
[key: string]: unknown;
|
|
33054
|
+
};
|
|
32663
33055
|
/** @description A saved view: its filter picks the rows too. */
|
|
32664
33056
|
view?: string;
|
|
32665
33057
|
/** @description Field name -> a value as in rows, or {"formula": "..."} for each row, such as {"Discount": {"formula": "{Discount} * 100"}}. */
|
|
@@ -32970,11 +33362,20 @@ export interface operations {
|
|
|
32970
33362
|
*/
|
|
32971
33363
|
format?: "csv" | "xlsx";
|
|
32972
33364
|
/** @description Every row that matches: queryDatabaseRows' where. */
|
|
32973
|
-
where?:
|
|
33365
|
+
where?: {
|
|
33366
|
+
[key: string]: unknown;
|
|
33367
|
+
};
|
|
32974
33368
|
/** @description A saved view: its filter, sort and fields. */
|
|
32975
33369
|
view?: string;
|
|
32976
33370
|
/** @description queryDatabaseRows' sort. */
|
|
32977
|
-
sort?:
|
|
33371
|
+
sort?: ({
|
|
33372
|
+
/** @description The field's name. */
|
|
33373
|
+
field: string;
|
|
33374
|
+
/** @enum {string} */
|
|
33375
|
+
direction?: "ascending" | "descending";
|
|
33376
|
+
} & {
|
|
33377
|
+
[key: string]: unknown;
|
|
33378
|
+
})[];
|
|
32978
33379
|
/** @description Fields in order, by name. Default: every field, or the view's. */
|
|
32979
33380
|
select?: string[];
|
|
32980
33381
|
/** @description For dates, such as Australia/Sydney. Default UTC. */
|
|
@@ -33107,7 +33508,9 @@ export interface operations {
|
|
|
33107
33508
|
/** @description The rows' ids. Leave out to delete every row that matches. */
|
|
33108
33509
|
rowIds?: string[];
|
|
33109
33510
|
/** @description Every row that matches: queryDatabaseRows' where. */
|
|
33110
|
-
where?:
|
|
33511
|
+
where?: {
|
|
33512
|
+
[key: string]: unknown;
|
|
33513
|
+
};
|
|
33111
33514
|
/** @description A saved view: its filter picks the rows too. */
|
|
33112
33515
|
view?: string;
|
|
33113
33516
|
/**
|