@loculabs/api-client 1.4.0 → 2.0.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/CHANGELOG.md +12 -0
- package/dist/index.d.mts +370 -98
- package/dist/index.d.ts +370 -98
- package/dist/index.js.map +1 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -109,6 +109,12 @@ interface paths {
|
|
|
109
109
|
folderId?: string;
|
|
110
110
|
/** @description Include HTML representation of the note content */
|
|
111
111
|
includeHtml?: boolean | null;
|
|
112
|
+
/** @description Include Markdown representation of the note content */
|
|
113
|
+
includeMarkdown?: boolean | null;
|
|
114
|
+
/** @description Include plain text representation of the note content */
|
|
115
|
+
includePlainText?: boolean | null;
|
|
116
|
+
/** @description Include ProseMirror JSON representation of the note content */
|
|
117
|
+
includeJson?: boolean | null;
|
|
112
118
|
};
|
|
113
119
|
header?: never;
|
|
114
120
|
path?: never;
|
|
@@ -182,6 +188,12 @@ interface paths {
|
|
|
182
188
|
query?: {
|
|
183
189
|
/** @description Include HTML representation of the note content */
|
|
184
190
|
includeHtml?: boolean | null;
|
|
191
|
+
/** @description Include Markdown representation of the note content */
|
|
192
|
+
includeMarkdown?: boolean | null;
|
|
193
|
+
/** @description Include plain text representation of the note content */
|
|
194
|
+
includePlainText?: boolean | null;
|
|
195
|
+
/** @description Include ProseMirror JSON representation of the note content */
|
|
196
|
+
includeJson?: boolean | null;
|
|
185
197
|
};
|
|
186
198
|
header?: never;
|
|
187
199
|
path?: never;
|
|
@@ -271,6 +283,12 @@ interface paths {
|
|
|
271
283
|
query?: {
|
|
272
284
|
/** @description Include HTML representation of the note content */
|
|
273
285
|
includeHtml?: boolean | null;
|
|
286
|
+
/** @description Include Markdown representation of the note content */
|
|
287
|
+
includeMarkdown?: boolean | null;
|
|
288
|
+
/** @description Include plain text representation of the note content */
|
|
289
|
+
includePlainText?: boolean | null;
|
|
290
|
+
/** @description Include ProseMirror JSON representation of the note content */
|
|
291
|
+
includeJson?: boolean | null;
|
|
274
292
|
};
|
|
275
293
|
header?: never;
|
|
276
294
|
path: {
|
|
@@ -422,6 +440,12 @@ interface paths {
|
|
|
422
440
|
query?: {
|
|
423
441
|
/** @description Include HTML representation of the note content */
|
|
424
442
|
includeHtml?: boolean | null;
|
|
443
|
+
/** @description Include Markdown representation of the note content */
|
|
444
|
+
includeMarkdown?: boolean | null;
|
|
445
|
+
/** @description Include plain text representation of the note content */
|
|
446
|
+
includePlainText?: boolean | null;
|
|
447
|
+
/** @description Include ProseMirror JSON representation of the note content */
|
|
448
|
+
includeJson?: boolean | null;
|
|
425
449
|
};
|
|
426
450
|
header?: never;
|
|
427
451
|
path: {
|
|
@@ -510,7 +534,7 @@ interface paths {
|
|
|
510
534
|
query?: {
|
|
511
535
|
/** @description Number of projects to return */
|
|
512
536
|
limit?: number;
|
|
513
|
-
/** @description Cursor for pagination */
|
|
537
|
+
/** @description Cursor for pagination. Use an ISO 8601 datetime cursor when orderBy=createdAt. */
|
|
514
538
|
cursor?: string;
|
|
515
539
|
/** @description Field to order results by */
|
|
516
540
|
orderBy?: "updatedAt" | "createdAt";
|
|
@@ -520,6 +544,12 @@ interface paths {
|
|
|
520
544
|
state?: "planned" | "completed";
|
|
521
545
|
/** @description Include HTML representation of the project description */
|
|
522
546
|
includeHtml?: boolean | null;
|
|
547
|
+
/** @description Include Markdown representation of the project description */
|
|
548
|
+
includeMarkdown?: boolean | null;
|
|
549
|
+
/** @description Include plain text representation of the project description */
|
|
550
|
+
includePlainText?: boolean | null;
|
|
551
|
+
/** @description Include ProseMirror JSON representation of the project description */
|
|
552
|
+
includeJson?: boolean | null;
|
|
523
553
|
};
|
|
524
554
|
header?: never;
|
|
525
555
|
path?: never;
|
|
@@ -593,6 +623,12 @@ interface paths {
|
|
|
593
623
|
query?: {
|
|
594
624
|
/** @description Include HTML representation of the project description */
|
|
595
625
|
includeHtml?: boolean | null;
|
|
626
|
+
/** @description Include Markdown representation of the project description */
|
|
627
|
+
includeMarkdown?: boolean | null;
|
|
628
|
+
/** @description Include plain text representation of the project description */
|
|
629
|
+
includePlainText?: boolean | null;
|
|
630
|
+
/** @description Include ProseMirror JSON representation of the project description */
|
|
631
|
+
includeJson?: boolean | null;
|
|
596
632
|
};
|
|
597
633
|
header?: never;
|
|
598
634
|
path?: never;
|
|
@@ -682,6 +718,12 @@ interface paths {
|
|
|
682
718
|
query?: {
|
|
683
719
|
/** @description Include HTML representation of the project description */
|
|
684
720
|
includeHtml?: boolean | null;
|
|
721
|
+
/** @description Include Markdown representation of the project description */
|
|
722
|
+
includeMarkdown?: boolean | null;
|
|
723
|
+
/** @description Include plain text representation of the project description */
|
|
724
|
+
includePlainText?: boolean | null;
|
|
725
|
+
/** @description Include ProseMirror JSON representation of the project description */
|
|
726
|
+
includeJson?: boolean | null;
|
|
685
727
|
};
|
|
686
728
|
header?: never;
|
|
687
729
|
path: {
|
|
@@ -833,6 +875,12 @@ interface paths {
|
|
|
833
875
|
query?: {
|
|
834
876
|
/** @description Include HTML representation of the project description */
|
|
835
877
|
includeHtml?: boolean | null;
|
|
878
|
+
/** @description Include Markdown representation of the project description */
|
|
879
|
+
includeMarkdown?: boolean | null;
|
|
880
|
+
/** @description Include plain text representation of the project description */
|
|
881
|
+
includePlainText?: boolean | null;
|
|
882
|
+
/** @description Include ProseMirror JSON representation of the project description */
|
|
883
|
+
includeJson?: boolean | null;
|
|
836
884
|
};
|
|
837
885
|
header?: never;
|
|
838
886
|
path: {
|
|
@@ -921,15 +969,15 @@ interface paths {
|
|
|
921
969
|
query?: {
|
|
922
970
|
/** @description Number of sessions to return */
|
|
923
971
|
limit?: number;
|
|
924
|
-
/** @description Cursor for pagination */
|
|
972
|
+
/** @description Cursor for pagination. Use ISO 8601 datetime cursors when orderBy is createdAt or finishedAt. */
|
|
925
973
|
cursor?: string;
|
|
926
974
|
/** @description Field to order results by */
|
|
927
975
|
orderBy?: "updatedAt" | "createdAt" | "finishedAt";
|
|
928
976
|
/** @description Sort order (ascending or descending) */
|
|
929
977
|
order?: "asc" | "desc";
|
|
930
|
-
/** @description Filter sessions starting after this date (
|
|
978
|
+
/** @description Filter sessions starting after this date (ISO 8601) */
|
|
931
979
|
startAfter?: string;
|
|
932
|
-
/** @description Filter sessions starting before this date (
|
|
980
|
+
/** @description Filter sessions starting before this date (ISO 8601) */
|
|
933
981
|
startBefore?: string;
|
|
934
982
|
/** @description Include activities in response */
|
|
935
983
|
includeActivities?: boolean | null;
|
|
@@ -1092,7 +1140,7 @@ interface paths {
|
|
|
1092
1140
|
query?: {
|
|
1093
1141
|
/** @description Number of activities to return */
|
|
1094
1142
|
limit?: number;
|
|
1095
|
-
/** @description Cursor for pagination */
|
|
1143
|
+
/** @description Cursor for pagination. Use an ISO 8601 datetime cursor when orderBy=createdAt. */
|
|
1096
1144
|
cursor?: string;
|
|
1097
1145
|
/** @description Field to order results by */
|
|
1098
1146
|
orderBy?: "updatedAt" | "createdAt";
|
|
@@ -1748,7 +1796,7 @@ interface paths {
|
|
|
1748
1796
|
get: {
|
|
1749
1797
|
parameters: {
|
|
1750
1798
|
query?: {
|
|
1751
|
-
/** @description Cursor for pagination */
|
|
1799
|
+
/** @description Cursor for pagination. Use an ISO 8601 datetime cursor when ordering by doneAt. */
|
|
1752
1800
|
cursor?: string;
|
|
1753
1801
|
/** @description Number of items to return (max 100) */
|
|
1754
1802
|
limit?: string;
|
|
@@ -1764,12 +1812,18 @@ interface paths {
|
|
|
1764
1812
|
parentId?: string;
|
|
1765
1813
|
/** @description Filter by section */
|
|
1766
1814
|
section?: "today" | "sooner" | "later";
|
|
1767
|
-
/** @description Filter tasks completed after this date (
|
|
1815
|
+
/** @description Filter tasks completed after this date (ISO 8601) */
|
|
1768
1816
|
doneAfter?: string;
|
|
1769
|
-
/** @description Filter tasks completed before this date (
|
|
1817
|
+
/** @description Filter tasks completed before this date (ISO 8601) */
|
|
1770
1818
|
doneBefore?: string;
|
|
1771
1819
|
/** @description Include HTML representation of the task description */
|
|
1772
1820
|
includeHtml?: boolean | null;
|
|
1821
|
+
/** @description Include Markdown representation of the task description */
|
|
1822
|
+
includeMarkdown?: boolean | null;
|
|
1823
|
+
/** @description Include plain text representation of the task description */
|
|
1824
|
+
includePlainText?: boolean | null;
|
|
1825
|
+
/** @description Include ProseMirror JSON representation of the task description */
|
|
1826
|
+
includeJson?: boolean | null;
|
|
1773
1827
|
};
|
|
1774
1828
|
header?: never;
|
|
1775
1829
|
path?: never;
|
|
@@ -1843,6 +1897,12 @@ interface paths {
|
|
|
1843
1897
|
query?: {
|
|
1844
1898
|
/** @description Include HTML representation of the task description */
|
|
1845
1899
|
includeHtml?: boolean | null;
|
|
1900
|
+
/** @description Include Markdown representation of the task description */
|
|
1901
|
+
includeMarkdown?: boolean | null;
|
|
1902
|
+
/** @description Include plain text representation of the task description */
|
|
1903
|
+
includePlainText?: boolean | null;
|
|
1904
|
+
/** @description Include ProseMirror JSON representation of the task description */
|
|
1905
|
+
includeJson?: boolean | null;
|
|
1846
1906
|
};
|
|
1847
1907
|
header?: never;
|
|
1848
1908
|
path?: never;
|
|
@@ -1934,6 +1994,12 @@ interface paths {
|
|
|
1934
1994
|
section?: "today" | "sooner" | "later";
|
|
1935
1995
|
/** @description Include HTML representation of the task description */
|
|
1936
1996
|
includeHtml?: boolean | null;
|
|
1997
|
+
/** @description Include Markdown representation of the task description */
|
|
1998
|
+
includeMarkdown?: boolean | null;
|
|
1999
|
+
/** @description Include plain text representation of the task description */
|
|
2000
|
+
includePlainText?: boolean | null;
|
|
2001
|
+
/** @description Include ProseMirror JSON representation of the task description */
|
|
2002
|
+
includeJson?: boolean | null;
|
|
1937
2003
|
};
|
|
1938
2004
|
header?: never;
|
|
1939
2005
|
path?: never;
|
|
@@ -2014,13 +2080,19 @@ interface paths {
|
|
|
2014
2080
|
};
|
|
2015
2081
|
/**
|
|
2016
2082
|
* Get task
|
|
2017
|
-
* @description Retrieve a single task by ID.
|
|
2083
|
+
* @description Retrieve a single task by ID with section, description, and subtask tree.
|
|
2018
2084
|
*/
|
|
2019
2085
|
get: {
|
|
2020
2086
|
parameters: {
|
|
2021
2087
|
query?: {
|
|
2022
2088
|
/** @description Include HTML representation of the task description */
|
|
2023
2089
|
includeHtml?: boolean | null;
|
|
2090
|
+
/** @description Include Markdown representation of the task description */
|
|
2091
|
+
includeMarkdown?: boolean | null;
|
|
2092
|
+
/** @description Include plain text representation of the task description */
|
|
2093
|
+
includePlainText?: boolean | null;
|
|
2094
|
+
/** @description Include ProseMirror JSON representation of the task description */
|
|
2095
|
+
includeJson?: boolean | null;
|
|
2024
2096
|
};
|
|
2025
2097
|
header?: never;
|
|
2026
2098
|
path: {
|
|
@@ -2037,7 +2109,7 @@ interface paths {
|
|
|
2037
2109
|
[name: string]: unknown;
|
|
2038
2110
|
};
|
|
2039
2111
|
content: {
|
|
2040
|
-
"application/json": components["schemas"]["
|
|
2112
|
+
"application/json": components["schemas"]["TaskDetailResponse"];
|
|
2041
2113
|
};
|
|
2042
2114
|
};
|
|
2043
2115
|
/** @description Bad request - validation error */
|
|
@@ -2172,6 +2244,12 @@ interface paths {
|
|
|
2172
2244
|
query?: {
|
|
2173
2245
|
/** @description Include HTML representation of the task description */
|
|
2174
2246
|
includeHtml?: boolean | null;
|
|
2247
|
+
/** @description Include Markdown representation of the task description */
|
|
2248
|
+
includeMarkdown?: boolean | null;
|
|
2249
|
+
/** @description Include plain text representation of the task description */
|
|
2250
|
+
includePlainText?: boolean | null;
|
|
2251
|
+
/** @description Include ProseMirror JSON representation of the task description */
|
|
2252
|
+
includeJson?: boolean | null;
|
|
2175
2253
|
};
|
|
2176
2254
|
header?: never;
|
|
2177
2255
|
path: {
|
|
@@ -2266,6 +2344,12 @@ interface paths {
|
|
|
2266
2344
|
done?: "true" | "false";
|
|
2267
2345
|
/** @description Include HTML representation of the task description */
|
|
2268
2346
|
includeHtml?: boolean | null;
|
|
2347
|
+
/** @description Include Markdown representation of the task description */
|
|
2348
|
+
includeMarkdown?: boolean | null;
|
|
2349
|
+
/** @description Include plain text representation of the task description */
|
|
2350
|
+
includePlainText?: boolean | null;
|
|
2351
|
+
/** @description Include ProseMirror JSON representation of the task description */
|
|
2352
|
+
includeJson?: boolean | null;
|
|
2269
2353
|
};
|
|
2270
2354
|
header?: never;
|
|
2271
2355
|
path: {
|
|
@@ -3416,15 +3500,28 @@ interface components {
|
|
|
3416
3500
|
id: string;
|
|
3417
3501
|
name: string;
|
|
3418
3502
|
done: "completed" | "canceled" | null;
|
|
3419
|
-
|
|
3420
|
-
|
|
3503
|
+
/**
|
|
3504
|
+
* Format: date-time
|
|
3505
|
+
* @description Completion timestamp (ISO 8601)
|
|
3506
|
+
*/
|
|
3507
|
+
doneAt: string | null;
|
|
3508
|
+
/**
|
|
3509
|
+
* Format: date-time
|
|
3510
|
+
* @description Creation timestamp (ISO 8601)
|
|
3511
|
+
*/
|
|
3512
|
+
createdAt: string;
|
|
3421
3513
|
parent: {
|
|
3422
3514
|
id: string;
|
|
3423
3515
|
order: number | null;
|
|
3424
3516
|
} | null;
|
|
3517
|
+
/** @description Task waiting state */
|
|
3425
3518
|
waiting?: {
|
|
3426
3519
|
reason?: string;
|
|
3427
|
-
|
|
3520
|
+
/**
|
|
3521
|
+
* Format: date-time
|
|
3522
|
+
* @description Timestamp when task entered waiting state (ISO 8601)
|
|
3523
|
+
*/
|
|
3524
|
+
waitingAt: string;
|
|
3428
3525
|
} | null;
|
|
3429
3526
|
projectId?: string | null;
|
|
3430
3527
|
cursorAgentUrl?: string | null;
|
|
@@ -3437,12 +3534,12 @@ interface components {
|
|
|
3437
3534
|
type: "locu";
|
|
3438
3535
|
/** @description Task description in multiple formats */
|
|
3439
3536
|
description?: {
|
|
3440
|
-
/** @description Description content as Markdown */
|
|
3441
|
-
markdown
|
|
3442
|
-
/** @description Description content as HTML (
|
|
3537
|
+
/** @description Description content as Markdown (included when includeMarkdown=true) */
|
|
3538
|
+
markdown?: string;
|
|
3539
|
+
/** @description Description content as HTML (included when includeHtml=true) */
|
|
3443
3540
|
html?: string;
|
|
3444
3541
|
/**
|
|
3445
|
-
* @description Description content as ProseMirror JSON document
|
|
3542
|
+
* @description Description content as ProseMirror JSON document (included when includeJson=true)
|
|
3446
3543
|
* @example {
|
|
3447
3544
|
* "type": "doc",
|
|
3448
3545
|
* "content": [
|
|
@@ -3496,23 +3593,36 @@ interface components {
|
|
|
3496
3593
|
}[];
|
|
3497
3594
|
}[];
|
|
3498
3595
|
};
|
|
3499
|
-
/** @description Description content as plain text */
|
|
3500
|
-
plainText
|
|
3596
|
+
/** @description Description content as plain text (included when includePlainText=true) */
|
|
3597
|
+
plainText?: string;
|
|
3501
3598
|
} | null;
|
|
3502
3599
|
};
|
|
3503
3600
|
LinearTask: {
|
|
3504
3601
|
id: string;
|
|
3505
3602
|
name: string;
|
|
3506
3603
|
done: "completed" | "canceled" | null;
|
|
3507
|
-
|
|
3508
|
-
|
|
3604
|
+
/**
|
|
3605
|
+
* Format: date-time
|
|
3606
|
+
* @description Completion timestamp (ISO 8601)
|
|
3607
|
+
*/
|
|
3608
|
+
doneAt: string | null;
|
|
3609
|
+
/**
|
|
3610
|
+
* Format: date-time
|
|
3611
|
+
* @description Creation timestamp (ISO 8601)
|
|
3612
|
+
*/
|
|
3613
|
+
createdAt: string;
|
|
3509
3614
|
parent: {
|
|
3510
3615
|
id: string;
|
|
3511
3616
|
order: number | null;
|
|
3512
3617
|
} | null;
|
|
3618
|
+
/** @description Task waiting state */
|
|
3513
3619
|
waiting?: {
|
|
3514
3620
|
reason?: string;
|
|
3515
|
-
|
|
3621
|
+
/**
|
|
3622
|
+
* Format: date-time
|
|
3623
|
+
* @description Timestamp when task entered waiting state (ISO 8601)
|
|
3624
|
+
*/
|
|
3625
|
+
waitingAt: string;
|
|
3516
3626
|
} | null;
|
|
3517
3627
|
projectId?: string | null;
|
|
3518
3628
|
cursorAgentUrl?: string | null;
|
|
@@ -3523,12 +3633,12 @@ interface components {
|
|
|
3523
3633
|
teamId: string;
|
|
3524
3634
|
/** @description Task description in multiple formats */
|
|
3525
3635
|
description?: {
|
|
3526
|
-
/** @description Description content as Markdown */
|
|
3527
|
-
markdown
|
|
3528
|
-
/** @description Description content as HTML (
|
|
3636
|
+
/** @description Description content as Markdown (included when includeMarkdown=true) */
|
|
3637
|
+
markdown?: string;
|
|
3638
|
+
/** @description Description content as HTML (included when includeHtml=true) */
|
|
3529
3639
|
html?: string;
|
|
3530
3640
|
/**
|
|
3531
|
-
* @description Description content as ProseMirror JSON document
|
|
3641
|
+
* @description Description content as ProseMirror JSON document (included when includeJson=true)
|
|
3532
3642
|
* @example {
|
|
3533
3643
|
* "type": "doc",
|
|
3534
3644
|
* "content": [
|
|
@@ -3582,8 +3692,8 @@ interface components {
|
|
|
3582
3692
|
}[];
|
|
3583
3693
|
}[];
|
|
3584
3694
|
};
|
|
3585
|
-
/** @description Description content as plain text */
|
|
3586
|
-
plainText
|
|
3695
|
+
/** @description Description content as plain text (included when includePlainText=true) */
|
|
3696
|
+
plainText?: string;
|
|
3587
3697
|
} | null;
|
|
3588
3698
|
assignee: {
|
|
3589
3699
|
id: string;
|
|
@@ -3601,32 +3711,46 @@ interface components {
|
|
|
3601
3711
|
* @enum {string}
|
|
3602
3712
|
*/
|
|
3603
3713
|
type: "linear";
|
|
3714
|
+
integrationDescription: string;
|
|
3604
3715
|
};
|
|
3605
3716
|
JiraTask: {
|
|
3606
3717
|
id: string;
|
|
3607
3718
|
name: string;
|
|
3608
3719
|
done: "completed" | "canceled" | null;
|
|
3609
|
-
|
|
3610
|
-
|
|
3720
|
+
/**
|
|
3721
|
+
* Format: date-time
|
|
3722
|
+
* @description Completion timestamp (ISO 8601)
|
|
3723
|
+
*/
|
|
3724
|
+
doneAt: string | null;
|
|
3725
|
+
/**
|
|
3726
|
+
* Format: date-time
|
|
3727
|
+
* @description Creation timestamp (ISO 8601)
|
|
3728
|
+
*/
|
|
3729
|
+
createdAt: string;
|
|
3611
3730
|
parent: {
|
|
3612
3731
|
id: string;
|
|
3613
3732
|
order: number | null;
|
|
3614
3733
|
} | null;
|
|
3734
|
+
/** @description Task waiting state */
|
|
3615
3735
|
waiting?: {
|
|
3616
3736
|
reason?: string;
|
|
3617
|
-
|
|
3737
|
+
/**
|
|
3738
|
+
* Format: date-time
|
|
3739
|
+
* @description Timestamp when task entered waiting state (ISO 8601)
|
|
3740
|
+
*/
|
|
3741
|
+
waitingAt: string;
|
|
3618
3742
|
} | null;
|
|
3619
3743
|
projectId: string;
|
|
3620
3744
|
cursorAgentUrl?: string | null;
|
|
3621
3745
|
integrationId: string;
|
|
3622
3746
|
/** @description Task description in multiple formats */
|
|
3623
3747
|
description?: {
|
|
3624
|
-
/** @description Description content as Markdown */
|
|
3625
|
-
markdown
|
|
3626
|
-
/** @description Description content as HTML (
|
|
3748
|
+
/** @description Description content as Markdown (included when includeMarkdown=true) */
|
|
3749
|
+
markdown?: string;
|
|
3750
|
+
/** @description Description content as HTML (included when includeHtml=true) */
|
|
3627
3751
|
html?: string;
|
|
3628
3752
|
/**
|
|
3629
|
-
* @description Description content as ProseMirror JSON document
|
|
3753
|
+
* @description Description content as ProseMirror JSON document (included when includeJson=true)
|
|
3630
3754
|
* @example {
|
|
3631
3755
|
* "type": "doc",
|
|
3632
3756
|
* "content": [
|
|
@@ -3680,8 +3804,8 @@ interface components {
|
|
|
3680
3804
|
}[];
|
|
3681
3805
|
}[];
|
|
3682
3806
|
};
|
|
3683
|
-
/** @description Description content as plain text */
|
|
3684
|
-
plainText
|
|
3807
|
+
/** @description Description content as plain text (included when includePlainText=true) */
|
|
3808
|
+
plainText?: string;
|
|
3685
3809
|
} | null;
|
|
3686
3810
|
assignee: {
|
|
3687
3811
|
id: string;
|
|
@@ -3711,7 +3835,24 @@ interface components {
|
|
|
3711
3835
|
* @enum {string}
|
|
3712
3836
|
*/
|
|
3713
3837
|
type: "jira";
|
|
3838
|
+
integrationDescription: string;
|
|
3839
|
+
};
|
|
3840
|
+
TaskDetailResponse: components["schemas"]["Task"] & {
|
|
3841
|
+
/**
|
|
3842
|
+
* @description Section the task belongs to
|
|
3843
|
+
* @enum {string|null}
|
|
3844
|
+
*/
|
|
3845
|
+
section: "today" | "sooner" | "later" | null;
|
|
3846
|
+
/** @description Subtask tree with descriptions */
|
|
3847
|
+
subtasks?: components["schemas"]["SubTask"][];
|
|
3714
3848
|
};
|
|
3849
|
+
SubTask: (components["schemas"]["LocuTask"] & {
|
|
3850
|
+
subtasks?: unknown[];
|
|
3851
|
+
}) | (components["schemas"]["LinearTask"] & {
|
|
3852
|
+
subtasks?: unknown[];
|
|
3853
|
+
}) | (components["schemas"]["JiraTask"] & {
|
|
3854
|
+
subtasks?: unknown[];
|
|
3855
|
+
});
|
|
3715
3856
|
MeResponse: {
|
|
3716
3857
|
/** @description Email of the authenticated user */
|
|
3717
3858
|
email: string;
|
|
@@ -3741,14 +3882,22 @@ interface components {
|
|
|
3741
3882
|
id: string;
|
|
3742
3883
|
type: "folder" | "virtual-folder";
|
|
3743
3884
|
} | null;
|
|
3744
|
-
|
|
3745
|
-
|
|
3746
|
-
|
|
3747
|
-
|
|
3748
|
-
|
|
3885
|
+
/**
|
|
3886
|
+
* Format: date-time
|
|
3887
|
+
* @description Creation timestamp (ISO 8601)
|
|
3888
|
+
*/
|
|
3889
|
+
createdAt?: string;
|
|
3890
|
+
/**
|
|
3891
|
+
* Format: date-time
|
|
3892
|
+
* @description Last update timestamp (ISO 8601)
|
|
3893
|
+
*/
|
|
3894
|
+
updatedAt?: string;
|
|
3895
|
+
/** @description Note content as Markdown (included when includeMarkdown=true) */
|
|
3896
|
+
markdown?: string;
|
|
3897
|
+
/** @description Note content as HTML (included when includeHtml=true) */
|
|
3749
3898
|
html?: string;
|
|
3750
3899
|
/**
|
|
3751
|
-
* @description Note content as ProseMirror JSON document
|
|
3900
|
+
* @description Note content as ProseMirror JSON document (included when includeJson=true)
|
|
3752
3901
|
* @example {
|
|
3753
3902
|
* "type": "doc",
|
|
3754
3903
|
* "content": [
|
|
@@ -3802,8 +3951,8 @@ interface components {
|
|
|
3802
3951
|
}[];
|
|
3803
3952
|
}[];
|
|
3804
3953
|
};
|
|
3805
|
-
/** @description Note content as plain text */
|
|
3806
|
-
plainText
|
|
3954
|
+
/** @description Note content as plain text (included when includePlainText=true) */
|
|
3955
|
+
plainText?: string;
|
|
3807
3956
|
};
|
|
3808
3957
|
CreateNoteRequest: {
|
|
3809
3958
|
/**
|
|
@@ -3853,18 +4002,31 @@ interface components {
|
|
|
3853
4002
|
name: string;
|
|
3854
4003
|
icon: string | null;
|
|
3855
4004
|
color: string | null;
|
|
3856
|
-
state: "planned" | "completed";
|
|
3857
|
-
|
|
3858
|
-
|
|
3859
|
-
|
|
4005
|
+
state: "planned" | "completed" | "canceled";
|
|
4006
|
+
/**
|
|
4007
|
+
* Format: date-time
|
|
4008
|
+
* @description Completion timestamp (ISO 8601)
|
|
4009
|
+
*/
|
|
4010
|
+
completedAt?: string | null;
|
|
4011
|
+
canceledAt?: number | null;
|
|
4012
|
+
/**
|
|
4013
|
+
* Format: date-time
|
|
4014
|
+
* @description Creation timestamp (ISO 8601)
|
|
4015
|
+
*/
|
|
4016
|
+
createdAt: string;
|
|
4017
|
+
/**
|
|
4018
|
+
* Format: date-time
|
|
4019
|
+
* @description Last update timestamp (ISO 8601)
|
|
4020
|
+
*/
|
|
4021
|
+
updatedAt: string;
|
|
3860
4022
|
/** @description Project description in multiple formats */
|
|
3861
4023
|
description?: {
|
|
3862
|
-
/** @description Description content as Markdown */
|
|
3863
|
-
markdown
|
|
3864
|
-
/** @description Description content as HTML (
|
|
4024
|
+
/** @description Description content as Markdown (included when includeMarkdown=true) */
|
|
4025
|
+
markdown?: string;
|
|
4026
|
+
/** @description Description content as HTML (included when includeHtml=true) */
|
|
3865
4027
|
html?: string;
|
|
3866
4028
|
/**
|
|
3867
|
-
* @description Description content as ProseMirror JSON document
|
|
4029
|
+
* @description Description content as ProseMirror JSON document (included when includeJson=true)
|
|
3868
4030
|
* @example {
|
|
3869
4031
|
* "type": "doc",
|
|
3870
4032
|
* "content": [
|
|
@@ -3918,8 +4080,8 @@ interface components {
|
|
|
3918
4080
|
}[];
|
|
3919
4081
|
}[];
|
|
3920
4082
|
};
|
|
3921
|
-
/** @description Description content as plain text */
|
|
3922
|
-
plainText
|
|
4083
|
+
/** @description Description content as plain text (included when includePlainText=true) */
|
|
4084
|
+
plainText?: string;
|
|
3923
4085
|
} | null;
|
|
3924
4086
|
};
|
|
3925
4087
|
CreateProjectRequest: {
|
|
@@ -3975,42 +4137,115 @@ interface components {
|
|
|
3975
4137
|
activities: components["schemas"]["SessionActivity"][];
|
|
3976
4138
|
};
|
|
3977
4139
|
SessionActivity: {
|
|
4140
|
+
/**
|
|
4141
|
+
* Format: uuid
|
|
4142
|
+
* @description Unique identifier for the activity
|
|
4143
|
+
*/
|
|
4144
|
+
id: string;
|
|
4145
|
+
/**
|
|
4146
|
+
* Format: date-time
|
|
4147
|
+
* @description Activity start timestamp (ISO 8601)
|
|
4148
|
+
*/
|
|
4149
|
+
createdAt: string;
|
|
4150
|
+
/**
|
|
4151
|
+
* Format: date-time
|
|
4152
|
+
* @description Activity end timestamp (ISO 8601)
|
|
4153
|
+
*/
|
|
4154
|
+
finishedAt: string;
|
|
4155
|
+
/**
|
|
4156
|
+
* Format: uuid
|
|
4157
|
+
* @description Session ID this activity belongs to
|
|
4158
|
+
*/
|
|
4159
|
+
sessionId: string;
|
|
4160
|
+
/** @description Whether the activity was manually created */
|
|
4161
|
+
isManual: boolean;
|
|
3978
4162
|
/** @enum {string} */
|
|
3979
4163
|
type: "TASK";
|
|
4164
|
+
/** @description Associated task ID */
|
|
3980
4165
|
taskId: string;
|
|
4166
|
+
} | {
|
|
4167
|
+
/**
|
|
4168
|
+
* Format: uuid
|
|
4169
|
+
* @description Unique identifier for the activity
|
|
4170
|
+
*/
|
|
3981
4171
|
id: string;
|
|
3982
|
-
|
|
3983
|
-
|
|
4172
|
+
/**
|
|
4173
|
+
* Format: date-time
|
|
4174
|
+
* @description Activity start timestamp (ISO 8601)
|
|
4175
|
+
*/
|
|
4176
|
+
createdAt: string;
|
|
4177
|
+
/**
|
|
4178
|
+
* Format: date-time
|
|
4179
|
+
* @description Activity end timestamp (ISO 8601)
|
|
4180
|
+
*/
|
|
4181
|
+
finishedAt: string;
|
|
4182
|
+
/**
|
|
4183
|
+
* Format: uuid
|
|
4184
|
+
* @description Session ID this activity belongs to
|
|
4185
|
+
*/
|
|
3984
4186
|
sessionId: string;
|
|
4187
|
+
/** @description Whether the activity was manually created */
|
|
3985
4188
|
isManual: boolean;
|
|
3986
|
-
} | {
|
|
3987
4189
|
/** @enum {string} */
|
|
3988
4190
|
type: "MEETING";
|
|
4191
|
+
/** @description Meeting title */
|
|
3989
4192
|
title: string;
|
|
3990
|
-
|
|
4193
|
+
/** @description Meeting URL */
|
|
4194
|
+
htmlLink?: string;
|
|
4195
|
+
/** @description Meeting identifier */
|
|
3991
4196
|
meetingId: string;
|
|
4197
|
+
/** @description Calendar identifier */
|
|
3992
4198
|
calendarId?: string;
|
|
4199
|
+
} | {
|
|
4200
|
+
/**
|
|
4201
|
+
* Format: uuid
|
|
4202
|
+
* @description Unique identifier for the activity
|
|
4203
|
+
*/
|
|
3993
4204
|
id: string;
|
|
3994
|
-
|
|
3995
|
-
|
|
4205
|
+
/**
|
|
4206
|
+
* Format: date-time
|
|
4207
|
+
* @description Activity start timestamp (ISO 8601)
|
|
4208
|
+
*/
|
|
4209
|
+
createdAt: string;
|
|
4210
|
+
/**
|
|
4211
|
+
* Format: date-time
|
|
4212
|
+
* @description Activity end timestamp (ISO 8601)
|
|
4213
|
+
*/
|
|
4214
|
+
finishedAt: string;
|
|
4215
|
+
/**
|
|
4216
|
+
* Format: uuid
|
|
4217
|
+
* @description Session ID this activity belongs to
|
|
4218
|
+
*/
|
|
3996
4219
|
sessionId: string;
|
|
4220
|
+
/** @description Whether the activity was manually created */
|
|
3997
4221
|
isManual: boolean;
|
|
3998
|
-
} | {
|
|
3999
4222
|
/** @enum {string} */
|
|
4000
4223
|
type: "PLANNING";
|
|
4224
|
+
} | {
|
|
4225
|
+
/**
|
|
4226
|
+
* Format: uuid
|
|
4227
|
+
* @description Unique identifier for the activity
|
|
4228
|
+
*/
|
|
4001
4229
|
id: string;
|
|
4002
|
-
|
|
4003
|
-
|
|
4230
|
+
/**
|
|
4231
|
+
* Format: date-time
|
|
4232
|
+
* @description Activity start timestamp (ISO 8601)
|
|
4233
|
+
*/
|
|
4234
|
+
createdAt: string;
|
|
4235
|
+
/**
|
|
4236
|
+
* Format: date-time
|
|
4237
|
+
* @description Activity end timestamp (ISO 8601)
|
|
4238
|
+
*/
|
|
4239
|
+
finishedAt: string;
|
|
4240
|
+
/**
|
|
4241
|
+
* Format: uuid
|
|
4242
|
+
* @description Session ID this activity belongs to
|
|
4243
|
+
*/
|
|
4004
4244
|
sessionId: string;
|
|
4245
|
+
/** @description Whether the activity was manually created */
|
|
4005
4246
|
isManual: boolean;
|
|
4006
|
-
} | {
|
|
4007
4247
|
/** @enum {string} */
|
|
4008
4248
|
type: "WRAP_UP";
|
|
4009
|
-
id: string;
|
|
4010
|
-
createdAt: number;
|
|
4011
|
-
finishedAt: number;
|
|
4012
|
-
sessionId: string;
|
|
4013
|
-
isManual: boolean;
|
|
4014
4249
|
};
|
|
4015
4250
|
Session: {
|
|
4016
4251
|
/**
|
|
@@ -4020,10 +4255,16 @@ interface components {
|
|
|
4020
4255
|
id: string;
|
|
4021
4256
|
/** @description Whether the session was manually created */
|
|
4022
4257
|
isManual: boolean;
|
|
4023
|
-
/**
|
|
4024
|
-
|
|
4025
|
-
|
|
4026
|
-
|
|
4258
|
+
/**
|
|
4259
|
+
* Format: date-time
|
|
4260
|
+
* @description Session start timestamp (ISO 8601)
|
|
4261
|
+
*/
|
|
4262
|
+
createdAt: string;
|
|
4263
|
+
/**
|
|
4264
|
+
* Format: date-time
|
|
4265
|
+
* @description Session end timestamp (ISO 8601)
|
|
4266
|
+
*/
|
|
4267
|
+
finishedAt: string;
|
|
4027
4268
|
};
|
|
4028
4269
|
ActivityPaginatedListResponse: {
|
|
4029
4270
|
data: components["schemas"]["SessionActivity"][];
|
|
@@ -4036,16 +4277,28 @@ interface components {
|
|
|
4036
4277
|
* @description Optional custom ID for the session
|
|
4037
4278
|
*/
|
|
4038
4279
|
id?: string;
|
|
4039
|
-
/**
|
|
4040
|
-
|
|
4041
|
-
|
|
4042
|
-
|
|
4280
|
+
/**
|
|
4281
|
+
* Format: date-time
|
|
4282
|
+
* @description Session start timestamp (ISO 8601)
|
|
4283
|
+
*/
|
|
4284
|
+
createdAt: string;
|
|
4285
|
+
/**
|
|
4286
|
+
* Format: date-time
|
|
4287
|
+
* @description Session end timestamp (ISO 8601)
|
|
4288
|
+
*/
|
|
4289
|
+
finishedAt: string;
|
|
4043
4290
|
};
|
|
4044
4291
|
UpdateSessionRequest: {
|
|
4045
|
-
/**
|
|
4046
|
-
|
|
4047
|
-
|
|
4048
|
-
|
|
4292
|
+
/**
|
|
4293
|
+
* Format: date-time
|
|
4294
|
+
* @description New session start timestamp (ISO 8601)
|
|
4295
|
+
*/
|
|
4296
|
+
createdAt?: string;
|
|
4297
|
+
/**
|
|
4298
|
+
* Format: date-time
|
|
4299
|
+
* @description New session end timestamp (ISO 8601)
|
|
4300
|
+
*/
|
|
4301
|
+
finishedAt?: string;
|
|
4049
4302
|
};
|
|
4050
4303
|
DeleteSessionResponse: {
|
|
4051
4304
|
success: boolean;
|
|
@@ -4060,16 +4313,28 @@ interface components {
|
|
|
4060
4313
|
type: "TASK";
|
|
4061
4314
|
/** @description Associated task ID */
|
|
4062
4315
|
taskId: string;
|
|
4063
|
-
/**
|
|
4064
|
-
|
|
4065
|
-
|
|
4066
|
-
|
|
4316
|
+
/**
|
|
4317
|
+
* Format: date-time
|
|
4318
|
+
* @description Activity start timestamp (ISO 8601)
|
|
4319
|
+
*/
|
|
4320
|
+
createdAt: string;
|
|
4321
|
+
/**
|
|
4322
|
+
* Format: date-time
|
|
4323
|
+
* @description Activity end timestamp (ISO 8601)
|
|
4324
|
+
*/
|
|
4325
|
+
finishedAt: string;
|
|
4067
4326
|
};
|
|
4068
4327
|
UpdateActivityRequest: {
|
|
4069
|
-
/**
|
|
4070
|
-
|
|
4071
|
-
|
|
4072
|
-
|
|
4328
|
+
/**
|
|
4329
|
+
* Format: date-time
|
|
4330
|
+
* @description New activity start timestamp (ISO 8601)
|
|
4331
|
+
*/
|
|
4332
|
+
createdAt?: string;
|
|
4333
|
+
/**
|
|
4334
|
+
* Format: date-time
|
|
4335
|
+
* @description New activity end timestamp (ISO 8601)
|
|
4336
|
+
*/
|
|
4337
|
+
finishedAt?: string;
|
|
4073
4338
|
};
|
|
4074
4339
|
DeleteActivityResponse: {
|
|
4075
4340
|
success: boolean;
|
|
@@ -4163,8 +4428,8 @@ interface components {
|
|
|
4163
4428
|
duration?: number;
|
|
4164
4429
|
/** @description ID of the task being worked on (only present when ACTIVE with a task) */
|
|
4165
4430
|
currentTaskId?: string;
|
|
4166
|
-
/** @description When the timer was started as
|
|
4167
|
-
startedAt?:
|
|
4431
|
+
/** @description When the timer was started as an ISO 8601 datetime (only present when not IDLE) */
|
|
4432
|
+
startedAt?: string;
|
|
4168
4433
|
};
|
|
4169
4434
|
StartTimerRequest: {
|
|
4170
4435
|
/** @description Duration in seconds (must be positive) */
|
|
@@ -4181,10 +4446,16 @@ interface components {
|
|
|
4181
4446
|
id: string;
|
|
4182
4447
|
/** @description Whether the session was manually created */
|
|
4183
4448
|
isManual: boolean;
|
|
4184
|
-
/**
|
|
4185
|
-
|
|
4186
|
-
|
|
4187
|
-
|
|
4449
|
+
/**
|
|
4450
|
+
* Format: date-time
|
|
4451
|
+
* @description Start timestamp (ISO 8601)
|
|
4452
|
+
*/
|
|
4453
|
+
createdAt: string;
|
|
4454
|
+
/**
|
|
4455
|
+
* Format: date-time
|
|
4456
|
+
* @description End timestamp (ISO 8601)
|
|
4457
|
+
*/
|
|
4458
|
+
finishedAt: string;
|
|
4188
4459
|
};
|
|
4189
4460
|
WebhookListResponse: {
|
|
4190
4461
|
data: components["schemas"]["Webhook"][];
|
|
@@ -4322,6 +4593,7 @@ type WithOptionalKeepBreaks<T> = Omit<T, "keepBreaks"> & {
|
|
|
4322
4593
|
keepBreaks?: boolean;
|
|
4323
4594
|
};
|
|
4324
4595
|
type Task = components["schemas"]["Task"];
|
|
4596
|
+
type TaskDetailResponse = components["schemas"]["TaskDetailResponse"];
|
|
4325
4597
|
type CreateTaskRequest = WithOptionalKeepBreaks<components["schemas"]["CreateTaskRequest"]>;
|
|
4326
4598
|
type UpdateTaskRequest = WithOptionalKeepBreaks<components["schemas"]["UpdateTaskRequest"]>;
|
|
4327
4599
|
type TaskSectionsResponse = components["schemas"]["TaskSectionsResponse"];
|
|
@@ -4419,7 +4691,7 @@ declare const createLocuClient: (config: LocuClientConfig) => {
|
|
|
4419
4691
|
/** List all tasks */
|
|
4420
4692
|
list: (params?: TaskListParams) => Promise<PaginatedResponse<Task>>;
|
|
4421
4693
|
/** Get a single task by ID */
|
|
4422
|
-
get: (id: string) => Promise<
|
|
4694
|
+
get: (id: string) => Promise<TaskDetailResponse>;
|
|
4423
4695
|
/** Create a new task */
|
|
4424
4696
|
create: (data: CreateTaskRequest) => Promise<Task>;
|
|
4425
4697
|
/** Update an existing task */
|
|
@@ -4467,7 +4739,7 @@ declare const createLocuClient: (config: LocuClientConfig) => {
|
|
|
4467
4739
|
/** List all sessions */
|
|
4468
4740
|
list: (params?: SessionListParams) => Promise<PaginatedResponse<SessionWithActivities>>;
|
|
4469
4741
|
/** Get a single session by ID */
|
|
4470
|
-
get: (id: string) => Promise<
|
|
4742
|
+
get: (id: string) => Promise<Session>;
|
|
4471
4743
|
/** Create a new session */
|
|
4472
4744
|
create: (data: CreateSessionRequest) => Promise<Session>;
|
|
4473
4745
|
/** Update an existing session */
|